For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Foundations
    • Introduction
    • Request Headers
    • User-Agent Header
    • Authentication
    • Errors
    • Data Requirements
  • Online API
    • Immediate Payment Flow
    • Deferred Payment Flow
      • Authorise Recurring Payment (Deferred Capture)
      • Cancel Billing Agreement
      • Create Billing Agreement
      • Create Recurring Payment (Immediate Capture)
      • Get Billing Agreement
      • Setup Billing Agreement Approval
  • Upgrading to the Clearpay Express Checkout
    • Express Checkout Overview
    • How to Integrate
    • Security
LogoLogo
On this page
  • Approved Response (201)
  • Declined Response (402)
  • Connection Timeouts
  • Errors
  • Recurring Payments Documentation
Online APIRecurring Payments Flow

Authorise Recurring Payment (Deferred Capture)

Was this page helpful?
Previous

Cancel Billing Agreement

Next
Built with
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

TimeoutTime (Seconds)
Open10
Read70

Errors

In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Authorize Recurring Payment (Deferred Capture):

HTTP Status CodeerrorCodeDescription
402
Payment Required		invalid_tokenThe billing agreement token is invalid, expired, completed, or does not exist.
403
Forbidden		forbiddenAccess is forbidden. Recurring payments product must be enabled on the merchant account.
422
Unprocessable Entity		invalid_objectOne or more required fields were missing or invalid.

Recurring Payments Documentation

  • Recurring Payments
    • Store Clearpay as a Payment Method
    • Checkout and Store Clearpay as Payment Method
    • Create Recurring Payment
  • Recurring Payments Flow
    • Setup Billing Agreement Approval
    • Create Billing Agreement
    • Get Billing Agreement
    • Cancel Billing Agreement
    • Create Recurring Payment (Immediate Capture)
    • Authorise Recurring Payment (Deferred Capture)