Ir para o conteúdo principal

Conta Bancária Credor | Schema V1 | 2025 ~

Tipo Envio: Diário | Regras

Objeto Raiz
Campo Informações
timestamp Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente
elementos

Item
Campo Chave Informações
cpfCnpjCredor
numeroContaBancaria
codigoBancoContaBancaria Código da FEBRABAN
numeroAgenciaContaBancaria
action Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão

Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Conta Bancária Credor",
  "description": "Schema para envio de contas bancárias dos credores por unidade gestora",
  "type": "object",
  "properties": {
    "timestamp": {
      "type": "string",
      "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)\\.\\d{3,6}$",
      "examples": ["2025-09-11T15:30:00.123456"]
    },
    "elementos": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "properties": {
         "cpfCnpjCredor": {
            "type": "string",
            "minLength": 11,
            "maxLength": 14,
            "pattern": "^[A-Z0-9]+$"
          },
          "numeroContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 13,
            "pattern": "^[A-Z0-9]+$"
          },
          "codigoBancoContaBancaria": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[0-9]+$"
          },
          "numeroAgenciaContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 6,
            "pattern": "^[A-Z0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "cpfCnpjCredor",
          "numeroContaBancaria",
          "codigoBancoContaBancaria",
          "numeroAgenciaContaBancaria",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "elementos"],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "cpfCnpjCredor": "12312312312",
      "numeroContaBancaria": "0012345678901",
      "codigoBancoContaBancaria": "001",
      "numeroAgenciaContaBancaria": "1234A",
      "action": "CREATE"
    },
    {
      "cpfCnpjCredor": "12312312312ACZ",
      "numeroContaBancaria": "0098765432100",
      "codigoBancoContaBancaria": "033",
      "numeroAgenciaContaBancaria": "5678B",
      "action": "UPDATE"
    },
    {
      "cpfCnpjCredor": "12312312312ACZ",
      "numeroContaBancaria": "0011122233300",
      "codigoBancoContaBancaria": "104",
      "numeroAgenciaContaBancaria": "9999C",
      "action": "DELETE"
    }
  ]
}