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

# Postman Collection

The following steps outline the steps to install Postman, configure your sandbox credentials and start testing the Clearpay API.

\


## What is Postman?

Postman is a free-to-download tool for making HTTP requests.

## Download Postman

1. Visit [www.getpostman.com](http://www.getpostman.com/downloads) and download the version of Postman required for your platform.

2. Install Postman.

   \


## Import the Clearpay Collection

1. Open Postman.

2. Click Import.

3. Import the Clearpay Postman Collection for *your* region.

**`Clearpay Postman Collection`**

```text Clearpay Postman Collection
https://static-us.afterpay.com/api/sandbox/Clearpay_Online_API_v2.postman_collection.json
```

![](https://static-us.afterpay.com/docs/assets/screenshots/postman/postman-import-button.png)![](https://static-us.afterpay.com/docs/assets/screenshots/postman/postman-import-from-link.png)

## Create a Postman Test Environment

To access and utilize environment variables, you will need to configure a new [Postman environment](https://learning.postman.com/docs/postman/variables-and-environments/managing-environments/).

1. Click on the gear icon in the top-right corner.

![](https://static-us.afterpay.com/docs/assets/screenshots/postman/postman-gear-icon.png)

2. Click **Add** on the **MANAGE ENVIRONMENTS** modal that appears.

\


3. Name the environment.

![](file:docs/assets/images/e7bf5af-Postman1.png "Postman1.png")

4. Click **Add** to save the environment, then close the window.

   \


5. Use this environment by selecting **Clearpay Online UK V2** from the dropdown list.

![](https://static-us.afterpay.com/docs/assets/screenshots/postman/postman-select-env.png)\


## Add Your Merchant ID and Secret Key

1. Click on the 3 dots `...` next to the collection name and click **Edit**.

![](https://static-us.afterpay.com/docs/assets/screenshots/postman/postman-configure-auth.png)

2. Click the Authorization Tab.

3. Enter your Merchant ID in the **Username** field.

4. Enter your Secret Key in the **Password** field.

5. Click Update.