> This page is for version v2 (default).
> For other versions, use one of these documentation indexes:
> - v2 (default): https://developers-beta.clearpay.co.uk/v-2/llms.txt
> - v1: https://developers-beta.clearpay.co.uk/v-1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers-beta.clearpay.co.uk/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers-beta.clearpay.co.uk/_mcp/server.

# API Quickstart

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

1. **Get Sandbox Credentials**
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.
3. **Choose Your Preferred Payment Flow**
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)](/selecting-a-payment-flow) and [using deferred payment flow](/using-deferred-payment).
5. **Start Testing**
Download our postman collection or use our API explorer to start testing the Clearpay calls before integrating with your systems.\
\
 [UK Sandbox Environments](/sandbox-testing)
7. **[**It's time to Launch 🚀**](/testing-your-clearpay-integration)**
Complete certification testing and get your live credentials

### **Not a Developer?**

Use our [pre-built plugins](/platforms-quickstart) to quickly add Clearpay to your store.

### **No Clearpay account?**

Sign up for a Merchant account [UK,](https://get.clearpay.co.uk/)

> **Direct API - Supported Countries**
>
> The Clearpay Online API is available for merchants with a store address in:
>
> * 🇬🇧⠀United Kingdom
>
> For countries listed below see the [Afterpay Docs](https://developers.afterpay.com/afterpay-online/reference/api-environments):
>
> * 🇨🇦⠀Canada
> * 🇦🇺⠀Australia
> * 🇳🇿⠀New Zealand
>
> Finally, there is [Cash App Afterpay](https://developers.cash.app/docs/merchant/welcome/getting-started) available in:
>
> * 🇺🇸⠀United States