Single Integration API

Create Order and Payments in a single API call.

Available in🇮🇳 India

You can now create an order along with a payment using a single API for netbanking, cards and UPI. Given below are details and examples for all three payment methods followed by steps to integrate S2S JSON API and accept payments using netbanking, cards and UPI.

Netbanking

Create an order along with payment using the consolidated order and payment API. This single API call combines order and payment creation, resulting in a more efficient and faster transaction process.

Create a order along with payment by:

• Making a single API call to Razorpay, combining order and payment creation.
• Authenticating using the provided credentials, ensuring access to the consolidated payment API.
• Manually integrating the API sample codes on your server.

Use the following API to create an order along with payment using netbanking as the payment method:

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
 "amount": 50000,
 "currency": "INR",
 "receipt": "receipt#1",
 "notes": {
   "key1": "value3",
   "key2": "value2"
 },
 "partial_payment": true,
 "customer_id": "cust_E9penp7VGhT5yt",
 "transfers": [
   {
     "account": "acc_IRQWUleX4BqvYn",
     "amount": 1000,
     "currency": "INR",
     "notes": {
       "branch": "Acme Corp Bangalore North",
       "name": "Gaurav Kumar"
     },
     "linked_account_notes": [
       "branch"
     ],
     "on_hold": true,
     "on_hold_until": 1671222870
   },
   {
     "account": "acc_IROu8Nod6PXPtZ",
     "amount": 1000,
     "currency": "INR",
     "notes": {
       "branch": "Acme Corp Bangalore South",
       "name": "Saurav Kumar"
     },
     "linked_account_notes": [
       "branch"
     ],
     "on_hold": false
   }
 ],
 "products": [],
 "bank_account": {
   "account_number": "765432123456789",
   "name": "Gaurav Kumar",
   "ifsc": "HDFC0000053"
 },
 "payment_config": {
 "capture": "automatic",
 "capture_options": {
     "automatic_expiry_period": 12,
     "manual_expiry_period": 7200,
     "refund_speed": "optimum"
   }
 },
 "payment": {
   "amount": 100,
   "email": "[e-mail]",
   "contact": "9123456789",
   "ip": "192.168.0.103",
   "method": "netbanking",
   "bank": "HDFC",
   "description": "Test payment",
   "notes": {
     "note_key": "value1"
   }
 },
 "user_agent": "Mozilla/5.0"
}

Success

{
  "id": "order_EKwxwAgItmmXdp",
  "status": "attempted",
  "receipt": "receipt#1",
  "notes": {
    "key1": "value3",
    "key2": "value2"
  },
  "created_at": 1582628071,
  "amount": 50000,
  "amount_paid": 0,
  "amount_due": 50000,
  "currency": "INR",
  "offer_id": null,
  "attempts": 1,
  "transfers": [],
  "payment_workflow": {
     "id": "pay_FVmAstJWfsD3SO",
     "next": [
       {
         "action": "redirect",
         "url": "https://api.razorpay.com/v1/payments/FVptEs3cSWX1fs/authorize"
       }
     ]
   }
 }

Request Parameters

amount mandatory : integer The amount for which the order was created in currency subunits. For example, for an amount of ₹295.00, enter 29500. The same amount will be used for the payment creation. For the partial payment scenario, we will use the amount specified in the payment request object in case.

currency mandatory : string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.

receipt optional : string Receipt number that corresponds to this order. Can have a maximum length of 40 characters and has to be unique.

partial_payment optional : boolean Indicates whether the customer can make a partial payment. Possible values:

• true: The customer can make partial payments.
• false (default): The customer cannot make partial payments.

first_payment_min_amount optional : integer Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of ₹7,000 is to be received from the customer in two installments of #1 - ₹5,000, #2 - ₹2,000, then you can set this value as 500000. This parameter should be passed only if partial_payment is true.

customer_id optional : string Unique identifier of the customer.

transfers optional : json object Details regarding the transfer.

account : string The recipient account ID for fund transfer.

amount optional : string The amount of the transfer.

currency mandatory : string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.

notes optional : json 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".

linked_account_notes optional : string Notes associated with the linked account.

on_hold mandatory : boolean Indicates whether the account settlement for transfer is on hold. Possible values:

• true: Puts the settlement on hold.
• false: Releases the settlement.

on_hold_until mandatory : integer Timestamp until which the transfer amount is on hold.

bank_account optional : json object Details of the bank account that the customer provides at the time of registration.

account_number optional : string Account number of the customers bank account.

name optional : string The name associated with the bank account.

ifsc optional : string The IFSC code of the bank.

payment_config optional : array Payment capture settings for the payment. The options sent here override the account level auto-capture settings configured using the Dashboard.

capture mandatory : string Option to automatically capture payment. Possible values:

• automatic: Payments are auto-captured according to the configurations specified in the capture_options array.
• manual: You have to manually capture payments using our Capture API or from the Dashboard.

capture_options optional : array Use this array to determine the expiry period for automatic and manual capture of payments and the refund speed in the case of non-capture.

automatic_expiry_period mandatory if capture = automatic : integer Time in minutes till when payments in the authorized state should be auto-captured. Minimum value 12 minutes. This parameter is mandatory only if the value of capture parameter is automatic.

manual_expiry_period optional : integer Time in minutes till when you can manually capture payments in the authorized state.

• Must be equal to or greater than the automatic_expiry_period value.
• Default value 7200 minutes.
• Maximum value 7200 minutes.
• Payments in the authorized state after the manual_expiry_period are auto-refunded.

refund_speed mandatory : string Refund speed for payments that were not captured (automatically or manually). Possible values:

• optimum: We try to process the refund instantly. We charge a small fee for this. If it is not possible to process an instant refund, we will process a normal refund in 5-7 working days. Learn more about instant refunds.
• normal: The refund is processed in 5-7 working days.
  
  If no value is passed, the refund is processed using the default speed set on the Dashboard.

payment mandatory : object Details of the payment.

amount optional : integer The amount for which the order was created in currency subunits. For example, for an amount of ₹295.00, enter 29500. The same amount will be used for the payment creation. For the partial payment scenario, we will use the amount specified in the payment request object in case.

email mandatory : string Email address of the customer.

contact mandatory : integer Contact number of the customer.

ip mandatory : string The customer’s IP address.

method mandatory : string Name of the payment method (example, netbanking, cards and upi).

bank mandatory : string Name of the bank.

description mandatory : string Description of the payment.

Descriptions for the response parameters are present in the Response parameter table.

Cards

Watch Out!

The request body will differ from those created by other PSPs for tokens created on Razorpay.

The following API will create a payment with cards as the payment method:

With Card Number

 curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
 -X POST https://api.razorpay.com/v1/orders \
 -H "Content-Type: application/json" \
 -d {
  "amount": 50000,
  "currency": "INR",
  "receipt": "receipt#1",
  "notes": {
    "key1": "value3",
    "key2": "value2"
  },
  "partial_payment": true,
  "customer_id": "cust_E9penp7VGhT5yt",
  "transfers": [
    {
      "account": "acc_IRQWUleX4BqvYn",
      "amount": 1000,
      "currency": "INR",
      "notes": {
        "branch": "Acme Corp Bangalore North",
        "name": "Gaurav Kumar"
      },
      "linked_account_notes": [
        "branch"
      ],
      "on_hold": true,
      "on_hold_until": 1671222870
    },
    {
      "account": "acc_IROu8Nod6PXPtZ",
      "amount": 1000,
      "currency": "INR",
      "notes": {
        "branch": "Acme Corp Bangalore South",
        "name": "Gaurav Kumar"
      },
      "linked_account_notes": [
        "branch"
      ],
      "on_hold": false
    }
  ],
  "products": [],
  "payment_config": {
    "capture": "automatic",
    "capture_options": {
      "automatic_expiry_period": 12,
      "manual_expiry_period": 7200,
      "refund_speed": "optimum"
    }
  },
  "payment": {
    "amount": 100,
    "email": "[e-mail]",
    "contact": "9090909090",
    "method": "card",
    "notes": {
      "key1": "value3",
      "key2": "value2"
    },
    "card": {
      "number": "4386289407660153",
      "name": "Gaurav",
      "expiry_month": "11",
      "expiry_year": "30",
      "cvv": "100"
    },
    "authentication": {
      "authentication_channel": "browser"
    },
    "browser": {
      "java_enabled": false,
      "javascript_enabled": false,
      "timezone_offset": 11,
      "color_depth": 23,
      "screen_width": 23,
      "screen_height": 100
    },
    "ip": "105.106.107.108",
    "referer": "https://merchansite.com/example/paybill"
  },
  "user_agent": "Mozilla/5.0"
 } 

Success

 {
  "id": "order_EKwxwAgItmmXdp",
  "status": "attempted",
  "receipt": "receipt#1",
  "notes": {
    "key1": "value3",
    "key2": "value2"
  },
  "created_at": 1582628071,
  "amount": 50000,
  "amount_paid": 0,
  "amount_due": 50000,
  "currency": "INR",
  "offer_id": null,
  "attempts": 1,
  "transfers": [],
  "payment_workflow": {
    "id": "pay_FVmAstJWfsD3SO",
    "next": [
      {
        "action": "redirect",
        "url": "https://api.razorpay.com/v1/payments/pay_FVmAstJWfsD3SO/authorize"
      },
      {
        "action": "otp_generate",
        "url": "https://api.razorpay.com/v1/payments/pay_FVmAstJWfsD3SO/otp_generate?track_id=FVmAtLUe9XZSGM&key_id=<YOUR_KEY_ID>"
      }
    ]
  }
 }

Request Parameters

amount mandatory : integer The amount for which the order was created in currency subunits. For example, for an amount of ₹295.00, enter 29500. The same amount will be used for the payment creation. For the partial payment scenario, we will use the amount specified in the payment request object in case.

currency mandatory : string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.

receipt optional : string Receipt number that corresponds to this order. Can have a maximum length of 40 characters and has to be unique.

partial_payment optional : boolean Indicates whether the customer can make a partial payment. Possible values:

• true: The customer can make partial payments.
• false (default): The customer cannot make partial payments.

first_payment_min_amount optional : integer Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of ₹7,000 is to be received from the customer in two installments of #1 - ₹5,000, #2 - ₹2,000, then you can set this value as 500000. This parameter should be passed only if partial_payment is true.

customer_id optional : string Unique identifier of the customer.

transfers optional : json object Details regarding the transfer.

account : string The recipient account ID for fund transfer.

amount optional : string The amount of the transfer.

currency mandatory : string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.

notes optional : json 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".

linked_account_notes optional : string Notes associated with the linked account.

on_hold mandatory : boolean Indicates whether the account settlement for transfer is on hold. Possible values:

• true: Puts the settlement on hold.
• false: Releases the settlement.

on_hold_until mandatory : string Timestamp until which the transfer amount is on hold.

payment_config optional : array Payment capture settings for the payment. The options sent here override the account level auto-capture settings configured using the Dashboard.

capture mandatory : string Option to automatically capture payment. Possible values:

• automatic: Payments are auto-captured according to the configurations specified in the capture_options array.
• manual: You have to manually capture payments using our Capture API or from the Dashboard.

capture_options optional : array Use this array to determine the expiry period for automatic and manual capture of payments and the refund speed in the case of non-capture.

automatic_expiry_period mandatory if capture = automatic : integer Time in minutes till when payments in the authorized state should be auto-captured. Minimum value 12 minutes. This parameter is mandatory only if the value of capture parameter is automatic.

manual_expiry_period optional : integer Time in minutes till when you can manually capture payments in the authorized state.

• Must be equal to or greater than the automatic_expiry_period value.
• Default value 7200 minutes.
• Maximum value 7200 minutes.
• Payments in the authorized state after the manual_expiry_period are auto-refunded.

refund_speed mandatory : string Refund speed for payments that were not captured (automatically or manually). Possible values:

• optimum: We try to process the refund instantly. We charge a small fee for this. If it is not possible to process an instant refund, we will process a normal refund in 5-7 working days. Learn more about instant refunds.
• normal: The refund is processed in 5-7 working days.
  
  If no value is passed, the refund is processed using the default speed set on the Dashboard.

payment mandatory : object Details of the payment.

amount optional : integer The amount for which the order was created in currency subunits. For example, for an amount of ₹295.00, enter 29500. The same amount will be used for the payment creation. For the partial payment scenario, we will use the amount specified in the payment request object in case.

email mandatory : string Email address of the customer.

contact mandatory : integer Contact number of the customer.

method mandatory : string Name of the payment method (example, netbanking, cards and upi).

card mandatory : object Details of the payment.

number mandatory : integer Details associated with the card.

expiry_month mandatory : string Expiry month for the card in MM format.

name mandatory : string Name of the cardholder.

expiry_year mandatory : string Expiry year for the card in YY format.

cvv mandatory : integer CVV printed on the back of the card.

ip mandatory : string The customer’s IP address.

referrer optional : string Referrer header passed by the client’s browser.

user-agent mandatory : string The User-Agent header of the user’s browser. The default value will be passed by Razorpay if not provided by you.

authentication mandatory : object Details of the authentication method used for the payment.

authentication_channel mandatory : string Specifies the channel through which authentication is performed. In this example, it’s set to browser.

browser mandatory : object Information regarding the customer’s browser. This parameter need not be passed when authentication_channel=app.

java_enabled mandatory : boolean Indicates whether the customer’s browser supports Java. Obtained from the navigator HTML DOM object.

javascript_enabled mandatory : boolean Indicates whether the customer’s browser can execute JavaScript.Obtained from the navigator HTML DOM object.

timezone_offset mandatory : integer Time difference between UTC time and the cardholder’s browser local time. Obtained from the getTimezoneOffset() method applied to the Date object.

color_depth mandatory : integer Obtained from the payer’s browser using the screen.colorDepth HTML DOM property.

screen_width mandatory : integer Total width of the payer’s screen in pixels. Obtained from the screen.width HTML DOM property.

screen_height mandatory : integer Obtained from the navigator HTML DOM object.

Descriptions for the response parameters are present in the Response parameter table.

UPI

Watch Out!

If you are a TPV business accepting UPI payments, you must pass method=upi in two places in this request:

1. At the order level (top-level method field, alongside amount and currency).
2. Inside the payment object (payment.method).

Passing method=upi only inside the payment object is not sufficient. Omitting it from the order level causes an invalid bank code error for long-tail banks. Refer to the TPV S2S UPI Intent Integration guide for details.

The following API will create a payment with UPI as the payment method:

Curl

curl -X POST https://api.razorpay.com/v1/orders \
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-H 'content-type: application/json' \
-d '{
  "amount": 10000,
  "method": "upi",
  "currency": "INR",
  "receipt": "receipt#1",
  "notes": {
    "key1": "value3",
    "key2": "value2"
  },
  "bank_account": {
    "account_number": "765432123456789",
    "name": "Gaurav Kumar",
    "ifsc": "HDFC0000053"
  },
  "payment": {
    "amount": 10000,
    "email": "[e-mail]",
    "contact": "9090909090",
    "method": "upi",
    "upi": {
      "flow": "intent"
    },
    "ip": "192.168.0.103",
    "referer": "http",
    "user_agent": "Mozilla/5.0",
    "description": "Test payment"
  }
}'

Success

 {
   "amount": 10000,
   "amount_due": 10000,
   "amount_paid": 0,
   "attempts": 10,
   "created_at": 1776678201,
   "currency": "INR",
   "entity": "order",
   "id": "order_SfhZHx8tDcfiv4",
   "notes": {
     "key1": "value3",
     "key2": "value2"
   },
   "offer_id": null,
   "payment_workflow": {
     "next": [
       {
         "action": "intent",
         "url": "upi://pay?am=100.00&cu=INR&mc=8241&mode=04&pa=mehulkhandelwal138051.rzp@rxairtel&pn=MEHULKHANDELWAL&tn=UPIrecurringflowTestingforrearch&tr=ShEWfGVXDGRjei"
       },
       {
         "action": "poll",
         "url": "https://api.razorpay.com/v1/payments/pay_ShEWfGVXDGRjei"
       }
     ],
     "razorpay_payment_id": "pay_ShEWfGVXDGRjei"
   },
   "receipt": "receipt#1",
   "status": "attempted"
 }

Request Parameters

amount mandatory : integer The amount for which the order was created in currency subunits. For example, for an amount of ₹295.00, enter 29500. The same amount will be used for the payment creation. For the partial payment scenario, we will use the amount specified in the payment request object in case.

currency mandatory : string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.

method optional : string The payment method for the order. Possible values:

• netbanking
• upi
• card

Watch Out!

If you are a TPV business accepting UPI payments, this field is mandatory. Pass method=upi here in addition to payment.method. Omitting method from the order level causes an invalid bank code error for long-tail banks, even when payment.method is correctly set.

receipt optional : string Receipt number that corresponds to this order. Can have a maximum length of 40 characters and has to be unique.

partial_payment optional : boolean Indicates whether the customer can make a partial payment. Possible values:

• true: The customer can make partial payments.
• false (default): The customer cannot make partial payments.

first_payment_min_amount optional : integer Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of ₹7,000 is to be received from the customer in two installments of #1 - ₹5,000, #2 - ₹2,000, then you can set this value as 500000. This parameter should be passed only if partial_payment is true.

customer_id optional : string Unique identifier of the customer.

transfers optional : json object Details regarding the transfer.

account : string The recipient account ID for fund transfer.

amount optional : string The amount of the transfer.

currency mandatory : string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.

notes optional : json 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".

linked_account_notes optional : string Notes associated with the linked account.

on_hold mandatory : boolean Indicates whether the account settlement for transfer is on hold. Possible values:

• true: Puts the settlement on hold.
• false: Releases the settlement.

on_hold_until mandatory : string Timestamp until which the transfer amount is on hold.

bank_account optional : json object Details of the bank account that the customer provides at the time of registration.

account_number optional : string Account number of the customers bank account.

name optional : string The name associated with the bank account.

ifsc optional : string The IFSC code of the bank.

payment_config optional : array Payment capture settings for the payment. The options sent here override the account level auto-capture settings configured using the Dashboard.

capture mandatory : string Option to automatically capture payment. Possible values:

• automatic: Payments are auto-captured according to the configurations specified in the capture_options array.
• manual: You have to manually capture payments using our Capture API or from the Dashboard.

capture_options optional : array Use this array to determine the expiry period for automatic and manual capture of payments and the refund speed in the case of non-capture.

automatic_expiry_period mandatory if capture = automatic : integer Time in minutes till when payments in the authorized state should be auto-captured. Minimum value 12 minutes. This parameter is mandatory only if the value of capture parameter is automatic.

manual_expiry_period optional : integer Time in minutes till when you can manually capture payments in the authorized state.

• Must be equal to or greater than the automatic_expiry_period value.
• Default value 7200 minutes.
• Maximum value 7200 minutes.
• Payments in the authorized state after the manual_expiry_period are auto-refunded.

refund_speed mandatory : string Refund speed for payments that were not captured (automatically or manually). Possible values:

• optimum: We try to process the refund instantly. We charge a small fee for this. If it is not possible to process an instant refund, we will process a normal refund in 5-7 working days. Learn more about instant refunds.
• normal: The refund is processed in 5-7 working days.
  
  If no value is passed, the refund is processed using the default speed set on the Dashboard.

payment mandatory : object Details of the payment.

amount optional : integer The amount for which the order was created in currency subunits. For example, for an amount of ₹299. The same amount will be used for the payment creation. For the partial payment scenario, we will use the amount specified in the payment request object in case.

email mandatory : string Email address of the customer. The maximum length supported is 40 characters.

contact mandatory : integer Phone number of the customer. The maximum length supported is 15 characters, inclusive of country code.

ip mandatory : string The customer’s IP address.

method mandatory : string Name of the payment method (example, netbanking, cards and upi).

description mandatory : string Description of the payment.

referrer optional : string Referrer header passed by the client’s browser.

upi mandatory : json object Details of the UPI payment received. Only applicable if method is upi.

flow : string The type of UPI flow. Possible value intent.

vpa : string The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi. Required when flow is collect.

user_agent optional : string The User-Agent header of the user’s browser. The default value will be passed by Razorpay if not provided by you.

Descriptions for the response parameters are present in the Response parameter table.

Response Parameters

Response Parameters

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

receipt : string Receipt number that corresponds to this order. Can have a maximum length of 40 characters and has to be unique.

status : string Status of the order. Possible values:

• attempted: An order moves from created to attempted state when a payment is first attempted on it. It remains in the attempted state till one payment associated with that order is captured.
• created: When you create an order it is in the created state. It stays in this state till a payment is attempted on it.
• paid: After the successful capture of the payment, the order moves to the paid state. No further payment requests are permitted once the order moves to the paid state. The order stays in the paid state even if the payment associated with the order is refunded.

id : string The unique identifier of the order.

amount : integer The amount for which the order was created, in currency subunits. For example, for an amount of ₹295.00, enter 29500.

created_at : integer Indicates the Unix timestamp when this order was created.

amount_paid : integer Indicates the amount paid for the order.

amount_due : integer Indicates the amount due for the order.

currency : string The currency in which the transaction was made. See the list of supported currencies. Length must be of 3 characters.

offer_id : string The unique identifier of the created offer.

attempts : string The number of payment attempts, successful and failed, that have been made against this order.

transfers : string Details regarding the transfer.

notes : object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each.

payment_workflow : array Details regarding the payment.

id : string Unique identifier of the payment.

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 endpoint where Razorpay will submit the final payment status.

Watch Out!

After completing the initial step for your preferred payment method mentioned above, follow these common steps given below, applicable for all payment methods.

Watch Out!

The steps given below are common for all payment methods.

1 Handle Payment Success and Error Events

Once a customer completes the payment, a POST request is made to the callback_url provided in the payment request. The data contained in this request will depend on whether the payment was a success or a failure.

Success Callback

If the payment made by the customer is successful, the following fields are sent:

• razorpay_payment_id
• razorpay_order_id
• razorpay_signature

Callback Example

{
  "razorpay_payment_id": "pay_29QQoUBi66xm2f",
  "razorpay_order_id": "order_9A33XWu170gUtm",
  "razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d"
}

Failure Callback

If the payment has failed, the callback will contain details of the error. Refer to Errors for details.

Given below is a sample error code you will receive when the order fails.

Order Create Failure Example

{
   "error": {
   "code": "BAD_REQUEST_ERROR",
   "description": "The amount must be at least INR 1.00",
   "source": "business",
   "step": "order_create",
   "reason": "input_validation_failed",
   "metadata": {},
   "field": "amount"
    }
}

Given below is a sample error code you will receive when the payment fails.

Watch Out!

You can use the order id present in the metadata for additional payment attempts on the order without creating a new one.

Payment Create Failure Example

{
   "error": {
   "code": "BAD_REQUEST_ERROR",
   "description": "Authentication failed due to incorrect OTP",
   "field": null,
   "source": "customer",
   "step": "payment_authentication",
   "reason": "invalid_otp",
   "metadata": {
       "order_id": "order_EKwxwAgItmmXdp"
    }
  }
}

The following error occurs when the order was processed, payment was created in Razorpay but failed at gateway level.

Gateway Processing Error Example

    
{
   "error": {
   "code": "GATEWAY_ERROR",
   "description": "Authentication failed due to incorrect OTP",
   "field": null,
   "source": "customer",
   "step": "payment_authentication",
   "reason": "gateway failure",
   "metadata": {
   "order_id": "order_EKwxwAgItmmXdp",
   "payment_id": "pay_TKwxwAgItmmXdp"
    }
  }
}

2 Retry/Re-Attempt Request

Use the following sample code example to make a retry request using Order id and Receipt in the request.

Order ID in request

 curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
 -X POST https://api.razorpay.com/v1/orders \
 -H "Content-Type: application/json" \
 -d{
  "id": "order_EKwxwAgItmmXdp",
  "payment": {
    "amount": 100,
    "currency": "INR",
    "method": "card",
    "card": {
      "number": "<cardNumber>",
      "name": "<name>",
      "expiry_month": "11",
      "expiry_year": "30",
      "cvv": "100"
    },
    "notes": {
      "key1": "value3",
      "key2": "value2"
    }
  }
 }

Success

 {
  "id": "order_EKwxwAgItmmXdp",
  "status": "attempted",
  "receipt": "receipt#1",
  "notes": {
    "key1": "value3",
    "key2": "value2"
  },
  "created_at": 1582628071,
  "amount": 50000,
  "amount_paid": 0,
  "amount_due": 50000,
  "currency": "INR",
  "offer_id": null,
  "attempts": 1,
  "transfers": [],
  "payment_workflow": {
    "id": "pay_FVmAstJWfsD3SO",
    "next": [
      {
        "action": "redirect",
        "url": "https://api.razorpay.com/v1/payments/pay_FVmAstJWfsD3SO/authorize"
      },
      {
        "action": "otp_generate",
        "url": "https://api.razorpay.com/v1/payments/pay_FVmAstJWfsD3SO/otp_generate?track_id=FVmAtLUe9XZSGM&key_id=<YOUR_KEY_ID>"
      }
    ]
  }
 }

3 Verify Payment Signature

Signature verification is a mandatory step to ensure that the callback is sent by Razorpay. The razorpay_signature contained in the callback can be regenerated by your system and verified as follows.

Create a string to be hashed using the razorpay_payment_id contained in the callback and the Order ID generated in the first step, separated by a |. Hash this string using SHA256 and your API Secret.

generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);

if (generated_signature == razorpay_signature) {
    payment is successful
}

Generate Signature on your Server

Java

/**
* This class defines common routines for generating
* authentication signatures for Razorpay Webhook requests.
*/
public class Signature
{
    private static final String HMAC_SHA256_ALGORITHM = "HmacSHA256";
    /**
    * Computes RFC 2104-compliant HMAC signature.
    * * @param data
    * The data to be signed.
    * @param key
    * The signing key.
    * @return
    * The Base64-encoded RFC 2104-compliant HMAC signature.
    * @throws
    * java.security.SignatureException when signature generation fails
    */
    public static String calculateRFC2104HMAC(String data, String secret)
    throws java.security.SignatureException
    {
        String result;
        try {

            // get an hmac_sha256 key from the raw secret bytes
            SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(), HMAC_SHA256_ALGORITHM);

            // get an hmac_sha256 Mac instance and initialize with the signing key
            Mac mac = Mac.getInstance(HMAC_SHA256_ALGORITHM);
            mac.init(signingKey);

            // compute the hmac on input data bytes
            byte[] rawHmac = mac.doFinal(data.getBytes());

            // base64-encode the hmac
            result = DatatypeConverter.printHexBinary(rawHmac).toLowerCase();

        } catch (Exception e) {
            throw new SignatureException("Failed to generate HMAC : " + e.getMessage());
        }
        return result;
    }
}

4 Integrate Payments Rainy Day Kit

Use Payments Rainy Day kit to overcome payments exceptions such as:

• Late Authorisation
• Payment Downtime
• Payment Errors

5 Verify Payment Status

Handy Tips

On the Razorpay Dashboard, ensure that the payment status is captured. Refer to the payment capture settings page to know how to capture payments automatically.

You can track the payment status in three ways:

Verify Status from Dashboard

To verify the payment status from the Razorpay Dashboard:

1. Log in to the Razorpay Dashboard and navigate to Transactions → Payments.
2. Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.

Subscribe to Webhook Events

You can use Razorpay webhooks to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook’s configured URL. Know how to set up webhooks.

Example

If you have subscribed to the order.paid webhook event, you will receive a notification every time a customer pays you for an order.

Poll APIs

Poll Payment APIs to check the payment status.

Next Steps

Step 2: Test Integration