The Readme API Simulator includes form elements for both required and optional Body Params. If not populated with values, Readme will send empty strings to the Clearpay Online API. Any optional parameter that is validated against a Model will need to have all of its required sub-params populated with non-empty values.
Therefore, to avoid receiving unexpected "400" responses from Clearpay, please fill out all fields of the simulation form with valid values. This is particularly important for the
currencysub-params of the
Returns a token, expiry date/time and checkout URL if successful.
|string||Checkout token to be used to complete payment.|
|string||The UTC timestamp of when the checkout token will expire, in ISO 8601 format.|
|string||A URL that can be used to redirect the consumer to the Clearpay screenflow directly from the merchant backend.|
It is not possible to update the checkout information (including
amount) after the token is generated.
If the consumer's cart changes on the merchant side after a token is generated, please discard this token. Use the current checkout information to generate a new checkout token. Use the new token to send the consumer through the Clearpay screenflow before attempting to call Auth or Capture Full Payment.
In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Create Checkout:
|HTTP Status Code||errorCode||Description|
|One or more required fields were missing or invalid.|
|One or more Money objects may have contained a currency that differs from the merchant's account currency.|