Recurring Payments

Recurring payments or subscriptions are scheduled payments to pay for products or services that occurs frequently. For example, a cardholder paying for an on-demand internet service provider's monthly subscriptions fee without having to manually pay every month.
After first successful payment from the customers card. The card is stored as tokens which will be used for subsequent transactions. Note that recurrent transaction works only for cards

Create Subscription

To complete this transaction, merchant is expected to redirect to the 3DSecure site via the redirect URL provided with the response below. However if the redirect url is not returned, the code is S20 and the message is transaction is pending, the Validate OTP endpoint should be called as the customer would have received a token either by email or sms on the customers' phone.

To get the subscription created or the status of a subscription for the customer, the GET Subscription endpoint is called by passing the paymentReference as billingId

Create Subscription

For the full specification, see our API Reference
Request Sample
The code snippet below shows an example response for creating a subscription
Billing Cycle should be set to : DAILY, WEEKLY, MONTHLY OR ANNUALLY
Response Sample
The code snippet below shows an example response for creating a subscription

Get Merchant Subscription

The Get Merchant Subscription returns all customer subscriptions. Included in the response is authorizationCode which can be used for separate charges to the customer
For the full specification, see our API Reference
Response Sample
The code snippet below shows an example response to get merchant subscription

Charge Subscription

For the full specification, see our API Reference
Request Sample
The code snippet below shows an example request for charging a customer with an authorizationCode
Authorise Charge - AuthorizationCode is gotten when a subscription has been successfully completed
Response Sample
The code snippet below shows an example response for charging a subscription

Get Customer Subscription

For the full specification, see our API Reference
Response Sample
The code snippet below shows an example response to get customer subscription by customerId

Update Customer Subscription

For the full specification, see our API Reference
Request Sample
The code snippet below shows an example request for updating a subscription
For Credit cards, you can update the previously stored payment details. This may be required when the card expiry date or the billing/delivery address changes.
Response Sample
The code snippet below shows an example response for updating a subscription
Need something else?
If you have any questions or need general help, visit our support page
Signup for developer update
You can unsubscribe at any time. Read our privacy policy.