Request a cancel, check eligibility, and launch if not rejected
POST https://api.nexway.store/retention/cancel
The request body takes a complete Cancel Payload resource, containing the following writable properties:
{
"comment": "string",
"orderNumber": "string",
"reason": "string",
"salesUnitId": "integer"
}
Name | Type | Description | Additional |
---|---|---|---|
comment | string |
Comment around the cancellation |
|
orderNumber | string |
order number from platform |
|
reason | string |
Reason of the cancellation |
|
salesUnitId | integer |
number indicating platform |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
201 | Created Refund request saved |
Cancel Answer |
400 | Bad Request invalid refund request |
|
401 | Unauthorized The token is wrong, auth failure |
|
403 | Forbidden Endpoint forbidden |
|
412 | Precondition Failed Refund request not eligible |