Consulta por código de autenticação

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/ted/auths/{{authenticationCode}}/{{branchNumber}}/{{accountNumber}}

--request GET 'https://sandbox.hiperbanco.com.br/ted/auths/{{authenticationCode}}/{{branchNumber}}/{{accountNumber}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

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)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição
authenticationCode	path	Obrigatório. Código de autenticação da transação a ser consultada.
branchNumber	path	Obrigatório. Agência da conta a partir da qual se realizou a transferência.
accountNumber	path	Obrigatório. Número da conta.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
companyKey	string	Chave que identifica o parceiro dentro do Hiperbanco.
authenticationCode	string	Código identificador da transação.
amount	number	Valor transferido.
description	string	Descrição da transferência.
correlationId	string	GUID informado em cada requisição realizada no endpoint.
sender	object	Objeto que contém os dados do pagador da transação.
sender.document	string	Número do documento.
sender.name	string	Nome do pagador.
sender.account	object	Objeto que contém os dados da conta bancária do pagador.
sender.account.branch	string	Agência bancária.
sender.account.number	string	Número da conta.
sender.account.bank	object	Objeto que contém os dados do banco do pagador.
sender.account.bank.ispb	string	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
sender.account.bank.name	string	Nome do banco.
sender.account.bank.compe	string	Código do banco.
recipient	object	Objeto que contém os dados do recebedor da transação.
recipient.document	string	Número do documento.
recipient.name	string	Nome do recebedor.
recipient.account	object	Objeto que contém os dados da conta bancária do recebedor.
recipient.account.branch	string	Agência bancária.
recipient.account.number	string	Número da conta.
recipient.account.bank	object	Objeto que contém os dados do banco do recebedor.
recipient.account.bank.ispb	string	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
recipient.account.bank.name	string	Nome do banco.
recipient.account.bank.compe	string	Código do banco.
channel	string	Indica se a transação é interna (`INTERNAL`) ou externa (`EXTERNAL`).
status	string	Situação da transação.
createdAt	string	Data de criação da transferência, no formato ISO 8601 - UTC.
updatedAt	string	Data de atualização dos dados da transferência, no formato ISO 8601 - UTC.

{
  "companyKey": "EMPRESA_TESTE_XYZ",
  "authenticationCode": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 55.5,
  "description": "Transferência via TED",
  "correlationId": "abc98765-def0-4321-ghij-87654321abcd",
  "sender": {
    "document": "12345678900",
    "name": "João da Silva",
    "account": {
      "branch": "0001",
      "number": "10203",
      "bank": {
        "ispb": "13140088",
        "name": "Acesso Soluções de Pagamento S.A.",
        "compe": "332"
      }
    }
  },
  "recipient": {
    "document": "98765432100",
    "name": "Ana Souza",
    "account": {
      "branch": "0001",
      "number": "405060",
      "bank": {
        "ispb": "13140088",
        "name": "Acesso Soluções De Pagamento S.A.",
        "compe": "332"
      }
    }
  },
  "channel": "INTERNAL",
  "status": "DONE",
  "createdAt": "2025-07-15T09:00:00.000-03:00",
  "updatedAt": "2025-07-15T09:00:05.000-03:00"
}

Possíveis status da transação

Status	Descrição
CREATED	A transferência via TED foi criada.
IN PROCESS	A transação está passando pela análise de risco do sistema antifraude do Hiperbanco e o valor está sendo reservado para a transação.
APPROVED	A transação foi aprovada.
REPROVED	A transação foi reprovada.
DONE	A transação foi completada com sucesso e o valor foi enviado para a conta de destino.
UNDONE	A transação foi desfeita devido à reprovação pela análise antifraude e o valor retornou para a conta de origem. Nesse caso, será gerado um evento de devolução (REFUND_ACCOUNT).
CANCELED	Falha ao reservar o valor.

Erros

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

Status code	Código	Mensagem	Descrição
403	SESSION_ACCOUNT_MISMATCH	The requested action is only allowed if the current session belongs to the provided account's holder.	A ação solicitada só será permitida se a sessão atual pertencer ao titular da conta fornecida.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.