Transferência via TED

Este endpoint possibilita realizar a transferência de valores via TED entre contas pertencentes ao Bankly (TED interno) e do Bankly para contas de outras instituições financeiras (TED externo).

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/fund-transfers

curl --request POST \
     --url 'https://api-mtls.sandbox.bankly.com.br/fund-transfers' \
     --header 'Idempotency-Key: GUID' \
     --header 'api-version: 1' \
     --header 'Authorization: Bearer [token]' \
     --header 'content-type: application/json' \
     --header 'accept: application/json' \
     --header 'x-correlation-id: GUID' \
     --data '
{
  "sender": {
    "document": "47742663023",
    "name": "Nísia Floresta",
    "branch": "0001",
    "account": "15164"
  },
  "recipient": {
    "accountType": "CHECKING",
    "document": "09992220074",
    "bankCode": "332",
    "branch": "0001",
    "account": "540108",
    "name": "Maria Quitéria de Jesus"
  },
  "amount": 100,
  "description": "Aluguel"
}
'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

🚧

Importante

Caso o parceiro envie o mesmo idempotencyKey em mais de uma requisição, não será retornado um erro. Porém, o authenticationCode será igual ao gerado na primeira operação, pois a transação não será duplicada.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

📘

Nota

O valor do campo bankCode pode ser obtido por meio da consulta ao endpoint Listagem de instituições financeiras.

{
  "sender": {
    "document": "47742663023",
    "name": "Nísia Floresta",
    "branch": "0001",
    "account": "15164"
  },
  "recipient": {
    "accountType": "CHECKING",
    "document": "09992220074",
    "bankCode": "332",
    "branch": "0001",
    "account": "540108",
    "name": "Maria Quitéria de Jesus"
  },
  "amount": 100,
  "description": "Aluguel"
}

Resposta (Response)

O status code 202 indicará sucesso na requisição.

🚧

Importante

O sucesso na requisição não significa que a transação já tenha acontecido. Desse modo, para conferir a situação da transferência, recomendamos realizar a consulta do status da transação.

Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:

{
  "authenticationCode": "string"
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são: