/bonus/execute

Endpoint para resgate e/ou geração de bônus

Dicionário de Dados | Requisição

{
    "user": {
        "phone": "11999864382",
        "name": "Ned Nix",
        "email": "[email protected]",
        "cpf": "07656553304"
    },
    "gross_value": 200,
    "generated_bonus": {
        "expiration_date_start": "2022-01-01T00:00:00",
        "expiration_date_end": "2022-01-01T00:00:00",
        "value": 50
    },
    "redeemed_bonus": {
        "bonus_ids": ["9873432", "2373134"],
        "value": 10
    },
    "internal_order_id": "60a3f6dc-01d4-4da5-81de-b43acb067504"
}
CampoDescrição
userDados do cliente (Nome, Celular E-mail, Cpf).
gross_valueValor da compra antes da aplicação do saldo de bônus.
generated_bonusDados para geração do bônus.
redeemed_bonusDados para resgate do bônus.
internal_order_idIdentificador da compra ou pedido no sistema.

Dicionário de Dados | Resposta

{
  "status": true,
  "message": "Successfully generated bonus",
  "data": {
    "bonus_id": "6m6AU/VuGMZablszkpr8/w==",
    "order_id": "N1zy1v2v+p4BdT/TyHCRAg=="
  }
}
CampoDescrição
bonus_idID do bônus gerado a partir deste pedido;
order_idID do pedido gerado na CRMBonus a partir deste pedido.
📘

Observação

A requisição deve conter os dados de "generated_bonus" e/ou "redeemed_bonus"

Body Params
user
object
required

Dados do cliente

float
required
Defaults to 500.5

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

generated_bonus
object

Dados para geração do bônus

redeemed_bonus
object

Dados para resgate do bônus

string
required

Identificador da compra ou pedido no sistema.

Headers
string
required
Defaults to base64

Token de autenticação.

string
Defaults to base64

Código da empresa enviado pela CRMBonus.

string
required
Defaults to {systemName}

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

string
required
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json