Recurring Payments API

Use Cases

• Create customers to set up recurring payments using the following payment methods.

  • Cards

• Create orders for customers using the following payment methods.

  • Cards

• Retrieve and manage tokens using the following payment methods.

  • Cards

• Set up recurring payments using the following payment methods.

  • Cards

API Gateway URL

For most of the Curlec APIs, the Gateway URL is https://api.razorpay.com/v1. You need to include this before each API endpoint to make API calls. However, certain APIs are on V2. Hence, the gateway URL may differ for certain APIs.

Example

• Use the URL https://api.razorpay.com/v1/payments to access payment resources.

API Authentication

All Curlec APIs are authenticated using Basic Auth. Basic auth requires the following:

• [YOUR_KEY_ID]
• [YOUR_KEY_SECRET]

Basic auth expects an Authorization header for each request in the Basic base64token format. Here, base64token is a base64 encoded string of YOUR_KEY_ID:YOUR_KEY_SECRET.

Generate API Key

Follow these steps to generate API keys:

1. Log in to your Dashboard with the appropriate credentials.
2. Select the mode (Test or Live) for which you want to generate the API key.
   • Test Mode: The test mode is a simulation mode that you can use to test your integration flow. Your customers will not be able to make payments in this mode.
   • Live Mode: When your integration is complete, switch to live mode and generate live mode API keys. In the integration, replace test mode keys with live mode keys to accept customer payments.
3. Navigate to Account & Settings → API Keys (under Website and app settings) → Generate Key to generate key for the selected mode.
   

The Key Id and Key Secret appear on a pop-up page.

Integration Flow

The integration flow varies depending on how you choose to create the authorisation transaction.

Using Curlec Standard Checkout

You can integrate Recurring Payments using Curlec Standard Checkout via APIs. Following is the integration flow to collect recurring payments using the Curlec Standard Checkout:

1. Create a customer
   This returns a customer_id.
2. Create an order
   This returns an order_id. The order amount for:
   • Cards is a minimum of RM 1.
3. Create authorization transaction
   Pass the customer_id, order_id and a few additional parameters in your Checkout to create the authorization payment. The customer completes the authorization payment, which generates a token. This payment can be authorized using one of the following instruments:
   • Card
4. Retrieve and check the status of the token
   After the token status changes to confirmed, you can create and charge subsequent payments.
5. Create and charge subsequent payments
   To do this, you have to manually:
   1. Create a new order.
   2. Create a recurring payment.

Using a Registration Link

You can create registration links from the Dashboard or using APIs.

Following is the integration flow to collect recurring payments using a registration link:

1. Create a registration link and send it to your customer
   The customer completes the authorisation payment, which generates a token. This payment can be authorised using one of the following instruments:

   • Card
   No Need to Create a Customer and Order Separately

   If you use a registration link to create the authorisation transaction, Curlec automatically creates a customer and the order on your behalf.

2. Retrieve and check the token status
   After the token status changes to confirmed, you can create and charge subsequent payments.

3. Create and charge subsequent payments
   To do this, you have to manually:

   1. Create a new order.
   2. Create a recurring payment.