String paymentId = "pay_G8VQzjPLoAvm6D";
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("amount", 1000);
paymentRequest.put("currency", "INR");
Payment payment = instance.payments.capture(paymentId, paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | string | Id of the payment to capture |
amount* | integer | The amount to be captured (should be equal to the authorized amount, in paise) |
currency | string | The currency of the payment (defaults to INR) |
Response:
{
"id": "pay_G8VQzjPLoAvm6D",
"entity": "payment",
"amount": 1000,
"currency": "INR",
"status": "captured",
"order_id": "order_G8VPOayFxWEU28",
"invoice_id": null,
"international": false,
"method": "upi",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": "Purchase Shoes",
"card_id": null,
"bank": null,
"wallet": null,
"vpa": "gaurav.kumar@exampleupi",
"email": "[email protected]",
"contact": "+919999999999",
"customer_id": "cust_DitrYCFtCIokBO",
"notes": [],
"fee": 24,
"tax": 4,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"acquirer_data": {
"rrn": "033814379298"
},
"created_at": 1606985209
}
JSONObject params = new JSONObject();
params.put("count","1");
List<Payment> payment = instance.payments.fetchAll(params);
Parameters:
Name | Type | Description |
---|---|---|
from | timestamp | timestamp after which the payments were created |
to | timestamp | timestamp before which the payments were created |
count | integer | number of payments to fetch (default: 10) |
skip | integer | number of payments to be skipped (default: 0) |
expand[] | string | Used to retrieve additional information about the payment.Possible value is cards or emi |
Response:
{
"entity": "collection",
"count": 2,
"items": [
{
"id": "pay_G8VaL2Z68LRtDs",
"entity": "payment",
"amount": 900,
"currency": "INR",
"status": "captured",
"order_id": "order_G8VXfKDWDEOHHd",
"invoice_id": null,
"international": false,
"method": "netbanking",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": "Purchase Shoes",
"card_id": null,
"bank": "KKBK",
"wallet": null,
"vpa": null,
"email": "[email protected]",
"contact": "+919999999999",
"customer_id": "cust_DitrYCFtCIokBO",
"notes": [],
"fee": 22,
"tax": 4,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"acquirer_data": {
"bank_transaction_id": "0125836177"
},
"created_at": 1606985740
}
]
}
String paymentId = "pay_G8VQzjPLoAvm6D";
Payment payment = instance.payments.fetch(paymentId);
Parameters:
Name | Type | Description |
---|---|---|
PaymentId* | string | Id of the payment to be retrieved |
Response:
{
"id": "pay_G8VQzjPLoAvm6D",
"entity": "payment",
"amount": 1000,
"currency": "INR",
"status": "captured",
"order_id": "order_G8VPOayFxWEU28",
"invoice_id": null,
"international": false,
"method": "upi",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": "Purchase Shoes",
"card_id": null,
"bank": null,
"wallet": null,
"vpa": "gaurav.kumar@exampleupi",
"email": "[email protected]",
"contact": "+919999999999",
"customer_id": "cust_DitrYCFtCIokBO",
"notes": [],
"fee": 24,
"tax": 4,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"acquirer_data": {
"rrn": "033814379298"
},
"created_at": 1606985209
}
String orderId = "order_DovFx48wjYEr2I";
List<Payment> payments = instance.orders.fetchPayments(orderId);
Parameters
Name | Type | Description |
---|---|---|
orderId* | string | The id of the order to be retrieve payment info |
Response:
{
"count": 1,
"entity": "collection",
"items": [
{
"id": "pay_DovGQXOkPBJjjU",
"entity": "payment",
"amount": 600,
"currency": "INR",
"status": "captured",
"order_id": "order_DovFx48wjYEr2I",
"method": "netbanking",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": "A Wild Sheep Chase is a novel by Japanese author Haruki Murakami",
"card_id": null,
"bank": "SBIN",
"wallet": null,
"vpa": null,
"email": "[email protected]",
"contact": "9364591752",
"fee": 70,
"tax": 10,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"notes": [],
"acquirer_data": {
"bank_transaction_id": "0125836177"
},
"created_at": 1400826750
}
]
}
String paymentId = "pay_CBYy6tLmJTzn3Q";
JSONObject paymentRequest = new JSONObject();
JSONObject notes = new JSONObject();
notes.put("key1","value1");
notes.put("key2","value2");
paymentRequest.put("notes",notes);
Payment payment = instance.payments.edit(paymentId,paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
PaymentId* | string | Id of the payment to update |
notes* | object | A key-value pair |
Response:
{
"id": "pay_CBYy6tLmJTzn3Q",
"entity": "payment",
"amount": 1000,
"currency": "INR",
"status": "authorized",
"order_id": null,
"invoice_id": null,
"international": false,
"method": "netbanking",
"amount_refunded": 0,
"refund_status": null,
"captured": false,
"description": null,
"card_id": null,
"bank": "UTIB",
"wallet": null,
"vpa": null,
"email": "[email protected]",
"notes": {
"key1": "value1",
"key2": "value2"
},
"fee": null,
"tax": null,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"acquirer_data": {
"bank_transaction_id": "0125836177"
},
"created_at": 1553504328
}
Request #1: Card
JSONObject params = new JSONObject();
params.put("expand[]","card");
List<Payment> payment = instance.payments.fetchAll(params);
Request #2: EMI
JSONObject params = new JSONObject();
params.put("expand[]","emi");
List<Payment> payment = instance.payments.fetchAll(params);
Response:
For expanded card or emi details for payments response please click here
String paymentId = "pay_CBYy6tLmJTzn3Q";
Card card = instance.cards.fetchCardDetails(paymentId);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | string | Id of the payment to update |
Response:
{
"id": "card_6krZ6bcjoeqyV9",
"entity": "card",
"name": "Gaurav",
"last4": "3335",
"network": "Visa",
"type": "debit",
"issuer": "SBIN",
"international": false,
"emi": null,
"sub_type": "business"
}
List<Payment> payment = instance.payments.fetchPaymentDowntime();
Response:
For payment downtime response please click here
String DowntimeId = "down_F7LroRQAAFuswd";
Payment payment = instance.payments.fetchPaymentDowntimeById(DowntimeId);
Parameters:
Name | Type | Description |
---|---|---|
DowntimeId* | string | Id to fetch payment downtime |
Response: For payment downtime by id response please click here
JSONObject orderRequest = new JSONObject();
orderRequest.put("amount",50000);
orderRequest.put("currency","INR");
orderRequest.put("receipt", "rcptid_11");
JSONObject payment = new JSONObject();
payment.put("capture","automatic");
JSONObject captureOptions = new JSONObject();
captureOptions.put("automatic_expiry_period",12);
captureOptions.put("manual_expiry_period",7200);
captureOptions.put("refund_speed","optimum");
payment.put("capture_options",captureOptions);
orderRequest.put("payment",payment);
Order order = instance.orders.create(orderRequest);
Parameters:
Name | Type | Description |
---|---|---|
amount* | integer | Amount of the order to be paid |
currency* | string | The currency of the payment (defaults to INR) |
order_id* | string | The unique identifier of the order created. |
email* | string | Email of the customer |
contact* | string | Contact number of the customer |
method* | string | Possible value is card , netbanking , wallet ,emi , upi , cardless_emi , paylater . |
card | array | All keys listed here are supported |
bank | string | Bank code of the bank used for the payment. Required if the method is netbanking . |
bank_account | object | All keys listed here are supported |
vpa | string | Virtual payment address of the customer. Required if the method is upi . |
wallet | string | Wallet code for the wallet used for the payment. Required if the method is wallet . |
notes | array | A key-value pair |
Response:
{
"id": "order_DBJOWzybf0sJbb",
"entity": "order",
"amount": 50000,
"amount_paid": 0,
"amount_due": 50000,
"currency": "INR",
"receipt": "rcptid_11",
"status": "created",
"attempts": 0,
"notes": [],
"created_at": 1566986570
}
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("amount",500);
paymentRequest.put("currency","INR");
paymentRequest.put("email", "[email protected]");
paymentRequest.put("contact", "9123456789");
paymentRequest.put("order_id", "order_JZluwjknyWdhnU");
paymentRequest.put("method", "card");
JSONObject card = new JSONObject();
card.put("number","4854980604708430");
card.put("cvv","123");
card.put("expiry_month","12");
card.put("expiry_year","25");
card.put("name","Gaurav Kumar");
paymentRequest.put("card",card);
Payment payment = instance.payments.createJsonPayment(paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
amount* | integer | Amount of the order to be paid |
currency* | string | The currency of the payment (defaults to INR) |
order_id* | string | The unique identifier of the order created. |
email* | string | Email of the customer |
contact* | string | Contact number of the customer |
method* | string | Possible value is card , netbanking , wallet ,emi , upi , cardless_emi , paylater . |
card | object | All keys listed here are supported |
bank | string | Bank code of the bank used for the payment. Required if the method is netbanking . |
bank_account | object | All keys listed here are supported |
vpa | string | Virtual payment address of the customer. Required if the method is upi . |
wallet | string | Wallet code for the wallet used for the payment. Required if the method is wallet . |
notes | object | A key-value pair |
please refer this doc for params
Response:
{
"razorpay_payment_id": "pay_FVmAstJWfsD3SO",
"next": [
{
"action": "redirect",
"url": "https://api.razorpay.com/v1/payments/FVmAtLUe9XZSGM/authorize"
},
{
"action": "otp_generate",
"url": "https://api.razorpay.com/v1/payments/pay_FVmAstJWfsD3SO/otp_generate?track_id=FVmAtLUe9XZSGM&key_id=<YOUR_KEY_ID>"
}
]
}
RazorpayClient instance = new RazorpayClient("key",""); // Use Only razorpay key
String paymentId = "pay_JWjI5kbJKUDE1a";
Payment payment = instance.payments.otpGenerate(paymentId);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | integer | Unique identifier of the payment |
Doc reference doc
Response:
{
"razorpay_payment_id": "pay_FVmAstJWfsD3SO",
"next": [
{
"action": "otp_submit",
"url": "https://api.razorpay.com/v1/payments/pay_FVmAstJWfsD3SO/otp_submit/ac2d415a8be7595de09a24b41661729fd9028fdc?key_id=<YOUR_KEY_ID>"
},
{
"action": "otp_resend",
"url": "https://api.razorpay.com/v1/payments/pay_FVmAstJWfsD3SO/otp_resend/json?key_id=<YOUR_KEY_ID>"
}
],
"metadata": {
"issuer": "HDFC",
"network": "MC",
"last4": "1111",
"iin": "411111"
}
}
String paymentId = "pay_JWjI5kbJKUDE1a";
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("otp","123456");
Payment payment = instance.payments.otpSubmit(paymentId, paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | integer | Unique identifier of the payment |
otp* | string | The customer receives the OTP using their preferred notification medium - SMS or email |
Doc reference doc
Response:
Success
{
"razorpay_payment_id": "pay_D5jmY2H6vC7Cy3",
"razorpay_order_id": "order_9A33XWu170gUtm",
"razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d"
}
String paymentId = "pay_JWjI5kbJKUDE1a";
Payment payment = instance.payments.otpResend(paymentId);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | integer | Unique identifier of the payment |
Doc reference doc
Response:
{
"next": [
"otp_submit",
"otp_resend"
],
"razorpay_payment_id": "pay_JWaNvYmrx75sXo"
}
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("amount",500);
paymentRequest.put("currency","INR");
paymentRequest.put("email", "[email protected]");
paymentRequest.put("contact", "9123456789");
paymentRequest.put("order_id", "order_JZluwjknyWdhnU");
paymentRequest.put("method", "netbanking");
paymentRequest.put("bank", "HDFC");
Payment payment = instance.payments.createJsonPayment(paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
amount* | integer | Amount of the order to be paid |
currency* | string | The currency of the payment (defaults to INR) |
order_id* | string | The unique identifier of the order created. |
email* | string | Email of the customer |
contact* | string | Contact number of the customer |
method* | string | Possible value is netbanking |
bank* | string | The customer's bank code.For example, HDFC . |
please refer this doc for params
Response:
{
"razorpay_payment_id": "pay_GAWOYqPlvrtPSi",
"next": [
{
"action": "redirect",
"url": "https://api.razorpay.com/v1/payments/pay_GAWOYqPlvrtPSi/authorize"
}
]
}
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("amount",500);
paymentRequest.put("currency","INR");
paymentRequest.put("order_id", "order_JZluwjknyWdhnU");
paymentRequest.put("email", "[email protected]");
paymentRequest.put("contact", "9123456789");
paymentRequest.put("method", "upi");
paymentRequest.put("customer_id", "cust_EIW4T2etiweBmG");
paymentRequest.put("save", 1);
paymentRequest.put("ip", "192.168.0.103");
paymentRequest.put("referer", "http");
paymentRequest.put("user_agent", "Mozilla/5.0");
paymentRequest.put("description", "Test flow");
JSONObject notes = new JSONObject();
notes.put("note_key","value1");
JSONObject upi = new JSONObject();
upi.put("flow","collect");
upi.put("vpa","gauravkumar@exampleupi");
upi.put("expiry_time",5);
paymentRequest.put("notes",notes);
paymentRequest.put("upi",upi);
Payment payment = instance.payments.createUpi(paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
amount* | integer | Amount of the order to be paid |
currency* | string | The currency of the payment (defaults to INR) |
order_id* | string | The unique identifier of the order created. |
email* | string | Email of the customer |
customer_id* | string | The id of the customer to be fetched |
contact* | string | Contact number of the customer |
notes | object | A key-value pair |
description | string | Descriptive text of the payment. |
save | boolean | Specifies if the VPA should be stored as tokens.Possible value is 0 , 1 |
callback_url | string | URL where Razorpay will submit the final payment status. |
ip* | string | The client's browser IP address. For example 117.217.74.98 |
referer* | string | Value of referer header passed by the client's browser. For example, https://example.com/ |
user_agent* | string | Value of user_agent header passed by the client's browser. For example, Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36 |
upi* (for Upi only) | object | All keys listed here are supported |
Response:
{
"razorpay_payment_id": "pay_EAm09NKReXi2e0"
}
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("amount",500);
paymentRequest.put("currency","INR");
paymentRequest.put("order_id", "order_JZluwjknyWdhnU");
paymentRequest.put("email", "[email protected]");
paymentRequest.put("contact", "9123456789");
paymentRequest.put("method", "upi");
paymentRequest.put("ip", "192.168.0.103");
paymentRequest.put("referer", "http");
paymentRequest.put("user_agent", "Mozilla/5.0");
paymentRequest.put("description", "Test flow");
JSONObject notes = new JSONObject();
notes.put("purpose","UPI test payment");
JSONObject upi = new JSONObject();
upi.put("flow","intent");
paymentRequest.put("notes",notes);
paymentRequest.put("upi",upi);
Payment payment = instance.payments.createUpi(paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
amount* | integer | Amount of the order to be paid |
currency* | string | The currency of the payment (defaults to INR) |
order_id* | string | The unique identifier of the order created. |
email* | string | Email of the customer |
customer_id* | string | The id of the customer to be fetched |
contact* | string | Contact number of the customer |
notes | object | A key-value pair |
description | string | Descriptive text of the payment. |
save | boolean | Specifies if the VPA should be stored as tokens.Possible value is 0 , 1 |
callback_url | string | URL where Razorpay will submit the final payment status. |
ip* | string | The client's browser IP address. For example 117.217.74.98 |
referer* | string | Value of referer header passed by the client's browser. For example, https://example.com/ |
user_agent* | string | Value of user_agent header passed by the client's browser. For example, Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36 |
upi* (for Upi only) | object | All keys listed here are supported |
Response:
{
"razorpay_payment_id": "pay_CMeM6XvOPGFiF",
"link": "upi://pay?pa=success@razorpay&pn=xyz&tr=xxxxxxxxxxx&tn=gourav&am=1&cu=INR&mc=xyzw"
}
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("vpa","gauravkumar@exampleupi");
Payment payment = instance.payments.validateUpi(paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
vpa* | string | The virtual payment address (VPA) you want to validate. For example, gauravkumar@exampleupi |
please refer this doc for params
Response:
{
"vpa": "gauravkumar@exampleupi",
"success": true,
"customer_name": "Gaurav Kumar"
}
RazorpayClient instance = new RazorpayClient("key",""); // Use only razorpay key
Methods methods = instance.payments.fetchPaymentMethods();
Response:
please refer this doc for response
String tokenIin = "412345";
Iin token = instance.iin.fetch(tokenIin);
Parameters:
Name | Type | Description |
---|---|---|
tokenIin* | string | The token IIN. |
Response:
{
"iin": "412345",
"entity": "iin",
"network": "Visa",
"type": "credit",
"sub_type": "business",
"issuer_code": "HDFC",
"issuer_name": "HDFC Bank Ltd",
"international": false,
"is_tokenized": true,
"card_iin": "411111",
"emi":{
"available": true
},
"recurring": {
"available": true
},
"authentication_types": [
{
"type":"3ds"
},
{
"type":"otp"
}
]
}
JSONObject request = new JSONObject();
request.put("expand[]","emi");
Payment payment = instance.payments.expandedDetails("pay_XXXXXXXXXXXXXX",request);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | integer | Unique identifier of the payment |
expand[] | string | Use to expand the emi details when the payment method is emi. |
Response:
{
"id": "pay_DG4ZdRK8ZnXC3k",
"entity": "payment",
"amount": 200000,
"currency": "INR",
"status": "authorized",
"order_id": null,
"invoice_id": null,
"international": false,
"method": "emi",
"amount_refunded": 0,
"refund_status": null,
"captured": false,
"description": null,
"card_id": "card_DG4ZdUO3xABb20",
"bank": "ICIC",
"wallet": null,
"vpa": null,
"email": "[email protected]",
"contact": "+919972000005",
"notes": [],
"fee": null,
"tax": null,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"emi": {
"issuer": "ICIC",
"rate": 1300,
"duration": 6
},
"acquirer_data": {
"auth_code": "828553"
},
"created_at": 1568026077
}
JSONObject request = new JSONObject();
request.put("expand[]","card");
Payment payment = instance.payments.expandedDetails("pay_XXXXXXXXXXXXXX",request);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | integer | Unique identifier of the payment |
expand[] | string | Use to expand the card details when the payment method is card . |
Response:
{
"id": "pay_H9oR0gLCaVlV6m",
"entity": "payment",
"amount": 100,
"currency": "INR",
"status": "failed",
"order_id": "order_H9o58N6qmLYQKC",
"invoice_id": null,
"terminal_id": "term_G5kJnYM9GhhLYT",
"international": false,
"method": "card",
"amount_refunded": 0,
"refund_status": null,
"captured": false,
"description": null,
"card_id": "card_H9oR0ocen1cmZq",
"card": {
"id": "card_H9oR0ocen1cmZq",
"entity": "card",
"name": "Gaurav",
"last4": "1213",
"network": "RuPay",
"type": "credit",
"issuer": "UTIB",
"international": false,
"emi": false,
"sub_type": "business"
},
"bank": null,
"wallet": null,
"vpa": null,
"email": "[email protected]",
"contact": "+919000090000",
"notes": {
"email": "[email protected]",
"phone": "09000090000"
},
"fee": null,
"tax": null,
"error_code": "BAD_REQUEST_ERROR",
"error_description": "Card issuer is invalid",
"error_source": "customer",
"error_step": "payment_authentication",
"error_reason": "incorrect_card_details",
"acquirer_data": {
"auth_code": null,
"authentication_reference_number": "100222021120200000000742753928"
},
"created_at": 1620807547
}
JSONObject request = new JSONObject();
request.put("expand[]","offers");
Payment payment = instance.payments.expandedDetails("pay_XXXXXXXXXXXXXX",request);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | integer | Unique identifier of the payment |
expand[] | string | Use to expand the emi details when the payment method is emi. |
Response:
{
"id": "pay_DG4ZdRK8ZnXC3k",
"entity": "payment",
"amount": 200000,
"currency": "INR",
"status": "authorized",
"order_id": null,
"invoice_id": null,
"international": false,
"method": "emi",
"amount_refunded": 0,
"refund_status": null,
"captured": false,
"description": null,
"card_id": "card_DG4ZdUO3xABb20",
"bank": "ICIC",
"wallet": null,
"vpa": null,
"email": "[email protected]",
"contact": "+919972000005",
"notes": [],
"fee": null,
"tax": null,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"emi": {
"issuer": "ICIC",
"rate": 1300,
"duration": 6
},
"acquirer_data": {
"auth_code": "828553"
},
"created_at": 1568026077
}
JSONObject request = new JSONObject();
request.put("expand[]","upi");
Payment payment = instance.payments.expandedDetails("pay_XXXXXXXXXXXXXX",request);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | integer | Unique identifier of the payment |
expand[] | string | Use to expand the UPI details when the payment method is upi. |
Response:
{
"id": "pay_DG4ZdRK8ZnXC3k",
"entity": "payment",
"amount": 100,
"currency": "INR",
"status": "captured",
"order_id": "order_GjCr5oKh4AVC51",
"invoice_id": null,
"international": false,
"method": "upi",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": "Payment for Adidas shoes",
"card_id": null,
"bank": null,
"wallet": null,
"vpa": "gaurav.kumar@upi",
"email": "[email protected]",
"contact": "9000090000",
"customer_id": "cust_K6fNE0WJZWGqtN",
"token_id": "token_KOdY$DBYQOv08n",
"notes": [],
"fee": 1,
"tax": 0,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"acquirer_data": {
"rrn": "303107535132"
},
"created_at": 1605871409,
"upi": {
"payer_account_type": "credit_card",
"vpa": "gaurav.kumar@upi",
"flow": "in_app" // appears only for Turbo UPI Payments.
}
}
PN: * indicates mandatory fields
For reference click here