Integration Steps
Follow the steps below to Razorpay Curlec S2S JSON API and accept payments using FPX. 1.1 Generate List of Banks Supporting FPX 1.2 Create an Order 1.3 Create a Payment 1.4 Handle Payment Success and Error Events 1.5 Integrate Payments Rainy Day Kit 1.6 Fetch Payment Details and Verify Payment Status1.1 Generate the List of Banks Supporting FPX
The first step is identifying and getting the list of banks with their respective codes to integrate correctly. Razorpay Curlec uses its bank codes to correctly identify a bank entity in the system.Handy Tips
_C as a parameter if the transaction is of a corporate type.
Use this endpoint to get the list of Banks and their respective codes:
Request
1.2 Create an Order
To process a payment, create a Razorpay Curlec 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.
Request Parameters
amount mandatory
: integer Payment amount in the smallest currency subunit. For example, if the amount to be charged is 299, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to accept a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to accept a payment of 295, pass the value as 295.
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 withfpx as the payment method:
/payments/create/json
Request
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 Integrate Payments Rainy Day Kit
Use Payments Rainy Day kit to overcome payments exceptions such as:1.6 Fetch Payment Details and Verify Payment Status
After receiving therazorpay_payment_id through the callback_url, use this endpoint to fetch the payment details:
Request
Handy Tips
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.