> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-formalizacao-de-credito/api-reference/webhooks/webhook-de-falha-na-liquidacao.md).

# Webhook de falha na liquidação

## Webhook de notificação de falha na liquidação

> Envia informações sobre falhas passivas na liquidação de uma CCB.\
> \
> ⚠️ Esse endpoint \`webhook/disbursements/failed\` é um exemplo, e pode ser customizado conforme necessidade, pelo cadastro do webhook.<br>

```json
{"openapi":"3.0.0","info":{"title":"API de Webhooks de Formalização de Crédito","version":"3.0.0"},"servers":[{"url":"https://webhook-endpoint-cliente.exemplo.com","description":"Endpoint configurado pelo cliente para receber webhooks"}],"security":[{"TokenAuth":[]}],"components":{"securitySchemes":{"TokenAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/webhook/disbursements/failed":{"post":{"summary":"Webhook de notificação de falha na liquidação","description":"Envia informações sobre falhas passivas na liquidação de uma CCB.\n\n⚠️ Esse endpoint `webhook/disbursements/failed` é um exemplo, e pode ser customizado conforme necessidade, pelo cadastro do webhook.\n","tags":["Webhooks de Liquidação"],"parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Token de autenticação."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"versao":{"type":"string","maxLength":10,"description":"versão do payload do evento"},"evento":{"type":"string","enum":["FALHA_DESEMBOLSO"],"description":"Tipo do evento"},"id_evento":{"type":"string","description":"Identificador único do evento"},"data_evento":{"type":"string","format":"date-time","description":"Data e horário do evento, conforme o horário universal (UTC)."},"dados":{"type":"object","description":"Dados dos pagamentos e das CCBs associadas.","properties":{"valor_desembolso":{"type":"number","format":"double","description":"Valor liquidado.","maximum":999999999.99,"minimum":0},"id_transacao":{"type":"integer","format":"int64","description":"Id único da transferência"},"data_pagamento":{"type":"string","format":"date","description":"Data em que o pagamento foi realizado."},"status":{"type":"string","enum":["AGUARDANDO_SOLUCAO_GIRO"],"description":"Situação do pagamento."},"favorecido":{"type":"object","description":"Informações sobre o favorecido da liquidação da operação.","required":["documento"],"properties":{"documento":{"type":"string","pattern":"^(\\d{11}|\\d{14})$","maxLength":14,"description":"CPF ou CNPJ do favorecido."}}},"conta_bancaria":{"type":"object","description":"Dados da conta bancária utilizada na liquidação da operação.","required":["codigo_banco","numero_conta","numero_agencia","tipo"],"properties":{"codigo_banco":{"type":"string","maxLength":14,"description":"Código do banco."},"numero_conta":{"type":"string","maxLength":20,"description":"Número da conta bancária."},"digito_conta":{"type":"string","maxLength":2,"description":"Dígito da conta bancária."},"numero_agencia":{"type":"string","maxLength":4,"description":"Número da Agência."},"tipo":{"type":"string","enum":["CORRENTE","POUPANCA"],"description":"Tipo de conta, Corrente ou Poupança."}}},"pix":{"type":"object","description":"Dados da chave pix utilizada na liquidação da operação.","required":["chave_pix","tipo_chave_pix"],"properties":{"chave_pix":{"type":"string","maxLength":255,"description":"Chave PIX."},"tipo_chave_pix":{"type":"string","enum":["EMAIL","CPF","CNPJ","PHONE","EVP"],"description":"Tipo da chave PIX."}}},"erro":{"type":"object","description":"Informações referentes ao erro que ocasionou falha no pagamento","properties":{"codigo":{"type":"string","maxLength":255,"description":"Código de erro interno para referência."},"mensagem":{"type":"string","maxLength":255,"description":"Mensagem de erro que ocasionou a falha no pagamento."}}},"ccbs":{"type":"array","description":"CCBs associadas ao pagamento","items":{"type":"object","description":"CCB associada à liquidação da operação","properties":{"origem":{"type":"string","maxLength":255,"description":"Originador da operação."},"numero_ccb":{"type":"string","maxLength":20,"description":"Número da CCB."},"documento_tomador":{"type":"string","pattern":"^(\\d{11}|\\d{14})$","maxLength":14,"description":"CPF ou CNPJ do tomador."},"valor_desembolso":{"type":"number","format":"double","description":"Valor liquidado.","maximum":999999999.99,"minimum":0}}}}}}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso, webhook entregue"},"400":{"description":"Requisição não processada, webhook não será entregue novamente"},"500":{"description":"Requisição não processada, webhook será entregue novamente após um período"}}}}}}
```
