Integration Steps
Follow the steps below to integrate S2S JSON API and accept payments using Wallet. 1.1 Generate List of Wallets Supported. 1.2 Create an Order. 1.3 Create a Payment. 1.4 Handle Payment Success and Error Events. 1.5 Fetch the Payment Details and Status. 1.6 Verify Payment Signature. 1.7 Integrate Payments Rainy Day Kit. 1.8 Verify Payment Status.1.1 Generate the List of Wallets Supported
The first step to identify and get the list of wallets enabled in your Razorpay account with their respective codes to integrate correctly. Razorpay uses its own wallet codes to identify the right wallet instrument entity in the system correctly. To get the list of wallets and their respective codes, use the following API code:Request
1.2 Create an Order
To process a payment, create a Razorpay Order to correspond with the order in your system. Send the order request parameters to the following endpoint: 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. Know how to authenticate Orders API.
- The
order_idreceived in the response should be passed to the checkout. This ties the order with the payment and secures the request from being tampered.
API Sample Code
Use this endpoint to create an order using the Orders API. /ordersCurl
Request Parameters
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 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 7000 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 500000. This parameter should be passed only if partial_payment is true.
Response Parameters
Descriptions for the response parameters are present in the Orders Entity parameters table.Error Response Parameters
The error response parameters are available in the API Reference Guide.1.3 Create a Payment
Once an order is created, your next step is to create a payment. The following API will create a payment withwallet as the payment method:
/payments/create/json
Curl
Request Parameters
The payment request for each of the supported payment methods will slightly vary. Know more about the relevant payment request fields.Response Parameters
If the payment request is valid, the response contains the following fields.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:
redirect: Use this URL to redirect customer to submit the OTP on the bank page.
url
: string URL to be used for the action indicated.
The Payment API will return the payment id along with the authentication URL to which the user has to be redirected. You may choose to store the Payment id on your server to help us enquire about the status and other accounting purposes if required.
You may now choose to redirect the user to the authentication URL that you have received in the response.
1.4 Handle Payment Success and Error Events
Once the payment is completed by the customer, aPOST 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_idrazorpay_order_idrazorpay_signature
Callback Example
Failure Callback
If the payment has failed, the callback will contain details of the error. Refer to Errors for details.1.5 Fetch Payment Details and Status
After receiving therazorpay_payment_id through the merchant callback_url, use this to fetch the payment details to check the status of the payment by using the following code:
Request
1.6 Verify Payment Signature
Signature verification is a mandatory step to ensure that Razorpay Curlec sends the callback. Therazorpay_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.
1.7 Integrate Payments Rainy Day Kit
Use Payments Rainy Day kit to overcome payments exceptions such as:1.8 Verify Payment Status
Handy TipsOn 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:
To verify the payment status from the Razorpay Dashboard:- Log in to the Razorpay Dashboard 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.
Example
If you have subscribed to theorder.paid webhook event, you will receive a notification every time a customer pays you for an order.
Poll Payment APIs to check the payment status.