Cancel an order
This method allows you to cancel an order. A call to this method can be performed after the customer has completed the checkout and the goods have not yet been shipped to the customer. For Invoices and loans, the reserved credit amount will be removed and any pre-paid purchases (such as cards or bank transfers) will be refunded automatically.
API endpoint
POST: {api_url}/api/partner/payments/{purchaseid}/cancel
Authorization: Bearer {partner_access_token}Input Parameters
| Name | Data Type | Default Value | Description |
|---|---|---|---|
| reason | String | None. Must be specified. | Reason for cancelling payment. |
Example request
{
"reason": "Cancelling order upon customer request."
}Return Value
If successful, the method returns a HTTP status code 200 (OK) with no additional content.
Not successful, the method returns a HTTP status code 400 with an error description in the body.
[
{
"ErrorCode": "10005",
"ErrorMessage": "Invalid or missing external ID."
}
]