repeating – Documentation

Subscriptions

The following content assumes you have obtained the necessary PCI certification to process and submit sensitive cardholder data in the request to our Webservices API.

If you are unsure, please contact our Support team for assistance.

You can schedule payments to be processed at regular intervals on your behalf by utilising our subscription engine. This is achieved by submitting a single JSON request to our system using our Webservices API, by following the specification outlined in this topic. Our subscription engine is activated once per day, automatically processing any payments previously-scheduled on your account.

Subscription payments require no further input from your system to be processed successfully at regular intervals, providing the initial request is processed successfully and has followed our specification.

Supported subscription workflows for Webservices

There are two types of JSON request that can be submitted to our Webservices API in order to schedule subscriptions. Please read the information provided below and ensure you are using the most appropriate request type for your requirements:

AUTH Subscription

A payment is processed immediately, the funds of which are typically settled into your account within 24 hours, providing the issuing bank authorises the request.

Following this, the subscription is scheduled in our subscription engine, with the second payment being processed on either of the following dates:

After the first interval – as defined by subscriptionfrequency and subscriptionunit – has passed (e.g. if the interval is “1 MONTH”, the second payment will be processed after 1 month has passed).
The custom subscriptionbegindate, if this is specified in the request.

Click to learn more

ACCOUNTCHECK Subscription (only available with select acquirers)

No funds are initially reserved on the customer’s account. The initial request is only used to perform Address Verification Service (AVS) and security code checks on the customer’s card.

Following this, the subscription is scheduled in our subscription engine, with the first payment being processed on either of the following dates:

After the first interval – as defined by- subscriptionfrequency and subscriptionunit – has passed (e.g. if the interval is “1 MONTH”, the first payment will be processed after 1 month has passed).
The custom begin date, if this is specified in the request.

Use an ACCOUNTCHECK request type as the parent when you would like to charge the customer after the first interval has passed (e.g. first month is free).

Account checks are only available for certain acquiring banks. Please contact our Support team for further details

Click to learn more