GetCapture
Summary
Returns all or specific captured payments of the order
Resource URL | /api/v3/orders/{orderNumber}/captures/{captureNumber} |
---|---|
HTTP method | GET |
Content type | application/json; text/json; |
Input parameters
Parameter name | Location | Type / Model | Description |
---|---|---|---|
orderNumber | path |
required
Order number |
|
captureNumber | path |
optional
Capture number |
Responses
HTTP status code | Model | Comment |
---|---|---|
OK(200) | GetAllCapturesResponse | Get All Captures 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
{
"captures": [
{
"reservationId": "614e37d1-25c2-41dc-ad17-7b801d3cb164",
"customerNumber": "000000001",
"captureNumber": "000000001",
"orderNumber": "ORDER000001",
"amount": 300.00,
"balance": 300.00,
"currency": "EUR",
"insertedAt": "2021-04-12T21:55:56Z",
"orderDate": "2021-04-12T21:55:56Z",
"captureItems": [
{
"productId": "0001",
"groupId": "0011",
"description": "Item 1 description",
"netUnitPrice": 10.0,
"grossUnitPrice": 12.0,
"quantity": 5.0,
"vatCategory": "MiddleCategory",
"vatPercent": 20.0,
"vatAmount": 2.0,
"lineNumber": 1
},
{
"productId": "0002",
"groupId": "0022",
"description": "Item 2 description",
"netUnitPrice": 100.0,
"grossUnitPrice": 120.0,
"quantity": 2.0,
"vatCategory": "MiddleCategory",
"vatPercent": 20.0,
"vatAmount": 20.0,
"lineNumber": 2
}
]
}
]
}