Listar números de celular já recarregados

Este endpoint retorna a lista de números de celular já recarregados pela conta autenticada, sem repetição. É útil para o parceiro sugerir ao cliente final os números usados em recargas anteriores. 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.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/cellphone/history

--request GET 'https://sandbox.hiperbanco.com.br/cellphone/history' \
--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)

Não é necessário enviar parâmetros na rota (path ou query) desta requisição.

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
`areaCode`	`string`	DDD do número de celular já recarregado.
`cellPhoneNumber`	`string`	Número de celular já recarregado, sem DDD.

[
  {
    "areaCode": "71",
    "cellPhoneNumber": "999999999"
  }
]

Erros

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

Status Code	Código	Mensagem	Descrição
`400`	`AccountNotFound`	`Main account not found.`	A conta do parceiro não foi encontrada.
`404`	`RechargesNotFound`	`Recharges not found.`	Não há nenhuma recarga de celular registrada para a conta.

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.