Consultar instrução de resgate

Este endpoint retorna a instrução manual de resgate cadastrada para um produto específico. É usado para o parceiro exibir ao cliente final o passo a passo de como resgatar o crédito de um produto de recarga. Veja a Visão Geral para o conceito de instrução de resgate.

Pré-requisitos

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

O parceiro esteja autenticado com um token válido.
Já exista uma instrução cadastrada para o produto consultado, usando o endpoint Atualizar instrução de resgate.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/recharge/provider/instruction/VIVO

--request GET 'https://sandbox.hiperbanco.com.br/recharge/provider/instruction/VIVO' \
--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
`product`	`path`	Obrigatório. Produto do qual buscar a instrução de resgate.	Apenas letras, números e espaços entre palavras.

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
`product`	`string`	Produto ao qual a instrução se refere.
`instructions`	`array`	Lista de passos textuais de resgate.

{
  "product": "VIVO",
  "instructions": [
    "Acesse o aplicativo.",
    "Vá na aba de configurações.",
    "Vá em resgatar código.",
    "Insira o valor do pin."
  ]
}

Erros

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

Status Code	Código	Mensagem	Descrição
`404`	`InstructionNotFound`	`Instruction not found`	Não existe instrução cadastrada para o produto informado.
`404`	`ManualNotFund`	`File not found.`	O arquivo de manuais de instrução ainda não existe.

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.