API Reference

Get Configuration

get
https://global-api-sandbox.afterpay.com/v2/configuration

This endpoint is used to retrieve the merchant's applicable payment limits.

A request to Create Checkout may be rejected if the order amount is not between the minimumAmount and maximumAmount (inclusive).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Note

Afterpay merchant configuration does not change frequently. For this reason, the configuration response will include Cache-Control headers in order to minimise network round trips when using a modern HTTP client.

Successful Response (200)

Returns a configuration object containing the following attributes.

AttributeTypeDescription
minimumAmountMoneyMinimum order amount.

Note: This attribute may not be included if the Merchant account has no minimum order amount.
maximumAmountMoneyMaximum order amount.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20

Errors

See GET Errors.

Headers
string
required
Defaults to Readme.io API Simulator
string
Defaults to application/json

Updated almost 5 years ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated almost 5 years ago