Pix enviado Webhook

info

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

Sobre Webhooks

Quando um Pix é debitado da sua conta, a melhor maneira de receber atualizações sobre o pagamento é usando o webhook PIX_PAYMENT_UPDATED. Assim que o status da transação é atualizado, um webhook PIX_PAYMENT_UPDATED é enviado.

Aqui está a maneira mais simples de configurar um webhook PIX_PAYMENT_UPDATED:

Headers

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

Corpo da requisição

{
  "eventType": "PIX_PAYMENT_UPDATED",
  "url": "https://example.com.br/webhooks/v1/pixupdate", // Add your own URL here
  "authorization": "NONE,
  "authorizationScheme": "NONE"
}

Aqui está um exemplo de um webhook de um pagamento efetivado de um pix enviado:

{
   "eventType":"PIX_PAYMENT_EFFECTIVE",
   "endToEndId":"E3822485720231013020122659082578",
   "idempotencyKey":"idempotencyKey999999",
   "status":"PIX_EFFECTIVE",
   "amount":20.0,
   "createdAt":"2023-10-13T05:01:22.953Z",
   "description":"description",
   "payer":{
      "number":"999999",
      "branch":"0001",
      "type":"CURRENT",
      "participant":{
         "ispb":"38224857"
      },
      "holder":{
         "name":"EXAMPLE EXAMPLE",
         "document":"111111111111111",
         "type":"LEGAL"
      }
   },
   "beneficiary":{
      "number":"1234556",
      "branch":"0001",
      "type":"PAYMENT",
      "participant":{
         "ispb":"08561701"
      },
      "holder":{
         "name":"HOLDER NAME",
         "document":"11111111111",
         "type":"NATURAL"
      }
   }
}

Aqui está um exemplo de um webhook de erro em um pix enviado:

{
   "eventType":"PIX_PAYMENT_ERROR",
   "endToEndId":"E3822485720231013015126180935816",
   "idempotencyKey":"idempotencyKey12345",
   "status":"PIX_ERROR",
   "error":{
      "code":"AC06",
      "description":"Conta transacional do usuário recebedor encontra-se bloqueada."
   },
   "amount":100.0,
   "createdAt":"2023-10-13T04:51:26.84Z",
   "description":"description",
   "payer":{
      "number":"12345",
      "branch":"0001",
      "type":"CURRENT",
      "participant":{
         "ispb":"38224857"
      },
      "holder":{
         "name":"EXAMPLE EXAMPLE",
         "document":"11111111111111",
         "type":"LEGAL"
      }
   },
   "beneficiary":{
      "number":"12345",
      "branch":"3231",
      "type":"CURRENT",
      "participant":{
         "ispb":"90400888"
      },
      "holder":{
         "name":"HOLDER NAME",
         "document":"11111111111",
         "type":"NATURAL"
      }
   }
}

Aqui estão os atributos que são passados ​​pelo webhook PIX_PAYMENT_UPDATED:

Nome	Descrição
eventType	O tipo de evento que acionou o webhook (ex.: "PIX_RECEIVED").
correlationId	Um identificador único para correlacionar o evento com outros processos relacionados.
idempotencyKey	Um identificador fornecido para rastrear o pagamento entre sistemas.
status	O status da transação (ex.: "PIX_PAYMENT_EFFECTIVE").
amount	O valor monetário da transação Pix.
createdAt	O timestamp indicando quando a transação Pix foi criada.
description	Descrição da transação atribuída pelo pagador.
payer	Objeto contendo informações sobre o pagador.
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.: "PAYMENT").
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.: "18236120").
payer.holder	Um objeto contendo informações sobre o titular da conta utilizada para o pagamento.
payer.holder.name	O nome do titular da conta do pagador.
payer.holder.document	O documento do titular da conta do pagador.
payer.holder.type	O tipo da conta do pagador (NATURAL ou LEGAL).
beneficiary	Um objeto contendo informações sobre o beneficiário da transação Pix.
beneficiary.number	O número da conta do beneficiário.
beneficiary.branch	O número da agência 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.: "18236120").
beneficiary.holder.name	O nome do titular da conta do beneficiário.
beneficiary.holder.document	O documento do titular da conta do beneficiário.
beneficiary.holder.type	O tipo da conta do beneficiário (NATURAL ou LEGAL).