Get Configuration

This endpoint is used to retrieve the merchant’s payment configuration, i.e. the merchant’s available payment types, and the valid payment ranges for each. A request to Create Order will be rejected if the total amount is not between the minimumAmount and maximumAmount (inclusive).

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. Note: Currently, PAY_BY_INSTALLMENT is the only payment type offered.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

This endpoint is used to retrieve the merchant's payment configuration, i.e. the merchant's available payment types, and the valid payment ranges for each. A request to Create Order will be rejected if the total amount is not between the `minimumAmount` and `maximumAmount` (inclusive). 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. Note: Currently, `PAY_BY_INSTALLMENT` is the only payment type offered. ### Connection Timeouts | Timeout | Time (Seconds) | | ------- | ------------ | | Open | 10 | | Read | 20 |

Authentication

AuthorizationBasic

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

Path parameters

environmentstringRequired

Use api-sandbox for AU/NZ, or api.us-sandbox for US.

Response

Attribute	Type	Description
type	string	The name of the payment type.
description	string	The description of the payment type.
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.

$	curl https://global-api-sandbox.afterpay.com/v1/configuration/environment:environment \
>	-H "User-Agent: Afterpay Online API Simulator" \
>	-H "Accept: application/json" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>"

1	{
2	"type": "PAY_BY_INSTALLMENT",
3	"description": "Pay for your purchase in 4 interest-free installments.",
4	"minimumAmount": {
5	"amount": 10,
6	"currency": "AUD"
7	},
8	"maximumAmount": {
9	"amount": 1500,
10	"currency": "AUD"
11	}
12	}

Connection Timeouts

Authentication

Path parameters

Headers

Response

Connection Timeouts

Authentication

Path parameters

Headers

Response