This endpoint requests a payment auth, which determines the order approval status. If approved, the auth will have an expiration date and time, which is returned in the events list for the "AUTH_APPROVED" payment event.
Note
This operation is idempotent based on the
requestId(if provided), which allows for the safe retry of multiple requests, guaranteeing the payment operation is only performed once.
Note
The consumer's payment plan begins at the time of auth approval.
Beware
Authorisation expires after 13 days and then the transaction is automatically voided. Voided transactions are frozen and cannot be reopened or changed in any way. In this case your only option is to use the v2/checkouts endpoint to create a new order.
Approved Response (201)
If payment is approved by Clearpay, returns a Payment object in response, with a status of "APPROVED" and a paymentState of "AUTH_APPROVED".
Declined Response (402)
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" and a paymentState of "AUTH_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 Auth:
| 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. |