v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/consulta_bonus

API responsável pela consulta do saldo de bônus.

post/consulta_bonus

Headers

Authorizationstring required

Token de autenticação.

CodEmpresastring required

Código da empresa enviado pela CRMBonus.

Content-Typestring required

System-Namestring required

Nome do sistema que está realizando a requisição.

User-Agentstring required

Request body

nomestring

Nome do cliente.

celularinteger required

Número de celular do cliente com DDD e sem o uso da máscara.

valor_brutonumber float required

Valor da compra antes da aplicação do saldo de bônus.

Response

200

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "sucesso",
  "data": {
    "tem_bonus": true,
    "saldo_bonus": 30,
    "bonus_total": 264,
    "compra_minima": 880,
    "ids_bonus": "136473650,136473651",
    "is_multi_resgate": true,
    "primeira_data_valida": "2024-07-10 00:00:00",
    "historico": [
      {
        "validade_inicio": "2024-07-10 00:00:00",
        "validade_fim": "2025-10-10 23:59:00",
        "valor": 189
      }
    ],
    "loja_id": 100164,
    "user_id": 27056298,
    "user_name": "João Silva",
    "user_cpf": 40541655086
  }
}