Ir para o conteúdo principal

Pagamento | 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
pagamentos

Item
Campo Chave Informações
codigoUnidadeGestora
anoEmissaoEmpenho
codigoUnidadeOrcamentaria Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício
numeroEmpenho
numeroLiquidacao
numeroPagamento
competencia
valorPagamento
numeroContaBancaria Conta bancária cadastrada pela Unidade Gestora para o exercício
numeroAgencia Conta bancária cadastrada pela Unidade Gestora para o exercício
codigoBanco Código da FEBRABAN
numeroCheque
numeroDocDebito
codigoBancoCredito Código da FEBRABAN
numeroAgenciaCredito
numeroContaBancariaCredito
exercicioFonteRecurso Atual / Anterior
codigoFonteRecurso Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC
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": "Pagamentos",
  "description": "Schema para envio de pagamentos 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"]
    },
    "pagamentos": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "properties": {
          "codigoUnidadeGestora": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "anoEmissaoEmpenho": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^(19|20)[0-9]{2}$"
          },
          "codigoUnidadeOrcamentaria": {
            "type": "string",
            "minLength": 5,
            "maxLength": 5,
            "pattern": "^[0-9]+$"
          },
          "numeroEmpenho": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroLiquidacao": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroPagamento": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "competencia": {
            "type": "string",
            "format": "date"
          },
          "valorPagamento": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "numeroContaBancaria": {
            "type": "string",
            "maxLength": 13
          },
          "numeroAgencia": {
            "type": "string",
            "maxLength": 6
          },
          "codigoBanco": {
            "type": "string",
            "maxLength": 3
          },
          "numeroCheque": {
            "type": "string",
            "maxLength": 6
          },
          "numeroDocDebito": {
            "type": "string",
            "maxLength": 11
          },
          "codigoBancoCredito": {
            "type": "string",
            "maxLength": 3
          },
          "numeroAgenciaCredito": {
            "type": "string",
            "maxLength": 6
          },
          "numeroContaBancariaCredito": {
            "type": "string",
            "maxLength": 13
          },
          "exercicioFonteRecurso": {
            "type": "string",
            "enum": ["ATUAL", "ANTERIOR"]
          },
          "codigoFonteRecurso": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[0-9]+$"
          },
          "tipoContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "cnpjGerenciaContaBancaria": {
            "type": "string",
            "minLength": 14,
            "maxLength": 14
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "codigoUnidadeGestora",
          "anoEmissaoEmpenho",
          "codigoUnidadeOrcamentaria",
          "numeroEmpenho",
          "numeroLiquidacao",
          "numeroPagamento",
          "competencia",
          "valorPagamento",
          "numeroContaBancaria",
          "numeroAgencia",
          "codigoBanco",
          "codigoFonteRecurso",
          "tipoContaBancaria",
          "cnpjGerenciaContaBancaria"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "pagamentos"],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2026-03-02T11:32:45.123456",
  "pagamentos": [
    {
      "codigoUnidadeGestora": "123456",
      "anoEmissaoEmpenho": "2026",
      "codigoUnidadeOrcamentaria": "54321",
      "numeroEmpenho": "0000001",
      "numeroLiquidacao": "0000001",
      "numeroPagamento": "0000001",
      "competencia": "2026-03-01",
      "valorPagamento": 150000.50,
      "numeroContaBancaria": "0123456789012",
      "numeroAgencia": "00123",
      "codigoBanco": "001",
      "numeroCheque": "000001",
      "numeroDocDebito": "00000000001",
      "codigoBancoCredito": "341",
      "numeroAgenciaCredito": "00456",
      "numeroContaBancariaCredito": "9876543210001",
      "exercicioFonteRecurso": "ATUAL",
      "codigoFonteRecurso": "500",
      "tipoContaBancaria": "1",
      "cnpjGerenciaContaBancaria": "12345678000195",
      "action": "CREATE"
    },
    {
      "codigoUnidadeGestora": "654321",
      "anoEmissaoEmpenho": "2026",
      "codigoUnidadeOrcamentaria": "12345",
      "numeroEmpenho": "0000002",
      "numeroLiquidacao": "0000002",
      "numeroPagamento": "0000002",
      "competencia": "2026-03-02",
      "valorPagamento": 82500.00,
      "numeroContaBancaria": "9876543210987",
      "numeroAgencia": "00789",
      "codigoBanco": "237",
      "codigoFonteRecurso": "501",
      "tipoContaBancaria": "2",
      "cnpjGerenciaContaBancaria": "98765432000187",
      "action": "UPDATE"
    }
  ]
}