Transferência via TED
stable scopes: ted.cashout.create
A transferência via TED, ou TED cash-out, possibilita aos nossos parceiros a transferência de valores entre contas pertencentes ao Bankly e para contas de outras instituições financeiras.
Etapas
No momento do request, o Bankly verifica os dados da conta informada, se ela possui saldo e se há limite disponível para realizar a transação (validações síncronas).
Nota
Quando algum dado da conta recebedora está incorreto, ou a conta recebedora está encerrada, o banco pode negar o recebimento e efetuar a devolução.
Após receber o pedido de transferência, em um processo assíncrono, verificamos se não existem problemas em nossa verificação de antifraude.
Endpoint
Para consumo do endpoint de transferência via TED, preencha os seguintes campos obrigatórios na requisição:
sender
: dados de quem enviará o pagamento;branch
: número da agência;account
: número da conta;document
: número do documento (CPF/CNPJ) do proprietário da conta;name
: nome do proprietário da conta;
recipient
: dados de quem receberá o pagamento;branch
: número da agência do recebedor;account
: número da conta;accountType
: tipo de conta, pode receber o tipo "CHECKING" (Conta corrente) ou "SAVINGS" (Conta poupança);bankCode
: código da instituição recebedora do pagamento;documentNumber
: documento (CPF/CNPJ) do proprietário da conta recebedora;name
: nome do proprietário da conta;
amount
: valor a ser enviado.
Nota
Você encontrará
bankCode
consultando a listagem das instituições financeiras.
Opcionalmente preencha os seguintes campos:
description
: insira uma descrição para o pagamento;Idempotency-Key
: informação utilizada para evitar a duplicidade de transações (valor em formato UUID). Se a mesma solicitação de TED for enviada mais de uma vez, estando com a mesmaidempotency-Key
, consideramos que se trata da mesma transação. Ou seja, a transação não será duplicada.
Importante
Caso o parceiro envie o mesmo
idempotencyKey
em mais de uma requisição, não será retornado um erro. Porém, oauthenticationCode
será igual ao gerado na primeira operação, pois a transação não será duplicada.
--location --request POST ' https://api-mtls.sandbox.bankly.com.br/fund-transfers ' \
--header 'api-version: 1' \
--header ' x-correlation-id: {{GUID}}' \
--header ' Idempotency-Key: {{GUID}}' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 50,
"sender": {
"branch": "0001",
"account": "187470",
"document": "12345678900",
"name": "SenderName"
},
"recipient": {
"accountType": "CHECKING",
"document": "12345678901",
"bankCode": "332",
"branch": "0001",
"account": "219000",
"name": "RecipientName"
},
"description": "Teste ted"
}'
Retorno
O sucesso retornará o status code 202 e o valor do authenticationCode
:
{
"authenticationCode": "e7619aff-a757-4c59-bc6b-dbd9711d721c"
}
No entanto, isso não significa que a transação já aconteceu, pois, como mencionado anteriormente, são feitas validações síncronas e assíncronas.
Desse modo, recomendamos realizar a consulta do status da transação.
Importante
Caso a transação TED demore mais que 1 hora para ser concluída, o parceiro deve entrar em contato com o Service Desk.
Erros
Status code | Código | Descrição |
---|---|---|
400 | 404 | Requisição inválida. Verifique se todos os campos obrigatórios foram enviados. |
400 | CASH_OUT_NOT_ALLOWED_OUT_OF_BUSINESS | Não é permitido realizar Ted fora do horário bancário (das 7h às 17h). |
403 | --- | Transação não autorizada. |
500 | --- | Ocorreu algum erro inesperado em nosso servidor. |
503 | --- | O serviço está temporariamente indisponível. |
Updated 12 months ago