Get Configuration

GET

/v2/configuration

This endpoint is used to retrieve the merchant's applicable payment limits. A request to [Create Checkout](/afterpay-online-developer/api-reference/reference/checkouts/create-checkout-1) may be rejected if the order amount is not between the `minimumAmount` and `maximumAmount` (inclusive). 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. Get configuration should be called on a fixed schedule, preferably once per day. **Connection Timeouts** | Timeout | Time (Seconds) | |---------|----------------| | Open | 10 | | Read | 20 |

Get Configuration

GET

/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).

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. Get configuration should be called on a fixed schedule, preferably once per day.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

Returns a [configuration](/afterpay-online-developer/api-reference/reference/configuration/schemas/merchant-limit) object containing the following attributes. | Attribute | Type | Description | |-----------|----------------| ----------- | | `minimumAmount` | Money | Minimum order amount. Note: This attribute may not be included if the Merchant account has no minimum order amount. | `maximumAmount` | Money | Maximum order amount.

minimumAmountobject

Object containing amount and currency.

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:

Example	errorCode	message
`amount` is omitted or null	invalid_object	{Money object}.amount Amount field required
`amount` has more than 2 decimal places	invalid_object amount	must be a valid ISO 4217 format value
`amount` includes a thousands separator comma, for example: “1,000”	invalid_amount	Amount must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “FREE”, “$2” or an empty string	invalid_object	{Money object}.amount Amount field must be a valid ISO 4217 format value
`currency` is omitted or null	invalid_object	{Money object}.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	invalid_object	{Money object}.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	unsupported_currency	An error occurred

maximumAmountobject

Object containing amount and currency.

Example	errorCode	message
`amount` is omitted or null	invalid_object	{Money object}.amount Amount field required
`amount` has more than 2 decimal places	invalid_object amount	must be a valid ISO 4217 format value
`amount` includes a thousands separator comma, for example: “1,000”	invalid_amount	Amount must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “FREE”, “$2” or an empty string	invalid_object	{Money object}.amount Amount field must be a valid ISO 4217 format value
`currency` is omitted or null	invalid_object	{Money object}.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	invalid_object	{Money object}.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	unsupported_currency	An error occurred

Errors

401

Unauthorized Error

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

Returns a configuration object containing the following attributes.

Attribute	Type	Description
`minimumAmount`	Money	Minimum order amount. Note: This attribute may not be included if the Merchant account has no minimum order amount.
`maximumAmount`	Money	Maximum order amount.

minimumAmountobject

Object containing amount and currency.

Example	errorCode	message
`amount` is omitted or null	invalid_object	{Money object}.amount Amount field required
`amount` has more than 2 decimal places	invalid_object amount	must be a valid ISO 4217 format value
`amount` includes a thousands separator comma, for example: “1,000”	invalid_amount	Amount must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “FREE”, “$2” or an empty string	invalid_object	{Money object}.amount Amount field must be a valid ISO 4217 format value
`currency` is omitted or null	invalid_object	{Money object}.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	invalid_object	{Money object}.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	unsupported_currency	An error occurred

maximumAmountobject

Object containing amount and currency.

Example	errorCode	message
`amount` is omitted or null	invalid_object	{Money object}.amount Amount field required
`amount` has more than 2 decimal places	invalid_object amount	must be a valid ISO 4217 format value
`amount` includes a thousands separator comma, for example: “1,000”	invalid_amount	Amount must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “FREE”, “$2” or an empty string	invalid_object	{Money object}.amount Amount field must be a valid ISO 4217 format value
`currency` is omitted or null	invalid_object	{Money object}.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	invalid_object	{Money object}.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	unsupported_currency	An error occurred

Errors

401

Unauthorized Error

1	{
2	"minimumAmount": {
3	"amount": "10.00",
4	"currency": "USD"
5	},
6	"maximumAmount": {
7	"amount": "2000.00",
8	"currency": "USD"
9	}
10	}

1	{
2	"minimumAmount": {
3	"amount": "10.00",
4	"currency": "USD"
5	},
6	"maximumAmount": {
7	"amount": "2000.00",
8	"currency": "USD"
9	}
10	}

Get Configuration

Get Configuration

Authentication

Headers

Response

Errors

Authentication

Headers

Response

Errors

$	curl https://global-api-sandbox.afterpay.com/v2/configuration \
>	-H "User-Agent: User-Agent" \
>	-u "<username>:<password>"