FPX
Steps to integrate S2S JSON API and accept payments using FPX.
Financial Process Exchange (FPX) is an online banking payment method that allows end users to pay money directly from their bank account for all online transactions.
Follow the steps below to Curlec S2S JSON API and accept payments using FPX.
1.1
1.2
1.3
1.4
1.5
1.6
The first step is identifying and getting the list of banks with their respective codes to integrate correctly. Curlec uses its bank codes to correctly identify a bank entity in the system.
Handy Tips
FPX transactions are of two categories: B2B and B2C. We follow a nomenclature of suffixing _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:
To process a payment, create a 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 . 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": 100,"currency": "MYR","receipt": "qwsaq1","partial_payment": true,"first_payment_min_amount": 230,"notes": {"key1": "value3","key2": "value2"}}'
amount
mandatory
integer
The amount to be paid by the customer in sen. For example, if the amount is MYR 500.00, enter 50000
.
currency
mandatory
string
The currency in which the payment should be made by the customer. Length must be of 3 characters.
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 - MYR 5,000.00, #2 - MYR 2,000.00 then you can set this value as 500000
. This parameter should be passed only if partial_payment
is true
.
Know more about
.Descriptions for the response parameters are present in the
parameters table.The error response parameters are available in the
.Once an order is created, your next step is to create a payment. The following API will create a payment with fpx
as the payment method:
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \-X POST https://api.razorpay.com/v1/payments/create/json \-H "content-type: application/json" \-d '{"amount": 200,"currency": "MYR","order_id": "order_LSA6ny1sGKAp0C","email": "nur.aisyah@example.com","contact": "+60123456789","method": "fpx","bank": "MB2U","callback_url": "https://merchant_callback_url.."}'
The payment request for each of the supported payment methods will slightly vary. Know more about the
.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.
Once the payment is completed by the customer, a POST
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.
If the payment made by the customer is successful, the following fields are sent:
razorpay_payment_id
razorpay_order_id
razorpay_signature
{"razorpay_payment_id": "pay_LUtJxInEqa0oAA&","razorpay_order_id": "order_LUtJ52zWwapfqs&","razorpay_signature": "e617a6c035cb39feb6cd16358d83a4e3d30b11d9e8e2181e6ef442da1d41df20"}
If the payment has failed, the callback will contain details of the error. Refer to
for details.Use Payments Rainy Day kit to overcome payments exceptions such as:
After receiving the razorpay_payment_id
through the merchant callback_url
, use this endpoint to fetch the payment details:
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.
Is this integration guide useful?