> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.clearpay.co.uk/v-2/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.clearpay.co.uk/_mcp/server. # API Reference ## Docs - [Clearpay API Introduction](https://developers.clearpay.co.uk/v-2/api-introduction.md): Introduction to the Clearpay API, including environments, authentication, error handling, and best practices for integration. - [Request Headers](https://developers.clearpay.co.uk/v-2/request-headers.md): - [User-Agent Header](https://developers.clearpay.co.uk/v-2/user-agent-header-1.md): What is a User-Agent and why do I need to have one? - [Authentication](https://developers.clearpay.co.uk/v-2/authentication.md): - [Errors](https://developers.clearpay.co.uk/v-2/common-errors.md): - [Data requirements for select verticals](https://developers.clearpay.co.uk/v-2/data-requirements-for-select-verticals.md): - [Contact object](https://developers.clearpay.co.uk/v-2/contact-object.md): - [Consumer object](https://developers.clearpay.co.uk/v-2/consumer-object.md): - [Discount object](https://developers.clearpay.co.uk/v-2/discount-object.md): - [Item object](https://developers.clearpay.co.uk/v-2/item-object.md): - [Money object](https://developers.clearpay.co.uk/v-2/money-object.md): - [Order Details object](https://developers.clearpay.co.uk/v-2/order-details-object.md): - [Payment object](https://developers.clearpay.co.uk/v-2/payment-object.md): - [Payment Event object](https://developers.clearpay.co.uk/v-2/payment-event-object.md): - [Refund object](https://developers.clearpay.co.uk/v-2/refund-object.md): - [Shipping Courier object](https://developers.clearpay.co.uk/v-2/shipping-courier-object.md): - [Shipping Options object](https://developers.clearpay.co.uk/v-2/shipping-options-object.md): - [Express Checkout Payload (Create Checkout)](https://developers.clearpay.co.uk/v-2/express-checkout-payload-create-checkout.md): - [Immediate Payment Flow](https://developers.clearpay.co.uk/v-2/immediate-payment-flow.md): - [Express Checkout Payload (Capture Full Payment)](https://developers.clearpay.co.uk/v-2/express-checkout-payload-capture-full-payment.md): - [Deferred Payment Flow](https://developers.clearpay.co.uk/v-2/deferred-payment-flow.md): - [Express Checkout Payload (Auth)](https://developers.clearpay.co.uk/v-2/express-checkout-payload-auth.md): - [Popup Method](https://developers.clearpay.co.uk/v-2/popup-method.md): - [Redirect Method](https://developers.clearpay.co.uk/v-2/redirect-method.md): - [Authorise Recurring Payment (Deferred Capture)](https://developers.clearpay.co.uk/v-2/authorise-recurring-payment-deferred-capture.md): - [Cancel Billing Agreement](https://developers.clearpay.co.uk/v-2/cancel-billing-agreement.md): - [Create Billing Agreement](https://developers.clearpay.co.uk/v-2/create-billing-agreement.md): This endpoint creates an approved billing agreement, returning a billing agreement ID for recurring payments. - [Create Recurring Payment (Immediate Capture)](https://developers.clearpay.co.uk/v-2/create-recurring-payment-immediate-capture.md): - [Get Billing Agreement](https://developers.clearpay.co.uk/v-2/get-billing-agreement.md): - [Setup Billing Agreement Approval](https://developers.clearpay.co.uk/v-2/setup-billing-agreement-approval.md): - [How to Integrate](https://developers.clearpay.co.uk/v-2/how-to-integrate.md): - [Express Checkout Payload (Create Checkout)](https://developers.clearpay.co.uk/v-2/express-checkout-payload-create-checkout-2.md): - [Express Checkout Payload (Capture Full Payment)](https://developers.clearpay.co.uk/v-2/express-checkout-payload-capture-full-payment-2.md): - [Express Checkout Payload (Auth)](https://developers.clearpay.co.uk/v-2/express-checkout-payload-auth-2.md): - [Adding the Express Checkout Button](https://developers.clearpay.co.uk/v-2/adding-the-express-checkout-button-2.md): You must show a Clearpay checkout button on your cart and/or product pages to enable Express Checkout. When clicked, the Clearpay checkout button will start the checkout process in a popup flow (the redirect flow can optionally be used with Deferred Shipping). - [Integrated Shipping](https://developers.clearpay.co.uk/v-2/integrated-shipping-2.md): - [Checkout Widget](https://developers.clearpay.co.uk/v-2/checkout-widget-2.md): - [Express Checkout Overview](https://developers.clearpay.co.uk/v-2/what-is-express-checkout.md): - [Security](https://developers.clearpay.co.uk/v-2/security.md): ## API Docs - Online API > Service Status [Ping](https://developers.clearpay.co.uk/v-2/api-reference/ping.md) - Online API > Configuration [Get Configuration](https://developers.clearpay.co.uk/v-2/api-reference/get-configuration.md) - Online API > Checkouts [Create Checkout](https://developers.clearpay.co.uk/v-2/api-reference/create-checkout.md) - Online API > Checkouts [Get Checkout](https://developers.clearpay.co.uk/v-2/api-reference/get-checkout.md) - Online API > Immediate Payment Flow [Capture Full Payment](https://developers.clearpay.co.uk/v-2/immediate-payment-flow/capture-full-payment.md) - Online API > Deferred Payment Flow [Auth](https://developers.clearpay.co.uk/v-2/deferred-payment-flow/auth.md) - Online API > Deferred Payment Flow [Capture Payment](https://developers.clearpay.co.uk/v-2/deferred-payment-flow/capture-payment.md) - Online API > Deferred Payment Flow [Void](https://developers.clearpay.co.uk/v-2/deferred-payment-flow/void.md) - Online API > Order Management [Update Shipping Courier](https://developers.clearpay.co.uk/v-2/api-reference/update-shipping-courier.md) - Online API > Order Management [Get Payment By Order ID](https://developers.clearpay.co.uk/v-2/api-reference/get-payment-by-order-id.md) - Online API > Order Management [Get Payment By Token](https://developers.clearpay.co.uk/v-2/api-reference/get-payment-by-token.md) - Online API > Order Management [List Payments](https://developers.clearpay.co.uk/v-2/api-reference/list-payments.md) - Online API > Order Management [Create Refund](https://developers.clearpay.co.uk/v-2/api-reference/create-refund.md) - Online API > Order Management [Update Payment by Order ID](https://developers.clearpay.co.uk/v-2/api-reference/update-payment-by-order-id.md) - Online API > Order Management [Reverse Payment By Token](https://developers.clearpay.co.uk/v-2/api-reference/reverse-payment-by-token.md) - Online API > How to Integrate [Create Checkout [Express Checkout]](https://developers.clearpay.co.uk/v-2/how-to-integrate/create-checkout-express-checkout.md) - Online API > How to Integrate [Capture Full Payment [Express Checkout]](https://developers.clearpay.co.uk/v-2/how-to-integrate/capture-full-payment-express-checkout-2.md) - Online API > How to Integrate [Auth [Express Checkout]](https://developers.clearpay.co.uk/v-2/how-to-integrate/auth-express-checkout-2.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.clearpay.co.uk/openapi.json) - [OpenAPI YAML](https://developers.clearpay.co.uk/openapi.yaml)