Skip to main content
POST
/
v1
/
pvt
/
Checkout
/
redeem
Redeems cashback for a checkout
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Checkout/redeem \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CustomerId": "<string>",
  "CheckoutId": "<string>",
  "CashbackValue": 123,
  "Total": 123,
  "Token": "<string>",
  "OriginalKey": "<string>",
  "RedeemOrigin": 0
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "RewardId": 123,
    "Point": {
      "PointId": 123,
      "Quantity": 123,
      "Metadatas": [
        {
          "Name": "<string>",
          "Value": "<string>"
        }
      ]
    },
    "ExternalCode": "<string>",
    "OriginalKey": "<string>",
    "Coupon": {
      "CouponCode": "<string>",
      "CouponType": 0,
      "CouponValue": 123,
      "ValidDateStart": "2023-11-07T05:31:56Z",
      "ValidDateEnd": "2023-11-07T05:31:56Z"
    }
  },
  "HasError": true
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Body

application/json

The redeem request

Request to redeem cashback in a checkout

​
CustomerId
string

Customer identifier (email or document/CPF)

​
CheckoutId
string

The checkout/cart ID from the e-commerce platform

​
CashbackValue
number<decimal> | null

Optional: The specific amount of cashback to apply. If not provided, the maximum available cashback will be used.

​
Total
number<decimal> | null

Optional: The checkout total value. Used for validation.

​
Token
string | null

Optional: Platform-specific token for the checkout

​
OriginalKey
string | null

Optional: A unique key to identify this redemption (for idempotency)

​
RedeemOrigin
enum<integer>

Optional: The origin of the redeem request

Available options:
0,
1,
2,
3,
4,
5

Response

200 - application/json

The reward information

​
ErrorMessage
string | null

Error message or description

​
ErrorCode
integer<int32> | null

Optional error code, if available

​
Result
object
​
HasError
boolean

If true the request had an error.