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 a requestId is 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

TimeoutTime (Seconds)
Open10
Read70

Errors

In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Capture Full Payment:

HTTP Status CodeerrorCodeDescription
402
Payment Required
invalid_tokenThe checkout token is invalid, expired, or does not exist.
412
Precondition Failed
invalid_order_transaction_statusThe Consumer has not confirmed their payment for the order associated with this token.
422
Unprocessable Entity
invalid_objectThe checkout token was missing or empty.
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!