Before integrating recurring payments, here are some things you need to know:
- For each recurring transaction it is required to obtain a prior express recurring Transaction consent from the consumer (including specifically the Cardholder), at the point of checkout, for your products /services sold using our widget.
- Information that is needed to provide before obtaining a consent:
- the amount of the recurring transaction;
- whether the amount is fixed or variable;
- the date of the recurring transaction (if it is in the future or else show it as today);
- whether the date is fixed or variable;
- an agreed method of communication for all future correspondence with the consumer.
- Using the agreed method of communication, you need to provide consumer with a confirmation that a recurring Transaction agreement has been entered into. This confirmation must be provided within two (2) business days of entering that recurring transaction agreement, which must be separate from the sales agreement.
- You must notify consumer that this recurring transaction consent is subject to cancellation by the consumer at any time, and you should not debit or attempt to debit the consumer’s card or any other payment method account after being notified of the cancellation of the Recurring Transaction consent.
- You must notify the consumer in writing of the amount to be debited and the due date of the debit at least 14 days prior to each subsequent debit (unless the recurring transaction consent sets out the amounts payable and the due dates and none of these have changed or other objective criteria are agreed with the consumer for calculating the due dates).
- You must retain the recurring transaction consent for the duration of the Recurring Transactions, and for a period of 18 months after the final payment that is made pursuant to it. You should be able to produce the recurring transaction consent to us on first demand.
Recurring payment’s parameters
Currently, only card payments can be recurring. We support 2 types of recurring card payments – merchant initiated transactions without schedule (unscheduled MITs) and regular scheduled payments (also known as subscriptions).
How does it work?
- You provide details to your customer for recurring payments (conditions, procedure how to cancel it etc.) before initiating a payment (in your checkout page), take their consent. Soon we will have an option to show details on our widget also.
- First payment is initiated with mandatory 3DS authentication, if successful, recurrence ID is created.
- With received recurrence ID you can initiate subsequent payments (if they are unscheduled MITs) or these subsequent payments are initiated by us following details frequency details you provided in initial’s payment request).
- You can see full history of all payments with particular recurrence ID using our separate Get recurrence details API.
For first payment use our Initiate Payment API with recurrence parameters:
Parameter | Description | Mandatory? |
---|---|---|
recurrence.type | Recurrent payment type.unscheduled – used for MITs without other details, initiated on your demand (cardholder not present)recurring – used for subscriptions and regular based payments. | Yes |
frequency.interval | Recurrent payment frequency interval type. Possible values: monthly, custom If interval= monthly , then frequency.days parameter is ignored and becomes irrelevantIf interval=custom , frequency.days parameter is mandatory | Yes |
recurrence.frequency.days | Integer, conditional mandatory if recurrence.type is recurring and if frequency.interval is custom.Period between payments.Min value: 1 Max value: 366 | No – for unscheduled MITs Yes – for recurring payments with custom interval. |
recurrence.endDate | Date format. Last date of recurring payment. Only future date can be used. No longer than 4 years from the date of a request. | No |
After payment initiation, you’ll receive recurrenceId
in Initiate payment API response. Use it for further subsequent payments.
"payment": {
"paymentId": "44812d69-2cac-45b8-a866-02057a973a1f",
"redirectUrl": "https://pay-stage.connectpay.com?key=eca83a69-6005-48e9-a36f-a35886f53a2c",
"recurrenceId": "700f6eda-1af5-4a77-9605-988845aac875"
}