Simulates purchase points for the current checkout/cart state.
BonifiQ fetches the checkout from the configured platform integration and uses the platform total.
Any Total property sent by legacy clients is ignored by model binding because it is not part of this request contract.
Authorizations
Use API Basic Auth Keys
Body
Customer and checkout information used to simulate purchase points.
Request to simulate purchase points for the current checkout/cart. The checkout total is always fetched from the platform integration.
Optional customer identifier resolved according to the tenant checkout customer lookup setting.
Optional customer identifiers used when checkout customer lookup is configured by document or email.
The checkout/cart ID from the e-commerce platform.
Response
The simulated purchase points and cashback.
Standard response envelope used by the External API.
Error message returned when the request fails validation or processing.
For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.
Legacy numeric error code derived from internal API errors when available.
This field is relevant only for error flows that use ApiResponseErrorDescription.
Business payload returned by the endpoint.
Endpoint-specific business code formatted as a two-digit string, such as 03 or 07.
This field is available for success, warning and error outcomes.
Symbolic enum name associated with Code, such as CheckoutNotFound.
Final severity of the response.
Success means the action completed as expected, Warning means the request was valid but the business outcome is informational or non-ideal, and Error means the request should be treated as a failure.
0, 1, 2 Convenience flag that is true when Severity is Warning.
Warnings are valid 200 OK business outcomes and should not be handled as transport or validation errors.
Indicates whether the request failed and should be handled as an error response.
This flag is reserved for real API errors; warnings must keep this property as false.