Bankslip paid Webhook

info

📘 To learn more about webhooks in our API, follow the link below:

About Webhooks

When a bankslip charge payment is credited to your account, the best way to receive this information is using the webhook CHARGE_PAID. As soon as a bankslip payment is received in your account, aCHARGE_PAID weboohk is sent.

Here's the simplest way to configure a CHARGE_PAID webhook:

Headers

Name	Description
x-delbank-api-key	Required. API key

Body

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

Now once a bankslip is paid and credited to your account here's what you are going to receive on the registered URL:

CHARGE_PAID

{
   "nsu":513,
   "correlationId":"217c34be-b374-4e33-9ae2-1b46f14b7116",
   "referenceId":"E3822485720230705211537850921369",
   "source":"SPI",
   "amount":12.12,
   "createdAt":"2023-07-05T17:52:33Z",
   "payer":{
      "name":"FULANO DA SILVA",
      "document":"12399999999"
   },
   "proof":{
      "endToEndId":"E3822485720230705211537850921369",
      "transactionId":"chargeCqkFlaENmal5NrPK58J",
      "key":"5b0ac9a4-fad6-43f9-be70-6d7c9a2fad26",
      "amount":12.12,
      "payer":{
         "number":"10065",
         "branch":"0001",
         "type":"CURRENT",
         "holder":{
            "name":"FULANO DA SILVA",
            "document":"02599999908"
         },
         "participant":{
            "ispb":"38224857",
            "name":"DELCRED SCD S.A."
         }
      },
      "payee":{
         "number":"29823",
         "branch":"0001",
         "type":"CURRENT",
         "holder":{
            "name":"HOMOLOGACAO INTEGRACAO API",
            "document":"30287697789"
         },
         "participant":{
            "ispb":"38224857",
            "name":"DELCRED SCD S.A."
         }
      }
   }
}

And another example

{
   "eventType":"CHARGE_PAID_V2",
   "correlationId":"a0443e00-a74f-4151-8022-6ad4256bfb66",
   "walletNumber":"112",
   "yourNumber":"200806081444",
   "ourNumber":"00001050733",
   "amount":20.00,
   "dueDate":"2025-01-28T00:00:00",
   "barCode":"43597997500000020000001112000082100001050733",
   "digitableLine":"43590001161200008210200010507333799750000002000",
   "payer":{
      "name":"TEST PAYER",
      "document":"11111111111",
      "zipCode":"12345678",
      "address":"ADDRESS TEST",
      "neighborhood":"NEIGHBORHOOD",
      "city":"SÃO PAULO",
      "state":"SP",
      "email":"[email protected]"
   },
   "createdAt":"2025-01-28T19:44:15.913Z",
   "status":"PAID",
   "payments":[
      {
         "date":"2025-01-28T03:00:00.000Z",
         "amount":20.00,
         "payer":{
            "name":"TEST PAYER",
            "document":"11111111111"
         },
         "issuer":{
            "code":"0633",
            "ispb":"68900810",
            "branch":"0001",
            "name":"BANCO RENDIMENTO S.A.",
            "fantasyName":"BCO RENDIMENTO S.A."
         }
      }
   ]
}

Here are the attributes that are passed by the CHARGE_PAID webhook:

Name	Description
nsu	The unique identifier for the transaction (e.g., "513").
correlationId	A unique identifier used to track the transaction (e.g., "217c34be-b374-4e33-9ae2-1b46f14b7116").
referenceId	The reference identifier for the transaction (e.g., "E3822485720230705211537850921369").
source	The source of the transaction (e.g., "SPI").
amount	The monetary value of the transaction (e.g., 12.12).
createdAt	The timestamp indicating when the transaction was created (e.g., "2023-07-05T17:52:33Z").
payer	An object containing information about the payer of the transaction.
payer.name	The name of the payer (e.g., "FULANO DA SILVA").
payer.document	The document number of the payer (e.g., "12399999999").
proof	An object containing detailed proof information for the transaction.
proof.endToEndId	The unique identifier for the transaction within the proof context (e.g., "E3822485720230705211537850921369").
proof.transactionId	The unique identifier for the transaction (e.g., "chargeCqkFlaENmal5NrPK58J").
proof.key	A unique key for the proof (e.g., "5b0ac9a4-fad6-43f9-be70-6d7c9a2fad26").
proof.amount	The monetary value of the transaction within the proof context (e.g., 12.12).
proof.payer	An object containing information about the payer of the transaction.
proof.payer.number	The account number of the payer (e.g., "10065").
proof.payer.branch	The branch number of the payer's account (e.g., "0001").
proof.payer.type	The type of the payer's account (e.g., "CURRENT").
proof.payer.holder	An object containing information about the holder of the payer's account.
proof.payer.holder.name	The name of the payer (e.g., "FULANO DA SILVA").
proof.payer.holder.document	The document number of the payer (e.g., "02599999908").
proof.payer.participant	An object containing information about the financial institution of the payer.
proof.payer.participant.ispb	The ISPB code of the payer's financial institution (e.g., "38224857").
proof.payer.participant.name	The name of the payer's financial institution (e.g., "DELCRED SCD S.A.").
proof.payee	An object containing information about the payee of the transaction.
proof.payee.number	The account number of the payee (e.g., "29823").
proof.payee.branch	The branch number of the payee's account (e.g., "0001").
proof.payee.type	The type of the payee's account (e.g., "CURRENT").
proof.payee.holder	An object containing information about the holder of the payee's account.
proof.payee.holder.name	The name of the payee (e.g., "HOMOLOGACAO INTEGRACAO API").
proof.payee.holder.document	The document number of the payee (e.g., "30287697789").
proof.payee.participant	An object containing information about the financial institution of the payee.
proof.payee.participant.ispb	The ISPB code of the payee's financial institution (e.g., "38224857").
proof.payee.participant.name	The name of the payee's financial institution (e.g., "DELCRED SCD S.A.").