Perform a TED transfer
Receiving a TED transaction is not instantaneous in the national financial system. When performing a TED transaction in the QI system, an immediate response will be returned indicating error, rejection, or acceptance of the transfer. Even if a transfer has been marked as sent
, the Receiving Financial Institution may refuse the incoming funds and return the amount. In this case, a new webhook with the status rejected
will be sent, and the reason for the rejection will be returned in the refusal_reason
field.
Debits in the source account of the transaction will be made immediately. This does not mean that the amount has been credited to the destination account due to the principles of TED transactions described above. If the sent transaction is rejected, the transaction amount will be credited back to the source account.
Request
Request Body
{
"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": "Account owner name",
"ispb": "12345678",
"account_type": "checking_account"
},
"transaction_amount": 8.86
}
BODY PARAMS
Field | Type | Description | Characters |
---|---|---|---|
request_control_key * | string | Unique request identification key used by the client in uuid v4 format. | 36 |
target_account * | object | Target account. | Object target_account |
transaction_amount * | float | Transaction amount. | 10 |
Object target_account
Field | Type | Description | Characters |
---|---|---|---|
account_branch * | string | Agency. | 4 |
account_digit * | string | Account digit. | 1 |
account_number * | string | Account number. | 20 |
owner_document_number * | string | CPF or CNPJ (numbers only) of account owner. | 14 |
owner_name * | string | Account owner name. | 50 |
account_type * | string | Account type. | Enumerador account_type |
ispb * | string | Based on the financial institution's CNPJ (8 digits). | 8 |
Enumerator account_type
Enumerator | Translation (PT-BR) |
---|---|
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 |
Response
Response Body
{
"request_control_key": "0c3d2a3e-c121-464e-b5a4-8e69e0c17bbd",
"ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"created_at": "2021-10-22T20:30:23.459Z",
"ted_status": "sent",
"transaction_amount": 126.97,
"fee_amount": 0.0
}
Response Body: Error
{
"title": "Error title",
"description": "description in English",
"translation": "description in Portuguese",
"code": "Code",
"extra_fields": {}
}
HTTP Codestatus | QI Codecode | Titletitle | Description (en)description | Description in Portuguesetranslation |
---|---|---|---|---|
400 | QIT000001 | Bad Request | Schema Error | Erro de Schema |
400 | TED000066 | InvalidUuid | request_control_key was not accepted for not being a valid uuid v4 string | request_control_key não foi aceito por não ser uma palavra uuid v4 válida |
400 | TED000011 | InvalidUuid | Wrong day/time for TED | Dia/hora incorretos para a TED |
400 | TED000055 | Invalid Observation | Observation sent is invalid | Observação enviada é inválida |
400 | TED000054 | Invalid Transaction Amount | Transaction amount of {transaction_amount} is not valid. It must be a positive value with at maximum 2 decimal places | O valor de transação {transaction_amount} não é válido. Deve ser um valor positivo com no máximo duas casas decimais |
400 | TED000012 | Bad Request | The target's length of the account + account_digit cannot be larger than 21 | O número de digitos na conta de destino + digito não pode ser maior que 21 |
400 | TED000053 | Invalid Target Account Type | Target Account Type {account_type} is invalid | Tipo de conta destino {account_type} é inválido |
400 | TED000031 | Bad Request | ISPB number {ispb} does not exist or is inactive | ISPB {ispb} não existe ou está inativo |
400 | TED000065 | Bad Request | It has been identified by request_control_key that this request is already being processed | Foi identificado por request_control_key que está requisição está sendo processada |
403 | TED000071 | Invalid target account | Invalid target account | Conta destino inválida |
400 | TED000058 | Bad Request | Insufficient account balance for transfer and fee amount | Saldo de conta insuficiente para a transação e a taxa |
400 | TED000070 | Bad Request | Insufficient account balance fee amount in billing account | Saldo de conta centralizadora insuficiente para taxa |
400 | TED000071 | Bad Request | Transaction cannot be made due to already blocked balance | Transação não pode ser feita pois saldo em conta bloqueado |
400 | TED000068 | Bad Request | Transfer rejected by the system | transferêancia foi recusada pelo sistema |
404 | TED000013 | Bad Request | Unable to find source_account_key's account | Não foi possível encontrar a conta com source_account_key fornecido |
400 | TED000015 | Bad Request | Account blocked or closed can not perform this action | A conta bloqueada ou fechada não pode executar esta ação |
400 | TED000016 | Bad Request | Hub account can not perform this action | A conta hub não pode executar esta ação |
403 | TED000017 | Unauthorized | Provided account does not have approval credential for the given person | A conta fornecida não possui credencial de aprovação para a pessoa especificada |
403 | TED000018 | Unauthorized | Provided account not owned by SELECTED_AGENT | Conta fornecida não pertencente ao SELECTED_AGENT |
400 | TED000060 | Bad Request | Billing Account is closed | Conta centralizadora de pagamentos de tarifa fechada |
400 | TED000061 | Bad Request | Billing Account without necessary funds | Conta centralizadora de pagamentos sem saldo necessário |
409 | TED000064 | Bad Request | request_control_key {request_control_key} already in use | request_control_key {request_control_key} já utilizada |