Webhook de revisão de liquidação
Evento REVISAO_DESEMBOLSO, enviado quando a liquidação falha por inconsistência na conta ou por instabilidade bancária recuperável. Contém o ticket para realizar a revisão de liquidação via API.
O campo dados.revisao_conta_desembolso.acoes_disponiveis informa o que é aceito naquele ticket: NOVA_CONTA (conta ou PIX diferentes dos que falharam) e/ou RETENTATIVA (reenviar a mesma conta da tentativa que falhou). Falha de dados bancários gera ["NOVA_CONTA"]; instabilidade bancária gera ["NOVA_CONTA", "RETENTATIVA"].
As regras de validação, o uso único do ticket e o limite de retentativas estão no guia de revisão de liquidação. Para disparar cada cenário em homologação, use as chaves PIX de teste.
Tickets emitidos antes deste campo continuam válidos e se comportam como ["NOVA_CONTA"].
Envia informações sobre a falha na liquidação de uma CCB devido a inconsistência da conta de liquidação. Inclui informações necessárias para revisão de uma conta de liquidação.
⚠️ Esse endpoint webhook/disbursements/amendment é um exemplo, e pode ser customizado conforme necessidade, pelo cadastro do webhook.
Token de autenticação.
versão do payload do evento
1.0Tipo do evento
Identificador único do evento
a9fabe92-4b07-43c4-ba1c-d5d4873d6a28Data e horário do evento, conforme o horário universal (UTC).
2024-04-25T10:30:00ZRequisição processada com sucesso, webhook entregue
Sem conteúdo
Requisição não processada, webhook não será entregue novamente
Requisição não processada, webhook será entregue novamente após um período
POST /webhook/disbursements/amendment HTTP/1.1
Host: webhook-endpoint-cliente.exemplo.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 930
{
"versao": "1.0",
"evento": "REVISAO_DESEMBOLSO",
"id_evento": "evt_revision_12345678_20231201",
"data_evento": "2023-12-01T10:30:00Z",
"dados": {
"valor_desembolso": 15000,
"id_transacao": 987654321,
"data_pagamento": "2023-12-01",
"status": "AGUARDANDO_REVISAO",
"favorecido": {
"documento": "12345678901"
},
"conta_bancaria": {
"codigo_banco": "001",
"numero_conta": "567890",
"digito_conta": "1",
"numero_agencia": "1234",
"tipo": "CORRENTE"
},
"erro": {
"codigo": "ERR_CONTA_INVALIDA",
"mensagem": "Conta bancária inválida ou inexistente"
},
"revisao_conta_desembolso": {
"ticket": "ticket_revision_abc123def456",
"data_criacao": "2023-12-01T10:30:00Z",
"data_vencimento": "2023-12-02T10:30:00Z",
"acoes_disponiveis": [
"NOVA_CONTA",
"RETENTATIVA"
]
},
"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
Atualizado