Cookie Consent by Free Privacy Policy Generator Update cookies preferences

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

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.

Successful Response (200)

Returns an array of payment configuration objects, each containing the following attributes.

AttributeTypeDescription
typestringThe name of the payment type.
descriptionstringThe description of the payment type.
minimumAmountMoneyMinimum order amount.
maximumAmountMoneyMaximum order amount.

📘

Note

Currently, PAY_BY_INSTALLMENT is the only payment type offered.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20

Errors

See GET Errors.

Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!