Void
Summary
Void (cancel) an authorization that has not been captured.
Resource URL | /api/v3/orders/{orderNumber}/voids |
---|---|
HTTP method | POST |
Content type | application/json; text/json; |
Input parameters
Parameter name | Location | Type / Model | Description |
---|---|---|---|
orderNumber | path |
required
Order number |
|
request | body | VoidAuthorizationRequest |
optional
Request |
Responses
HTTP status code | Model | Comment |
---|---|---|
OK(200) | VoidAuthorizationResponse | Void Authorization Response |
BadRequest (400) | array of ResponseMessage | Request failed. Check response model for list of Errors. |
Unauthorized (401) | API user is unauthorized. Make sure X-Auth-Key header is sent. | |
InternalServerError (500) | Request failed due internal error. Retry request later. |
Examples
{
"cancellationDetails": {
"totalNetAmount": 162.00,
"totalGrossAmount": 200.00,
"currency": "EUR",
"items": [
{
"productId": "0002",
"groupId": "0022",
"description": "Item 2 description",
"netUnitPrice": 162.00,
"grossUnitPrice": 200.00,
"quantity": 1.0,
"vatCategory": "MiddleCategory",
"vatPercent": 19.00,
"vatAmount": 38.00,
"lineNumber": 2
}
]
}
}
{
"totalCapturedAmount": 200.00,
"totalAuthorizedAmount": 1000.00
}