2b. Auth and Capture

If you expect to be able to fulfil the order, authorize the payment by using the auth call with the token.


Supported Platforms for Auth and Capture Payment Flow

1. Auth


If the Auth is successful, Clearpay will return a unique, Clearpay generated, orderId. You will use this orderID when you want to capture the funds.

If the payment was declined by Clearpay (e.g. the Consumer’s payment instrument details are entered incorrectly), Merchant presents an appropriate message to the Consumer at the checkout.

Deferred Capture


Capture a payment against the Authorization - POST /v2/payments/{id}/capture
If you are able to fulfil the order finalize the payment by using the capture call with the id. If you are fulfilling part of the order you can capture a partial payment. Multiple captures can be performed against an authorization, provided that the sum of captures does not exceed the authorized amount. The capture call is idempotent if a unique requestId (GUID) is provided with the request.

This flow completes the payment approval, starts the consumer's payment plan - all as a combined action. Funds, up to the order value, are settled with the merchant as the order total is captured by the merchant.

The Deferred Payment flow allows the merchant to capture payments up to the order value via
- multiple partial captures with Auths, or
- a single capture request with Auth, or
- a single capture request without Auth, or

A few examples of when the Deferred Payment flow is the recommended approach to utilize when capturing payments.

  • Partial Deferred Captures for Multi-item Orders Shipped via Split Shipments - In this case, if the merchant typically charges its customers partial amounts based on the value of the items in the split shipment. The value includes item price, and all applicable fees, taxes, and/or discounts.
  • Single Deferred Capture for Single-item, or Multi-item Orders - In this case, if the merchant typically charges its customers the full order value after all items in the order have been shipped.
  • Single Immediate Capture for Single-item, or Multi-item Orders - In this case, if the merchant typically charges its customers the full order value at the time of successful order placement. Please refer to the Immediate Payment Flow section.

Order Placement, and Payment Capture

  • Merchant calls the Auth (/v2/payments/auth) endpoint to confirm the order.
    • Payment status ("APPROVED" or "DECLINED") is only known once Auth has been completed.
    • If the payment was approved by Afterpay, Merchant stores the id of the Payment, and the expires timestamp of the "AUTH_APPROVED" Payment Event, and presents the Consumer with an order confirmation/receipt page. The "AUTH_APPROVED" status indicates that,
      • Clearpay was able to successfully validate (and/or charge) the payment instrument (credit, or debit card) associated to the Consumer's Clearpay account.
      • Order information can now be viewed by authorized users of the Merchant team on the Clearpay portal.


Payment Capture Window and Expiry

In Production all payment capture requests must be completed within 13-days from the order placement date. Any remaining open-to-capture amounts will be automatically voided when the 13-day window elapses, and the customers' instalments will be updated to reflect the new (reduced) order total.

Merchants will not be able to capture any partial (or, full) order value that has been automatically voided.

Update Shipping Courier

As shipments occur for the order, send Clearpay each shipment’s tracking information with the courier API call.