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 Headers
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
      • Contact object
      • Consumer object
      • Discount object
      • Item object
      • Money object
      • Order Details object
      • Payment object
      • Refund object
      • Shipping Courier object
    • API Simulator
    • JavaScript afterpay.js
    • Errors
LogoLogo
On this page
  • Attributes
  • 422 Errors
  • Example Money object
Online APIModels

Money object

Was this page helpful?
Previous

Order Details object

Next
Built with

Attributes

AttributeTypeDescription
amountstring requiredThe amount is a string representation of a decimal number, rounded to 2 decimal places.
currencystring requiredThe currency in ISO 4217 format. Only “GBP” is supported.

422 Errors

Where a Money object is included in an API request, it will be validated according to the specification above. Invalid Money objects will trigger a 422 Unprocessable Entity response. The following is a list of common examples.

ExampleerrorCodemessage
amount is omitted or nullinvalid_object{Money object}.amount Amount field required
amount is less than or equal to 0invalid_objectamount must be greater than 0.00
amount has more than 2 decimal placesinvalid_objectamount. must be a valid ISO 4217 format value
amount is not a decimal number, for example: “free”, “1,000”, “$2” or an empty stringinvalid_objectThe object provided is not valid
currency is omitted or nullinvalid_object{Money object}.currency Currency field required
currency is not a valid currency code, not all uppercase or an empty stringinvalid_object{Money object}.currency Currency not supported for this merchant
currency is supported by Afterpay, but not valid for the Merchant accountunsupported_currencyAn error occurred

Example Money object

UK
1{
2 "amount": "29.99",
3 "currency": "GBP"
4}