Consultar recarga de celular

Este endpoint retorna os dados detalhados de uma recarga de celular específica, identificada pelo seu id. Veja a Visão Geral para o fluxo completo de uma recarga.

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 já tenha sido criada por meio do endpoint Criar recarga de celular.

Requisição (Request)

Requisição HTTP

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

--request GET 'https://sandbox.hiperbanco.com.br/cellphone/recharge/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 de celular.	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
`cellPhoneNumber`	`string`	Número de celular recarregado.
`areaCode`	`string`	DDD do número de celular.
`authorizationCode`	`string`	Código de autorização da recarga.
`message`	`string`	Mensagem descritiva do resultado da recarga.
`nsu`	`string`	NSU da recarga.
`amount`	`number`	Valor da recarga.
`productId`	`string`	Id do produto recarregado.

{
  "cellPhoneNumber": "999999999",
  "areaCode": "71",
  "authorizationCode": "123456",
  "message": "Recharge captured successfully.",
  "nsu": "123456789",
  "amount": 10,
  "productId": "abc123"
}

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.

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.