For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Online API
    • API Environments
    • Direct Payment Flow
    • REST
    • HTTPS
      • Request Header Overview
      • User-Agent Request Header
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
    • API Simulator
  • Models
    • Introduction
    • Contact Object
    • Consumer Object
    • Discount Object
    • Item Object
    • Money Object
    • Order Details Object
    • Payment Object
    • Refund Object
    • Shipping Courier Object
  • Service Status
    • GETPing
  • Configuration
    • GETGet Configuration
  • Orders
    • Introduction
    • GETGet Order
    • POSTCreate Order
  • Javascript afterpay.js
    • Information
    • Redirect Method
  • Payments
    • Introduction
    • POSTCapture Payment
    • PUTUpdate Shipping Courier
    • GETGet Payment By Order ID
    • GETGet Payment By Token
    • GETList Payment(s)
    • POSTCreate Refund
    • PUTUpdate Payment by Order ID
    • POSTReverse Payment By Token
  • Errors
    • Introduction
    • Get Errors
    • Put/Post Errors
  • Reference
LogoLogo
Online APIRequest Headers

User-Agent Header

User-Agent header must be supplied with all Merchant API requests prior to placing any live transactions.

For example:

  • MyAfterpayModule/1.0.0 (E-Commerce Platform Name/1.0.0; PHP/7.0.0; Merchant/60032000) https://merchant.example.com
DescriptionExample Data AboveOther Merchant Examples
Afterpay PluginMyAfterpayModule/1.0.0Custom Plugin/1.0
Shopify Plugin/3.5.1
AfterpayCartridge/1.0
AfterpayExtension/2.9
PlatformE-Commerce Platform Name/1.0.0Websphere Commerce/8.1
Commerce Cloud/1.1
Magento/2.3.0
System InformationPHP/7.0.0PHP/7.2.18
Ruby/2.5.3
Java/8.3
Merchant Website URLhttps://merchant.example.comhttp://www.merchantwebsite.com
Was this page helpful?
Previous

Dates

Next
Built with