Documentation contents
POST/checkouts/preview

Calculate a benefit

Scope: checkouts:write

Headers

Idempotency-Keystringrequired
The persisted UUID for this operation. Retry with the same UUID and original body.
Format: uuid

Request body

location_idstringrequired
The authorized Mereu location UUID; inside external_ref, your own store identifier.
Format: uuid
card_idstringrequired
The Mereu card UUID.
Format: uuid
amountsobjectrequired
Original sale amounts before the Mereu benefit.
Fields amounts
total_before_loyaltyobjectrequired
Total before the Mereu benefit.
Fields total_before_loyalty
amount_minorintegerrequired
An integer in minor units; 10000 means 100.00.
Format: int64
Range: 0 – 100000000
currencystringrequired
The operation currency code, such as MDL or EUR.
Values: "MDL" · "RON" · "EUR" · "USD" · "GBP" · "UAH" · "PLN" · "TRY" · "CHF" · "RUB" · "GEL" · "KZT"
eligible_amountobjectrequired
Eligible gross before the benefit for preview; eligible amount actually paid for purchases.
Fields eligible_amount
amount_minorintegerrequired
An integer in minor units; 10000 means 100.00.
Format: int64
Range: 0 – 100000000
currencystringrequired
The operation currency code, such as MDL or EUR.
Values: "MDL" · "RON" · "EUR" · "USD" · "GBP" · "UAH" · "PLN" · "TRY" · "CHF" · "RUB" · "GEL" · "KZT"
tax_included_minorintegerrequired
Tax already included in the total; informational.
Format: int64
Range: 0 – 100000000
tip_minorintegerrequired
Tip, excluded from the benefit.
Format: int64
Range: 0 – 100000000
surcharge_minorintegerrequired
Surcharge, excluded from the benefit.
Format: int64
Range: 0 – 100000000
rewardvariantsrequired
Requested benefit: none, points or a visit reward.
Fields reward
Variant 1
modestringrequired
The documented operation mode.
Values: "none"
Variant 2
modestringrequired
The documented operation mode.
Values: "points"
pointsstringrequired
A decimal string with at most two effective decimal places; additional places must be zero.
Variant 3
modestringrequired
The documented operation mode.
Values: "visit_reward"
Response 200 · fields
dataobjectrequired
Authorized resource data.
Fields data
idstringrequired
The resource identifier.
Format: uuid
card_idstringrequired
The Mereu card UUID.
Format: uuid
location_idstringrequired
The authorized Mereu location UUID; inside external_ref, your own store identifier.
Format: uuid
program_version_idstringrequired
Format: uuid
loyalty_revisionintegerrequired
Format: int64
Range: 0 – …
discountobjectrequired
The benefit calculated by Mereu.
Fields discount
amount_minorintegerrequired
An integer in minor units; 10000 means 100.00.
Format: int64
Range: 0 – 100000000
currencystringrequired
The operation currency code, such as MDL or EUR.
Values: "MDL" · "RON" · "EUR" · "USD" · "GBP" · "UAH" · "PLN" · "TRY" · "CHF" · "RUB" · "GEL" · "KZT"
expected_paid_totalobjectrequired
The amount to collect after applying the benefit.
Fields expected_paid_total
amount_minorintegerrequired
An integer in minor units; 10000 means 100.00.
Format: int64
Range: 0 – 100000000
currencystringrequired
The operation currency code, such as MDL or EUR.
Values: "MDL" · "RON" · "EUR" · "USD" · "GBP" · "UAH" · "PLN" · "TRY" · "CHF" · "RUB" · "GEL" · "KZT"
points_to_earnstringrequired
points_to_redeemstringrequired
visit_reward_usedbooleanrequired
expires_atstringrequired
The resource expiry time.
Format: date-time

Errors and retrying requests: recovery guide →