Webhook de falha em desembolso

Webhook de notificação de falha no desembolso

post

Envia informações sobre falhas passivas no desembolso de uma CCB.

⚠️ Esse endpoint webhook/disbursements/failed é um exemplo, e pode ser customizado conforme necessidade, pelo cadastro do webhook.

Autorizações
Parâmetros de cabeçalho
AuthorizationstringObrigatório

Token de autenticação.

Corpo
versaostring · máx: 10Opcional

versão do payload do evento

Example: 1.0
eventostring · enumOpcional

Tipo do evento

Valores possíveis:
id_eventostringOpcional

Identificador único do evento

Example: a9fabe92-4b07-43c4-ba1c-d5d4873d6a28
data_eventostring · date-timeOpcional

Data e horário do evento, conforme o horário universal (UTC).

Example: 2024-04-25T10:30:00Z
Respostas
200

Requisição processada com sucesso, webhook entregue

Sem conteúdo
post
/webhook/disbursements/failed
POST /webhook/disbursements/failed HTTP/1.1
Host: webhook-endpoint-cliente.exemplo.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 784

{
  "versao": "1.0",
  "evento": "FALHA_DESEMBOLSO",
  "id_evento": "evt_failed_12345678_20231201",
  "data_evento": "2023-12-01T10:30:00Z",
  "dados": {
    "valor_desembolso": 15000,
    "id_transacao": 987654321,
    "data_pagamento": "2023-12-01",
    "status": "AGUARDANDO_SOLUCAO_GIRO",
    "favorecido": {
      "documento": "12345678901"
    },
    "conta_bancaria": {
      "codigo_banco": "001",
      "numero_conta": "567890",
      "digito_conta": "1",
      "numero_agencia": "1234",
      "tipo": "CORRENTE",
      "documento_favorecido": "12345678901"
    },
    "erro": {
      "codigo": "ERR_SISTEMA_INDISPONIVEL",
      "mensagem": "Sistema bancário temporariamente indisponível"
    },
    "ccbs": [
      {
        "origem": "PARCEIRO_XYZ",
        "numero_ccb": "12345678",
        "documento_tomador": "12345678901",
        "valor_desembolso": 5000
      },
      {
        "origem": "PARCEIRO_ABC",
        "numero_ccb": "87654321",
        "documento_tomador": "98765432100",
        "valor_desembolso": 10000
      }
    ]
  }
}
Sem conteúdo
AnteriorWebhooks de pagamento do desembolsoPróximoNotificação de Recebimento da CCB

Atualizado