Nuvem de Recompensas

Endpoint

Método HTTP: GET

URL: /prizes

Parâmetros de Consulta

Parâmetro	Tipo	Descrição
faceValue	integer	Filtra recompensas pelo valor exato. Se omitido, retorna todas as recompensas disponíveis.

Exemplo de Requisição

curl --request GET \
  --url https://api.minu.biz/v1/prizes?faceValue=20 \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>'

Propriedades de Resposta

Se a requisição for bem-sucedida, a API retornará as seguintes propriedades no formato JSON

Propriedade	Tipo	Descrição
title	string	Título da Aliança que disponibiliza as recompensas.
category	string	Categoria em que a aliança está classificada.
description	string	Descrição breve da Aliança.
prizes	array	Coleção de recompensas oferecidas pela Aliança.
prizes.title	string	Título da recompensa na plataforma.
prizes.faceValue	integer	Valor da recompensa para o consumidor.
prizes.price	double	Valor da recompensa para o cliente corporativo.
prizes.name	string	Identificador da recompensa utilizado na plataforma Minu.biz.
prizes.processingFee	double	Taxa de processamento associada à recompensa.

Exemplo de Resposta

[
  {
    "title": "iFood",
    "category": "Alimentação e Delivery",
    "description": "Recompensas oferecidas pela parceria com o iFood.",
    "prizes": [
      {
        "title": "Cupom iFood R$20",
        "faceValue": 20,
        "price": 18.0,
        "name": "cupom-ifood-20",
        "processingFee": 0.5
      }
    ]
  }
]