A recurring contract is created along with a payment request, similar to a regular payment request, except the below fields to be provided in the payment session HPP form or in the API request. If the payment is successful, the details are stored, and the
recurringDetailReference is created. Set the
recurringProcessingModel to Subscription for payments that recur on a fixed schedule, and Card On File for payments that do not occur on a fixed schedule.
For more information on available fields, refer to PaymentRequest.
Always provide a unique
shopperReference parameter for every shopper. Note that you can store maximum 50 card details associated with the same
The following code examples show the creation of recurring contracts together with a payment request using
/authorise endpoint in JSON, SOAP, and cURL.
When you are ready to process a subsequent payment, set the value of the
selectedRecurringDetailReference to either:
recurringDetailReferencereturned from the list of all stored recurring details based on the
shopperReferenceprovided during the recurring contract.
The word "LATEST", which uses a recent recurring detail.
On AUTHORISATION you receive a notification with success=”true”.