GuidesAPI Reference

API Quickstart

What do I need to start building a direct API Integration?

Use our API to integrate Clearpay with any system or custom platform.

  1. Get Sandbox Credentials

    2. Speak to your Clearpay account manager to coordinate the receipt of your Sandbox credentials. These will enable you to commence the development and testing of your connection to our Sandbox environment.

  2. Choose Your Preferred Payment Flow

    3. Clearpay can either take payment as soon as the purchase is completed on your site, or defer the payment until a later date, depending on your business model. Review the documentation for more details on using direct capture (immediate payment flow) and using deferred payment flow.

  4. Start Testing

    5. Download our postman collection or use our API explorer to start testing the Clearpay calls before integrating with your systems.

    UK Sandbox Environments

  5. It's time to Launch 🚀

    6. Complete certification testing and get your live credentials

Not a Developer?

Use our pre-built plugins to quickly add Clearpay to your store.

No Clearpay account?

Sign up for a Merchant account UK,

👍

Direct API - Supported Countries

The Clearpay Online API is available for merchants with a store address in these countries;

  • 🇬🇧⠀United Kingdom

For countries listed below please see the Afterpay Docs;

  • 🇺🇸⠀United States
  • 🇨🇦⠀Canada
  • 🇦🇺⠀Australia
  • 🇳🇿⠀New Zealand

Updated about 1 month ago