Webhook after TED sending completion

The webhook will notify if a TED transaction has been returned.

Webhook Request Body

Webhook Body: TED Rejected

{
  "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

Field	Type	Description	Max. Characters
webhook_type	string	An enumerator that defines the type of event being reported	23
webhook_datetime	string	Date and time the webhook was sent	20
request_control_key	string	Unique request identification key used by the client in uuid v4 format	36
ted_key	string	Unique identification key of the TED transfer	36
created_at	string	Date and time the transaction was created	24
ted_status	string	Status of the TED transaction	Enumerator ted_status
transaction_amount	number	Transfer amount	10
fee_amount	number	Fee amount charged by the transfer	35
target_account	Object	Destination account - Should only be sent in transactions of type "manual"	Object target_account
refusal_reason	Object	Reason for refusal according to the Central Bank standard	Object refusal_reason

Enumerator ted_status

Enumerator	Description
sent	TED transfer successfully completed.
pending	TED transfer pending.
rejected	TED transfer rejected.
returned	TED transfer returned.

Object target_account

Field	Type	Description	Characters
account_branch *	string	Branch.	4
account_digit *	string	Account digit	1
account_number *	string	Account number.	20
owner_document_number *	string	CPF or CNPJ (numbers only) of the account holder.	14
owner_name *	string	Name of the account holder.	50
account_type *	string	Account type.	Enumerator account_type
ispb *	string	Based on the financial institution's CNPJ (8 digits).	8

Object refusal_reason

Field	Type	Description	Characters
bacen_code *	string	Bacen refusal code	3
enumerator *	string	Bacen refusal enumerator	100
description *	string	Bacen refusal description	100

Enumerator account_type

Enumerator	Translation
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 after TED reception

The webhook will inform about the final status of the TED transaction.

Webhook Request Body

Request Body: TED Received

{
  "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

Field	Type	Description	Max. Characters
webhook_type	string	A enumerator that defines the type of event being reported	23
webhook_datetime	string	Date and time the webhook was sent	20
ted_key	string	Unique identification key of the TED transfer	36
created_at	string	Date and time the transaction was created	100
ted_status	string	Status of the TED transaction	Enumerator ted_status
transaction_amount	number	Transfer amount	10
fee_amount	number	Fee amount charged by the transfer	35
target_account	Object	Destination account - Should only be sent in transactions of type "manual"	Object target_account
refusal_reason	Object	Reason for refusal according to the Central Bank standard	Object refusal_reason

Enumerator ted_status

Enumerator	Description
received	TED transfer successfully completed.
pending	TED transfer pending.
rejected	TED transfer rejected.

Object target_account

Field	Type	Description	Characters
account_branch *	string	Branch.	10
account_digit *	string	Account digit	10
account_number *	string	Account number.	10
owner_document_number *	string	CPF or CNPJ (numbers only) of the account holder.	14
owner_name *	string	Name of the account holder.	50
account_type*	string	Account type.	Enumerator account_type
ispb *	string	Based on the financial institution's CNPJ (8 digits).	8

Object refusal_reason

Field	Type	Description	Characters
bacen_code *	string	Bacen refusal code	3
enumerator *	string	Bacen refusal enumerator	100
description *	string	Bacen refusal description	100

Enumerator account_type

Enumerator	Translation
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