Partially cancel an order

If your customer returns or ask for refund for some part of their purchase you can you this endpoint to cancel the corresponding points/cashback for that purchase

orderID

This is the exact same ID used when sending the order to BonifiQ. Usually is the ID from the origin plataform.

ValueToRefund

The purchase value being refunded. It should be less than the order total value.

CancelKey

This field allows to create idempotency. It can be any unique string such an ID for the cancellation. If you try to cancel the same order using the same CancelKey the cancellation will fail.

orderIdstring required

Request body

ValueToRefundnumber

Value to be refunded from the order total. This value must be greater than 0 and less or equal than the OrderTotal value sent when the order was created or updated.

CancelKeystring

This key is used to avoid duplicated partial cancel on the same order. Use a unique value (such as an ID) for each partial cancel request.

ShouldRefundRedeemboolean nullable

Controls whether BonifiQ should refund points/cashback redeemed on this order. True forces redeem refund, false skips redeem refund, null follows the tenant feature flag.

Response

ErrorMessagestring nullable

Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.

ErrorCodeinteger nullable

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

Codestring nullable

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.

CodeNamestring nullable

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity0 | 1 | 2

0 = Success 1 = Warning 2 = Error

HasWarningboolean

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.

HasErrorboolean

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.

v5