Payments

Payment Gateway

S2s Integration

Recurring Payments

Cards

Authorization Transaction

1. Create the Authorization Transaction

Create an authorisation transaction for cards using Razorpay APIs.

You can create an authorization transaction:

Note

Bank downtime can affect success rates when processing recurring payments via debit cards.

1.1. Using Razorpay APIs

To create an authorization transaction using the Razorpay APIs, you need to:

  1. Create a Customer

    .

  2. Create an Order

    .

  3. Create Authorization Payment using Razorpay APIs

    .

1.1.1. Create a Customer

Token Sharing for Partner Auth Model

If you are a Razorpay Partner, who wants to use this API via Partner Auth, you must ensure the following:

  • Add the basic auth with partner credentials (client_id and client_secret).
  • Add the account_id of the sub-merchant using X-Razorpay-Account in the header. For example, -H "X-Razorpay-Account: acc_KBrJAIEqre5ucn"
curl -X POST https://api.razorpay.com/v1/customers \
-u [YOUR_PARTNER_KEY_ID]:[YOUR_PARTNER_KEY_SECRET]\
-H "X-Razorpay-Account: acc_KBrJAIEqre5ucn" \

Razorpay links recurring tokens to customers via a unique identifier. You can generate this identifier using the Customer API.

You can create

customers

with basic information such as email and contact and use them for various Razorpay offerings. The following endpoint creates a customer.

POST
/customers

Request Parameters

fail_existing

optional

string The request throws an exception by default if a customer with the exact details already exists. You can pass an additional parameter fail_existing to get the existing customer's details in the response. Possible values:

  • 1 (default): If a customer with the same details already exists, throws an error.
  • 0: If a customer with the same details already exists, fetches details of the existing customer.

notes

optional

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

1.1.2. Create an Order

You can use the

Orders API

to create a unique Razorpay order_id that is associated with the authorisation transaction. The following endpoint creates an order.

POST
/orders

Token Sharing for Partner Auth Model

If you are a Razorpay Partner, who wants to use this API via Partner Auth, you must ensure the following:

  • Add the basic auth with partner credentials (client_id and client_secret).
  • Add the account_id of the sub-merchant using X-Razorpay-Account in the header. For example, -H "X-Razorpay-Account: acc_KBrJAIEqre5ucn"
curl -X POST https://api.razorpay.com/v1/orders \
-u [YOUR_PARTNER_KEY_ID]:[YOUR_PARTNER_KEY_SECRET]\
-H "X-Razorpay-Account: acc_KBrJAIEqre5ucn" \

Request Parameters

amount

mandatory

integer Amount in currency subunits. For cards, the amount should be 100 ($1.00).

customer_id

mandatory

string The unique identifier of the customer. For example, cust_4xbQrmEoA5WJ01.

method

optional

string Payment method used to make the authorisation transaction. Here, it is card.

receipt

optional

string A user-entered unique identifier for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.

notes

optional

object Key-value pair you can use to store additional information about the entity. Maximum 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”.

1.1.3. Create an Authorization Payment

Once an order is created, your next step is to create a payment. Use the below endpoint to create a payment with payment method card.

Token Sharing for Partner Auth Model

If you are a Razorpay Partner, who wants to use this API via Partner Auth, you must ensure the following:

  • Add the basic auth with partner credentials (client_id and client_secret).
  • Add the account_id of the sub-merchant using X-Razorpay-Account in the header. For example, -H "X-Razorpay-Account: acc_KBrJAIEqre5ucn"
curl -X POST https://api.razorpay.com/v1/create/json \
-u [YOUR_PARTNER_KEY_ID]:[YOUR_PARTNER_KEY_SECRET]\
-H "X-Razorpay-Account: acc_KBrJAIEqre5ucn" \
POST
/payments/create/json

Handy Tips

  • To process recurring transactions, customer card details will need to be secured/tokenised in accordance with the applicable laws. The merchant will be solely responsible for obtaining informed consent from customers for the processing of e-mandates and such consent shall be explicit and not by way of a forced/default/automatic selection of check box, radio button etc.
  • When the merchant is sharing recurring: 1 or preferred, it is for tokenising the card as per applicable rules for recurring mandate creation. If such consent is not shared during the payment flow, then Razorpay will not tokenise the card or process the e-mandate/ recurring transaction.

Request Parameters

amount

mandatory

integer Amount in currency subunits. For cards, the minimum value is 100 (₹1).

currency

mandatory

string The 3-letter ISO currency code for the payment. Currently, we only support INR.

order_id

mandatory

string The unique identifier of the order created in

Step 1.1.2.: Create an Order

.

recurring

mandatory

string Possible values:

  • 1: Recurring payment is enabled.
  • preferred: Use this when you want to support recurring payments and one-time payment in the same flow.

email

mandatory

string The customer's email address. For example, gaurav.kumar@example.com.

contact

mandatory

string The customer's contact number. For example, 9123456780.

method

mandatory

string The payment method selected by the customer. Here, the value must be card.

card

The attributes associated with a card.

number

mandatory

integer Unformatted card number. This field is required if value of method is card. Use one of our

test cards

to try out the payment flow.

name

mandatory

string The name of the cardholder.

expiry_month

mandatory

integer The expiry month of the card in MM format. For example, 01 for January and 12 for December.

expiry_year

mandatory

integer Expiry year for card in the YY format. For example, 2025 will be in format 25.

cvv

mandatory

integer CVV printed on the back of the card.

Handy Tips

  • CVV is not required by default for tokenised cards across all networks.
  • CVV is optional for tokenised card payments. Do not pass dummy CVV values.
  • To implement this change, skip passing the cvv parameter entirely, or pass a null or empty value in the CVV field.
  • We recommend removing the CVV field from your checkout UI/UX for tokenised cards.
  • If CVV is still collected for tokenised cards and the customer enters a CVV, pass the entered CVV value to Razorpay.

Response Parameters

If the payment request is valid, the response contains the following fields. Refer to the

S2S Json V2 integration document

for more details.

razorpay_payment_id

string Unique identifier of the payment. Present for all responses.

next

array A list of action objects available to you to continue the payment process. Present when the payment requires further processing.

action

string An indication of the next step available to you to continue the payment process. Possible values:

  • otp_generate - Use this URL to allow the customer to generate OTP and complete the payment on your webpage.
  • redirect - Use this URL to redirect the customer to submit the OTP on the bank page.

url

string URL to be used for the action indicated.

1.2. Using a Registration Link

Registration Links are an alternate way of creating an authorization transaction. If you create a registration link, you need not create a customer or an order.

When you create a registration link, an

invoice

is automatically issued to the customer. The customer can use the invoice to make the Authorization Payment.

Know how to

create Registration Links

using the Dashboard.

Handy Tips

You can use webhooks to get notifications about successful payments against a registration link. Know more about

Webhooks

.

A registration link must always have the amount (in Paise) that the customer will be charged when making the authorization payment. For cards, the amount must be a minimum of ₹1.

1.2.1. Create a Registration Link

The following endpoint creates a registration link.

POST
/subscription_registration/auth_links

Request Parameters

customer

object Details of the customer to whom the registration link is sent.

name

mandatory

string Customer's name.

email

mandatory

string Customer's email address.

contact

mandatory

integer Customer's contact number.

type

mandatory

string In this case, the value is link.

amount

mandatory

integer The payment amount in the smallest currency sub-unit.

currency

mandatory

string The 3-letter ISO currency code for the payment.

description

mandatory

string A description that appears on the hosted page.

subscription_registration

Details of the authorisation transaction.

method

mandatory

string The authorisation method. Here it is card.

max_amount

mandatory

integer The maximum amount that can be auto-debited in a single charge.

expire_at

optional

integer The Unix timestamp till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. The card's expiry year is considered a default value.

frequency

mandatory

string The frequency at which you can charge your customer. Possible values:

  • weekly
  • monthly
  • yearly
  • as_presented

sms_notify

optional

boolean Indicates if SMS notifications are to be sent by Razorpay. Possible values:

  • true (default): Notifications are sent by Razorpay .
  • false: Notifications are not sent by Razorpay.

email_notify

optional

boolean Indicates if email notifications are to be sent by Razorpay. Possible values:

  • true (default): Notifications are sent by Razorpay .
  • false: Notifications are not sent by Razorpay.

expire_by

optional

integer The Unix timestamp indicates the expiry of the registration link.

receipt

optional

string A unique identifier entered by you for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.

notes

optional

object This is a key-value pair that is used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

1.2.2. Send/Resend Notifications

The following endpoint sends/resends notifications with the short URL to the customer:

POST
/invoices/:id/notify_by/:medium

Path Parameters

id

mandatory

string The unique identifier of the invoice linked to the registration link for which you want to send the notification. For example, inv_1Aa00000000001.

medium

mandatory

string Determines through which medium you want to resend the notification. Possible values:

  • sms
  • email

1.2.3. Cancel a Registration Link

The following endpoint cancels a registration link.

POST
/invoices/:id/cancel

Handy Tips

You can only cancel registration link in the issued state.

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X POST https://api.razorpay.com/v1/invoices/inv_1Aa00000000001/cancel

Path Parameter

id

mandatory

string The unique identifier for the invoice linked to the registration link that you want to cancel. For example, inv_1Aa00000000001.

Is this integration guide useful?

ON THIS PAGE