> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers-beta.afterpay.com/afterpay-online-developer/main/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers-beta.afterpay.com/_mcp/server.

# Main

## Docs

- [](https://developers-beta.afterpay.com/afterpay-online-developer/main/home.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/welcome/getting-started/introduction.md)
- [In-store startup](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/welcome/getting-started/in-store-startup.md)
- [Cross Border Trade](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/welcome/getting-started/cross-border-trade.md)
- [Support](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/welcome/getting-started/support.md)
- [Business Hub](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/welcome/business-hub.md)
- [Settlement Reports](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/welcome/business-hub/settlement-reports.md)
- [Platforms Quickstart](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/platforms-quickstart.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/adobe-commerce-magento/introduction.md)
- [Getting Started](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/adobe-commerce-magento/getting-started.md)
- [Install Extension](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/adobe-commerce-magento/install-extension.md)
- [Configure Extension](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/adobe-commerce-magento/configure-extension.md)
- [Update Extension](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/adobe-commerce-magento/update-extension.md)
- [Adyen](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/adyen.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/big-commerce/introduction.md)
- [Getting Started](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/big-commerce/getting-started.md)
- [Add Payment Option](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/big-commerce/add-payment-option.md)
- [Afterpay Site Messaging](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/big-commerce/afterpay-site-messaging.md)
- [Ecwid](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/ecwid.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/presta-shop/introduction.md)
- [Migrating to the new Afterpay module](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/presta-shop/migrating-to-the-new-afterpay-module.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/salesforce-commerce-cloud/introduction.md)
- [Getting Started](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/salesforce-commerce-cloud/getting-started.md)
- [Install Cartridge and Import Metadata](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/salesforce-commerce-cloud/install-cartridge-and-import-metadata.md)
- [Configure Cartridge](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/salesforce-commerce-cloud/configure-cartridge.md)
- [SiteGenesis Code Changes](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/salesforce-commerce-cloud/site-genesis-code-changes.md)
- [SFRA Files Change Review](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/salesforce-commerce-cloud/sfra-files-change-review.md)
- [Shopify](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify.md)
- [Getting Started](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/getting-started.md)
- [Add Afterpay at Checkout](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/add-afterpay-at-checkout.md)
- [Add Cash App Pay at Checkout](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/add-cash-app-pay-at-checkout.md)
- [Afterpay On-Site Messaging App](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/afterpay-on-site-messaging-app.md)
- [Manually Add Afterpay Site Messaging to Theme](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/manually-add-afterpay-site-messaging-to-theme.md)
- [Shopify Manual Capture](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/shopify-manual-capture.md)
- [Shopify Order Reconciliation](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/shopify-order-reconciliation.md)
- [Shopify Test Mode](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/shopify-test-mode.md)
- [Add an Afterpay Banner to Shopify](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/add-an-afterpay-banner-to-shopify.md)
- [Hide Payment Methods at Checkout](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/hide-payment-methods-at-checkout.md)
- [FAQ](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/shopify/faq.md)
- [Stripe](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/stripe.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/woo-commerce/introduction.md)
- [Getting Started](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/woo-commerce/getting-started.md)
- [Install Plugin](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/woo-commerce/install-plugin.md)
- [Configure Plugin](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/woo-commerce/configure-plugin.md)
- [Update Plugin](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/woo-commerce/update-plugin.md)
- [Advanced Configuration](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/woo-commerce/advanced-configuration.md)
- [Currency Conversion](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/woo-commerce/currency-conversion.md)
- [FAQ](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/woo-commerce/faq.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/introduction.md)
- [Bolt](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/bolt.md)
- [Ecorner](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/ecorner.md)
- [Enflexion](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/enflexion.md)
- [Havealook](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/havealook.md)
- [Kynect](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/kynect.md)
- [Lightspeed](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/lightspeed.md)
- [Nimbo](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/nimbo.md)
- [Oncord](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/oncord.md)
- [Opencart](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/opencart.md)
- [Rocketspark](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/rocketspark.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/solidus/introduction.md)
- [Configure Afterpay](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/solidus/configure-afterpay.md)
- [How to apply a Promotion Code or Voucher](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/solidus/how-to-apply-a-promotion-code-or-voucher.md)
- [How to refund a customer](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/solidus/how-to-refund-a-customer.md)
- [Spiffy Stores](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/spiffy-stores.md)
- [Storbie](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/storbie.md)
- [Straightsell](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/straightsell.md)
- [Website World](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/website-world.md)
- [Web Ninja](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/web-ninja.md)
- [Wix](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/platforms/other-platforms/wix.md)
- [Getting Started](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/afterpay-messaging/getting-started.md)
- [Implementation](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/afterpay-messaging/implementation.md)
- [Migration](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/afterpay-messaging/migration.md)
- [Legacy Messaging Products](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/afterpay-messaging/legacy-messaging-products.md)
- [Launch Afterpay Info Modal Anywhere](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/afterpay-messaging/launch-afterpay-info-modal-anywhere.md)
- [API Quickstart](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/api-quickstart.md)
- [Create a Checkout](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/api-quickstart/create-a-checkout.md)
- [Immediate Capture](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/api-quickstart/immediate-capture.md)
- [Deferred Capture](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/api-quickstart/deferred-capture.md)
- [Create a Refund](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/api-quickstart/create-a-refund.md)
- [Test Environments](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/test-environments.md)
- [Certification](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/certification.md)
- [Disputes](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/disputes.md)
- [Integrate with the Disputes API](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/disputes/integrate-with-the-disputes-api.md)
- [Manage Disputes in the Business Hub](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/disputes/manage-disputes-in-the-business-hub.md)
- [Express Checkout](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/additional-features/express-checkout.md)
- [Integrated Shipping](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/additional-features/express-checkout/integrated-shipping.md)
- [Deferred Shipping](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/additional-features/express-checkout/deferred-shipping.md)
- [Reference Information](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/additional-features/express-checkout/reference-information.md)
- [Afterpay On File](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/additional-features/afterpay-on-file.md)
- [Checkout Widget](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/additional-features/checkout-widget.md)
- [Account Linking (Oauth)](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/additional-features/account-linking-oauth.md)
- [Upgrade from API v1 to v2](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/api-development/upgrade-from-api-v-1-to-v-2.md)
- [Shop Directory](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/marketing/shop-directory.md)
- [Brand Assets](https://developers-beta.afterpay.com/afterpay-online-developer/main/guides/marketing/brand-assets.md)
- [Introduction](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/introduction.md)
- [Request Headers](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/introduction/request-headers.md)
- [Authentication](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/introduction/authentication.md)
- [Errors](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/introduction/errors.md)
- [Data Requirements](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/introduction/data-requirements.md)
- [Checkout Request](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/checkouts/schemas/checkout-request.md)
- [Checkout Response](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/checkouts/schemas/checkout-response.md)
- [Merchant Limit](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/configuration/schemas/merchant-limit.md)
- [Configuration Mappings](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/configuration/schemas/configuration-mappings.md)
- [Dispute](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/schemas/dispute.md)
- [Meta](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/schemas/meta.md)
- [Evidence](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/schemas/evidence.md)
- [Authorize Payment](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/schemas/authorize-payment.md)
- [Capture Payment](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/schemas/capture-payment.md)
- [Enrichments](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/schemas/enrichments.md)
- [Capture Payment](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/capture-payment.md)
- [Consumer](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/consumer.md)
- [Consumer Offers](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/consumer-offers.md)
- [Contact](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/contact.md)
- [Create Refund](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/create-refund.md)
- [Discount](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/discount.md)
- [Interval](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/interval.md)
- [Item](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/item.md)
- [Money](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/money.md)
- [Offer](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/offer.md)
- [Offers Request](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/offers-request.md)
- [Offers Response](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/offers-response.md)
- [Order Details](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/order-details.md)
- [Payment Event](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/payment-event.md)
- [Payment](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/payment.md)
- [Payment (Auth)](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/payment-auth.md)
- [Payment Schedule](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/payment-schedule.md)
- [Refund](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/refund.md)
- [Shipping Courier](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/models/shipping-courier.md)

## API Docs

- Checkouts [Create Checkout](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/checkouts/create-checkout-1.md)
- Checkouts [Get Checkout](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/checkouts/get-checkout.md)
- Configuration [Get Configuration](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/configuration/get-configuration.md)
- Configuration [Get Configuration Mappings](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/configuration/get-configuration-mappings.md)
- Disputes [Retrieve Dispute](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/retrieve-dispute.md)
- Disputes [Receive Dispute](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/receive-dispute.md)
- Disputes [Respond to Dispute](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/respond-to-dispute.md)
- Disputes [Accept Dispute](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/accept-dispute.md)
- Disputes [Upload File](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/upload-file.md)
- Disputes [Retrieve file](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/disputes/retrieve-file.md)
- Grants [Create Grant Approval](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/grants/start-grant-approval.md)
- Grants [Create Grant](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/grants/create-grant.md)
- Grants [Retrieve Grant](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/grants/get-grant.md)
- Grants [Revoke Grant](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/grants/revoke-grant.md)
- Grants [Create Grant Alias](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/grants/alias-grant.md)
- Grants [Start Grant Link Flow](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/grants/start-billing-agreement-link.md)
- Grants [Grant status updated](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/grants/grant-status-updated.md)
- Orders [Create Order](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/orders/create-grant.md)
- Payments [List Payments](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/list-payments.md)
- Payments [Auth](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/auth.md)
- Payments [Capture Full Payment](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/capture-full-payment.md)
- Payments [Get Payment By Order ID](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/get-payment-by-order-id.md)
- Payments [Update Payment by Order ID](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/update-payment-by-order-id.md)
- Payments [Capture Payment](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/capture-payment.md)
- Payments [Update Shipping Courier](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/update-shipping-courier.md)
- Payments [Create Refund](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/create-refund.md)
- Payments [Void](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/void-payment.md)
- Payments [Get Payment By Token](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/get-payment-by-token.md)
- Payments [Reverse Payment By Token](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/payments/reverse-payment-by-token.md)
- Service Status [Ping](https://developers-beta.afterpay.com/afterpay-online-developer/main/api-reference/reference/service-status/ping.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developers-beta.afterpay.com/openapi.json)
- [OpenAPI YAML](https://developers-beta.afterpay.com/openapi.yaml)