TED recebido Webhook

info

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

Sobre Webhooks

Quando uma transferência TED é creditada em sua conta, a melhor maneira de receber essas informações é usando o webhook TRANSFER_EXTERNAL_CREDITED. Assim que a transação for concluída, o webhook TRANSFER_EXTERNAL_CREDITED será enviado.

Esta é a maneira mais simples de configurar um webhook TRANSFER_EXTERNAL_CREDITED:

Headers

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

Corpo da requisição

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

Assim que a transferência for creditada na sua conta, veja o que você receberá no URL registrado:

{
  "id": "75bb0190-f96d-4a5b-a8f0-798680932bf2",
  "externalId": null,
  "eventType": "TRANSFER_EXTERNAL_CREDITED",
  "status": "DONE",
  "paymentChannel": "API",
  "type": "TED",
  "amount": 0.01,
  "createdAt": "2025-05-09T20:29:46.156Z",
  "payer": {
    "number": "30422",
    "branch": "0001",
    "type": "CURRENT",
    "holder": {
      "document": "06790157000144",
      "name": "conta teste 0003",
      "type": "LEGAL"
    },
    "participant": {
      "name": "DELBANK",
      "ispb": "38224857"
    }
  },
  "beneficiary": {
    "number": "31712",
    "branch": "0001",
    "type": "CURRENT",
    "holder": {
      "document": "30287697789",
      "name": "HOMOLOGACAO INTEGRACAO API",
      "type": "NATURAL"
    },
    "participant": {
      "name": "BCO DO BRASIL S.A.",
      "ispb": "00000000"
    }
  }
}

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

Name	Description
id	O identificador único da transação
externalId	Um identificador externo da transação
eventType	O tipo de evento que acionou o webhook (por exemplo, "TRANSFER_EXTERNAL_CREDITED")
status	O status atual da transação (por exemplo, "EFFECTIVE")
paymentChannel	O canal pelo qual o pagamento foi realizado
type	O tipo da transação (por exemplo, "INTERNAL")
amount	O valor monetário da transação
createdAt	A data e hora 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 (por exemplo, "CURRENT")
payer.holder	Um objeto contendo informações sobre o titular da conta do pagador
payer.holder.document	O número do documento do pagador
payer.holder.name	O nome do pagador
payer.holder.type	O tipo do pagador (por exemplo, "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 número do documento do beneficiário
beneficiary.holder.name	O nome do beneficiário
beneficiary.holder.type	O tipo 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