> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.clearpay.co.uk/v-1/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.clearpay.co.uk/_mcp/server. # v1 ## Docs - [](https://developers.clearpay.co.uk/home.md) - [Getting Started with Clearpay Online](https://developers.clearpay.co.uk/v-1/getting-started-with-clearpay-online.md): - [Pre-Integration Checks](https://developers.clearpay.co.uk/v-1/shopify-pre-integration-checks.md): To offer Clearpay as a payment method, the below configurations are required. Please check your Shopify settings to ensure these prerequisites are met. - [Clearpay Gateway Configuration](https://developers.clearpay.co.uk/v-1/shopify-clearpay-gateway-configuration.md): To enable the Clearpay payment method on the Shopify Checkout page, please follow the below steps. - [Clearpay Product Page Display](https://developers.clearpay.co.uk/v-1/shopify-clearpay-product-page-display.md): The Clearpay logo and instalment amounts will appear on the Shopify Product Pages. Note: The display may differ depending on site-specific theme and layout. - [Frequently Asked Questions (FAQs)](https://developers.clearpay.co.uk/v-1/shopify-frequently-asked-questions.md): This section outlines the Frequently Asked Questions (FAQs) related to the Shopify-Clearpay integration. - [Pre-Integration Checks](https://developers.clearpay.co.uk/v-1/woocommerce-pre-integration-checks.md): Please check your WordPress Admin to ensure these prerequisites are met. - [Clearpay Gateway Installation](https://developers.clearpay.co.uk/v-1/woocommerce-clearpay-gateway-installation.md): Follow the below steps to install the Clearpay payment gateway on your WooCommerce website. - [Clearpay Gateway Configuration](https://developers.clearpay.co.uk/v-1/woocommerce-clearpay-gateway-configuration.md): Follow the below steps to configure the Clearpay payment gateway on your WooCommerce website. - [Frequently Asked Questions (FAQs)](https://developers.clearpay.co.uk/v-1/woocommerce-frequently-asked-questions.md): This section outlines the Frequently Asked Questions (FAQs) related to the Clearpay WooCommerce integration. - [Plugin Updates](https://developers.clearpay.co.uk/v-1/woocommerce-plugin-updates.md): To update the ‘Clearpay Gateway for WooCommerce’ plugin, please follow the below steps. - [Advanced Configuration](https://developers.clearpay.co.uk/v-1/woocommerce-advanced-configuration.md): This section outlines the advanced configuration options related to the Clearpay WooCommerce integration and site-specific customisation. - [Hooks](https://developers.clearpay.co.uk/v-1/woocommerce-advanced-configuration-hooks.md): This section outlines the WordPress hooks utilised by the Clearpay WooCommerce integration. - [Shortcodes](https://developers.clearpay.co.uk/v-1/woocommerce-advanced-configuration-shortcodes.md): This section outlines the shortcodes utilised by the Clearpay WooCommerce integration. - [Rocketspark Gateway Configuration](https://developers.clearpay.co.uk/v-1/rocketspark-gateway-configuration.md): - [Ecwid Gateway Configuration](https://developers.clearpay.co.uk/v-1/ecwid-gateway-configuration.md): - [Brand Assets](https://developers.clearpay.co.uk/v-1/brand-assets.md): This page contains a link to all Clearpay's logos, buttons, and banners for branding and marketing purposes. - [API Environments](https://developers.clearpay.co.uk/v-1/api-environments.md): - [Direct Payment Flow](https://developers.clearpay.co.uk/v-1/direct-payment-flow.md): - [REST](https://developers.clearpay.co.uk/v-1/rest.md): - [HTTPS](https://developers.clearpay.co.uk/v-1/https.md): - [Request Headers](https://developers.clearpay.co.uk/v-1/request-headers.md): - [User-Agent Header](https://developers.clearpay.co.uk/v-1/user-agent-header.md): - [Dates](https://developers.clearpay.co.uk/v-1/dates.md): - [Pagination](https://developers.clearpay.co.uk/v-1/pagination.md): - [Authentication](https://developers.clearpay.co.uk/v-1/authentication.md): - [Idempotent Requests](https://developers.clearpay.co.uk/v-1/idempotent-requests.md): - [Timeouts](https://developers.clearpay.co.uk/v-1/timeouts.md): - [Contact object](https://developers.clearpay.co.uk/v-1/contact-object.md): - [Consumer object](https://developers.clearpay.co.uk/v-1/consumer-object.md): - [Discount object](https://developers.clearpay.co.uk/v-1/discount-object.md): - [Item object](https://developers.clearpay.co.uk/v-1/item-object.md): - [Money object](https://developers.clearpay.co.uk/v-1/money-object.md): - [Order Details object](https://developers.clearpay.co.uk/v-1/order-details-object.md): - [Payment object](https://developers.clearpay.co.uk/v-1/payment-object.md): - [Refund object](https://developers.clearpay.co.uk/v-1/refund-object.md): - [Shipping Courier object](https://developers.clearpay.co.uk/v-1/shipping-courier-object.md): - [API Simulator](https://developers.clearpay.co.uk/api-simulator.md): - [JavaScript afterpay.js](https://developers.clearpay.co.uk/javascript-afterpayjs.md): - [Errors](https://developers.clearpay.co.uk/v-1/common-errors.md): - [GET Errors](https://developers.clearpay.co.uk/v-1/get-errors.md): - [PUT/POST Errors](https://developers.clearpay.co.uk/v-1/put-post-errors.md): ## API Docs - Online API > Service Status [Ping](https://developers.clearpay.co.uk/api-reference/ping.md) - Online API > Configuration [Get Configuration](https://developers.clearpay.co.uk/api-reference/get-configuration.md) - Online API > Orders [Create Order](https://developers.clearpay.co.uk/v-1/api-reference/create-order.md) - Online API > Orders [Get Order](https://developers.clearpay.co.uk/v-1/api-reference/get-order.md) - Online API > Payments [Capture Payment](https://developers.clearpay.co.uk/deferred-payment-flow/capture-payment.md) - Online API > Payments [Update Shipping Courier](https://developers.clearpay.co.uk/api-reference/update-shipping-courier.md) - Online API > Payments [Get Payment By Order ID](https://developers.clearpay.co.uk/api-reference/get-payment-by-order-id.md) - Online API > Payments [Get Payment By Token](https://developers.clearpay.co.uk/api-reference/get-payment-by-token.md) - Online API > Payments [List Payments](https://developers.clearpay.co.uk/api-reference/list-payments.md) - Online API > Payments [Create Refund](https://developers.clearpay.co.uk/api-reference/create-refund.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.clearpay.co.uk/v-1/openapi.json) - [OpenAPI YAML](https://developers.clearpay.co.uk/v-1/openapi.yaml)