Webhook após finalização de envio de TED

Webhook informará caso uma transação TED tenha sido devolvida.

Webhook Request Body

Webhook Body: TED Rejeitada

{
  "webhook_type": "baas.ted.outgoing_ted",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
    "created_at": "2021-10-22T20:30:23.459Z",
    "ted_status": "sent",
    "transaction_amount": 126.97,
    "fee_amount": 0.0,
    "target_account": {
      "account_branch": "0001",
      "account_digit": "6",
      "account_number": "78340",
      "ispb": "12345678",
      "owner_document_number": "32402502000135",
      "owner_name": "QI Tech"
    },
    "refusal_reason": {
      "refusal_code": 1,
      "enumerator": "conta_destinatario_encerrada",
      "description": "Conta Destinatária do Crédito Encerrada"
    }
  }
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
request_control_key	string	Chave única de identificação da request utilizada pelo cliente no formato uuid v4	36
ted_key	string	Chave única de identificação da transferência TED	36
created_at	string	Data e hora de criação da transação	24
ted_status	string	Status da transação TED	Enumerador ted_status
transaction_amount	number	Valor da transferência	10
fee_amount	number	Valor da taxa cobrada pela transferencia	35
target_account	Object	Conta destino - Só deve ser enviada em transações do tipo "manual"	Objeto target_account
refusal_reason	Object	Motivo da recusa de acordo com o padrão do Banco Central	Objeto refusal_reason

Enumerador ted_status

Enumerador	Descrição
sent	Transferência TED realizada com sucesso.
pending	Transferência TED pendente.
rejected	Transferência TED rejeitada.
returned	Transferência TED devolvida.

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência.	4
account_digit *	string	Dígito da conta	1
account_number *	string	Número da conta.	20
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta.	14
owner_name *	string	Nome do titular da conta.	50
account_type*	string	Tipo da conta.	Enumerador account_type
ispb *	string	Base no CNPJ da instituição financeira (8 dígitos).	8

Objeto refusal_reason

Campo	Tipo	Descrição	Caracteres
bacen_code *	string	Código de recusa Bacen	3
enumerator *	string	Enumerador da recusa Bacen	100
description *	string	Descrição da recusa Bacen	100

Enumerador account_type

Enumerador	Tradução
checking_account	conta corrente
deposit_account	conta depósito
guaranteed_account	conta de garantia
investment_account	conta de investimento
payment_account	conta de pagamento
saving_account	conta poupança

Webhook após o recebimento de TED

Webhook informará sobre o status final da transação TED.

Webhook Request Body

Request Body: TED Recebida

{
  "webhook_type": "baas.ted.incoming_ted",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
    "created_at": "2021-10-22T20:30:23.459Z",
    "ted_status": "received",
    "transaction_amount": 126.97,
    "fee_amount": 0.0,
    "source_account": {
      "account_branch": "0001",
      "account_digit": "6",
      "account_number": "78340",
      "ispb": "12345678",
      "owner_document_number": "32402502000135",
      "owner_name": "QI Tech"
    },
    "refusal_reason": {}
  }
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
ted_key	string	Chave única de identificação da transferência TED	36
created_at	string	Data e hora de criação da transação	100
ted_status	string	Status da transação TED	Enumerador ted_status
transaction_amount	number	Valor da transferência	10
fee_amount	number	Valor da taxa cobrada pela transferencia	35
target_account	Object	Conta destino - Só deve ser enviada em transações do tipo "manual"	Objeto target_account
refusal_reason	Object	Motivo da recusa de acordo com o padrão do Banco Central	Objeto refusal_reason

Enumerador ted_status

Enumerador	Descrição
received	Transferência TED realizada com sucesso.
pending	Transferência TED pendente.
rejected	Transferência TED rejeitada.

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência.	10
account_digit *	string	Dígito da conta	10
account_number *	string	Número da conta.	10
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta.	14
owner_name *	string	Nome do titular da conta.	50
account_type*	string	Tipo da conta.	Enumerador account_type
ispb *	string	Base no CNPJ da instituição financeira (8 dígitos).	8

Objeto refusal_reason

Campo	Tipo	Descrição	Caracteres
bacen_code *	string	Código de recusa Bacen	3
enumerator *	string	Enumerador da recusa Bacen	100
description *	string	Descrição da recusa Bacen	100

Enumerador account_type

Enumerador	Tradução
checking_account	conta corrente
deposit_account	conta depósito
guaranteed_account	conta de garantia
investment_account	conta de investimento
payment_account	conta de pagamento
saving_account	conta poupança