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

--request POST 'https://sandbox.hiperbanco.com.br/ted/transfer' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "amount": 1.17,
  "sender": {
    "document": "50300633859100",
    "name": "Techwave Digital Solutions LTDA",
    "branch": "0001",
    "account": "1104835921"
  },
  "recipient": {
    "accountType": "CHECKING",
    "document": "73379344915",
    "bankCode": "332",
    "branch": "0001",
    "account": "1104714229",
    "name": "Vinicius Ferreira"
  },
  "description": "Realizando TED"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON
Authorization	Bearer token	Obrigatório. Token de autorização do tipo Bearer.

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 não enviado, será considerado "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`	number	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.

{
  "amount": 1.17,
  "sender": {
    "document": "50300633859100",
    "name": "Techwave Digital Solutions LTDA",
    "branch": "0001",
    "account": "1104835921"
  },
  "recipient": {
    "accountType": "CHECKING",
    "document": "73379344915",
    "bankCode": "222",
    "branch": "0001",
    "account": "1104714229",
    "name": "Vinicius Ferreira"
  },
  "description": "Realizando TED"
}

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 realizada.

{
    "authenticationCode": "40cee23e-d786-4660-8079-fa1309252908",
    "transactionId": "cb43d713-7925-4eea-8fdd-8b5935845a5e"
}

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 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.