2b. Deferred Capture

👍

Supported Platforms for Auth and Capture Payment Flow

• Direct API (v2 API)
• Salesforce Commerce Cloud
• Adobe Commerce (Magento)
• BigCommerce

This flow completes the payment approval and starts the customer's payment plan, but does not initiate the settlement process. This flow allows settlement of merchant funds to be deferred until order fulfilment can be confirmed.

Authorise the payment

• POST /v2/payments/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 customer’s payment instrument details are entered incorrectly), the merchant presents an appropriate message to the customer at the checkout.

Capture the payment

• POST /v2/payments/orderId/capture

Capture a payment against the Authorization - POST /v2/payments/{id}/capture
If you are able to fulfill 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 authorisation, provided that the sum of captures does not exceed the authorised amount. The capture call is idempotent if a unique requestId (GUID) is provided with the request.

This flow completes the payment approval, starts the customer'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

Here are a few examples of when the Deferred Payment flow is the recommended approach to use 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.

🚧

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' installments 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.

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

Update Shipping Courier

• PUT /v2/payments/{orderId}/courier

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