Para saber mais sobre webhooks em nossa API, siga o link abaixo:
Quando uma transferência interna é creditada na sua conta, a melhor maneira de receber essas informações é usando o webhook TRANSFER_INTERNAL_CREDITED
. Assim que a transação for concluída, o webhook TRANSFER_INTERNAL_CREDITED
é enviado.
Aqui está a maneira mais simples de configurar um webhook TRANSFER_INTERNAL_CREDITED
:
Headers
Name | Description |
---|---|
x-delbank-api-key | Required. API key |
Body
{
"eventType": "TRANSFER_INTERNAL_CREDITED",
"url": "https://example.com.br/webhooks/v1/transferinternalreceived", // Adicione seu próprio URL aqui
"authorization": "NONE,
"authorizationScheme": "NONE"
}
Assim que a transferência for creditada na sua conta, veja o que você receberá no URL registrado:
{
"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"
}
}
}
Aqui estão os atributos que são passados pelo webhook TRANSFER_INTERNAL_CREDITED
:
Name | Description |
---|---|
id | O identificador único para a transação. |
externalId | Um identificador externo para a transação. |
eventType | O tipo de evento que acionou o webhook (ex.: "TRANSFER_INTERNAL_CREDITED"). |
status | O status atual da transação (ex.: "EFFECTIVE"). |
paymentChannel | O canal pelo qual o pagamento foi realizado. |
type | O tipo de transação (ex.: "INTERNAL"). |
amount | O valor monetário da transação. |
createdAt | O timestamp indicando quando a transação foi criada. |
payer | Um objeto contendo informações sobre o pagador da transação. |
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.holder | Um objeto contendo informações sobre o titular da conta do pagador. |
payer.holder.document | O documento do titular da conta do pagador. |
payer.holder.name | O nome do titular da conta do pagador. |
payer.holder.type | O tipo do titular da conta do pagador (ex.: "NATURAL" ou "LEGAL"). |
payer.participant | Um objeto contendo informações sobre a instituição financeira do pagador. |
payer.participant.name | O nome da instituição financeira do pagador. |
payer.participant.ispb | O código ISPB da instituição financeira do pagador. |
beneficiary | Um objeto contendo informações sobre o beneficiário da transação. |
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. |
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. |
beneficiary.holder.name | O nome do titular da conta do beneficiário. |
beneficiary.holder.type | O tipo do titular da conta do beneficiário. |
beneficiary.participant | Um objeto contendo informações sobre a instituição financeira do beneficiário. |
beneficiary.participant.name | O nome da instituição financeira do beneficiário. |
beneficiary.participant.ispb | O código ISPB da instituição financeira do beneficiário. |