Authorise Recurring Payment (Deferred Capture)
The Readme API Simulator includes form elements for both required and optional body params. If not populated with values, Readme sends empty strings to the Afterpay 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 the simulation form fields with valid values. This is particularly important for the amount and currency sub-params of the amount, taxAmount and shippingAmount params.
Note
This operation is idempotent based on the requestId (if provided), which allows for the safe retry of requests, guaranteeing the payment operation is only performed once.
Note
The customer’s payment plan starts at the time of auth approval.
Approved Response (201)
If payment is approved by Clearpay, returns a Payment object in response, with a status of “APPROVED” and a paymentState of “AUTH_APPROVED”.
Declined Response (402)
If payment is declined by Clearpay, for example, if invalid card details were entered, returns a Payment object in response, with a status of “DECLINED”.
Please advise the customer to contact the Clearpay Customer Service team for more information.
Connection Timeouts
Errors
In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Authorize Recurring Payment (Deferred Capture):
