Para saber mais sobre webhooks em nossa API, siga o link abaixo:
Quando um Pix é creditado na sua conta e um reembolso é emitido e enviado, a melhor maneira de receber atualizações sobre o reembolso é usando o webhook PIX_REFUND_PAYMENT_UPDATED. Assim que o status da transação é atualizado, um webhook PIX_REFUND_PAYMENT_UPDATED é enviado.
Esta é a maneira mais simples de configurar um webhook PIX_REFUND_PAYMENT_UPDATED:
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
Body
{
"eventType": "PIX_REFUND_PAYMENT_UPDATED",
"url": "https://example.com.br/webhooks/v1/pixrefundsent", // Adicione seu próprio URL aqui
"authorization": "NONE,
"authorizationScheme": "NONE"
}
Aqui está um exemplo de um webhook de um pagamento efetivado de um reembolso Pix enviado:
{
"eventType": "PIX_REFUND_PAYMENT_EFFECTIVE",
"operationType": "DEBIT_REFUND",
"endToEndId": "D3822485720250110140546Z3zRrju5F",
"originalEndToEndId": "E18236120202501101358s045da5bed3",
"idempotencyKey": "30178290-69b0-43e0-97ba-e9a93b8e2d04",
"status": "PIX_EFFECTIVE",
"amount": 0.01,
"createdAt": "2025-01-10T11:05:46.703Z",
"description": "Pedido reembolso",
"payer":
{
"number": "38709",
"branch": "0001",
"type": "CURRENT",
"participant":
{
"ispb": "38224857"
},
"holder":
{
"name": "EMPRESA LTDA",
"document": "94478450000138",
"type": "LEGAL"
}
},
"beneficiary":
{
"number": "11111111111",
"branch": "0001",
"type": "PAYMENT",
"participant":
{
"ispb": "1111111111"
},
"holder":
{
"document": "***1111111**",
"type": "NATURAL"
}
},
"payee":
{
"number": "11111111111",
"branch": "0001",
"type": "PAYMENT",
"participant":
{
"ispb": "1111111111"
},
"holder":
{
"document": "***1111111**",
"type": "NATURAL"
}
}
}
Aqui estão os atributos que são passados pelo webhook PIX_REFUND_PAYMENT_UPDATED:
| Name | Description |
|---|---|
| eventType | O tipo de evento que acionou o webhook (ex.: "PIX_REFUND_PAYMENT_EFFECTIVE"). |
| operationType | O tipo de operação que está sendo realizada. |
| 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. |
| idempotencyKey | Uma chave única para garantir a idempotência do processamento do evento. |
| status | O status da transação de reembolso PIX. |
| amount | O valor monetário da transação de reembolso PIX. |
| createdAt | O timestamp indicando quando a transação de reembolso PIX foi criada. |
| description | Uma descrição textual explicando o motivo do reembolso (ex.: "Pedido reembolso"). |
| payer | Um objeto contendo informações sobre o pagador da transação de reembolso PIX. |
| payer.number | O número da conta do pagador. |
| payer.branch | O número da agência da conta do pagador. |
| payer.type | O tipo da conta do pagador (ex.: "CURRENT"). |
| payer.participant | Um objeto contendo informações sobre a instituição financeira do pagador. |
| payer.participant.ispb | O código ISPB da instituição financeira do pagador (ex.: "38224857"). |
| payer.holder | Um objeto contendo informações sobre o titular da conta do pagador. |
| payer.holder.name | O nome do titular da conta do pagador (ex.: "EMPRESA LTDA"). |
| payer.holder.document | O documento do titular da conta do pagador (ex.: "94478450000138"). |
| payer.holder.type | O tipo do titular da conta do pagador (ex.: "LEGAL"). |
| beneficiary | Um objeto contendo informações sobre o beneficiário da transação de reembolso PIX. |
| beneficiary.number | O número da conta do beneficiário. |
| beneficiary.branch | O número da agência da conta do beneficiário. |
| beneficiary.type | O tipo da conta do beneficiário (ex.: "PAYMENT"). |
| beneficiary.participant | Um objeto contendo informações sobre a instituição financeira do beneficiário. |
| beneficiary.participant.ispb | O código ISPB da instituição financeira do beneficiário (ex.: "1111111111"). |
| beneficiary.holder | Um objeto contendo informações sobre o titular da conta do beneficiário. |
| beneficiary.holder.document | O documento do titular da conta do beneficiário (ex.: parcialmente mascarado). |
| beneficiary.holder.type | O tipo do titular da conta do beneficiário (ex.: "NATURAL" ou "LEGAL"). |
| payee | Um objeto contendo informações sobre o recebedor da transação de reembolso PIX. |
| payee.number | O número da conta do recebedor. |
| payee.branch | O número da agência da conta do recebedor. |
| payee.type | O tipo da conta do recebedor (ex.: "PAYMENT"). |
| payee.participant | Um objeto contendo informações sobre a instituição financeira do recebedor. |
| payee.participant.ispb | O código ISPB da instituição financeira do recebedor (ex.: "1111111111"). |
| payee.holder | Um objeto contendo informações sobre o titular da conta do recebedor. |
| payee.holder.document | O documento do titular da conta do recebedor (ex.: parcialmente mascarado). |
| payee.holder.type | O tipo do titular da conta do recebedor (ex.: "NATURAL" ou "LEGAL"). |