Partially cancel an order - BonifiQ Developers

curl --request POST \ --url https://api.bonifiq.com.br/v1/pvt/POS/{orderId}/partialcancel \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --data ' { "ValueToRefund": 123, "CancelKey": "<string>" } '

{ "ErrorMessage": "<string>", "ErrorCode": 123, "Result": { "isCanceled": true, "UpdatedAt": "2023-11-07T05:31:56Z" }, "Code": "<string>", "CodeName": "<string>", "HasWarning": true, "HasError": true }

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Path Parameters

orderId

string

required

Body

application/json

ValueToRefund

number<decimal>

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.

CancelKey

string

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.

Response

200 - application/json

Standard response envelope used by the External API.

ErrorMessage

string | null

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

ErrorCode

integer<int32> | null

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

Result

object

Business payload returned by the endpoint.

Show child attributes

Code

string | null

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.

CodeName

string | null

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity

enum<integer>

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.

Available options:

0,

1,

2

HasWarning

boolean

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.

HasError

boolean

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.