Manual
Start typing to search…

Transferência via TED

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

Requisição (Request)

Requisição HTTP 

POST https://sandbox.hiperbanco.com.br/ted/transfer

Cabeçalhos (Headers)

Nome Descrição Especificação
version Obrigatório. Utilizar essa propriedade para o response da API retornar um JSON cutting-edge
Authorization Obrigatório. Token de autorização do tipo Bearer. —
x-correlation-id Obrigatório. Informe um GUID, sendo um novo cada requisição. —
Idempotency-Key Chave de idempotência cuja finalidade é garantir que uma operação seja executada uma única vez. Importante: o tempo para a expiração do Idempotency-Key é de 6 minutos. Formato UUID v4. Informe um UUID novo a cada requisição.

🚧

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:

Nome Tipo Descrição
sender object Obrigatório. Objeto que deverá conter os dados do pagador da transação.
sender.document string Obrigatório. Número do documento.
sender.name string Obrigatório. Nome do pagador.
sender.branch string Obrigatório. Agência bancária.
sender.account string Obrigatório. Número da conta.
recipient object Obrigatório. Objeto que deverá conter os dados do recebedor da transação.
recipient.accountType string Tipo de conta, o qual pode ser "CHECKING", para conta corrente, ou "SAVINGS", para conta poupança. Caso este campo não seja enviado na requisição, será considerado o valor "CHECKING".
recipient.document string Obrigatório. Número do documento.
recipient.bankCode string Obrigatório. Código do banco.
recipient.branch string Obrigatório. Agência bancária.
recipient.account string Obrigatório. Número da conta.
recipient.name string Obrigatório. Nome do recebedor.
amount string Obrigatório. Valor da transação.
description string Descrição da transferência.

📘

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:

Nome Tipo Descrição
authenticationCode string Código de autenticação da transação realizada.
transactionId string ID da transação utilizado para consultar a transação. 
{
  "authenticationCode": "string",
  "transactionId": "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:

Status code Código Mensagem Descrição
400 CASH_OUT_NOT_ALLOWED_OUT_OF_BUSINESS_PERIOD Cash out not allowed out of business period Não é permitido realizar Ted fora do horário bancário (das 7h às 17h).
400 CASHOUT_LIMIT_NOT_ENOUGH Sender does not have sufficient cash out limit O pagador não tem limite de saque suficiente.

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:

Nome do evento (name) Descrição
TED_CASH_OUT_WAS_APPROVED Transação aprovada pela análise de antifraude.
TED_CASH_OUT_WAS_CANCELED Transferência cancelada por falta de saldo na conta.
TED_CASH_OUT_WAS_REPROVED A transação foi reprovada pela equipe de análise antifraude.

Updated 13 days ago