Ir para o conteúdo principal

Transferência Recebida | Schema V1 | 2025 - ∞

Tipo Envio: Diário

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
codigoUnidadeGestoraTransferencia
dataTransferencia
tipoTransferencia Tabela Tipo Transferência
tipoLancamento Tabela Tipo Lancamento
valor
numeroContaBancaria
codigoBancoContaBancaria Código da FEBRABAN
numeroAgenciaContaBancaria
tipoContaBancaria Tabela Tipo Conta Bancária
cnpjGerenciaContaBancaria
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": "Lista de Transferências",
  "description": "Lista de objetos representando a entidade Transferência",
  "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": {
        "title": "Transferência",
        "description": "Representação do schema para envio da entidade Transferência",
        "type": "object",
        "properties": {
          "codigoUnidadeGestoraTransferencia": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "dataTransferencia": {
            "type": "string",
            "format": "date"
          },
          "tipoTransferencia": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "tipoLancamento": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "valor": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "numeroContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 13
          },
          "codigoBancoContaBancaria": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[0-9]+$"
          },
          "numeroAgenciaContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 6
          },
          "tipoContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "cnpjGerenciaContaBancaria": {
            "type": "string",
            "minLength": 14,
            "maxLength": 14,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "codigoUnidadeGestoraTransferencia",
          "dataTransferencia",
          "tipoTransferencia",
          "tipoLancamento",
          "valor",
          "numeroContaBancaria",
          "codigoBancoContaBancaria",
          "numeroAgenciaContaBancaria",
          "tipoContaBancaria",
          "cnpjGerenciaContaBancaria",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "elementos"],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "codigoUnidadeGestoraTransferencia": "654321",
      "dataTransferencia": "2025-09-11",
      "tipoTransferencia": "1",
      "tipoLancamento": "2",
      "valor": 150000.50,
      "numeroContaBancaria": "1234567890123",
      "codigoBancoContaBancaria": "001",
      "numeroAgenciaContaBancaria": "123456",
      "tipoContaBancaria": "1",
      "cnpjGerenciaContaBancaria": "12345678000190",
      "action": "CREATE"
    },
    {
      "codigoUnidadeGestoraTransferencia": "789012",
      "dataTransferencia": "2025-08-15",
      "tipoTransferencia": "3",
      "tipoLancamento": "1",
      "valor": 75000.00,
      "numeroContaBancaria": "9876543210987",
      "codigoBancoContaBancaria": "033",
      "numeroAgenciaContaBancaria": "654321",
      "tipoContaBancaria": "2",
      "cnpjGerenciaContaBancaria": "98765432000199",
      "action": "DELETE"
    }
  ]
}