JSONObject customerRequest = new JSONObject();
customerRequest.put("name","Gaurav Kumar");
customerRequest.put("contact","9123456780");
customerRequest.put("email","gaurav.kumar@example.com");
customerRequest.put("fail_existing","0");
customerRequest.put("gstin","29XAbbA4369J1PA");
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_2","Tea, Earl Grey… decaf.");
customerRequest.put("notes",notes);
Customer customer = instance.customers.create(customerRequest);
Parameters:
Name | Type | Description |
---|---|---|
name* | string | Name of the customer |
string | Email of the customer | |
contact | string | Contact number of the customer |
fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is 0 or 1 |
notes | object | A key-value pair |
Response:
{
"id": "cust_1Aa00000000003",
"entity": "customer",
"name": "Gaurav Kumar",
"email": "Gaurav.Kumar@example.com",
"contact": "9000000000",
"gstin": null,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"created_at": 1582033731
}
JSONObject orderRequest = new JSONObject();
orderRequest.put("amount", 0);
orderRequest.put("currency", "INR");
orderRequest.put("customer_id", "cust_JDdNazagOgg9Ig");
orderRequest.put("method", "emandate");
orderRequest.put("receipt", "receipt#1");
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_2","Tea, Earl Grey… decaf.");
orderRequest.put("notes", notes);
JSONObject token = new JSONObject();
token.put("first_payment_amount",100);
token.put("auth_type","netbanking");
token.put("max_amount","9999900");
token.put("expire_at","2709971120");
JSONObject tokenNotes = new JSONObject();
tokenNotes.put("notes_key_1","Tea, Earl Grey, Hot");
tokenNotes.put("notes_key_2","Tea, Earl Grey… decaf.");
token.put("notes",tokenNotes);
orderRequest.put("token", token);
JSONObject bankAccount = new JSONObject();
bankAccount.put("beneficiary_name","Gaurav Kumar");
bankAccount.put("account_number","11214311215411");
bankAccount.put("account_type","savings");
bankAccount.put("ifsc_code","HDFC0001233");
token.put("bank_account",bankAccount);
Order order = instance.orders.create(orderRequest);
Parameters:
Name | Type | Description |
---|---|---|
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) |
method* | string | Payment method used to make the registration transaction. Possible value is emandate . |
payment_capture* | boolean | Indicates whether payment status should be changed to captured automatically or not. Possible values: true - Payments are captured automatically. false - Payments are not captured automatically. |
receipt | string | Your system order reference id. |
token | object | All keys listed here are supported |
notes | object | A key-value pair |
Response:
For create order response please click here
Please refer this doc for authorization payment
JSONObject registrationLinkRequest = new JSONObject();
JSONObject customer = new JSONObject();
customer.put("name","Gaurav Kumar");
customer.put("email","gaurav.kumar@example.com");
customer.put("contact","9123456780");
registrationLinkRequest.put("customer", customer);
registrationLinkRequest.put("type", "link");
registrationLinkRequest.put("amount", 0);
registrationLinkRequest.put("currency", "INR");
registrationLinkRequest.put("description", "12 p.m. Meals");
JSONObject subscriptionRegistration = new JSONObject();
subscriptionRegistration.put("method","emandate");
subscriptionRegistration.put("auth_type","netbanking");
subscriptionRegistration.put("max_amount",50000);
subscriptionRegistration.put("expire_at",1609423824);
JSONObject bankAccount = new JSONObject();
bankAccount.put("beneficiary_name","Gaurav Kumar");
bankAccount.put("account_number","11214311215411");
bankAccount.put("account_type","savings");
bankAccount.put("ifsc_code","HDFC0001233");
subscriptionRegistration.put("bank_account",bankAccount);
registrationLinkRequest.put("subscription_registration", subscriptionRegistration);
registrationLinkRequest.put("receipt", "Receipt No. 1");
registrationLinkRequest.put("email_notify", 1);
registrationLinkRequest.put("sms_notify", 1);
registrationLinkRequest.put("expire_by", 1580479824);
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_2","Tea, Earl Grey… decaf.");
registrationLinkRequest.put("notes", notes);
Invoice invoice = instance.invoices.createRegistrationLink(registrationLinkRequest);
Parameters:
Name | Type | Description |
---|---|---|
customer | object | All keys listed here are supported |
type* | object | the value is link . |
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) |
description* | string | A brief description of the payment. |
subscription_registration | object | All keys listed here are supported |
receipt | string | Your system order reference id. |
sms_notify | boolean | SMS notifications are to be sent by Razorpay (default : 1) |
email_notify | boolean | Email notifications are to be sent by Razorpay (default : 1) |
expire_by | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
notes | object | A key-value pair |
Response: For create registration link response please click here
JSONObject orderRequest = new JSONObject();
orderRequest.put("amount", 1000);
orderRequest.put("currency", "INR");
orderRequest.put("payment_capture", true);
orderRequest.put("receipt", "Receipt No. 1");
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_2","Tea, Earl Grey… decaf.");
orderRequest.put("notes", notes);
Order order = instance.orders.create(orderRequest);
Parameters:
Name | Type | Description |
---|---|---|
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) |
receipt | string | Your system order reference id. |
payment_capture* | boolean | Indicates whether payment status should be changed to captured automatically or not. Possible values: true - Payments are captured automatically. false - Payments are not captured automatically. |
notes | object | A key-value pair |
Response:
{
"id":"order_1Aa00000000002",
"entity":"order",
"amount":1000,
"amount_paid":0,
"amount_due":1000,
"currency":"INR",
"receipt":"Receipt No. 1",
"offer_id":null,
"status":"created",
"attempts":0,
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
},
"created_at":1579782776
}
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("email", "gaurav.kumar@example.com");
paymentRequest.put("contact", "9123456789");
paymentRequest.put("amount", 1000);
paymentRequest.put("currency", "INR");
paymentRequest.put("order_id", "order_1Aa00000000002");
paymentRequest.put("customer_id", "cust_1Aa00000000001");
paymentRequest.put("token", "token_1Aa00000000001");
paymentRequest.put("recurring", 1);
paymentRequest.put("description", "Creating recurring payment for Gaurav Kumar");
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_2","Tea, Earl Grey… decaf.");
paymentRequest.put("notes", notes);
Payment payment = instance.payments.createRecurringPayment(paymentRequest);
Parameters:
Name | Type | Description |
---|---|---|
email* | string | The customer's email address |
contact* | string | The customer's phone number |
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) |
orderId* | string | The id of the order to be fetched |
customerId* | string | The id of the customer to be fetched |
tokenId* | string | The id of the token to be fetched |
recurring* | boolean | Possible values is 0 or 1 |
description | string | A brief description of the payment. |
notes | object | A key-value pair |
Response:
{
"razorpay_payment_id" : "pay_1Aa00000000001",
"razorpay_order_id" : "order_1Aa00000000001",
"razorpay_signature" : "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d"
}
String invoiceId = "inv_DAweOiQ7amIUVd";
String medium = "sms";
Invoice invoice = instance.invoices.notifyBy(invoiceId,medium);
Parameters:
Name | Type | Description |
---|---|---|
invoiceId* | string | The id of the invoice to be fetched |
medium* | string | Possible values are sms or email |
Response:
{
"success": true
}
String invoiceId = "inv_DAweOiQ7amIUVd";
Invoice invoice = instance.invoices.cancel(invoiceId);
Parameters:
Name | Type | Description |
---|---|---|
InvoiceId* | string | The id of the invoice to be fetched |
Response:
{
"id": "inv_FHrfRupD2ouKIt",
"entity": "invoice",
"receipt": "Receipt No. 1",
"invoice_number": "Receipt No. 1",
"customer_id": "cust_BMB3EwbqnqZ2EI",
"customer_details": {
"id": "cust_BMB3EwbqnqZ2EI",
"name": "Gaurav Kumar",
"email": "gaurav.kumar@example.com",
"contact": "9123456780",
"gstin": null,
"billing_address": null,
"shipping_address": null,
"customer_name": "Gaurav Kumar",
"customer_email": "gaurav.kumar@example.com",
"customer_contact": "9123456780"
},
"order_id": "order_FHrfRw4TZU5Q2L",
"line_items": [],
"payment_id": null,
"status": "cancelled",
"expire_by": 4102444799,
"issued_at": 1595491479,
"paid_at": null,
"cancelled_at": 1595491488,
"expired_at": null,
"sms_status": "sent",
"email_status": "sent",
"date": 1595491479,
"terms": null,
"partial_payment": false,
"gross_amount": 100,
"tax_amount": 0,
"taxable_amount": 0,
"amount": 100,
"amount_paid": 0,
"amount_due": 100,
"currency": "INR",
"currency_symbol": "₹",
"description": "Registration Link for Gaurav Kumar",
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Tea. Earl Gray. Hot."
},
"comment": null,
"short_url": "https://rzp.io/i/QlfexTj",
"view_less": true,
"billing_start": null,
"billing_end": null,
"type": "link",
"group_taxes_discounts": false,
"created_at": 1595491480,
"idempotency_key": null
}
String paymentId = "pay_1Aa00000000001";
Payment payment = instance.payments.fetch(paymentId);
Parameters:
Name | Type | Description |
---|---|---|
paymentId* | string | The id of the payment to be fetched |
Response: For fetch token by payment id response please click here
String customerId = "cust_BMB3EwbqnqZ2EI";
List<Token> token = instance.customers.fetchTokens(customerId);
Parameters:
Name | Type | Description |
---|---|---|
customerId* | string | The id of the customer to be fetched |
Response:
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "token_FHf94Uym9tdYFJ",
"entity": "token",
"token": "2wDPM7VAlXtjAR",
"bank": "HDFC",
"wallet": null,
"method": "emandate",
"vpa": null,
"recurring": true,
"recurring_details": {
"status": "confirmed",
"failure_reason": null
},
"auth_type": "netbanking",
"mrn": null,
"used_at": 1595447381,
"created_at": 1595447381,
"bank_details": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"ifsc": "HDFC0000001",
"account_type": "savings"
},
"max_amount": 9999900,
"expired_at": 1689971140,
"dcc_enabled": false
}
]
}
String customerId = "cust_BMB3EwbqnqZ2EI";
String tokenId = "token_FHf94Uym9tdYFJ";
Customer customer = instance.customers.deleteToken(customerId, tokenId);
Parameters:
Name | Type | Description |
---|---|---|
customerId* | string | The id of the customer to be fetched |
tokenId* | string | The id of the token to be fetched |
Response:
{
"deleted": true
}
PN: * indicates mandatory fields
For reference click here