Perform Ted Transaction in Batch

QI Tech offers the possibility to perform multiple ted transactions with a single call. In this system, transactions are performed asynchronously. If an http status 4xx is returned in the initial call, none of the transactions will be performed. After the request, the integrating partner will receive a webhook for each transaction informing the final status of the attempt, which can be rejected or sent.

Request

ENDPOINT

/account/ACCOUNT_KEY/ted_batch

METHOD

POST

{
  "request_control_key": "6e4fc980-f8a1-4462-b6e2-d8a49f0ac055",
  "teds": [
    {
      "request_control_key": "0c3d2a3e-c121-464e-b5a4-8e69e0c17bbd",
      "target_account": {
        "account_branch": "0001",
        "account_number": "92796",
        "account_digit": "1",
        "owner_document_number": "23599885000192",
        "owner_name": "Titular da Conta",
        "ispb": "12345678",
        "account_type": "checking_account"
      },
      "transaction_amount": 8.86
    }
  ]
}

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key.	36

Body Params

Field	Type	Description	Characters
request_control_key *	uuidv4	Unique request identification key used by the client in uuid v4 format.	36
teds *	array	List of ted objects linked to the batch.	list of Ted object

Ted object

Field	Type	Description	Characters
request_control_key *	string	Unique request identification key used by the client in uuid v4 format.	36
target_account *	object	Destination account	target_account object
transaction_amount *	float	Transfer amount	10

target_account object

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	Account holder name.	50
account_type*	string	Account type.	account_type enumerator
ispb *	string	Based on financial institution CNPJ (8 digits).	8

account_type enumerator

Enumerator	Translation
checking_account	checking account
deposit_account	deposit account
guaranteed_account	guaranteed account
investment_account	investment account
payment_account	payment account
saving_account	savings account

Response

STATUS

201

Response Body: Batch Transfer Approved

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "ted_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "ted_batch_status": "approved"
}

ted_batch_status enumerator

Enumerator	Description
approved	Batch transfer approved and transactions in execution process.
rejected	Batch transfer rejected
pending_2fa_approval	Batch scheduling pending approval by two-factor authentication
cancelled	Batch transfer cancelled

STATUS

4xx

Response Body: Batch Rejected

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {
    "ted_batch_data": {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "ted_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "ted_batch_status": "rejected"
    }
  }
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Information

The errors previously listed for Ted transfer are liable to be returned by this endpoint.