API Reference
Log In
API Reference

Transferência Interna enviada Webhook

📘

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

Sobre Webhooks

Quando uma transferência interna é debitada da sua conta, a melhor maneira de receber atualizações é usando o webhook TRANSFER_INTERNAL_DEBITED. Assim que a transação é concluída, o webhook TRANSFER_INTERNAL_DEBITED é enviado.

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

Headers

NameDescription
x-delbank-api-keyRequired. API key

Body

{
  "eventType": "TRANSFER_INTERNAL_DEBITED",
  "url": "https://example.com.br/webhooks/v1/transferinternalsent", // Adicione seu próprio URL aqui
  "authorization": "NONE,
  "authorizationScheme": "NONE"
}

Assim que a transferência for debitada da sua conta, aqui está o que você receberá no URL registrado:

{
   "id":"e9ee2e45-8ccc-449c-857a-e6cb52b229cd",
   "externalId":"SDFSDFSDFSD1234589278",
   "eventType":"TRANSFER_INTERNAL_DEBITED",
   "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_DEBITED:

NameDescription
idO identificador único para a transação.
externalIdUm identificador externo para a transação.
eventTypeO tipo de evento que acionou o webhook (ex.: "TRANSFER_INTERNAL_CREDITED").
statusO status atual da transação (ex.: "EFFECTIVE").
paymentChannelO canal pelo qual o pagamento foi realizado.
typeO tipo de transação (ex.: "INTERNAL").
amountO valor monetário da transação.
createdAtO timestamp indicando quando a transação foi criada.
payerUm objeto contendo informações sobre o pagador da transação.
payer.numberO número da conta do pagador.
payer.branchO número da agência da conta do pagador.
payer.typeO tipo da conta do pagador (ex.: "CURRENT").
payer.holderUm objeto contendo informações sobre o titular da conta do pagador.
payer.holder.documentO documento do titular da conta do pagador.
payer.holder.nameO nome do titular da conta do pagador.
payer.holder.typeO tipo do titular da conta do pagador (ex.: "NATURAL" ou "LEGAL").
payer.participantUm objeto contendo informações sobre a instituição financeira do pagador.
payer.participant.nameO nome da instituição financeira do pagador.
payer.participant.ispbO código ISPB da instituição financeira do pagador.
beneficiaryUm objeto contendo informações sobre o beneficiário da transação.
beneficiary.numberO número da conta do beneficiário.
beneficiary.branchO número da agência da conta do beneficiário.
beneficiary.typeO tipo da conta do beneficiário.
beneficiary.holderUm objeto contendo informações sobre o titular da conta do beneficiário.
beneficiary.holder.documentO documento do titular da conta do beneficiário.
beneficiary.holder.nameO nome do titular da conta do beneficiário.
beneficiary.holder.typeO tipo do titular da conta do beneficiário.
beneficiary.participantUm objeto contendo informações sobre a instituição financeira do beneficiário.
beneficiary.participant.nameO nome da instituição financeira do beneficiário.
beneficiary.participant.ispbO código ISPB da instituição financeira do beneficiário.