Buscar benefício por ID

GET /api/v1/valepix/benefits/{benefit_id}

Consulta os detalhes de um benefício específico.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json

Path params

Parâmetro	Tipo	Obrigatório	Descrição
benefit_id	string	Sim	Identificador do benefício retornado pela API

Query params

Esta rota não possui query params documentados.

Exemplo curl

curl --request GET \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json" \
  --url "https://routes.valepix.com.br/api/v1/valepix/benefits/$BENEFIT_ID"

Response

{
  "success": "success",
  "data": {
    "benefit": {
      "id": "00000000-0000-4000-8000-000000000030",
      "name": "Benefício Flexível",
      "description": "Configuração padrão para colaboradores elegíveis",
      "coparticipation_percentage": 0,
      "items": [
        {
          "product_id": "00000000-0000-4000-8000-000000000201",
          "product_slug": "alimentacao",
          "product_name": "Alimentação",
          "monthly_amount": 50000
        }
      ]
    }
  }
}

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	Identificador inválido	Conferir benefit_id
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
404	Benefício não encontrado	Conferir benefit_id
500	Erro interno temporário	Tentar novamente com backoff