v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/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.

post/api_finaliza_compra

Headers

Authorizationstring required

Token de autenticação.

CodEmpresastring required

Código da empresa enviado pela CRMBonus.

Celularinteger required

Celular do cliente em base64.

Content-Typestring required

System-Namestring required

Nome do sistema PDV que está enviando a requisição

User-Agentstring required

Request body

restricao_horarioboolean required

Campo retornado na /api_bonus_disponivel.

vai_utilizar_bonusboolean required

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

ids_bonusstring required

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

loja_idinteger required

ID da loja na CRM&Bônus.

customer_idinteger required

ID do cliente na CRM&Bônus.

valor_brutonumber float required

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

bonus_resgatadonumber float required

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

campanha_idinteger required

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

smsstring required

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

pin_masterboolean required

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

nome_vendedorstring required

Nome do vendedor que realizou a venda.

nfstring

Nota Fiscal gerada a partir desta compra.

terminalstring

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

ticketstring required

Identificador da compra ou pedido no sistema.

Response

200

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "sucesso",
  "data": {
    "bonus_id": 135960899,
    "order_id": 129385214
  }
}