Listar produtos de recarga

Este endpoint retorna o catálogo de produtos de recarga disponíveis, agrupados por operadora. É usado para o parceiro descobrir quais produtos podem ser comprados antes de iniciar uma recarga, incluindo valores mínimo e máximo aceitos por produto. Veja a Visão Geral para os conceitos de produto e 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/products

--request GET 'https://sandbox.hiperbanco.com.br/products?kinds=cellphone&areaCode=71&provider=CLARO' \
--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
`kinds`	`query`	Opcional. Tipo da operadora.	—
`areaCode`	`query`	Opcional. DDD enviado no corpo da requisição.	Exatamente 2 caracteres numéricos.
`provider`	`query`	Opcional. Informar o nome da operadora.	—

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
`<nome do provider>`	`array`	Chave dinâmica com o nome do provedor. Cada item do array é um produto disponível daquele provedor.
`<nome do provider>[].provider`	`string`	Nome do provedor.
`<nome do provider>[].kind`	`string`	Tipo da operadora.
`<nome do provider>[].name`	`string`	Nome do produto.
`<nome do provider>[].amount`	`number`	Valor do produto.
`<nome do provider>[].minimumAmount`	`number`	Valor mínimo permitido para o produto.
`<nome do provider>[].maximumAmount`	`number`	Valor máximo permitido para o produto.
`<nome do provider>[].productId`	`string`	Identificador do produto.
`<nome do provider>[].expiresIn`	`string`	Prazo de expiração do produto. Pode ser vazio.

{
  "CLARO": [
    {
      "provider": "CLARO",
      "kind": "cellphone",
      "name": "Crédito Claro R$ 10",
      "amount": 10,
      "minimumAmount": 10,
      "maximumAmount": 100,
      "productId": "abc123",
      "expiresIn": ""
    }
  ]
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.