Capture an authorized order
Takes the money on an order you previously authorized, fully or partially. Capture before the hold expires — 7 or 30 days depending on your configuration — or the authorization lapses and the funds go back to the customer on their own. To release an authorization deliberately, use void rather than letting it expire.
The same operation as PUT /v3/orders/{orderId} with apiOperation: CAPTURE. The checkout host forwards to this exact route without authenticating, so the two are interchangeable.
Authorize-and-capture must be switched on for your account — contact your account manager or customer success if a capture is rejected as unsupported.
Send your secret key in the Authorization header. Unlike refund and void, capture does not require the refund permission.
Request
- Base URL: https://test-api.kashier.io
- URL: https://test-api.kashier.io/v3/payment/capture/{orderId}
- Auth: API key in header Authorization
Path parameters
Kashier's order id.
Request body
Response
The capture result. A successful capture leaves the order at CAPTURED.
Changes
No recorded changes to this operation across all 1 revision of this API.