Capture an authorized order
curl -X PUT "https://test-api.kashier.io/v3/payment/capture/string" \ -H "Content-Type: application/json" \ -d '{ "apiOperation": "CAPTURE", "transaction": { "amount": 3 } }'{ "response": {}, "transactionId": "string", "messages": { "en": "string", "ar": "string" }, "status": "string", "provider": { "type": "string", "version": "string" }}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.
Authorization
secretKey Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).
In: header
Path Parameters
Kashier's order id.
Request Body
application/json
The same body the checkout host forwards for a capture.
TypeScript Definitions
Use the request body type in TypeScript.
Capture a previously authorized amount, fully or partially. You should capture the amount before 7 days or 30 days depending on your configuration.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
Void an order PUT
Cancels a transaction on the order before it settles — the clean undo while the money has not actually moved yet. Use it to cancel a pay, an authorization, a capture or a refund; pass the targetTra…
Reverse an order PUT
Reverses a transaction at the rail level. This is the card-present and BNPL undo — for an ordinary online card sale reach for void (before settlement) or refund (after) instead, which is almost alw…