For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Skip to navigation

Online API

HTTPS

This page is for Afterpay Online Developer, version v1. For other versions, use one of these documentation indexes: - Main (default): https://developers.afterpay.com/afterpay-online-developer/main/llms.txt - v1: https://developers.afterpay.com/afterpay-online-developer/v-1/llms.txt - Chinese: https://developers.afterpay.com/afterpay-online-developer/chinese/llms.txt

The Afterpay Online API requires all communications to be secured using TLS 1.2 or greater.

Was this page helpful?

Home Guides API Reference

Online API
Models
Service Status
- GETPing
Configuration
- GETGet Configuration
Orders
Javascript afterpay.js
- Information
- Redirect Method
Payments
Errors
Reference

API Environments
Direct Payment Flow
REST
HTTPS
Request Header Overview
User-Agent Request Header
Dates
Pagination
Authentication
Idempotent Requests
Timeouts
API Simulator
Introduction
Contact Object
Consumer Object
Discount Object
Item Object
Money Object
Order Details Object
Payment Object
Refund Object
Shipping Courier Object
Ping
Get Configuration
Introduction
Get Order
Create Order
Information
Redirect Method
Introduction
Capture Payment
Update Shipping Courier
Get Payment By Order ID
Get Payment By Token
List Payment(s)
Create Refund
Update Payment by Order ID
Reverse Payment By Token
Introduction
Get Errors
Put/Post Errors
Capture Payment
Create Refund
Get Payment By Order ID
Get Payment By Token
List Payments
Reverse Payment
Update Courier
Update Payment
Create Order
Get Order
Get Configuration
Ping

Afterpay Online Developer
Afterpay Partner API
Afterpay Button Documentation

Main
v1
Chinese