Upgrading to the Clearpay Express CheckoutHow to Integrate

Auth [Express Checkout]

This endpoint performs a payment capture for the full value of the payment plan. <Note title="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 a `requestId` is not required. </Note> <Note title="Note"> The consumer's payment plan will begin at the time of auth approval. </Note> ## Approved Response (201) If payment is approved by Clearpay, returns a [Payment object](/payment-object) in response, with a `status` of "APPROVED". ## Declined Response (201) If payment is approved by Clearpay, for example, if invalid card details were entered, returns a [Payment object](/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](/put-post-errors) applicable to all POST endpoints, the following errors are specific to Capture Full Payment: | HTTP Status Code | errorCode | Description | | :-- | :-- | :-- | | 402 <br />Payment Required | `invalid_token` | The checkout token is invalid, expired, or does not exist. | | 412 <br />Precondition Failed | `invalid_order_transaction_status` | The Consumer has not confirmed their payment for the order associated with this token. | | 422 <br />Unprocessable Entity | `invalid_object` | The checkout token was missing or empty. |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Headers

User-AgentstringRequired
AcceptstringOptional

Request

This endpoint expects an object.
tokenstringRequired
The token returned in the Create Checkout request.
amountobjectRequired
Amount to be checked against the value in the create checkout request. If the amounts do not match, then the request will be rejected and an error specific to this scenario will be returned. This field is required for Express Checkout.
merchantReferencestringOptional

The merchant’s order id/reference that this payment corresponds to. This will update any value previously provided in the Create Checkout request.

isCheckoutAdjustedbooleanOptional
The isCheckoutAdjusted field can be used to allow the order amount to be changed after the Express Checkout flow.
paymentScheduleChecksumstringOptional

A unique value representing the payment schedule that must be provided when there has been changes since the initial order creation (retrieved from checkout widget).

itemslist of stringsOptional
An array of order items that have been updated to be provided if it has changed since the initial order creation.
shippingobjectOptional
The shipping address if it has changed since the initial order creation.

Response

200

Errors