Skip to main content
POST
/
v1
/
pvt
/
Order
/
{orderId}
/
partialcancel
Partially cancel an order
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Order/{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",
    "Status": 0
  },
  "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
​
ErrorMessage
string | null

Error message or description

​
ErrorCode
integer<int32> | null

Optional error code, if available

​
Result
object
​
HasError
boolean

If true the request had an error.