Get Configuration

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

A request to Create Checkout may be rejected if the order 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.

Get configuration should be called on a fixed schedule, we recommend about once per day. </Note>

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20

Errors

See GET Errors.

get/v2/configuration

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v2/configuration
  • Auth: HTTP basic

Headers

User-Agentstring required
Acceptstring

Response

Get Configuration Response

Changes

No recorded changes to this operation across all 1 revision of this API.