Internal Transfer received Webhook

📘

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

About Webhooks

When an internal transfer is credited to your account, the best way to receive this information is using the webhook TRANSFER_INTERNAL_CREDITED. As soon as the transaction is concluded the TRANSFER_INTERNAL_CREDITED webhook is sent.

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

Headers

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

Body

JSON

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

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

JSON

{
   "id":"Ce9ee2e45-8ccc-449c-857a-e6cb52b229cd",
   "externalId":"SDFSDFSDFSD1234589278",
   "eventType":"TRANSFER_INTERNAL_CREDITED",
   "status":"EFFECTIVE",
   "paymentChannel":"API",
   "type":"INTERNAL",
   "amount":0.15,
   "createdAt":"2025-01-15T17:45:59.11Z",
   "payer":{
      "number":"10480",
      "branch":"0001",
      "type":"CURRENT",
      "holder":{
         "document":"12154856555",
         "name":"Alexandre Santos",
         "type":"NATURAL"
      },
      "participant":{
         "name":"DELBANK",
         "ispb":"38224857"
      }
   },
   "beneficiary":{
      "number":"10073",
      "branch":"0001",
      "type":"CURRENT",
      "holder":{
         "document":"14656723822",
         "name":"VINÍCIUS ABREU",
         "type":"NATURAL"
      },
      "participant":{
         "name":"DELBANK",
         "ispb":"38224857"
      }
   }
}

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

Name	Description
id	The unique identifier for the transaction
externalId	An external identifier for the transaction
eventType	The type of event that triggered the webhook (e.g., "TRANSFER_INTERNAL_CREDITED").
status	The current status of the transaction (e.g., "EFFECTIVE").
paymentChannel	The channel through which the payment was made
type	The type of transaction (e.g., "INTERNAL").
amount	The monetary value of the transaction
createdAt	The timestamp indicating when the transaction was created
payer	An object containing information about the payer of the transaction.
payer.number	The account number of the payer
payer.branch	The branch number of the payer's account
payer.type	The type of the payer's account (e.g., "CURRENT").
payer.holder	An object containing information about the holder of the payer's account.
payer.holder.document	The document number of the payer
payer.holder.name	The name of the payer
payer.holder.type	The type of the payer (e.g., "NATURAL" or "LEGAL").
payer.participant	An object containing information about the financial institution of the payer.
payer.participant.name	The name of the payer's financial institution
payer.participant.ispb	The ISPB code of the payer's financial institution
beneficiary	An object containing information about the beneficiary of the transaction.
beneficiary.number	The account number of the beneficiary
beneficiary.branch	The branch number of the beneficiary's account
beneficiary.type	The type of the beneficiary's account
beneficiary.holder	An object containing information about the holder of the beneficiary's account.
beneficiary.holder.document	The document number of the beneficiary
beneficiary.holder.name	The name of the beneficiary
beneficiary.holder.type	The type of the beneficiary
beneficiary.participant	An object containing information about the financial institution of the beneficiary.
beneficiary.participant.name	The name of the beneficiary's financial institution
beneficiary.participant.ispb	The ISPB code of the beneficiary's financial institution