Get Configuration | Clearpay Documentation

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

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.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

Errors

See GET Errors.

This endpoint is used to retrieve the merchant's payment limits. A request to [Create Checkout](/api-reference/online-api/checkouts/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 | Timeout | Time (Seconds) | | :------ | :------------- | | Open | 10 | | Read | 20 | ## Errors See [GET Errors](/get-errors).

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Response

Get Configuration Response

minimumAmountobject

Minimum order amount.

maximumAmountobject

Maximum order amount.

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

Note

Connection Timeouts

Errors

Authentication

Headers

Response

Note

Connection Timeouts

Errors