Feature RequestThis is an on-demand feature. Please raise a request with our Support team to get this feature activated on your account.
Handy TipsUnlike integrating recurring payments from APIs, you do not have to create the order or the customer separately while integrating from the Dashboard. The customer will be added when creating a registration link and an order will be created when the customer makes the authentication payment.
1. Create a Registration Link
To create a registration link:- Log in to the Dashboard.
- Under PAYMENT PRODUCTS, navigate to Subscription → Registration Links.
- Click +Create New Link and follow the on-screen instructions.
captured state.
Create Registration Links via APIsYou can create registration links using APIs. Refer to the API section for more details.
Registration Link Fields
The below table lists and gives a brief description of the various fields available when creating a registration link from the Dashboard.Description mandatory
: A brief description of the registration link.
Customer Name optional
: Name of the customer. If you have already created a customer via APIs, you must enter the same Customer Name here.
Customer Contact mandatory
: Phone number and email address of the customer. If you have already created a customer via APIs, you must enter the same email address and phone number here.
Notify optional
: There are two ways in which you can send notifications:
- SMS
Receipt No. optional
: A user-entered unique identifier for the order. For example, Receipt No. 1. This parameter should be mapped to the order_id sent by Razorpay.
Registration Link Expiry optional
: The expiry date of the link. Defaults to No Expire.
Payment Method mandatory
: The payment method to make the authentication payment. Available options:
- Card
Card
: Details to be filled when you select Card as the payment method.
Amount mandatory
: The payment amount. For Card, the minimum amount is RM 0.10.
2. View the Payment Status
When an authorisation payment iscreated, the corresponding payment_id appears on the list of created payments along with an order_id.
To view the status of a recurring payment:
- Log in to the Dashboard.
- Under PAYMENT PRODUCTS, navigate to Subscription → Payments. You can view the payment status on the screen. Click a
payment_idto view details of the payment.
3. Search for the Token
Tokens are not returned as part of the checkout response. However, you can view them on the Dashboard. You can also view the details of the token using APIs or Webhooks. To search for a token:- Log in to the Dashboard.
- Under PAYMENT PRODUCTS, navigate to Subscriptions → Tokens.
- Search for the Token using the
token_id.
4. Charge the Token
After your customer successfully makes an authorisation transaction, a payment is created and moved to theauthorized state. A token is generated and is in the initiated state. After the payment moves to the captured state, the token next moves to the confirmed state. Once the token is confirmed, you can charge the token.
To charge a Token:
- Log in to the Dashboard.
- Under PAYMENT PRODUCTS, navigate to Subscriptions → Tokens.
- Search for the token using the
token_id. - Click on the
token_idto open the details page. - Click Charge Now to create a recurring payment.
Delete the Token
You can delete a token from the Dashboard. To delete a token:- Log in to the Dashboard.
- Under PAYMENT PRODUCTS, navigate to Subscriptions → Tokens.
- Search for the token using the
token_id. - Click on the
token_idto open the details page. - Click Delete Token.