Pagamento
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
elementos
–
Item
Campo
Chave
Informações
codigoUnidadeOrcamentaria
✅
Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício
numeroEmpenho
✅
–
numeroLiquidacao
✅
–
numeroPagamento
✅
–
dataPagamento
–
–
valorPagamento
–
–
codigoFonteRecurso
–
Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC
exercicioFonteRecurso
–
Atual / Anterior
codigoBancoContaBancaria
–
Código da FEBRABAN
numeroContaBancaria
–
Conta bancária cadastrada pela Unidade Gestora para o exercício
tipoContaBancaria
–
Tabela Tipo Conta Bancária
numeroAgenciaContaBancaria
–
Conta bancária cadastrada pela Unidade Gestora para o exercício
cnpjGerenciaContaBancaria
–
–
numeroDocumentoDebito
–
–
codigoBancoContaBancariaCredito
–
Código da FEBRABAN
numeroAgenciaContaBancariaCredito
–
Conta do credor do pagamento (adicionar para as outras)
numeroContaBancariaCredito
–
–
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"]
},
"elementos": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"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]+$"
},
"dataPagamento": {
"type": "string",
"format": "date"
},
"valorPagamento": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": ["ATUAL", "ANTERIOR"]
},
"codigoBancoContaBancaria": {
"type": "string",
"maxLength": 3
},
"numeroContaBancaria": {
"type": "string",
"maxLength": 13
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"maxLength": 6
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14
},
"numeroDocumentoDebito": {
"type": "string",
"maxLength": 11
},
"codigoBancoContaBancariaCredito": {
"type": "string",
"maxLength": 3
},
"numeroAgenciaContaBancariaCredito": {
"type": "string",
"maxLength": 6
},
"numeroContaBancariaCredito": {
"type": "string",
"maxLength": 13
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroPagamento",
"dataPagamento",
"valorPagamento",
"codigoFonteRecurso",
"exercicioFonteRecurso",
"codigoBancoContaBancaria",
"numeroContaBancaria",
"tipoContaBancaria",
"numeroAgenciaContaBancaria",
"cnpjGerenciaContaBancaria",
"numeroDocumentoDebito",
"codigoBancoContaBancariaCredito",
"numeroAgenciaContaBancariaCredito",
"numeroContaBancariaCredito",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"pagamentos": [
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001234",
"numeroLiquidacao": "0000001",
"numeroPagamento": "0000001",
"dataPagamento": "2025-09-11",
"valorPagamento": 15000.00,
"codigoFonteRecurso": "100",
"exercicioFonteRecurso": "ATUAL",
"codigoBancoContaBancaria": "001",
"numeroContaBancaria": "12345678901",
"tipoContaBancaria": "1",
"numeroAgenciaContaBancaria": "1234",
"cnpjGerenciaContaBancaria": "12345678000195",
"numeroDocumentoDebito": "12345678901",
"codigoBancoContaBancariaCredito": "341",
"numeroAgenciaContaBancariaCredito": "5678",
"numeroContaBancariaCredito": "98765432100",
"action": "CREATE"
}
]
}