Order is an important step in the payment process.
An order should be created for every payment.
You can create an order using the Orders API. It is a server-side API call.
The order_id received in the response should be passed to the checkout. This ties the Order with the payment and secures the request from being tampered.
Copy$order = $client->order->create([
'receipt' => 'order_rcptid_11',
'amount' => 50000, // amount in the smallest currency unit'currency' => 'INR'// <a href="/docs/international-payments/#supported-currencies" target="_blank">See the list of supported currencies</a>.)
]);
CopyDictionary<string, object> options = new Dictionary<string,object>();
options.Add("amount", 50000); // amount in the smallest currency unit
options.add("receipt", "order_rcptid_11");
options.add("currency", "INR");
Order order = client.Order.Create(options);
Copyoptions = amount:50000, currency:'INR', receipt:'<order_rcptid_11>'
order = Razorpay::Order.create
Here is the list of parameters and their description for creating an order:
amountmandatory
integer The transaction amount, expressed in the currency subunit, such as paise (in case of INR). For example, for an actual amount of ₹299.35, the value of this field should be 29935.
currencymandatory
string The currency in which the transaction should be made. See the list of supported currencies. Length must be 3 characters.
receiptoptional
string Your receipt id for this order should be passed here. Maximum length 40 characters.
notesoptional
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”.
partial_paymentoptional
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.
When creating a custom checkout form, display only the activated methods to the customer. Use the below methods to fetch all payments methods available to you:
Copyvar razorpay = newRazorpay({
key: '<YOUR_KEY_ID>',
// logo, displayed in the popupimage: 'https://i.imgur.com/n5tjHFD.png',
});
razorpay.once('ready', function(response) {
console.log(response.methods);
})
Include the script from https://checkout.razorpay.com/v1/razorpay.js instead of serving a copy from your server. This allows the library's new updates and bug fixes to fit your application automatically.
We always maintain backward compatibility with our code.
If you need multiple razorpay instances on the same page, you can globally set some of the options:
CopyRazorpay.configure({
key: '<YOUR_KEY_ID>',
// logo, displayed in the payment processing popupimage: 'https://i.imgur.com/n5tjHFD.png',
})
newRazorpay({}); // will inherit key and image from above.
While building a custom UI for accepting payments from your customers, you should be familiar with the fields supported in the razorpay.js script.
keymandatory
string API Key ID generated from Razorpay Dashboard → Settings → API Keys.
amountmandatory
integer The amount to be paid by the customer in currency subunits. For example, if the amount is ₹100, enter 10000.
currencymandatory
string The currency in which the payment should be made by the customer. See the list of supported currencies.
namemandatory
string The business name shown in the Checkout form.
descriptionoptional
string Description of the purchase item shown in the Checkout form. It must start with an alphanumeric character.
imageoptional
string Link to an image (usually your business logo) shown in the Checkout form. Can also be a base64 string, if loading the image from a network is not desirable.
object Set of key-value pairs that can be used to store additional information about the payment. It can hold a maximum of 15 key-value pairs, each 256 characters long (maximum).
methodmandatory
string The payment method used by the customer on Checkout. Possible values:
string UPI ID used for making the payment on the UPI app.
callback_urloptional
string The URL to which the customer must be redirected upon completion of payment. The URL must accept incoming POST requests. The callback URL will have razorpay_payment_id, razorpay_order_id and razorpay_signature as the request parameters for a successful payment.
redirectconditionally mandatory
boolean Determines whether customer should be redirected to the URL mentioned in the
callback_url parameter. This is mandatory if callback_url parameter is used. Possible values:
true: Customer will be redirected to the callback_url.
false: Customer will not be redirected to the callback_url
After creating an order and obtaining the customer's payment details, send the information to Razorpay to complete the payment. The data that needs to be submitted depends on the customer's payment method. You can do this by invoking createPayment method.
Copyvar data = {
amount: 1000, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10currency: "INR",// Default is INR. We support more than 90 currencies.email: 'gaurav.kumar@example.com',
contact: '9123456780',
notes: {
address: 'Ground Floor, SJR Cyber, Laskar Hosur Road, Bengaluru',
},
order_id: 'order_CuEzONfnOI86Ab',// Replace with Order ID generated in Step 4method: 'netbanking',
// method specific fieldsbank: 'HDFC'
};
var btn = document.querySelector('#btn');
btn.addEventListener('click', function(){
// has to be placed within user initiated context, such as click, in order for popup to open.
razorpay.createPayment(data);
razorpay.on('payment.success', function(resp) {
alert(resp.razorpay_payment_id),
alert(resp.razorpay_order_id),
alert(resp.razorpay_signature)}); // will pass payment ID, order ID, and Razorpay signature to success handler.
razorpay.on('payment.error', function(resp){alert(resp.error.description)}); // will pass error object to error handler
})
Copyvar data = {
callback_url: 'https://www.examplecallbackurl.com/',
amount: 1000, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10currency: "INR",// Default is INR. We support more than 90 currencies.email: 'gaurav.kumar@example.com',
contact: '9123456780',
notes: {
address: 'Ground Floor, SJR Cyber, Laskar Hosur Road, Bengaluru',
},
order_id: 'order_CuEzONfnOI86Ab',// Replace with Order ID generated in Step 4method: 'netbanking',
// method specific fieldsbank: 'HDFC'
};
var btn = document.querySelector('#btn');
btn.addEventListener('click', function(){
// has to be placed within user initiated context, such as click, in order for popup to open.
razorpay.createPayment(data);
})
Watch Out!
The createPayment method should be called within an event listener triggered by user action to prevent the popup from being blocked. For example:
js $('button').click( function (){ razorpay.createPayment(...) })
Handy Tips
Handler Function When you use the handler function, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Checkout Form. You need to collect these and send them to your server.
Callback URL When you use a callback URL, Razorpay makes a post call to the callback URL, with the razorpay_payment_id, razorpay_order_id and razorpay_signature in the response object of the successful payment (razorpay_payment_id, razorpay_order_id.
string Unique identifier for the payment returned by Checkout only for successful payments.
razorpay_order_id
string Unique identifier for the order returned by Checkout.
razorpay_signature
string Signature returned by the Checkout. This is used to verify the payment.
A failed payment returns an error response.
Copy{"error":{"code":"BAD_REQUEST_ERROR","description":"Authentication failed due to incorrect otp","field":null,"source":"customer","step":"payment_authentication","reason":"invalid_otp","metadata":{"payment_id":"pay_EDNBKIP31Y4jl8","order_id":"order_DBJKIP31Y4jl8"}}}
This is a mandatory step to confirm the authenticity of the details returned to the Checkout form for successful payments.
To verify the razorpay_signature returned to you by the Checkout form:
Create a signature in your server using the following attributes:
order_id: Retrieve the order_id from your server. Do not use the razorpay_order_id returned by Checkout.
razorpay_payment_id: Returned by Checkout.
key_secret: Available in your server. The key_secret that was generated from the Razorpay Dashboard.
Use the SHA256 algorithm, the razorpay_payment_id and the order_id to construct a HMAC hex digest as shown below:
Copygenerated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);
if (generated_signature == razorpay_signature) {
payment is successful
}
If the signature you generate on your server matches the razorpay_signature returned to you by the Checkout form, the payment received is from an authentic source.
Given below are the sample codes for payment signature verification.
Copy/**
* This class defines common routines for generating
* authentication signatures for Razorpay Webhook requests.
*/publicclassSignature
{
privatestaticfinalStringHMAC_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
*/publicstatic String calculateRFC2104HMAC(String data, String secret)throws java.security.SignatureException
{
String result;
try {
// get an hmac_sha256 key from the raw secret bytesSecretKeySpecsigningKey=newSecretKeySpec(secret.getBytes(), HMAC_SHA256_ALGORITHM);
// get an hmac_sha256 Mac instance and initialize with the signing keyMacmac= Mac.getInstance(HMAC_SHA256_ALGORITHM);
mac.init(signingKey);
// compute the hmac on input data bytesbyte[] rawHmac = mac.doFinal(data.getBytes());
// base64-encode the hmac
result = DatatypeConverter.printHexBinary(rawHmac).toLowerCase();
} catch (Exception e) {
thrownewSignatureException("Failed to generate HMAC : " + e.getMessage());
}
return result;
}
}
Copyimport (
"crypto/hmac""crypto/sha256""crypto/subtle""encoding/hex""fmt"
)
funcmain() {
signature := "477d1cdb3f8122a7b0963704b9bcbf294f65a03841a5f1d7a4f3ed8cd1810f9b"
secret := "qp3zKxwLZxbMORJgEVWi3Gou"
data := "order_J2AeF1ZpvfqRGH|pay_J2AfAxNHgqqBiI"//fmt.Printf("Secret: %s Data: %s\n", secret, data)// Create a new HMAC by defining the hash type and the key (as byte array)
h := hmac.New(sha256.New, []byte(secret))
// Write Data to it
_, err := h.Write([]byte(data))
if err != nil {
panic(err)
}
// Get result and encode as hexadecimal string
sha := hex.EncodeToString(h.Sum(nil))
fmt.Printf("Result: %s\n", sha)
if subtle.ConstantTimeCompare([]byte(sha), []byte(signature)) == 1 {
fmt.Println("Works")
}
}
After you have successfully completed the integration, you can set up webhooks, make test payments, replace test key with live key and integrate with other APIs.
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.
