Subscriptions
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.
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:
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.
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
Duplicate checks (API)
When enabled on your account, duplicate checks suspend transactions that are identical to previous transactions processed within the last 15 minutes. This is to automatically prevent assumed duplicate transactions (e.g. If the customer refreshes their browser and inadvertently sends two requests).
To enable duplicate checks on your account, please contact our Support team.
Managing transactions flagged as duplicates
When a transaction is suspended, its settlestatus is set to “2”, and the funds will not be settled into your bank account until you manually update the transaction. You can update the settlestatus to “1”, and this will instruct us to settle the pending transaction in the next settlement batch. Click here for information on settlement.
Emails informing of duplicates
When duplicates are flagged on your account, you will be informed using the email address you provided when you signed up with us. If you prefer, we can arrange these emails to be sent to a different address. Please contact our Support team for assistance.