Removes an already applied cashback from a checkout.
Use this endpoint when your integration needs to explicitly undo a checkout cashback redeem before the order is created. Depending on the platform integration, BonifiQ also cancels the underlying redeem after removing the cashback from the checkout.
When to use
Call this endpoint when the shopper manually removes the cashback, abandons the checkout flow or when your platform decides the cashback should no longer be used.
Input parameters
CustomerId(required): Customer identifier used by your store, such as e-mail or CPF/document.CheckoutId(required): Platform checkout/cart identifier from which the cashback should be removed.Total(optional): Current checkout total. Use it when the integration requires the caller to send the latest total explicitly.
Response envelope
The endpoint returns BaseExternalApiResponse<CheckoutRemoveCashbackResponse>.
Code: two-digit business code for the final outcome.CodeName: enum name associated withCode.Severity:Success,WarningorError.HasError:trueonly for request/validation failures that should be treated as an API error.HasWarning:truewhen the request is valid but there is nothing to remove or the outcome is only informational.Result.Success:truewhen the cashback was effectively removed.Result.CustomerMessage: human-readable message describing the final state.
Business outcomes
A valid request may still return Severity = Warning.
This is expected when:
- the checkout does not exist
- the checkout exists but no cashback is currently applied
Validation errors
Invalid requests return 400 Bad Request with Severity = Error.
This happens when the customer cannot be identified or the CheckoutId is missing.
Response codes
01 / CustomerNotFound / Error: the informed customer could not be found.02 / CheckoutIdRequired / Error: the request did not includeCheckoutId.03 / CheckoutNotFound / Warning: the checkout was not found in the platform.04 / CashbackNotApplied / Warning: the checkout exists but no cashback is currently applied.07 / CashbackRemovedSuccessfully / Success: the cashback was removed successfully.
Authorizations
Use API Basic Auth Keys
Body
Customer and checkout information used to remove the cashback.
Request payload for checkout actions that need both customer identification and checkout reference.
Required customer identifier used by the merchant platform, such as e-mail or CPF/document.
Required checkout or cart identifier from the e-commerce platform.
Optional current checkout total value. Send this only when the platform integration needs the caller to provide the latest checkout amount explicitly.
Response
A checkout removal response with business code, severity and removal outcome.
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.