Estorno Pagamento

• Estorno Pagamento | Schema V1 | 2025 - ∞

Estorno 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	✅	–
numeroPagamento	✅	–
numeroEstornoPagamento	✅	–
dataEstornoPagamento	–	–
motivoEstornoPagamento	–	–
valorEstornoPagamento	–	–
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": "Estornos de Pagamento",
  "description": "Schema para envio de estornos de pagamento 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]+$"
          },
          "numeroPagamento": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroEstornoPagamento": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "dataEstornoPagamento": {
            "type": "string",
            "format": "date"
          },
          "motivoEstornoPagamento": {
            "type": "string",
            "maxLength": 500
          },
          "valorEstornoPagamento": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "codigoUnidadeOrcamentaria",
          "numeroEmpenho",
          "numeroPagamento",
          "numeroEstornoPagamento",
          "dataEstornoPagamento",
          "motivoEstornoPagamento",
          "valorEstornoPagamento",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "elementos"],
  "additionalProperties": false
}

---

Exemplo de Payload

{
  "timestamp": "2025-09-11T15:30:00.123456",
  "estornosPagamento": [
    {
      "codigoUnidadeOrcamentaria": "17050",
      "numeroEmpenho": "0001234",
      "numeroPagamento": "0000001",
      "numeroEstornoPagamento": "0000001",
      "dataEstornoPagamento": "2025-09-11",
      "motivoEstornoPagamento": "Pagamento realizado em duplicidade referente ao processo administrativo nº 001/2025.",
      "valorEstornoPagamento": 15000.00,
      "action": "CREATE"
    },
    {
      "codigoUnidadeOrcamentaria": "17050",
      "numeroEmpenho": "0001235",
      "numeroPagamento": "0000002",
      "numeroEstornoPagamento": "0000002",
      "dataEstornoPagamento": "2025-09-12",
      "motivoEstornoPagamento": "Erro na identificação do credor. Pagamento efetuado para fornecedor incorreto conforme processo nº 002/2025.",
      "valorEstornoPagamento": 8500.50,
      "action": "CREATE"
    }
  ]
}