IntroduçãoDocumentação APICentral de AjudaObter SuporteStatus page
Conceitos

Como utilizar o cashback como desconto

📘

O que você irá aprender com esse artigo?

  • O que é cashback como desconto
  • Como aplicar o cashback como desconto em compras futuras
  • Diferença entre cashback como desconto e cashback para saque
  • Exemplos de uso do cashback como desconto
  • Instruções para consultar o saldo de cashback disponível

Ainda não configurou o cashback?

Saiba como realizar essas configurações iniciais em Criar cashback.

O que é cashback como desconto

O cashback como desconto oferece ao comprador um desconto no valor da próxima compra, ao invés de disponibilizar o valor do cashback para saque. Dessa forma, o valor do cashback pode ser aplicado como desconto na próxima transação.

Caso de uso

"Uma loja oferece ao cliente um benefício através do cashback como desconto. Por exemplo, ao adquirir um par de sapatos por R$ 300 com 10% de cashback como desconto, o cliente recebe R$ 30 de crédito para a próxima compra. Assim, na próxima transação, esse valor será subtraído automaticamente do total da compra.

Quando o cliente realiza uma nova compra de R$ 150, o crédito de R$ 30 é aplicado, reduzindo o valor a ser pago para R$ 120. Esse mecanismo atua como um incentivo para futuras compras, proporcionando economia contínua e fidelizando o cliente."

Diagrama de Sequência para Cashback como Desconto

Diagrama de Sequência para Cashback como Desconto

Consultar saldo disponível

Utilize o endpoint Informações da Conta — v1/accounts/{id}para consultar o saldo disponível para aplicar o desconto. Esse valor será retornado no parâmetro balance_available_for_withdraw.

 "balance": "R$ 0,60",
  "balance_in_protest": "R$ 0,00",
  "balance_available_for_withdraw": "R$ 0,60", /// Saldo disponível para Saque
  "protected_balance": "R$ 0,00",
  "payable_balance": "R$ 0,00",
  "receivable_balance": "R$ 0,00",
...

Criar fatura com desconto

Depois de consultar o valor disponível, utilize o parâmetro discount_cents do endpoint Criar Fatura — v1/invoices para criar uma fatura com o desconto.

Modelo de Request

  • Fatura com 1 item. Este item custa R$89,00 (price_cents 8900 cents) .
  • Com desconto (cashback) de R$12,00 (discount_cents 1200 cents).
curl --request POST \
     --url 'https://api.iugu.com/v1/invoices?api_token=<seu-token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "ensure_workday_due_date": false,
  "payer": {
    "cpf_cnpj": "113.436.750-30",
    "name": "Nome"
  },
  "customer_id": "2074A47210264DC496A3BD865D5CA92D",
  "items": [
    {
      "description": "Nome do Item",
      "quantity": 1,
      "price_cents": 8900
    }
  ],
  "payable_with": [
    "all"
  ],
  "due_date": "2024-05-20",
  "discount_cents": 1200
}
,

Response

  • Valor total da Fatura R$77,00 (total_cents 7700)
  • Desconto de R$12,00 (discount_cents 1200)
{
  "id": "2411FC1B3B6A42D08C8DCFD3B85131DD",
  "due_date": "2024-05-20",
  "currency": "BRL",
  "discount_cents": 1200, //Valor do desconto
  "email": "[email protected]",
  "items_total_cents": 8900, //Valor do item (sem desconto)
  "notification_url": null,
  "return_url": null,
  "status": "pending",
  "tax_cents": null,
  "total_cents": 7700, //Valor Total da Fatura: 8900-1200=7700
  "total_paid_cents": 0,
  "taxes_paid_cents": null,
  "paid_at": null,
  "paid_cents": null,
...

Response alternativa com Descritivo de Cashback

Para especificar na fatura que o valor do desconto se refere ao Cashback, em vez de usar o parâmetro discount_cents, utilize o objeto item com o price_cents configurado como negativo.

Modelo de Request

  • Fatura com 2 itens.
    • Item 1: custa R$89,00 (price_cents 8900 cents) .
    • Item 2: (cashback): subtrai R$12,00 (price_cents -1200) e description "Cashaback".
curl --request POST \
     --url 'https://api.iugu.com/v1/invoices?api_token=<seu-api_token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "ensure_workday_due_date": false,
  "payer": {
    "cpf_cnpj": "113.436.750-30",
    "name": "Nome"
  },
  "customer_id": "2074A47210264DC496A3BD865D5CA92D",
  "items": [
    {
      "description": "Nome do Item",
      "quantity": 1,
      "price_cents": 8900
    },
    {
      "description": "Cashback",
      "quantity": 1,
      "price_cents": -1200
    }
  ],
  "payable_with": [
    "all"
  ],
  "due_date": "2024-05-20"
}
'

Response

  • Valor total da Fatura R$77,00 (total_cents 7700)
  • Desconto de R$12,00 (price_cents -1200)
{
  "id": "1DD7941E517B49FFA028C77675CC4EBB",
  "due_date": "2024-05-20",
  "currency": "BRL",
  "discount_cents": null, //Valor do Desconto 'null', porém, 'total_cents' 7700.
  "email": "[email protected]",
  "items_total_cents": 7700,//Valor dos itens (com desconto)
  "notification_url": null,
  "return_url": null,
  "status": "pending",
  "tax_cents": null,
  "total_cents": 7700, //Valor Total da Fatura: 8900-1200=7700
  "total_paid_cents": 0,
  "taxes_paid_cents": null,
  "paid_at": null,
  "paid_cents": null,
...

Updated 5 months ago

O que mais?

Assuntos relacionados