The Clearpay Online Developer Hub

Welcome to the Clearpay Online developer hub. You'll find comprehensive guides and documentation to help you start working with Clearpay Online as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

API Calls & Payment Flows

The Clearpay v2 API offers merchants a choice of two different payment flows. The v1 API uses the Direct Capture flow.

📘

Customers repayment commences once the order has been confirmed.

  • For Immediate Capture repayment commences on Capture.
  • For Deferred Payment repayment commences on Auth.

1. Direct Capture (Immediate Payment Flow)

This flow allows merchants to capture the full payment amount at the time of order.
Read more about this payment flow in our API v2 docs

👍

All platforms support the Direct Capture payment flow

2. Auth and Capture (Deferred Payment Flow)

This flow allows merchants to capture incremental amounts as items are shipped. Clearpay will settle funds when payments are captured by the merchant. If it is later determined that one or more shipments cannot be fulfilled, the un-captured remainder of the payment auth can be voided. This is similar to the Auth and Capture process of an order paid with a credit card.
Read about this payment flow in our API v2 docs.

🚧

Supported Platforms for Auth and Capture Payment Flow

📘

Try out the Postman Collection!

The quickest way to start testing the API is to use our Postman request collection

Updated 7 months ago

API Calls & Payment Flows


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.