GetVoid
Summary
Returns all or specific voided (cancelled) authorizations of the order.
| Resource URL | /api/v3/orders/{orderNumber}/voids/{voidNumber} |
|---|---|
| http method | GET |
| Content type | application/json; text/json; |
Input parameters
| Parameter name | Location | Type / Model | Description |
|---|---|---|---|
| orderNumber | path |
required
Order number |
|
| voidNumber | path |
optional
Void number |
Responses
| http status code | Model | Comment |
|---|---|---|
| OK(200) | GetVoidsResponse | Get Voids 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
{
"cancellations": [
{
"cancellationNo": "ORDER000001C00",
"cancellationAmount": 100.00,
"cancellationItems": []
}
]
}