Para saber mais sobre webhooks em nossa API, siga o link abaixo:
No caso de um reembolso de um Pix que é creditado na sua conta, a melhor maneira de receber essa informação é usando o webhook PIX_REFUNDED. Assim que um reembolso é recebido na sua conta, um webhook PIX_REFUNDED é enviado.
Aqui está a maneira mais simples de configurar um webhook PIX_REFUNDED:
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
Body
{
"eventType": "PIX_REFUNDED",
"url": "https://example.com.br/webhooks/v1/pixrefundreceived", // Adicione seu próprio URL aqui
"authorization": "NONE,
"authorizationScheme": "NONE"
}
Assim que um Pix é reembolsado e creditado na sua conta, aqui está o que você receberá no URL registrado:
PIX_REFUNDED
PIX_REFUNDED{
"eventType": "PIX_REFUNDED",
"endToEndId": "D0041696820240426011111111111",
"originalEndToEndId": "E38224857202404260111111111111",
"amount": 500.0,
"bankAccount": "11111",
"refundCode": "MD06",
"reasonRefund": "Devolução solicitada pelo cliente",
"createdAt": "2024-04-26T01:53:04.329Z",
"proof": {
"idempotencyKey": "D0041696820240426011111111111",
"endToEndId": "D0041696820240426011111111111",
"originalEndToEndId": "E38224857202404260111111111111",
"status": "PIX_EFFECTIVE",
"operationType": "CREDIT_REFUND",
"amount": 500.0,
"createdAt": "2024-04-26T01:53:02.901Z",
"finishedAt": "2024-04-26T01:53:02.901Z",
"payer": {
"number": "11111111111",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "BANCO XXXXX",
"ispb": "1111111111"
},
"holder": {
"document": "***1111111**",
"type": "NATURAL"
}
},
"beneficiary": {
"number": "38709",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELCRED SCD S.A.",
"ispb": "38224857"
},
"holder": {
"name": "EMPRESA LTDA",
"document": "94478450000138",
"type": "LEGAL"
}
}
}
}
Aqui estão os atributos que são passados pelo webhook PIX_REFUNDED:
| Name | Description |
|---|---|
| eventType | O tipo de evento que acionou o webhook (ex.: "PIX_REFUNDED"). |
| endToEndId | O identificador único para a transação de reembolso PIX. |
| originalEndToEndId | O identificador único para a transação PIX original que está sendo reembolsada. |
| amount | O valor monetário da transação de reembolso PIX. |
| bankAccount | O número da conta onde o reembolso será creditado. |
| refundCode | Um código que representa o motivo do reembolso (ex.: "MD06"). |
| reasonRefund | Uma descrição textual explicando o motivo do reembolso (ex.: "Devolução solicitada pelo cliente"). |
| createdAt | O timestamp indicando quando a transação de reembolso PIX foi criada. |
| proof | Um objeto contendo informações detalhadas de comprovante da transação de reembolso PIX. |
| proof.idempotencyKey | Uma chave única para garantir a idempotência do processamento do contexto proof. |
| proof.endToEndId | O identificador único para a transação de reembolso PIX no contexto proof. |
| proof.originalEndToEndId | O identificador único para a transação PIX original no contexto proof. |
| proof.status | O status da transação de reembolso PIX (ex.: "PIX_EFFECTIVE"). |
| proof.operationType | O tipo de operação que está sendo realizada (ex.: "CREDIT_REFUND"). |
| proof.amount | O valor monetário da transação de reembolso PIX no contexto proof. |
| proof.createdAt | O timestamp de quando o processo de reembolso foi iniciado. |
| proof.finishedAt | O timestamp de quando o processo de reembolso foi concluído. |
| proof.payer | Um objeto contendo informações sobre o pagador da transação de reembolso PIX. |
| proof.payer.number | O número da conta do pagador. |
| proof.payer.branch | O número da agência da conta do pagador. |
| proof.payer.type | O tipo da conta do pagador (ex.: "CURRENT"). |
| proof.payer.participant | Um objeto contendo informações sobre a instituição financeira do pagador. |
| proof.payer.participant.name | O nome da instituição financeira do pagador (ex.: "BANCO XXXXX"). |
| proof.payer.participant.ispb | O código ISPB da instituição financeira do pagador. |
| proof.payer.holder | Um objeto contendo informações sobre o titular da conta do pagador. |
| proof.payer.holder.document | O documento do titular da conta do pagador (ex.: parcialmente mascarado para segurança). |
| proof.payer.holder.type | O tipo do pagador (ex.: "LEGAL" ou "NATURAL"). |
| proof.beneficiary | Um objeto contendo informações sobre o beneficiário da transação de reembolso PIX. |
| proof.beneficiary.number | O número da conta do beneficiário. |
| proof.beneficiary.branch | O número da agência da conta do beneficiário. |
| proof.beneficiary.type | O tipo da conta do beneficiário (ex.: "CURRENT"). |
| proof.beneficiary.participant | Um objeto contendo informações sobre a instituição financeira do beneficiário. |
| proof.beneficiary.participant.name | O nome da instituição financeira do beneficiário (ex.: "DELCRED SCD S.A."). |
| proof.beneficiary.participant.ispb | O código ISPB da instituição financeira do beneficiário (ex.: "38224857"). |
| proof.beneficiary.holder | Um objeto contendo informações sobre o titular da conta do beneficiário. |
| proof.beneficiary.holder.name | O nome do beneficiário (ex.: "EMPRESA LTDA"). |
| proof.beneficiary.holder.document | O documento do beneficiário. |
| proof.beneficiary.holder.type | O tipo do beneficiário (ex.: "LEGAL" ou "NATURAL"). |