Atualizar instrução de resgate

Este endpoint cria ou substitui a instrução manual de resgate de um produto, usada para orientar o cliente final sobre como resgatar o crédito comprado. Se o produto ainda não tiver instrução cadastrada, ela é criada; se já existir, o conteúdo é substituído. Veja a Visão Geral para o conceito de instrução de resgate.

📘
Nota
Esta operação não valida conflito ou existência prévia da instrução: independente do produto já ter uma instrução cadastrada ou não, a requisição sempre retorna status 200, variando apenas a mensagem retornada em data conforme o cenário.

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

PATCH https://sandbox.hiperbanco.com.br/recharge/provider/instruction

--request PATCH 'https://sandbox.hiperbanco.com.br/recharge/provider/instruction' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "product": "UBER",
  "instructions": [
    "Acesse o aplicativo.",
    "Vá na aba de configurações.",
    "Vá em resgatar código.",
    "Insira o valor do pin."
  ]
}'

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)

No body, envie os seguintes campos em formato JSON:

Campo	Tipo	Descrição	Especificação
`product`	`string`	Obrigatório. Produto ao qual a instrução se refere.	O valor enviado é normalizado removendo espaços nas extremidades.
`instructions`	`array`	Obrigatório. Lista de passos textuais de resgate do produto.	Não pode ser um array vazio. Cada item é uma string e tem os espaços nas extremidades removidos.

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

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
`data`	`string`	Mensagem indicando o resultado da operação: `Instruction inserted` quando o produto é novo, `Instruction updated.` quando a instrução de um produto já existente foi substituída, ou `Manual created` quando o arquivo de manuais ainda não existia e foi criado do zero com este item.

{
  "data": "Instruction updated."
}

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.