> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.afterpay.com/afterpay-online-developer/v-1/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.afterpay.com/_mcp/server. # v1 ## Docs - [](https://developers.afterpay.com/afterpay-online-developer/home.md) - [Getting Started with Afterpay Online](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/welcome/getting-started-with-afterpay-online.md) - [Pre-Integration Checks](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/shopify-au-nz-us/pre-integration-checks.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/shopify-au-nz-us/afterpay-gateway-configuration.md) - [Afterpay Product Page Display](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/shopify-au-nz-us/afterpay-product-page-display.md) - [Frequently Asked Questions](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/shopify-au-nz-us/frequently-asked-questions.md) - [Pre-Integration Checks](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/woocommerce-au-nz-us/pre-integration-checks.md) - [Afterpay Gateway Installation](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/woocommerce-au-nz-us/afterpay-gateway-installation.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/woocommerce-au-nz-us/afterpay-gateway-configuration.md) - [Frequently Asked Questions](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/woocommerce-au-nz-us/frequently-asked-questions.md) - [Plugin Updates](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/woocommerce-au-nz-us/plugin-updates.md) - [Hooks](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/woocommerce-au-nz-us/advanced-configuration/hooks.md) - [Shortcodes](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/woocommerce-au-nz-us/advanced-configuration/shortcodes.md) - [Pre-Integration Checks](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/bigcommerce-au-nz-us/pre-integration-checks.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/bigcommerce-au-nz-us/afterpay-gateway-configuration.md) - [Pre-Integration Checks](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/neto-au-nz/pre-integration-checks.md) - [neto-afterpay-gateway-configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/neto-au-nz/neto-afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/lightspeed-au/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/ecorner-au-nz/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/ecwid-au-nz-us/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/enflexion-au/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/rocketspark-au-nz-us/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/spiffy-stores-au/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/kynect-au-nz/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/website-world-au-nz-us/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/have-a-look-au/afterpay-gateway-configuration.md) - [Afterpay Gateway Configuration](https://developers.afterpay.com/afterpay-online-developer/v-1/guides/storbie-au-nz/afterpay-gateway-configuration.md) - [API Environments](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/api-environments.md) - [Direct Payment Flow](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/direct-payment-flow.md) - [REST](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/rest.md) - [HTTPS](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/https.md) - [Request Header Overview](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/request-headers/request-header-overview.md) - [User-Agent Request Header](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/request-headers/user-agent-request-header.md) - [Dates](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/dates.md) - [Pagination](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/pagination.md) - [Authentication](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/authentication.md) - [Idempotent Requests](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/idempotent-requests.md) - [Timeouts](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/timeouts.md) - [API Simulator](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/online-api/api-simulator.md) - [Introduction](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/introduction.md) - [Contact Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/contact-object.md) - [Consumer Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/consumer-object.md) - [Discount Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/discount-object.md) - [Item Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/item-object.md) - [Money Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/money-object.md) - [Order Details Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/order-details-object.md) - [Payment Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/payment-object.md) - [Refund Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/refund-object.md) - [Shipping Courier Object](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/models/shipping-courier-object.md) - [Introduction](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/orders/introduction.md) - [Information](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/javascript-afterpay-js/information.md) - [Redirect Method](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/javascript-afterpay-js/redirect-method.md) - [Introduction](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/payments/introduction.md) - [Introduction](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/errors/introduction.md) - [Get Errors](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/errors/get-errors.md) - [Put/Post Errors](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/errors/put-post-errors.md) ## API Docs - Service Status [Ping](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/service-status/ping.md) - Configuration [Get Configuration](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/configuration/get-configuration.md) - Orders [Get Order](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/orders/get-order.md) - Orders [Create Order](https://developers.afterpay.com/afterpay-online-developer/v-1/api-reference/orders/create-order.md) - Payments [Capture Payment](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/capture-payment.md) - Payments [Update Shipping Courier](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/update-shipping-courier.md) - Payments [Get Payment By Order ID](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/get-payment-by-order-id.md) - Payments [Get Payment By Token](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/get-payment-by-token.md) - Payments [List Payment(s)](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/list-payments.md) - Payments [Create Refund](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/create-refund.md) - Payments [Update Payment by Order ID](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/update-payment-by-order-id.md) - Payments [Reverse Payment By Token](https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/reverse-payment-by-token.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.afterpay.com/afterpay-online-developer/v-1/openapi.json) - [OpenAPI YAML](https://developers.afterpay.com/afterpay-online-developer/v-1/openapi.yaml)