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 title="Note">Clearpay 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>
Successful Response (200)
Returns an array of payment configuration objects, each containing the following attributes.
| Attribute | Type | Description |
|---|---|---|
| type | string | The name of the payment type. |
| description | string | The description of the payment type. |
| minimumAmount | Money | Minimum order amount. |
| maximumAmount | Money | Maximum order amount. |
Currently, PAY_BY_INSTALLMENT is the only payment type offered. </Note>
Connection Timeouts
| Timeout | Time (Seconds) |
|---|---|
| Open | 10 |
| Read | 20 |
Errors
See GET Errors.
Request
- Base URL: https://global-api-sandbox.afterpay.com
- URL: https://global-api-sandbox.afterpay.com/v1/configuration
- Auth: HTTP basic
Headers
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.