You can install Razorpay using Maven or Gradle.
1. Build Integration
Steps to integrate Curlec Payment Gateway with Java SDK.
Follow the steps given below to integrate Curlec Payment Gateway with your Java website. The integration process is explained using the Java sample app, which contains the following files:
File Name | Purpose |
---|---|
index.jsp | Contains the checkout code. |
OrderCreation.java | Contains the Orders API code. |
Handy Tips
- The amount must always be in currency subunits.
- The time is represented as Unix timestamp, which can be obtained using the
Utils.ToUnixTimestamp
method.
To integrate Curlec Payment Gateway with Java SDK:
1.1
1.2
1.3
1.4
1.5
1.6
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 the following code to create an order:
Here is the list of parameters and their description for creating an order:
amount
mandatory
integer
The transaction amount, expressed in the currency's subunit. For example, for an actual amount of RM 299.35, the value of this field should be 29935
.
currency
mandatory
string
The currency in which the transaction should be made. Currency length must be 3 characters long.
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
: Yes, the customer can make partial payments.false
(default): No, the customer cannot make partial payments.
Know more about
.The error response parameters are available in the
.Add the Curlec Checkout options to your project. For example, if you are using HTML for your frontend, create a page called index.jsp and add the Pay button on your web page using the checkout code and the:
- Callback URL.
- Handler Function.
Callback URL | Handler Function |
---|---|
When you use this:
| When you use this:
|
Handy Tips
For FPX payments, you must use the Callback URL sample code for checkout. You should send the following parameters along with the other checkout parameters:
callback_url
with the URL to which customers should be redirected after payment completion.redirect
with the value astrue
.
Handy Tips
If case you want to use this as your final code, follow the steps given below:
- Edit the
[KEY_ID]
inside index.ftl. Use the test keys while testing your application. Know how to . - Edit the
[KEY_ID]
and[KEY_SECRET]
in server.yml.
key
mandatory
string
API Key ID generated from the Curlec Dashboard.
amount
mandatory
integer
The amount to be paid by the customer in currency subunits. For example, if the amount is RM 500.00, enter 50000
.
currency
mandatory
string
The currency in which the payment should be made by the customer.
name
mandatory
string
The business name shown on the Checkout form. For example, Acme Corp.
description
optional
string
Description of the purchase item shown on the Checkout form. It should start with an alphanumeric character.
image
optional
string
Link to an image (usually your business logo) shown on the Checkout form. Can also be a base64 string if you are not loading the image from a network.
order_id
mandatory
string
Order ID generated via
prefill
object
You can prefill the following details at Checkout.
Boost Conversions and Minimise Drop-offs
- Autofill customer contact details, especially phone number to ease form completion. Include customer’s phone number in the
contact
parameter of the JSON request'sprefill
object. Format: +(country code)(phone number). Example: “contact": "+919000090000"). - This is not applicable if you do not collect customer contact details on your website before checkout, have Shopify stores or use any of the no-code apps.
name
optional
string
Cardholder's name to be pre-filled if customer is to make card payments on Checkout. For example, Siti Aisyah.
optional
string
Email address of the customer.
contact
optional
string
Phone number of the customer. The expected format of the phone number is + {country code}{phone number}
. If the country code is not specified, 60
will be used as the default value. This is particularly important while prefilling contact
of customers with phone numbers issued outside Malaysia. Examples:
- +14155552671 (a valid non-Malaysian number)
- +601113455567 (a valid Malaysian number).
If 1113455567 is entered without the country code,+60
is added to it as +601113455567.
method
optional
string
Pre-selection of the payment method for the customer. Will only work if contact
and email
are also pre-filled.
Possible value is card
.
notes
optional
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).
theme
object
Thematic options to modify the appearance of Checkout.
hide_topbar
optional
boolean
Used to display or hide the top bar on the Checkout form. This bar shows the selected payment method, phone number and gives the customer the option to navigate back to the start of the Checkout form. Possible values:
true
: Hides the top barfalse
(default): Displays the top bar.
color
optional
string
Enter your brand colour's HEX code to alter the text, payment method icons and CTA (call-to-action) button colour of the Checkout form.
backdrop_color
optional
string
Enter a HEX code to change the Checkout's backdrop colour.
modal
object
Options to handle the Checkout modal.
backdropclose
optional
boolean
Indicates whether clicking the translucent blank space outside the Checkout form should close the form. Possible values:
true
: Closes the form when your customer clicks outside the checkout form.false
(default): Does not close the form when customer clicks outside the checkout form.
escape
optional
boolean
Indicates whether pressing the escape key should close the Checkout form. Possible values:
true
(default): Closes the form when the customer presses the escape key.false
: Does not close the form when the customer presses the escape key.
handleback
optional
boolean
Determines whether Checkout must behave similar to the browser when back button is pressed. Possible values:
true
(default): Checkout behaves similarly to the browser. That is, when the browser's back button is pressed, the Checkout also simulates a back press. This happens as long as the Checkout modal is open.false
: Checkout does not simulate a back press when browser's back button is pressed.
confirm_close
optional
boolean
Determines whether a confirmation dialog box should be shown if customers attempts to close Checkout. Possible values:
true
: Confirmation dialog box is shown.false
(default): Confirmation dialog box is not shown.
ondismiss
optional
function
Used to track the status of Checkout. You can pass a modal object with ondismiss: function()\{\}
as options. This function is called when the modal is closed by the user.
animation
optional
boolean
Shows an animation before loading of Checkout. Possible values:
true
(default): Animation appears.false
: Animation does not appear.
callback_url
optional
string
Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is allowlisted. This parameter is mandatory for FPX payments.
redirect
optional
boolean
Determines whether to post a response to the event handler post payment completion or redirect to Callback URL. callback_url
and redirect
parameters are mandatory for FPX payments. Possible values:
true
: Customer is redirected to the specified callback URL in case of payment failure. For FPX payments, theredirect
parameter should always be sent astrue
.false
(default): Customer is shown the Checkout popup to retry the payment.
customer_id
optional
string
Unique identifier of customer.
remember_customer
optional
boolean
Determines whether to allow saving of cards. Can also be configured via the
true
: Enables card saving feature.false
(default): Disables card saving feature.
timeout
optional
integer
Sets a timeout on Checkout, in seconds. After the specified time limit, the customer will not be able to use Checkout.
readonly
object
Marks fields as read-only.
contact
optional
boolean
Used to set the contact
field as readonly. Possible values:
true
: Customer will not be able to edit this field.false
(default): Customer will be able to edit this field.
optional
boolean
Used to set the email
field as readonly. Possible values:
true
: Customer will not be able to edit this field.false
(default): Customer will be able to edit this field.
name
optional
boolean
Used to set the name
field as readonly. Possible values:
true
: Customer will not be able to edit this field.false
(default): Customer will be able to edit this field.
hidden
object
Hides the contact details.
contact
optional
boolean
Used to set the contact
field as optional. Possible values:
true
: Customer will not be able to view this field.false
(default): Customer will be able to view this field.
optional
boolean
Used to set the email
field as optional. Possible values:
true
: Customer will not be able to view this field.false
(default): Customer will be able to view this field.
allow_rotation
optional
boolean
Used to rotate payment page as per screen orientation. Applicable from Android SDK version 1.6.4 and above. Possible values:
true
: Payment page can be rotated.false
(default): Payment page cannot be rotated.
retry
optional
object
Parameters that enable retry of payment on the checkout.
enabled
boolean
Determines whether the customers can retry payments on the checkout. Possible values:
true
(default): Enables customers to retry payments.false
: Disables customers from retrying the payment.
max_count
integer
The number of times the customer can retry the payment. We recommend you to set this to 4. Having a larger number here can cause loops to occur.
Watch Out!
Web Integration does not support the max_count
parameter. It is applicable only in Android and iOS SDKs.
config
optional
object
Parameters that enable configuration of checkout display language.
display
object
Child parameter that enables configuration of checkout display language.
language
string
The language in which checkout should be displayed. Possible value is en
: English.
Handy Tips
The open method of the Razorpay object (rzp1.open()
) must be invoked by your site's JavaScript, which may or may not be a user-driven action such as a click.
Multiple payment methods are available on Curlec Standard Checkout.
- The payment methods are fixed and cannot be changed.
- You can configure the order or make certain payment methods prominent. Know more about .
The way the Payment Success and Failure scenarios are handled depends on the
you used in the last step.If you used the sample code with the callback URL:
If you used the sample code with the handler function:
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 that allows you to confirm the authenticity of the details returned to the checkout for successful payments.
To verify the razorpay_signature
returned to you by the checkout:
-
Create a signature in your server using the following attributes:
Attribute Description order_id
Retrieve the order_id
from your server. Do not use therazorpay_order_id
returned by checkout.razorpay_payment_id
Returned during checkout. key_secret
Available in your server. The key_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, the payment received is from an authentic source.
Use the code given below to generate signature on your server:
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);
You can track the payment status in three ways:
- .
- .
- .
Handy Tips
- On the Dashboard, ensure that the payment status is
captured
. Refer to the payment capture settings page to know how to . - Subscribe to our webhooks or poll the Fetch a Payment API to track the payment status.
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.
You can use Curlec 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
If you have subscribed to the order.paid
webhook event, you will receive a notification every time a customer pays you for an order.
to check the payment status.
Is this integration guide useful?
ON THIS PAGE