This endpoint captures a full or partial payment. Any amounts successfully captured will be settled from Clearpay to the merchant's nominated bank account on the following day. Records of all payments captured against an order are returned in the events list as events of type, "CAPTURED".
Note
This operation is idempotent based on the
requestId
(if provided), which allows for the safe retry of requests, guaranteeing the payment operation is only performed once.
Successful Response (201)
If successful, returns an updated copy of the Payment object, with the newly captured payment appended to the events
array as a Payment Event object with a type
of "CAPTURED".
Connection Timeouts
Timeout | Time (Seconds) |
---|---|
Open | 10 |
Read | 70 |
Errors
In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Capture Payment:
HTTP Status Code | errorCode | Description |
---|---|---|
404 |
| No numeric |
410 |
| Payment has already been fully captured for this order, or partially captured with the remainder voided. |
412 |
| A numeric |
412 |
| The order was declined by Clearpay; no payment can be captured for this order. |
412 |
| The auth for this order has already been completely voided. |
412 |
| The auth for this order has expired; no further payment can be captured. |
422 |
| The |
422 |
| The |