Capture Full Payment [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>

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 <br />Payment Requiredinvalid_tokenThe checkout token is invalid, expired, or does not exist.
412 <br />Precondition Failedinvalid_order_transaction_statusThe Consumer has not confirmed their payment for the order associated with this token.
422 <br />Unprocessable Entityinvalid_objectThe checkout token was missing or empty.
post/v2/payments/capture.

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v2/payments/capture.
  • Auth: HTTP basic

Headers

User-Agentstring required
Acceptstring

Request body

tokenstring required

The token returned in the Create Checkout request.

merchantReferencestring

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

isCheckoutAdjustedboolean

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

paymentScheduleChecksumstring

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).

itemsstring[]
shippingV2PaymentsCapturePostRequestBodyContentApplicationJsonSchemaShipping

The shipping address if it has changed since the initial order creation.

Response

200

CaptureFullPaymentExpressCheckout2Response200 required

Changes

No recorded changes to this operation across all 1 revision of this API.