Pular para o conteúdo principal

Realizar Transação Ted em Lote com Autenticação de Dois Fatores

A QI Tech oferece a possibilidade de realizar várias transações ted com uma única chamada. Nesse sistema as transações são realizadas de forma assíncrona. Caso na chamada inicial seja retornado um http status 4xx, nenhuma das transações será realizada. Após a solicitação, o parceiro integrador receberá um webhook para cada transação informando o status final da tentativa, podendo ser rejected ou sent.

Neste tipo de transação, é necessário a confirmação do pagamento via token enviado à pessoa com poderes de aprovação de movimentação na conta credora.

A solicitação de transação Ted por parceiros integradores configurados para a utilização de autenticação de dois fatores é realizada de forma similar ao descrito em realizar transação ted em lote. A diferença ocorre na adição do objeto tfa_info, contento informações sobre o aprovador da transferência e a forma de contato, e o status de uma solicitação bem sucedida que será sempre pending_2fa_approval.

O evento de notificação para o envio de token ao aprovador é baas.token_validation.ted.batch. É possível personalizar a mensagem enviada.

Request

ENDPOINT
/account/ACCOUNT_KEY/ted_batch
MÉTODO
POST
Request Body
{
"request_control_key": "6e4fc980-f8a1-4462-b6e2-d8a49f0ac055",
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "email"
},
"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
},
{
"request_control_key": "ff9f2a48-918c-4911-9371-a496e37dccfc",
"target_account": {
"account_branch": "0001",
"account_number": "92797",
"account_digit": "2",
"owner_document_number": "23599885000192",
"owner_name": "Titular da Conta",
"ispb": "12345678",
"account_type": "checking_account"
},
"transaction_amount": 10.00
}
]
}

Path Params

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta.36

Body Params

CampoTipoDescriçãoCaracteres
request_control_key *uuidv4Chave única de identificação da request utilizada pelo cliente no formato uuid v4.36
teds *arrayLista de objetos ted vinculados ao lote.lista de Objeto ted
tfa_info*ObjectObjeto contendo o documento da pessoa aprovadora da conta e a forma de contato.Objeto tfa_info

Objeto tfa_info

CampoTipoDescrição
approver_document_number*stringNúmero de documento da pessoa aprovadora da conta.
contact_type*stringForma de contato com a pessoa aprovadora da conta, podendo ser sms ou email

Objeto ted

CampoTipoDescriçãoCaracteres
request_control_key *stringChave única de identificação da request utilizada pelo cliente no formato uuid v4.36
target_account *objectConta de destinoObjeto target_account
transaction_amount *floatValor da transferência10

Objeto target_account

CampoTipoDescriçãoCaracteres
account_branch *stringAgência.4
account_digit *stringDígito da conta1
account_number *stringNúmero da conta.20
owner_document_number *stringCPF ou CNPJ (apenas números) do titular da conta.14
owner_name *stringNome do titular da conta.50
account_type*stringTipo da conta.Enumerador account_type
ispb *stringBase no CNPJ da instituição financeira (8 dígitos).8

Enumerador account_type

EnumeradorTradução
checking_accountconta corrente
deposit_accountconta depósito
guaranteed_accountconta de garantia
investment_accountconta de investimento
payment_accountconta de pagamento
saving_accountconta poupança

Response

STATUS
202
Response Body: Transferência em Lote Solicitada
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"ted_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"ted_batch_status": "pending_2fa_approval"
}

Enumerador ted_batch_status

EnumeradorDescrição
approvedTransferência em lote aprovada e transações em processo de execução.
rejectedTransferência em lote rejeitada
pending_2fa_approvalAgendamento em lote pendente de aprovação por autenticação de dois fatores
cancelledTransferência em lote cancelada
STATUS
4xx
Response Body: Transferência Rejeitada
{
"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": {}
}
Informação

Os erros anteriormente listados para transferência Ted são passiveis de serem retornados por este endpoint além dos erros listados abaixo.

Código HTTP
status
Código QI
code
Título
title
Descrição (eng)
description
Descrição (ptbr)
translation
400TED000079No approver permissionGiven document number does not belong to an approver for this accountNúmero de documento enviado não pertence a um aprovador da conta
400TED000080tfa_info is requiredClient must send object tfa_infoCliente deve enviar objeto tfa_info
400TED000081Error occurred while sending tokenAn unexpected error occurred while sending tokenUm erro inexperado ocorreu ao tentar enviar token