Integration Steps
Steps to integrate with Razorpay Hosted Web Integration.
Follow these steps to integrate the standard checkout form on your website:
- : Use the sample codes to integrate the Curlec Hosted Integration on your website.
- : Make a test payment using the payment methods configured at checkout to ensure the integration is working as expected.
- : Check the go-live checklist before taking the integration live.
Follow the steps given below:
Order is an important step in the payment process.
- An order should be created for every payment.
- You can create an order using the . It is a server-side API call. Know how to Orders API.
- 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.
Use this endpoint to create an order using the Orders API.
curl -X POST https://api.razorpay.com/v1/orders-U [YOUR_KEY_ID]:[YOUR_KEY_SECRET]-H 'content-type:application/json'-d '{"amount": 5000,"currency": "MYR","receipt": "qwsaq1","partial_payment": true,"first_payment_min_amount": 230}'
{"id": "order_IluGWxBm9U8zJ8","entity": "order","amount": 5000,"amount_paid": 0,"amount_due": 5000,"currency": "MYR","receipt": "rcptid_11","offer_id": null,"status": "created","attempts": 0,"notes": [],"created_at": 1642662092}
amount
mandatory
integer
The transaction amount, expressed in the currency subunit, such as Ringgit (in case of MY). For example, for an actual amount of MYR 299.35 , the value of this field should be 29935
.
currency
mandatory
string
The currency in which the transaction should be made. Length must be of 3 characters. For example, MYR
.
receipt
optional
string
Your receipt id for this order should be passed here. Maximum length is 40 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”
.
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 MYR 7,000.00 is to be received from the customer in two installments of #1 - RM 5,000, #2 - RM 2,000, then you can set this value as 5000
. This parameter should be passed only if partial_payment
is true
.
Descriptions for the response parameters are present in the
parameters table.The error response parameters are available in the
.Add the Pay button on your web page using the checkout code given below. The hosted checkout page is displayed when the customers click the Pay button.
The Checkout options are sent as form-data to the following URL in a POST request.
POST: https://api.razorpay.com/v1/checkout/embedded
- For every successful payment,
razorpay_payment_id
,razorpay_order_id
andrazorpay_signature
are submitted via a POST request to thecallback_url
passed in payment options. - If your customer cancels the transaction or clicks the back button, they are redirected to the
cancel_url
via a GET request. - If the payment fails, a POST request is made to the
callback_url
, with the error fields as payload.
key_id
mandatory
string
Enter [YOUR_Key_ID] generated from the
name
mandatory
string
The business name to be shown in the checkout form.
description
optional
string
Description of the item purchased shown in the checkout form.
image
optional
string
URL of the logo that must appear on the checkout form.
order_id
mandatory
string
Unique identifier of the Order, created using the Orders API.
amount
mandatory
integer
Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is MYR 299.00, then pass 29900
in this field.
currency
mandatory
string
Currency code for the currency in which you want to accept the payment. For example, MYR
.
method
optional
string
Use this parameter to show a specific payment method in Checkout. Possible values:
card
fpx
wallet
prefill
The fields that can be pre-populated in the Checkout form.
name
optional
string
Name of the cardholder.
mandatory
string
Email address of the customer.
contact
mandatory
string
Customer's phone number.
notes
optional
object
An additional set of fields that you want to associate with the payment. For example, you can add "shipping address" and "alternate contact" in the Notes field. You can specify up to 15 note fields.
Shipping address
string
106, Razorpay, Bangalore
Alternate contact
string
9000090000
callback_url
mandatory
string
Page to which the customers are redirected to after a successful payment. razorpay_payment_id
, razorpay_order_id
and razorpay_signature
are sent as form-data through a POST
request to the callback_url
.
cancel_url
optional
string
The URL customers are redirected to after the cancellation of a payment.
A successful payment returns the following fields to the Checkout form.
- You need to store these fields in your server.
- You can confirm the authenticity of these details by verifying the signature in the next step.
razorpay_payment_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.
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 theorder_id
from your server. Do not use therazorpay_order_id
returned by Checkout.razorpay_payment_id
: Returned by Checkout.key_secret
: Available in your server. Thekey_secret
that was generated from the .
-
Use the SHA256 algorithm, the
razorpay_payment_id
and theorder_id
to construct a HMAC hex digest as shown below:generated_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 is the sample code for payment signature verification:
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");String secret = "EnLs21M47BllR3X8PSFtjtbd";JSONObject options = new JSONObject();options.put("razorpay_order_id", "order_IEIaMR65cu6nz3");options.put("razorpay_payment_id", "pay_IH4NVgf4Dreq1l");options.put("razorpay_signature", "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f");boolean status = Utils.verifyPaymentSignature(options, secret);
After you have completed the integration, you can
, make test payments, replace the test key with the live key and integrate with other .Here are the links to our
for the supported platforms.Handy Tips
On the Dashboard, ensure that the payment status is captured
. Refer to the payment capture settings page to know how to
You can track the payment status in three ways:
To verify the payment status from the Dashboard:
- Log in to the and navigate to Transactions → Payments.
- Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.
After the integration is complete, a Pay button appears on your webpage/app.
Click the button and make a test transaction to ensure the integration is working as expected. You can start accepting actual payments from your customers once the test transaction is successful.
You can make test payments using one of the payment methods configured at the Checkout.
Watch Out!
This is a mock payment page that uses your test API keys, test card and payment details.
- Ensure you have entered only your in the Checkout code.
- No real money is deducted due to the usage of test API keys. This is a simulated transaction.
Following are all the payment modes that the customer can use to complete the payment on the Checkout.
Following are the payment methods supported as configured at Curlec Checkout.
You can select any of the listed banks. After choosing a bank, Curlec will redirect to a mock page where you can make the payment a success
or a failure
. Since this is Test Mode, we will not redirect you to the bank login portals.
You can select any of the listed wallets. After choosing a wallet, you will be redirected to a mock page where you can make the payment success
or a failure
. Since this is Test Mode, we will not redirect you to the wallet login portals.
We support
wallet.Watch Out!
iOS integration for Touch'n Go wallet is currently unavailable. We will be adding support for it soon.
You can use one of the following test cards to test transactions for your integration in Test Mode.
- Use any valid expiration date in the future in the MM/YY format.
- Use any random CVV to create a successful payment.
Check the list of
.Check the go-live checklist for Curlec Web Standard Checkout integration. Consider these steps before taking the integration live.
You can perform an end-to-end simulation of funds flow in the Test Mode. Once confident that the integration is working as expected, switch to the Live Mode and start accepting payments from customers.
Watch Out!
Ensure you are switching your test API keys with API keys generated in Live Mode.
To generate API Keys in Live Mode on your Curlec Dashboard:
- Log in to the and switch to Live Mode on the menu.
- Navigate to Account & Settings → API Keys → Generate Key to generate the API Key for Live Mode.
- Download the keys and save them securely.
- Replace the Test API Key with the Live Key in the Checkout code and start accepting actual payments.
After payment is authorized
, you need to capture it to settle the amount to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time.
Watch Out
- You should deliver the products or services to your customers only after the payment is captured. Curlec automatically refunds all the uncaptured payments.
- You can track the payment status using our or webhooks.
- Auto-capture payments (recommended)
Authorized payments can be automatically captured. You can auto-capture all payments on the Curlec Dashboard.
Watch Out!
Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the
.- Manually capture payments
Each authorized payment can also be captured individually. You can manually capture payments using:
Know more about
.Ensure you have
in the live mode and configured the events for which you want to receive notifications.Is this integration guide useful?