/api_finaliza_compra

Esse endpoint é responsável por finalizar o fluxo de resgate de um bônus. Após isso, um novo bônus será gerado e poderá ser utilizado no futuro.

Introdução à /api_finaliza_compra

❗️

Respostas de Erro:

Bônus utilizado maior do que o saldo: Para esta mensagem de erro há duas possibilidades distintas, sendo elas:

  • O bonus_resgatado informado é diferente do saldo_bonus retornado na api_bonus_disponivel;
  • O valor_bruto informado é diferente do valor_bruto informado na *api_bonus_disponivel.

O bônus que o cliente pode resgatar está diretamente ligado ao valor bruto de sua compra. Caso haja qualquer alteração, o processo deve retornar à api_bonus_disponivel.

Ids dos Bonus usados em Conflito: quando o ids_bonus enviado é divergente do campo de mesmo nome recebido na api_bonus_disponivel.

Dicionário de Dados | Resposta

CampoDescrição
bonus_idID do bônus gerado a partir desta venda.
order_idID do pedido gerado na CRM&Bônus a partir desta venda.
Body Params
boolean
required
Defaults to false

Campo retornado na /api_bonus_disponivel.

boolean
required
Defaults to true

Informa se o cliente está utilizando o bônus.

string
required
Defaults to 135960898

IDs dos bônus disponíveis nesta compra. Campo retornado na /api_bonus_disponivel.

int32
required
Defaults to 100164

ID da loja na CRM&Bônus.

int32
required
Defaults to 27126798

ID do cliente na CRM&Bônus.

float
required
Defaults to 2000

Valor da compra antes da aplicação do saldo de bônus. Campo enviado na requisição da /api_bonus_disponivel.

float
required
Defaults to 50

Valor de bônus resgatado nesta compra. Campo "saldo" retornado na /api_bonus_disponivel.

int32
required
Defaults to 20263

ID da campanha CRM&Bônus. Campo "id" selecionado dentre as opções retornadas na /api_campanha_disponivel.

string
required
Defaults to SANDBOX: PIN 7873 - -

Mensagem de SMS enviada ao cliente no inicio do processo. Campo de mesmo nome retornado na /api_inicio.

boolean
required
Defaults to false

Informa se foi utilizado o PIN Master. Campo de mesmo nome retornado na /api_validar_pin.

string
required
Defaults to Ana Caroline

Nome do vendedor que realizou a venda.

string
Defaults to CRM-TESTE

Nota Fiscal gerada a partir desta compra.

string
Defaults to CB0001

Identificação do terminal ou caixa onde a venda foi realizada.

string
required
Defaults to CRM-TESTE-001

Identificador da compra ou pedido no sistema.

Headers
string
required
Defaults to Base64

Token de autenticação.

string
required
Defaults to Base64

Código da empresa enviado pela CRMBonus.

int32
required
Defaults to null

Celular do cliente em base64.

string
required
Defaults to {pdvSystemName}

Nome do sistema PDV que está enviando 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