Devolução recebida de Pix Webhook

info

📘 Para saber mais sobre webhooks em nossa API, siga o link abaixo:

Sobre Webhooks

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

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API

Corpo da requisição

{
  "eventType": "PIX_REFUNDED",
  "url": "https://example.com.br/webhooks/v1/pixrefundreceived", // Add your own URL here
  "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

{
   "eventType": "PIX_REFUNDED",
   "endToEndId": "D38224857202502281818Xo3VqKXafNW",
   "originalEndToEndId": "E38224857202502281816OTCGIA6RVKG",
   "amount": 10,
   "bankAccount": "43028",
   "refundCode": "MD06",
   "reasonRefund": "Pedido reembolso",
   "idempotencyKey": "9ee5dfcb-8733-4271-bceb-64130171b616",
   "externalId": "13c5edd4-616e-43a1-aa80-c25b6ee15967",
   "createdAt": "2025-02-28T18:18:35.861Z",
   "proof": {
      "endToEndId": "D38224857202502281818Xo3VqKXafNW",
      "originalEndToEndId": "E38224857202502281816OTCGIA6RVKG",
      "status": "PIX_EFFECTIVE",
      "operationType": "CREDIT_REFUND",
      "amount": 10,
      "createdAt": "2025-02-28T18:18:35.776Z",
      "finishedAt": "2025-02-28T18:18:35.776Z",
      "description": "Pedido reembolso",
      "payer": {
         "number": "10138",
         "branch": "0001",
         "type": "CURRENT",
         "participant": {
            "name": "DELCRED SCD S.A.",
            "ispb": "38224857"
         },
         "holder": {
            "name": "FIDC DELCRED",
            "document": "11468192000181",
            "type": "LEGAL"
         }
      },
      "beneficiary": {
         "number": "43028",
         "branch": "0001",
         "type": "CURRENT",
         "participant": {
            "name": "DELCRED SCD S.A.",
            "ispb": "38224857"
         },
         "holder": {
            "name": "JOSE WILSON DOS SANTOS JUNIOR",
            "document": "498925*",
            "type": "NATURAL"
         }
      }
   }
}

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").
idempotencyKey	Uma chave exclusiva para garantir a idempotência do processamento do evento de prova.
externalId	Um identificador externo para a transação.
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.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").