Integração com PDV (Point of Sale)

Antes de começar

Este guia descreve o fluxo que um PDV deve implementar para:

consultar benefícios usando o cliente e o carrinho atual;
validar a identidade do consumidor quando solicitado pela BonifiQ;
resgatar desconto, cashback, produto ou brinde;
registrar a venda concluída;
estornar um resgate abandonado e cancelar um pedido total ou parcialmente.

Raiz da API privada: https://api.bonifiq.com.br/v1/pvtOs caminhos deste guia são mostrados completos a partir de /v1/pvt. A maioria começa com /POS, mas o resgate de produto ou brinde usa /RewardConfigurations.

A API privada usa Basic Auth e foi criada para comunicação entre sistemas. Mantenha as credenciais em um backend, serviço local seguro do PDV ou cofre de segredos.Nunca coloque usuário e senha em frontend/browser, aplicativo distribuído ao consumidor, repositório, log ou cURL compartilhado.

Use sempre JSON em PascalCase, como nos exemplos desta página.

Fluxo completo

O PDV deve tratar resgate e cadastro do pedido como operações distintas. Um resgate bem-sucedido consome o benefício; o pedido concluído registra a compra e gera a bonificação.

Chamada	Dados enviados	Persistir antes de continuar	Compensação ou retry
`POST /POS/rewards/available`	Cliente, valor bruto, desconto externo e carrinho	Resposta mais recente e flags de validação	Descartar resposta se cliente ou carrinho já tiver mudado
`POST /POS/customers/{id}/challenge`	`TransactionId` e dados cadastrais solicitados	`TransactionId` e dados usados	Repetir com o mesmo ID e os mesmos dados
`POST /POS/rewards/{id}/redeem`	Cliente, valor, `OriginalKey` e `RedeemOrigin`	`OriginalKey` antes da chamada; depois `RewardId` e `ExternalCode`	Repetir com a mesma `OriginalKey`
`POST /RewardConfigurations/{id}/product-discount/redeem`	Dados acima e produto selecionado	Os campos acima, `ExternalProductId` e desconto aplicado	Repetir com a mesma `OriginalKey`
`POST /POS/orders`	Pedido líquido, produtos, pagamentos e `Coupon`	`OriginalId` estável e resultado do pedido	Repetir com o mesmo `OriginalId`
`DELETE /POS/rewards/{RewardId}`	`RewardId` na rota	Confirmação do estorno	Não liberar edição enquanto o estorno falhar
`POST /POS/{orderId}/partialcancel`	Valor, produtos, `ShouldRefundRedeem` e `CancelKey`	`CancelKey` e payload original	Repetir com a mesma chave e o mesmo payload

1. Consultar benefícios

Chame POST /v1/pvt/POS/rewards/available quando:

o cliente for identificado ou alterado;
um produto ou quantidade mudar;
um desconto que não seja da BonifiQ mudar;
o PDV precisar revalidar a seleção antes do resgate.

Valores do pedido

PurchaseValue é o valor bruto, antes de descontos, cupons e promoções.DiscountValue contém somente descontos que já existiam no PDV e não vieram da BonifiQ.

Exemplo:

Valor	Resultado
Carrinho bruto	R$ 100,00
Desconto próprio do PDV	R$ 20,00
`PurchaseValue`	`100.00`
`DiscountValue`	`20.00`
Base líquida local antes da BonifiQ	R$ 80,00

A BonifiQ usa PurchaseValue para regras de valor mínimo, limites e cashback. Ela usa DiscountValue separadamente para avaliar cumulatividade. Não envie o valor líquido em PurchaseValue.

Request

string

required

Identificador do cliente. Pode ser documento ou e-mail. Para CPF/CNPJ, envie apenas números.

decimal

required

Valor bruto atual do carrinho.

decimal

Desconto já aplicado pelo PDV e que não pertence à BonifiQ. Envie 0 ou null quando não houver.

array

Carrinho atual. Embora o contrato preserve compatibilidade sem esta lista, envie-a para considerar restrições por produto e benefícios RewardType = 5.

Cada produto pode conter:

OriginalId: SKU ou identificador estável no PDV;
LineId: identificador da linha, útil quando o mesmo SKU aparece com preços diferentes;
Title, Quantity e IsActive;
ProductPrice: preço unitário regular;
ProductDiscountPrice: preço unitário promocional, quando houver;
ProductBrand e ProductCategory, ambas com OriginalId e Name;
ProductCategory.ParentCategory para hierarquia de categorias.

cURL

curl --request POST \
  --url 'https://api.bonifiq.com.br/v1/pvt/POS/rewards/available' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>' \
  --header 'Content-Type: application/json' \
  --data '{
    "CustomerId": "12345678900",
    "PurchaseValue": 100.00,
    "DiscountValue": 20.00,
    "Products": [
      {
        "OriginalId": "SKU-001",
        "LineId": "LINHA-001",
        "Title": "Camiseta Básica",
        "Quantity": 1,
        "ProductPrice": 100.00,
        "ProductDiscountPrice": null,
        "IsActive": true,
        "ProductBrand": {
          "OriginalId": "MARCA-001",
          "Name": "Básicos"
        },
        "ProductCategory": {
          "OriginalId": "CAT-001",
          "Name": "Camisetas"
        }
      }
    ]
  }'

Response

{
  "Customer": {
    "Id": 1001,
    "OriginalId": "12345678900",
    "Name": "Maria Silva",
    "Email": "maria@example.com",
    "Phone": "11999998888",
    "Document": "12345678900",
    "IsEnrolled": true,
    "CurrentTier": {
      "Name": "Ouro",
      "Color": "#D97706",
      "IconUrl": null
    }
  },
  "HasRewards": true,
  "ShouldValidateCustomer": true,
  "ShouldValidateCustomerSignup": false,
  "AvailablePoints": 1500,
  "CashbackEnabled": true,
  "AvailableCashback": 25.00,
  "MaxCashbackForCurrentPurchase": 15.00,
  "HasRestrictedItems": false,
  "RestrictedValue": 0,
  "EligibleValue": 100.00,
  "Rewards": [
    {
      "Id": 5,
      "Title": "Caneca BonifiQ de brinde",
      "RewardType": 5,
      "Value": 0,
      "CanSelectValue": false,
      "IsCashback": false,
      "Requirements": "",
      "CanUse": true,
      "CannotUseReason": 0,
      "Points": 0,
      "RewardCanBeCumulative": true,
      "ExternalProductId": "SKU-BRINDE-001",
      "ProductDisplayName": "Caneca BonifiQ",
      "ProductDiscountMode": 2,
      "ProductDiscountValue": 0,
      "ProductMaxUnitsPerRedeem": 1,
      "ProductAvailableQuantity": 1,
      "ProductDiscountTotal": 0
    }
  ]
}

Rewards[].CanUse é a fonte autoritativa para habilitar uma opção. Não recalcule elegibilidade usando apenas saldo, preço ou Requirements.Algumas variantes antigas ou respostas internas podem trazer CanUseReward como resumo. A integração POS não deve depender desse campo: use Rewards[].CanUse.

Use Requirements como explicação amigável e CannotUseReason para comportamento estruturado:

Valor	Significado
`0`	Pode usar
`1`	Pontos insuficientes
`2`	Valor mínimo não atingido
`3`	Cashback indisponível
`4`	Cliente não encontrado
`5`	Benefício maior que a compra
`6`	Percentual mínimo não atingido
`7`	Cliente não inscrito
`8`	Não cumulativo com outro desconto
`9`	Produto aplicável ausente
`10`	Limite de uso do produto atingido
`11`	Benefício exige checkout online
`12`	Configuração de produto inválida

Tipos de recompensa

`RewardType`	Tipo	Ação no PDV
`0`	Desconto percentual	Usar `Value` como percentual
`1`	Desconto em valor	Usar `Value` como valor monetário
`2`	Frete	Não é o fluxo usual do PDV
`3`	Cashback	Permitir escolher valor decimal até `MaxCashbackForCurrentPurchase`
`4`	Recompensa customizada	Tratar conforme a configuração acordada
`5`	Produto, desconto em SKU ou brinde	Usar o endpoint específico de produto

Se HasRewards=false, prossiga com a venda sem benefício. Se houver recompensas com CanUse=false, elas podem ser exibidas desabilitadas com o motivo retornado.

2. Validar o cliente

Execute o challenge quando:

ShouldValidateCustomer = true
OU
ShouldValidateCustomerSignup = true

Se ambas as flags forem falsas, pule diretamente para o resgate.

Criar challenge

cURL

curl --request POST \
  --url 'https://api.bonifiq.com.br/v1/pvt/POS/customers/12345678900/challenge' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>' \
  --header 'Content-Type: application/json' \
  --data '{
    "TransactionId": "PDV-OTP-PEDIDO-123",
    "Document": "12345678900",
    "Name": "Maria Silva",
    "Email": "maria@example.com",
    "Phone": "11999998888"
  }'

Gere TransactionId uma vez por tentativa de validação e mantenha-o até concluir ou abandonar o fluxo.
Quando ShouldValidateCustomerSignup=true, envie Document e Name, além dos contatos disponíveis.
Se a resposta retornar ShouldInformPhone=true ou ShouldInformEmail=true, repita com o contato solicitado, o mesmo TransactionId e os dados cadastrais originais.

{
  "Success": true,
  "FriendlyErrorMessage": null,
  "ShouldInformPhone": false,
  "ShouldInformEmail": false,
  "SentBySMS": true,
  "SentByEmail": true,
  "TransactionId": "PDV-OTP-PEDIDO-123",
  "ErrorMessage": null
}

O código pode não ser devolvido ao PDV em produção: normalmente o consumidor o recebe pelo canal configurado.

Validar código

cURL

curl --request POST \
  --url 'https://api.bonifiq.com.br/v1/pvt/POS/customers/12345678900/challengevalidate' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>' \
  --header 'Content-Type: application/json' \
  --data '{
    "TransactionId": "PDV-OTP-PEDIDO-123",
    "Code": "123456"
  }'

Se Success=false, não resgate. Permita nova digitação ou solicite outro código. Não hardcode o tempo de validade do PIN; trate a resposta da API.

3. Resgatar o benefício

Antes da primeira chamada:

gere uma OriginalKey única para a operação;
persista essa chave junto à venda pendente;
reutilize exatamente a mesma chave em timeout ou retry.

Desconto ou cashback

Use POST /v1/pvt/POS/rewards/{id}/redeem para os tipos comuns.

cURL

curl --request POST \
  --url 'https://api.bonifiq.com.br/v1/pvt/POS/rewards/1/redeem' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>' \
  --header 'Content-Type: application/json' \
  --data '{
    "CustomerId": "12345678900",
    "OriginalKey": "PDV-REWARD-PEDIDO-123-1",
    "RedeemOrigin": 5
  }'

Para cashback, acrescente Value com o valor decimal escolhido, maior que zero e limitado por MaxCashbackForCurrentPurchase. Não envie Value para desconto fixo ou percentual.

{
  "HasError": false,
  "Severity": 0,
  "HasWarning": false,
  "Result": {
    "RewardId": 456,
    "ExternalCode": "BNF-ABC123",
    "OriginalKey": "PDV-REWARD-PEDIDO-123-1",
    "Coupon": null,
    "Point": {
      "PointId": 789,
      "Quantity": -100,
      "Metadatas": null
    }
  }
}

Persista:

Result.RewardId para um eventual estorno;
Result.ExternalCode para enviar como Coupon no pedido;
Result.OriginalKey para conciliação.

Produto, desconto em SKU ou brinde

Quando RewardType=5, use:

POST /v1/pvt/RewardConfigurations/{id}/product-discount/redeem

O id da rota é Rewards[].Id. O Product.ExternalProductId deve corresponder ao identificador offline retornado na consulta.

cURL

curl --request POST \
  --url 'https://api.bonifiq.com.br/v1/pvt/RewardConfigurations/5/product-discount/redeem' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>' \
  --header 'Content-Type: application/json' \
  --data '{
    "RewardConfigurationId": 5,
    "CustomerId": "12345678900",
    "OriginalKey": "PDV-REWARD-PEDIDO-123-5",
    "RedeemOrigin": 5,
    "Product": {
      "ExternalProductId": "SKU-BRINDE-001",
      "Quantity": 1,
      "ProductPrice": 29.90,
      "ProductDiscountPrice": null,
      "HasPromotion": false
    }
  }'

`ProductDiscountMode`	Significado	Aplicação
`0`	Desconto percentual	Subtrair `ProductDiscountTotal` do total das unidades
`1`	Preço final fixo	Usar o desconto efetivamente retornado
`2`	Brinde	Adicionar linha separada com preço zero
`3`	Desconto em valor fixo	Subtrair `ProductDiscountTotal`

Para os modos que não são brinde, informe ProductPrice ou ProductDiscountPrice. Se a linha já possui promoção, envie o preço promocional e HasPromotion=true para que a API aplique as regras de cumulatividade.

{
  "HasError": false,
  "Severity": 0,
  "Result": {
    "RewardId": 457,
    "ExternalCode": "BNF-PRODUTO-ABC123",
    "OriginalKey": "PDV-REWARD-PEDIDO-123-5",
    "ExternalProductId": "SKU-BRINDE-001",
    "ProductDiscountTotal": 0,
    "Coupon": null,
    "Point": {
      "PointId": 790,
      "Quantity": 0,
      "Metadatas": null
    }
  }
}

Adicione o produto resgatado como linha separada do carrinho. Para desconto em produto, use ProductDiscountTotal retornado para calcular o preço líquido. Para brinde, o preço final da linha é zero.

4. Registrar o pedido

Envie todos os pedidos concluídos, mesmo quando não houver benefício. Use:

POST /v1/pvt/POS/orders

OrderTotal é o valor líquido efetivamente pago, sem frete, depois de descontos, cashback, cupons e promoções. Continuando o exemplo:

Valor	Resultado
Carrinho bruto	R$ 100,00
Desconto próprio	- R$ 20,00
Benefício BonifiQ	- R$ 10,00
`OrderTotal`	R$ 70,00

PurchaseValue da consulta e OrderTotal do pedido representam valores diferentes. Não reutilize um no lugar do outro.

cURL

curl --request POST \
  --url 'https://api.bonifiq.com.br/v1/pvt/POS/orders' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>' \
  --header 'Content-Type: application/json' \
  --data '{
    "OriginalId": "PDV-PEDIDO-123",
    "OrderPlacementDate": "2026-07-22T14:30:00Z",
    "OrderCompletedDate": "2026-07-22T14:35:00Z",
    "OrderStatus": "Concluido",
    "IsCancelledOrReturned": false,
    "IsCompleted": true,
    "OrderTotal": 70.00,
    "Coupon": "BNF-ABC123",
    "Customer": {
      "OriginalId": "12345678900",
      "Name": "Maria Silva",
      "Email": "maria@example.com",
      "Phone": "11999998888",
      "Document": "12345678900",
      "IsEnrolled": true
    },
    "Products": [
      {
        "OriginalId": "SKU-001",
        "Title": "Camiseta Basica",
        "ProductPrice": 70.00,
        "IsActive": true,
        "ProductBrand": {
          "OriginalId": "MARCA-001",
          "Name": "Basicos"
        },
        "ProductCategory": {
          "OriginalId": "CAT-001",
          "Name": "Camisetas"
        }
      }
    ],
    "PaymentMethods": [
      {
        "OriginalId": "DINHEIRO",
        "Name": "Dinheiro",
        "PaidAmount": 70.00
      }
    ],
    "Branch": {
      "OriginalId": "LOJA-001",
      "Name": "Loja Centro"
    },
    "SalesPerson": {
      "OriginalId": "VENDEDOR-001",
      "Name": "Joao Silva"
    }
  }'

Regras do payload

OriginalId deve permanecer igual em retries. Não gere um novo ID após timeout.
Coupon recebe o ExternalCode escalar retornado pelo resgate.
Customer é um DTO de criação. Não copie o objeto da consulta inteiro e não envie campos como Id ou CurrentTier.
Products[] usa Title, ProductPrice e IsActive. O contrato não possui Quantity, Price nem ProductDiscountPrice.
ProductPrice representa o valor líquido atribuído à linha. Distribua descontos em centavos para a soma dos produtos fechar com OrderTotal.
Prefira PaymentMethods[]. O campo singular PaymentMethod existe apenas por compatibilidade.
A soma de PaymentMethods[].PaidAmount deve representar o valor efetivamente pago.

Cashback e pontos estimados

A resposta inclui EstimatedBonus:

{
  "HasError": false,
  "Severity": 0,
  "Result": {
    "OriginalId": "PDV-PEDIDO-123",
    "OrderTotal": 70.00,
    "Coupon": "BNF-ABC123",
    "EstimatedBonus": {
      "GenerateBonus": true,
      "EstimatedPoints": 70,
      "EstimatedCashback": 7.00,
      "EstimatedCashbackFormatted": "R$ 7,00"
    }
  }
}

Se GenerateBonus=true, o PDV pode informar ao consumidor quanto ganhou. Para cashback, exiba diretamente EstimatedCashbackFormatted; não refaça formatação ou conversão local.

5. Estornos e cancelamentos

Abandono antes do resgate

Se ainda não existe RewardId, não há resgate para estornar. Limpe apenas o estado local.

Resgate realizado, venda ainda não concluída

Antes de permitir edição de cliente, carrinho ou benefício, estorne:

cURL

curl --request DELETE \
  --url 'https://api.bonifiq.com.br/v1/pvt/POS/rewards/456' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>'

Use o RewardId retornado pelo resgate, não o ID da configuração. Remova a linha resgatada somente depois de confirmar Result.IsCanceled=true. Também existe cancelamento por OriginalKey em DELETE /v1/pvt/POS/rewards, com a chave no body.

Cancelamento total do pedido

cURL

curl --request POST \
  --url 'https://api.bonifiq.com.br/v1/pvt/POS/orders/PDV-PEDIDO-123/cancel' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>' \
  --header 'Content-Type: application/json' \
  --data '{
    "OrderCancelledDate": "2026-07-22T16:00:00Z",
    "OrderStatus": "Cancelado"
  }'

O orderId da rota é o OriginalId enviado no cadastro. O cancelamento remove a bonificação da compra e trata o resgate associado segundo as regras da BonifiQ.

Cancelamento parcial

Use POST /v1/pvt/POS/{orderId}/partialcancel quando apenas parte do valor pago for devolvida.

cURL

curl --request POST \
  --url 'https://api.bonifiq.com.br/v1/pvt/POS/PDV-PEDIDO-123/partialcancel' \
  --header 'Authorization: Basic <CREDENCIAL_BASE64>' \
  --header 'Content-Type: application/json' \
  --data '{
    "ValueToRefund": 25.90,
    "CancelKey": "PDV-CANCELAMENTO-123-1",
    "Products": [
      {
        "OriginalId": "SKU-001",
        "ValueToRefund": 25.90
      }
    ],
    "ShouldRefundRedeem": null
  }'

ValueToRefund é o valor líquido devolvido.
A soma de Products[].ValueToRefund deve ser exatamente igual a ValueToRefund após arredondamento monetário.
Cada Products[].OriginalId deve existir no pedido original.
Omita ShouldRefundRedeem ou envie null para seguir a configuração do tenant; true força e false impede o estorno do resgate.
Gere e persista CancelKey antes da primeira tentativa.
Em timeout, repita a mesma chave com o mesmo payload.
Nunca reutilize a chave com valor, produtos ou ShouldRefundRedeem diferentes.

Resposta aceita:

{
  "HasError": false,
  "Severity": 0,
  "Result": {
    "IsCanceled": true,
    "UpdatedAt": "2026-07-22T16:30:00Z",
    "Status": 4,
    "RefundErrorDetails": null
  }
}

Resposta de validação, normalmente com HTTP 400:

{
  "HasError": true,
  "ErrorMessage": "Os produtos do cancelamento parcial sao invalidos.",
  "Severity": 2,
  "HasWarning": false,
  "Result": {
    "IsCanceled": false,
    "UpdatedAt": "2026-07-22T16:30:00Z",
    "Status": 4,
    "RefundErrorDetails": {
      "Code": "ProductRefundTotalMismatch",
      "Message": "A soma dos produtos deve ser igual ao valor do cancelamento.",
      "Field": "products",
      "ProductOriginalId": null,
      "ExpectedValue": 25.90,
      "ActualValue": 20.00
    }
  }
}

Não atualize o pedido local quando HasError=true, Result.IsCanceled=false ou RefundErrorDetails estiver preenchido.

6. Erros, warnings e retries

As respostas envelopadas podem conter:

Campo	Uso
HTTP status	Falha de transporte, autenticação ou validação
`HasError`	A operação deve ser tratada como erro
`Severity`	`0` sucesso, `1` warning, `2` erro
`HasWarning`	Resultado válido, porém informativo ou não ideal
`Code` e `CodeName`	Código estável do resultado quando disponível
`ErrorMessage`	Mensagem técnica ou de negócio
`Result`	Payload de sucesso ou detalhes específicos do endpoint

Não assuma que todo HTTP 200 é sucesso: verifique HasError e Severity. Um warning com HasWarning=true e HasError=false continua sendo um resultado válido. Os endpoints de challenge têm resposta própria com Success e FriendlyErrorMessage. Não aplique cegamente o envelope genérico a eles.

Operação	Chave preservada no retry
Challenge	`TransactionId`
Resgate	`OriginalKey`
Cadastro do pedido	`OriginalId`
Cancelamento parcial	`CancelKey` e o mesmo payload

Implemente timeout explícito, correlação e backoff para falhas transitórias. Em 429 Too Many Requests, respeite Retry-After quando disponível. Não dependa de limites numéricos fixos no cliente.

7. Segurança e operação

Envie somente campos aceitos pelo contrato. Não reaproveite respostas inteiras como requests.
Nunca registre o header Authorization.
Em ambientes reais, aplique política de proteção de PII a documentos, e-mails e telefones.
Ferramentas de teste podem exibir dados fictícios completos, mas cURLs compartilhados devem manter a credencial como placeholder.
Persista OriginalKey, RewardId, ExternalCode, OriginalId do pedido e CancelKey de forma durável.
Concilie operações cujo resultado ficou incerto antes de criar novas chaves.
Envie pedidos sem benefício; eles também geram pontos e cashback conforme a configuração.

Projeto de referência

PDV BonifiQ Integration Example

Projeto educacional com modo mock, fluxo visual e linha do tempo de requests e responses.

O projeto demonstra os fluxos desta página, mas não é uma implementação pronta para produção:

o acesso direto pelo navegador existe apenas para facilitar o aprendizado;
pedidos e chaves são mantidos em memória;
o exemplo de produto usa uma unidade e preço simplificado;
persistência, timeout, recuperação após reinício e proteção de credenciais pertencem ao PDV integrador.

O suporte a RewardType=5 deve ser publicado junto com a versão da API que disponibiliza /RewardConfigurations/{id}/product-discount/redeem no ambiente alvo.

Checklist de implementação

Perguntas frequentes

OrderTotal deve ser bruto ou líquido?

Líquido. Envie o valor efetivamente pago depois de descontos, cashback, cupons e promoções, sem frete.

PurchaseValue e OrderTotal são iguais?

Não necessariamente. PurchaseValue é bruto e serve para consultar elegibilidade; OrderTotal é o total líquido da venda concluída.

Posso usar mais de uma recompensa no mesmo pedido?

O fluxo POS vincula um ExternalCode escalar ao campo Coupon. Apresente as opções e permita que o consumidor escolha uma recompensa.

Preciso enviar pedidos sem recompensa?

Sim. Todos os pedidos concluídos devem ser enviados para que a BonifiQ calcule a bonificação.

Posso gerar outra OriginalKey depois de timeout?

Não. Reutilize a chave persistida até descobrir o resultado da operação original.

Guias de Integração

Integração com PDV (Point of Sale)

Antes de começar

Fluxo completo

1. Consultar benefícios

Valores do pedido

Request

Response

Tipos de recompensa

2. Validar o cliente

Criar challenge

Validar código

3. Resgatar o benefício

Desconto ou cashback

Produto, desconto em SKU ou brinde

4. Registrar o pedido

Regras do payload

Cashback e pontos estimados

5. Estornos e cancelamentos

Abandono antes do resgate

Resgate realizado, venda ainda não concluída

Cancelamento total do pedido

Cancelamento parcial

6. Erros, warnings e retries

7. Segurança e operação

Projeto de referência

PDV BonifiQ Integration Example

Checklist de implementação

Perguntas frequentes

Suporte

​Antes de começar

​Fluxo completo

​1. Consultar benefícios

​Valores do pedido

​Request

​Response

​Tipos de recompensa

​2. Validar o cliente

​Criar challenge

​Validar código

​3. Resgatar o benefício

​Desconto ou cashback

​Produto, desconto em SKU ou brinde

​4. Registrar o pedido

​Regras do payload

​Cashback e pontos estimados

​5. Estornos e cancelamentos

​Abandono antes do resgate

​Resgate realizado, venda ainda não concluída

​Cancelamento total do pedido

​Cancelamento parcial

​6. Erros, warnings e retries

​7. Segurança e operação

​Projeto de referência

PDV BonifiQ Integration Example

​Checklist de implementação

​Perguntas frequentes

​Suporte

Antes de começar

Fluxo completo

1. Consultar benefícios

Valores do pedido

Request

Response

Tipos de recompensa

2. Validar o cliente

Criar challenge

Validar código

3. Resgatar o benefício

Desconto ou cashback

Produto, desconto em SKU ou brinde

4. Registrar o pedido

Regras do payload

Cashback e pontos estimados

5. Estornos e cancelamentos

Abandono antes do resgate

Resgate realizado, venda ainda não concluída

Cancelamento total do pedido

Cancelamento parcial

6. Erros, warnings e retries

7. Segurança e operação

Projeto de referência

Checklist de implementação

Perguntas frequentes

Suporte