Listar benefícios

GET /api/v1/valepix/benefits

Lista benefícios configurados para a integração autorizada, com busca opcional por nome.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json

Path params

Esta rota não possui path params.

Query params

Parâmetro	Tipo	Obrigatório	Descrição
search	string	Não	Busca por nome do benefício

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?search=flex"

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "benefits": [
      {
        "id": "00000000-0000-4000-8000-000000000030",
        "name": "benefício flexível",
        "description": "configuração padrão para colaboradores elegíveis",
        "items": [
          {
            "product_id": "00000000-0000-4000-8000-000000000201",
            "product_slug": "alimentacao",
            "product_name": "Alimentação",
            "monthly_amount": 50000
          }
        ]
      }
    ]
  }
}

O campo id de cada benefício em data.benefits é o valor que deve ser usado como benefit_id nas rotas de colaboradores.

Erros comuns

HTTP	Quando acontece	Ação recomendada
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
429	Limite de chamadas excedido	Reduzir a frequência e aplicar backoff
500, 502, 503, 504	Falha temporária na consulta	Tentar novamente com backoff