Realizar TED com Autenticação de Dois Fatores
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 TED. 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.
Request
ENDPOINT
/account/ACCOUNT_KEY/tedMÉTODO
POSTRequest 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": "Titular da Conta",
"ispb": "12345678",
"account_type": "checking_account"
},
"transaction_amount": 8.86,
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "email"
}
}
Body Params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
request_control_key * | string | Chave única de identificação da request utilizada pelo cliente no formato uuid v4. | 36 |
target_account * | object | Conta de destino | Objeto target_account |
transaction_amount * | float | Valor da transferência | 10 |
tfa_info * | object | Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato. | Objeto tfa_info |
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 tfa_info
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
approver_document_number * | string | Número de documento da pessoa aprovadora da conta. | 11 |
contact_type * | string | Forma de contato com a pessoa aprovadora da conta, podendo ser sms ou email |
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 |
Response
STATUS
202Response 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": "pending_2fa_approval",
"transaction_amount": 126.97,
"fee_amount": 0.0
}
STATUS
4xxResponse Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
Informação
Os erros anteriormente listados para realizar TED são passiveis de serem retornados por este endpoint além dos erros listados abaixo.
Código HTTPstatus | Código QIcode | Títulotitle | Descrição (eng)description | Descrição (ptbr)translation |
---|---|---|---|---|
400 | TED000079 | No approver permission | Given document number does not belong to an approver for this account | Número de documento enviado não pertence a um aprovador da conta |
400 | TED000080 | tfa_info is required | Client must send object tfa_info | Cliente deve enviar objeto tfa_info |
400 | TED000081 | Error occurred while sending token | An unexpected error occurred while sending token | Um erro inexperado ocorreu ao tentar enviar token |