Capture
Summary
Completes the payment that has been authorized. Typically done when the order is shipped. Can be a full or partial capture of the order amount.
Resource URL | /api/v3/orders/{orderNumber}/captures |
---|---|
HTTP method | POST |
Content type | application/json; text/json; |
Input parameters
Parameter name | Location | Type / Model | Description |
---|---|---|---|
orderNumber | path |
required
Order number |
|
request | body | CaptureRequest |
optional
Request object |
Responses
HTTP status code | Model | Comment |
---|---|---|
OK(200) | CaptureResponse | Capture 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
{
"orderDetails": {
"totalNetAmount": 50.00,
"totalGrossAmount": 60.00,
"currency": "EUR",
"items": [
{
"productId": "0001",
"groupId": "0011",
"description": "Item 1 description",
"netUnitPrice": 10.00,
"grossUnitPrice": 12.00,
"quantity": 5.0,
"vatCategory": "MiddleCategory",
"vatPercent": 20.00,
"vatAmount": 2.00,
"lineNumber": 1
}
]
}
}
{
"capturedAmount": 60.00,
"authorizedAmount": 300.00,
"remainingAuthorizedAmount": 240.00,
"captureNumber": "000000001"
}