Consultar comprovante de recarga

Este endpoint retorna o comprovante detalhado de uma recarga específica, identificada pelo seu id, incluindo status, código de autorização e, quando disponível, a instrução manual de resgate do produto. Veja a Visão Geral para os conceitos de produto e recarga.

📘
Nota
O campo instruction só é retornado quando existe uma instrução manual cadastrada para o produto da recarga consultada. Se não houver nenhuma instrução cadastrada para aquele produto, o campo é omitido da resposta, sem gerar erro.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O parceiro esteja autenticado com um token válido.
A recarga consultada pertença à conta do parceiro autenticado.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/recharge/receipt/64a70040-8a3a-013d-d0e7-5686d902e59e

--request GET 'https://sandbox.hiperbanco.com.br/recharge/receipt/64a70040-8a3a-013d-d0e7-5686d902e59e' \
--header 'version: cutting-edge' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. 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 / Query)

Nome	Tipo	Descrição	Especificação
`id`	`path`	Obrigatório. Id da recarga.	Formato UUID.

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 requisição. Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`transactionId`	`string`	Identificador da transação.
`type`	`string`	Tipo do produto da recarga (atualmente sempre `cellphone`).
`nsu`	`string`	NSU da recarga.
`product`	`string`	Nome do produto. Presente quando não nulo na origem.
`code`	`string`	Código de autorização da recarga.
`status`	`string`	Status da recarga (`authorized`, `captured` ou `denied`).
`message`	`string`	Mensagem descritiva do status.
`amount`	`number`	Valor da recarga, sempre normalizado para positivo.
`dueDate`	`string`	Data de vencimento.
`createdAt`	`Date`	Data de criação da recarga.
`expiresIn`	`string`	Prazo de expiração. Pode ser vazio.
`cellphoneNumber`	`string`	Número de celular recarregado.
`instruction`	`object`	Instrução manual de resgate do produto. Presente apenas quando existe uma instrução cadastrada para o produto da recarga.
`instruction.product`	`string`	Produto ao qual a instrução se refere.
`instruction.instructions`	`array`	Lista de passos textuais de resgate.

{
  "transactionId": "64a70040-8a3a-013d-d0e7-5686d902e59e",
  "type": "cellphone",
  "product": "CLARO",
  "code": "123456",
  "status": "captured",
  "message": "Recharge captured successfully.",
  "amount": 50,
  "dueDate": "2026-08-25",
  "createdAt": "2026-08-25T10:00:00.000Z",
  "expiresIn": "",
  "cellphoneNumber": "999999999",
  "instruction": {
    "product": "CLARO",
    "instructions": [
      "Acesse o aplicativo da operadora.",
      "Vá na aba de recarga.",
      "Insira o código informado."
    ]
  }
}

Erros

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

Status Code	Código	Mensagem	Descrição
`404`	`RechargeNotFound`	`Recharge not found.`	Não existe recarga com o id informado para a conta autenticada.
`403`	`RechargeNotBeenCaptured`	`Recharge not yet approved.`	A recarga ainda não foi aprovada.

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.