Afterpay Developer Docs

API Quickstart

What do I need to start building a direct API Integration?

Use our API to integrate Afterpay with any system or custom platform.

  1. Get Sandbox Credentials
  2. Speak to your Afterpay account manager to coordinate the receipt of your Sandbox credentials. These will enable you to commence the development and testing of your connection to our Sandbox environment.

  3. Choose Your Preferred Payment Flow
  4. Afterpay supports the ability to capture funds at the time of order or at the time of shipping.

  5. Start Testing
  6. Download our postman collection or use our API explorer to start testing the Afterpay calls before integrating with your systems

  7. It's time to Launch 🚀
  8. Complete certification testing and get your live credentials

Not a Developer?

Use our pre-built plugins to quickly add Afterpay to your store.

No Afterpay account?

Sign up for a Merchant account at get.afterpay.com

👍

Direct API - Supported Countries

The Afterpay API is available for merchants with a store address in these countries:

  • 🇺🇸⠀United States
  • 🇨🇦⠀Canada
  • 🇦🇺⠀Australia
  • 🇳🇿⠀New Zealand
  • 🇬🇧⠀UK - See Clearpay Docs

Updated 4 months ago


API Quickstart


What do I need to start building a direct API Integration?

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.