> 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/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.clearpay.co.uk/_mcp/server. # v2 ## Docs - [](https://developers.clearpay.co.uk/v-2/home.md) - [Getting Started with Clearpay Online](https://developers.clearpay.co.uk/v-2/getting-started-with-clearpay-online.md): - [Getting Started](https://developers.clearpay.co.uk/v-2/what-is-clearpay.md): - [Support](https://developers.clearpay.co.uk/v-2/support.md): Get help with Clearpay integration and find answers to common questions - [In-Store Operations](https://developers.clearpay.co.uk/v-2/in-store-operations.md): Use Clearpay in your "bricks and mortar" stores as well as online - [Cross Border Trade](https://developers.clearpay.co.uk/v-2/cross-border-trade.md): Sell to customers in other countries - [Business Hub](https://developers.clearpay.co.uk/v-2/merchant-portal.md): Run your business or organisation quickly and efficiently from the UK Business Hub. - [Settlement Reports](https://developers.clearpay.co.uk/v-2/settlements.md) - [Platforms Quickstart](https://developers.clearpay.co.uk/v-2/platforms-quickstart.md): How can I add Clearpay to my store? - [Adobe Commerce (Magento 2)](https://developers.clearpay.co.uk/v-2/adobe-commerce.md): What are the requirements for the Clearpay Adobe Commerce Extension? - [Install Extension](https://developers.clearpay.co.uk/v-2/install-extension.md): How Can I Install and Enable the Adobe Commerce Extension? - [Configure Extension](https://developers.clearpay.co.uk/v-2/configure-extension.md): Basic Settings, Advanced Settings, Advanced Front End Settings and Express Checkout Settings. - [Update Extension](https://developers.clearpay.co.uk/v-2/update-extension.md): How can I update my Adobe Commerce Extension? - [Adyen](https://developers.clearpay.co.uk/v-2/using-adyen-with-clearpay.md): - [Ecwid](https://developers.clearpay.co.uk/v-2/ecwid-1.md): - [Shopify](https://developers.clearpay.co.uk/v-2/shopify-1.md): Get started integrating Clearpay with Shopify - [Add Clearpay at Checkout](https://developers.clearpay.co.uk/v-2/add-clearpay-at-checkout.md): With your Shopify integration, add Clearpay as a payment option at checkout. - [Clearpay On-Site Messaging App](https://developers.clearpay.co.uk/v-2/clearpay-on-site-messaging-app.md): - [Manually Add Clearpay Site Messaging to Theme](https://developers.clearpay.co.uk/v-2/manually-add-clearpay-site-messaging-to-theme.md): How can I add Clearpay Site Messaging to my Shopify product and cart pages? - [Shopify Manual Capture](https://developers.clearpay.co.uk/v-2/shopify-manual-capture-1.md): - [Shopify Order Reconciliation](https://developers.clearpay.co.uk/v-2/shopify-order-reconciliation.md): Reconcile Clearpay orders on Shopify and ensure all transactions are accounted for. - [Shopify Test Mode](https://developers.clearpay.co.uk/v-2/shopify-test-mode.md): - [Add a Clearpay Banner to Shopify](https://developers.clearpay.co.uk/v-2/add-a-clearpay-banner.md): Add a Clearpay banner to your Shopify page - [Hide Payment Methods at Checkout](https://developers.clearpay.co.uk/v-2/hide-payment-methods-at-checkout.md): Shopify Plus merchants can stop Clearpay being offered at the checkout for selected products. - [Shopify FAQ](https://developers.clearpay.co.uk/v-2/faq.md): Frequently asked questions on the Clearpay Shopify integration - [Stripe](https://developers.clearpay.co.uk/v-2/using-stripe-with-clearpay.md): - [Wix](https://developers.clearpay.co.uk/v-2/wix-1.md): - [Frequently asked questions](https://developers.clearpay.co.uk/v-2/frequently-asked-questions-1.md): - [WooCommerce](https://developers.clearpay.co.uk/v-2/woocommerce-1.md): - [Advanced configuration](https://developers.clearpay.co.uk/v-2/advanced-configuration-1.md): - [Frequently asked questions](https://developers.clearpay.co.uk/v-2/frequently-asked-questions.md): - [Currency Conversion](https://developers.clearpay.co.uk/v-2/currency-conversion.md): - [Configure plugin](https://developers.clearpay.co.uk/v-2/woo-comm-configure-plugin.md): How can I add Clearpay as a payment method and display Clearpay Site Messaging? - [Hooks](https://developers.clearpay.co.uk/v-2/woo-comm-hook.md): This section describes the WordPress hooks used by the Clearpay WooCommerce integration. - [Aero Commerce](https://developers.clearpay.co.uk/v-2/aerocommerce.md): - [Apexx](https://developers.clearpay.co.uk/v-2/processing-payments-with-apexx.md): - [BigCommerce](https://developers.clearpay.co.uk/v-2/bigcommerce-1.md): - [Cybersource](https://developers.clearpay.co.uk/v-2/processing-payments-with-cybersource.md): - [OpenCart](https://developers.clearpay.co.uk/v-2/opencart-1.md): - [PrestaShop](https://developers.clearpay.co.uk/v-2/prestashop-1.md): - [Rocketspark](https://developers.clearpay.co.uk/v-2/rocketspark-1.md): - [Salesforce Commerce Cloud](https://developers.clearpay.co.uk/v-2/salesforce-commerce-cloud-1.md): - [Thunes](https://developers.clearpay.co.uk/v-2/processing-payments-with-thunes.md): - [API Quickstart](https://developers.clearpay.co.uk/v-2/guides/api-development/api-quickstart.md): Get started with the Clearpay API - essential endpoints and basic integration flow - [Create a Checkout](https://developers.clearpay.co.uk/v-2/guides/api-development/api-quickstart/create-a-checkout.md): Learn how to create a Clearpay checkout and launch the customer payment flow - [Immediate Capture](https://developers.clearpay.co.uk/v-2/guides/api-development/api-quickstart/immediate-capture.md): Capture the full payment amount immediately after checkout completion - [Deferred Capture](https://developers.clearpay.co.uk/v-2/guides/api-development/api-quickstart/deferred-capture.md): Authorize payments upfront and capture funds when you're ready to fulfill orders - [Refunds](https://developers.clearpay.co.uk/v-2/guides/api-development/api-quickstart/create-a-refund.md): Process full and partial refunds for Clearpay payments - [Test Environments](https://developers.clearpay.co.uk/v-2/guides/api-development/test-environments.md): Test your Clearpay integration safely using the sandbox environment - [Certification Testing](https://developers.clearpay.co.uk/v-2/testing-your-clearpay-integration.md): - [Display the checkout widget](https://developers.clearpay.co.uk/v-2/the-clearpay-widget.md): - [Introduction to Express Checkout](https://developers.clearpay.co.uk/v-2/expresscheckout-1.md): Learn about Clearpay Express Checkout and how it reduces checkout steps for higher conversion - [Set up express checkout with integrated shipping](https://developers.clearpay.co.uk/v-2/ec-int-shipping.md): Learn how to implement Clearpay Express Checkout with integrated shipping options - [Set up express checkout with deferred shipping](https://developers.clearpay.co.uk/v-2/ec-deferred-shipping.md): Learn how to implement Clearpay Express Checkout with deferred shipping options - [Express checkout reference](https://developers.clearpay.co.uk/v-2/ec-reference-info.md): Technical reference information for Clearpay Express Checkout implementation - [Getting Started](https://developers.clearpay.co.uk/v-2/messaging-getting-started.md) - [Implementation](https://developers.clearpay.co.uk/v-2/messaging-implementation.md): How to implement on-site messaging - [Migration](https://developers.clearpay.co.uk/v-2/messaging-migration.md): - [Launch Clearpay Info Modal Anywhere](https://developers.clearpay.co.uk/v-2/launch-clearpay-info-modal-anywhere.md): Use JavaScript to enable any on-screen element to open the Clearpay information modal. - [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)