This endpoint performs a payment capture for the full value of the payment plan.
Note
This operation is idempotent based on the token, which allows for the safe retry of requests, guaranteeing the payment operation is only performed once.
Since the idempotency of this endpoint is based on the
token, the inclusion of arequestIdis not required.
Approved Response (201)
If payment is approved by Clearpay, returns a Payment object in response, with a status of "APPROVED".
Declined Response (201)
If payment is declined by Clearpay, for example, if invalid card details were entered, returns a Payment object in response, with a status of "DECLINED".
Please advise the consumer to contact the Clearpay Customer Service team for more information.
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 Full Payment:
| HTTP Status Code | errorCode | Description |
|---|---|---|
| 402 Payment Required | invalid_token | The checkout token is invalid, expired, or does not exist. |
| 412 Precondition Failed | invalid_order_transaction_status | The Consumer has not confirmed their payment for the order associated with this token. |
| 422 Unprocessable Entity | invalid_object | The checkout token was missing or empty. |