Sample Code

Handy Tips

Amount must always be in currency subunits.
Time represented as Unix timestamp, which can be obtained using the Utils.ToUnixTimestamp method.

Partner Authentication🔗

If you are a partner and want to use the API as a particular merchant, you must authenticate your account by passing an additional header X-Razorpay-Account with the merchant account_id as the value.

Example:

Copyvar instance = new Razorpay({
  key_id: '',
  key_secret: '',
  headers: {
    "X-Razorpay-Account": ""
  }
});

instance.orders.all().then(console.log).catch(console.error);

Orders🔗

Note:
Click here for request parameters and an example request and response.

Create an Order🔗

Copyinstance.orders.create({
  amount: 50000,
  currency: "INR",
  receipt: "receipt#1",
  notes: {
    key1: "value3",
    key2: "value2"
  }
})

Fetch Order by ID🔗

Copyinstance.orders.fetch(orderId)

Fetch Payment for an Order🔗

Copyinstance.orders.fetchPayments(orderId)

Fetch all Orders🔗

Copyinstance.orders.all(option)

Update Order🔗

Copyinstance.orders.edit({
  "notes": {
    "key1": "value3",
    "key2": "value2"
  }
})

Payments🔗

Note:
Click here for request parameters and an example request and response.

Capture a Payment🔗

Copyinstance.payments.capture(paymentId, amount, currency)

Fetch Payment by ID🔗

Copyinstance.payments.fetch(paymentId)

Fetch all Payments🔗

Copyinstance.payments.all(option)

Fetch Payments for an Order🔗

Copyinstance.orders.fetchPayments(orderId)

Update a Payment🔗

Copyinstance.payments.edit(paymentId,{
	"notes": {
		"key1": "value1",
		"key2": "value2"
	}
})

Fetch Expanded Card or EMI Details for Payments🔗

 Card
Copyinstance.payments.all({'expand[]':'card'})

 EMI
Copyinstance.payments.all({'expand[]':'emi'})

Fetch Card Details with Payment ID🔗

Copyinstance.payments.fetchCardDetails(paymentId)

Fetch Payment Downtime Details🔗

Copyinstance.payments.fetchPaymentDowntime()

Fetch Payment Downtime🔗

Copyinstance.payments.fetchPaymentDowntimeById(downtimeId)

Refunds🔗

Note:
Click here for request parameters and an example request and response.

Create a Refund🔗

Copyinstance.payments.refund(paymentId,{
  "amount": "100",
  "speed": "normal",
  "notes": {
    "notes_key_1": "Beam me up Scotty.",
    "notes_key_2": "Engage"
  },
  "receipt": "Receipt No. 31"
})

Fetch Refund by ID🔗

Copyinstance.refunds.fetch(refundId)

Fetch all Refunds🔗

Copyinstance.refunds.all(options)

Create an instant refund🔗

Copyinstance.payments.refund(paymentId,{
  "amount": "100",
  "speed": "optimum",
  "receipt": "Receipt No. 31"
})

Fetch multiple refunds for a payment🔗

Copyinstance.payments.fetchMultipleRefund(paymentId,option)

Fetch a specific refund for a payment🔗

Copyinstance.payments.fetch(paymentId,refundId)

Update the refund🔗

Copyinstance.refunds.edit({
  "notes": {
    "notes_key_1": "Beam me up Scotty.",
    "notes_key_2": "Engage"
  }
})

Note:
If payment_id is passed, refunds related to the payment are fetched.

Customers🔗

Note:
Click here for request parameters and an example request and response.

Create a Customer🔗

Copyinstance.customer.create({
  name: "Gaurav Kumar",
  contact: 9123456780,
  email: "gaurav.kumar@example.com",
  fail_existing: 0,
  gstin: "29XAbbA4369J1PA",
  notes: {
    notes_key_1: "Tea, Earl Grey, Hot",
    notes_key_2: "Tea, Earl Grey… decaf."
  }
})

Edit Customer Details🔗

Copyinstance.customers.edit(customerId,{
  name: "Gaurav Kumar",
  email: "Gaurav.Kumar@example.com",
  contact: 9000000000
})

Fetch Customer by ID🔗

Copyinstance.customers.fetch(customerId)

Fetch all Customers🔗

Copyinstance.customers.all(options)

Tokens🔗

Fetch Token for a Customer🔗

Copyinstance.customers.fetchToken(customer_id, token_id)

Delete a Token🔗

Copyinstance.customers.deleteToken(customer_id, token_id)

Subscriptions🔗

Note:
Click here for request parameters and an example request and response.

Create a Subscription🔗

Copyinstance.subscriptions.create({
  plan_id: "plan_7wAosPWtrkhqZw",
  customer_notify: 1,
  quantity: 5,
  total_count: 6,
  start_at: 1495995837,
  addons: [
    {
      item: {
        name: "Delivery charges",
        amount: 30000,
        currency: "INR"
      }
    }
  ],
  notes: {
    key1: "value3",
    key2: "value2"
  }
})

Create a Subscription Link🔗

Copyinstance.subscriptions.create({
  plan_id: "plan_HoYg68p5kmuvzD",
  total_count: 12,
  quantity: 1,
  expire_by: 1633237807,
  customer_notify: 1,
  addons: [
    {
      item: {
        name: "Delivery charges",
        amount: 30000,
        currency: "INR"
      }
    }
  ],
  notes: {
    notes_key_1: "Tea, Earl Grey, Hot",
    notes_key_2: "Tea, Earl Grey… decaf."
  },
  notify_info: {
    notify_phone: 9123456789,
    notify_email: "gaurav.kumar@example.com"
  }
})

Fetch Subscription by ID🔗

Copyinstance.subscriptions.fetch(subscriptionId)

Fetch all Subscriptions🔗

Copyinstance.subscriptions.all(options)

Cancel a Subscription🔗

Copyinstance.subscriptions.cancel(subscriptionId,options)

Update a Subscription🔗

Copyinstance.subscriptions.update(subscriptionId,options)

Fetch Details of a Pending Update🔗

Copyinstance.subscriptions.pendingUpdate(subscriptionId)

Cancel an Update🔗

Copyinstance.subscriptions.cancelScheduledChanges(subscriptionId)

Pause a Subscription🔗

Copyinstance.subscriptions.pause(subscriptionId,{
  pause_at : 'now'
})

Resume a Subscription🔗

Copyinstance.subscriptions.resume(subscriptionId,{
  resume_at : 'now'
})

Fetch All Invoices for a Subscription🔗

Copyinstance.invoices.all({
  'subscription_id':subscriptionId
})

Payment Verification🔗

Copyinstance.payments.paymentVerification({
   'subscription_id':'sub_ID6MOhgkcoHj9I',
   'payment_id':'pay_IDZNwZZFtnjyym',
   'signature':'601f383334975c714c91a7d97dd723eb56520318355863dcf3821c0d07a17693'
   },secret)

Create a Plan🔗

Copyinstance.plans.create(params)

Fetch Plan by ID🔗

Copyinstance.plans.fetch(planId)

Fetch all Plans🔗

Copyinstance.plans.all(params)

Create an Add-on🔗

Copyinstance.subscriptions.createAddon(subscriptionId, params)

Fetch Add-on by ID🔗

Copyinstance.addons.fetch(addonId)

Delete an Add-on🔗

Copyinstance.addons.delete(addonId)

Payment Links🔗

Note:
Click here for request parameters and an example request and response.

Create a Payment Link🔗

 Standard Payment Link
Copyinstance.paymentLink.create({
  amount: 500,
  currency: "INR",
  accept_partial: true,
  first_min_partial_amount: 100,
  description: "For XYZ purpose",
  customer: {
    name: "Gaurav Kumar",
    email: "gaurav.kumar@example.com",
    contact: 919999999999
  },
  notify: {
    sms: true,
    email: true
  },
  reminder_enable: true,
  notes: {
    policy_name: "Jeevan Bima"
  },
  callback_url: "https://example-callback-url.com/",
  callback_method: "get"
})

 UPI Payment Link
Copyinstance.paymentLink.create({
  upi_link: true,
  amount: 500,
  currency: "INR",
  accept_partial: true,
  first_min_partial_amount: 100,
  description: "For XYZ purpose",
  customer: {
    name: "Gaurav Kumar",
    email: "gaurav.kumar@example.com",
    contact: 919999999999
  },
  notify: {
    sms: true,
    email: true
  },
  reminder_enable: true,
  notes: {
    policy_name: "Jeevan Bima"
  }
})

Fetch all Payment Links🔗

Copyinstance.paymentLink.all()

Fetch Payment Link by ID🔗

Copyinstance.paymentLink.fetch(paymentLinkId)

Update a Payment Link🔗

Copyinstance.paymentLink.edit({
    "reference_id": "TS35",
    "expire_by": 1653347540,
    "reminder_enable":false,
    "notes":{
      "policy_name": "Jeevan Saral"
    }
})

Cancel a Payment Link🔗

Copyinstance.paymentLink.cancel(paymentLinkId)

Send/Resend Notification🔗

Copyinstance.paymentLink.notifyBy(paymentLinkId, medium)

Invoices🔗

Handy Tips
Click here for request parameters and an example request and response.

Create an Invoice🔗

Copyinstance.invoices.create({
  type: "invoice",
  date: 1589994898,
  customer_id: "cust_E7q0trFqXgExmT",
  line_items: [
    {
      "item_id": "item_DRt61i2NnL8oy6"
    }
  ]
})

Update Invoice🔗

Copyinstance.invoices.edit(invoiceId,{
  line_items: [
    {
      id: "li_DAweOizsysoJU6",
      name: "Book / English August - Updated name and quantity",
      quantity: 1
    },
    {
      name: "Book / A Wild Sheep Chase",
      amount: 200,
      currency: "INR",
      quantity: 1
    }
  ],
  notes: {
    "updated-key": "An updated note."
  }
})

Issue an Invoice🔗

Copyinstance.invoices.issue(invoiceId)

Fetch Invoice by ID🔗

Copyinstance.invoices.fetch(invoiceId)

Fetch all Invoices🔗

Copyinstance.invoices.all()

Cancel an Invoice🔗

Copyinstance.invoices.cancel(invoiceId)

Send/Resend Notification🔗

Copyinstance.invoices.notifyBy(invoiceId,medium)

Delete an Invoice🔗

Copyinstance.invoices.delete(invoiceId)

Smart Collect🔗

Note:
Click here for request parameters and an example request and response.

Create a Virtual Account🔗

Copyinstance.virtualAccounts.create({
  receivers: {
    types: [
      "bank_account"
    ]
  },
  description: "Virtual Account created for Raftar Soft",
  customer_id: "cust_CaVDm8eDRSXYME",
  close_by: 1681615838,
  notes: {
    project_name: "Banking Software"
  }
})

Fetch Virtual Account by ID🔗

Copyinstance.virtualAccounts.fetch(virtualId)

Fetch all Virtual Accounts🔗

Copyinstance.virtualAccounts.all(options)

Fetch Payment for a Virtual Account🔗

Copyinstance.virtualAccounts.fetchPayments(virtualId,options)

Note:
To get more information about the payment, use the payments.bankTransfer API.

Fetch Payment Details using ID and Transfer Method🔗

Copyinstance.payments.bankTransfer(paymentId)

Refund Payments made to a Virtual Account🔗

Copyinstance.payments.refund(paymentId,{
  "amount": "100",
  "speed": "normal",
  "notes": {
    "notes_key_1": "Beam me up Scotty.",
    "notes_key_2": "Engage"
  },
  "receipt": "Receipt No. 31"
})

Add receiver to an existing virtual account🔗

Copyinstance.virtualAccounts.addReceiver(virtualId,{
  types: [
    "vpa"
  ],
  vpa: {
    descriptor: "gauravkumar"
  }
})

Close a Virtual Account🔗

Copyinstance.virtualAccounts.close(virtualId)

Route🔗

Note:
Click here for request parameters and an example request and response.

Create a Direct Transfer🔗

Copyinstance.transfers.create({
  "amount": 500,
  "currency": "INR"
})

Create Transfers from Payments🔗

Copyinstance.payments.transfer(paymentId,{
   "transfers": [
    {
      "account": 'acc_HgzcrXeSLfNP9U',
      "amount": 100,
      "currency": "INR",
      "notes": {
        "name": "Gaurav Kumar",
        "roll_no": "IEC2011025"
      },
      "linked_account_notes": [
        "branch"
      ],
      "on_hold": 1,
      "on_hold_until": 1671222870
    }
  ]
 })

Create Transfers from Orders🔗

Copyinstance.orders.create({
  amount: 2000,
  currency: "INR",
  transfers: [
    {
      account: "acc_CPRsN1LkFccllA",
      amount: 1000,
      currency: "INR",
      notes: {
        branch: "Acme Corp Bangalore North",
        name: "Gaurav Kumar"
      },
      linked_account_notes: [
        "branch"
      ],
      on_hold: 1,
      on_hold_until: 1671222870
    },
    {
      account: "acc_CNo3jSI8OkFJJJ",
      amount: 1000,
      currency: "INR",
      notes: {
        branch: "Acme Corp Bangalore South",
        name: "Saurav Kumar"
      },
      linked_account_notes: [
        "branch"
      ],
      on_hold: 0
    }
  ]
})

Fetch Transfers for a Payment🔗

Copyinstance.payment.fetchTransfer(paymentId)

Fetch Transfers for an Order🔗

Copyinstance.orders.transfers({
  "expand[]": "transfers"
})

Fetch Transfer by ID🔗

Copyinstance.transfers.fetch(transferId)

Fetch Transfers for a Settlement🔗

Copyinstance.transfers.all({
   recipient_settlement_id :  recipientSettlementId
})

Fetch Settlement Details🔗

Copyinstance.transfers.all({
  expand[] = 'recipient_settlement'  
})

Fetch Payments of a Linked Account🔗

Copyinstance.payments.all({
  'X-Razorpay-Account':  linkedAccountId
})

Refund Payments and Reverse Transfer from a Linked Account🔗

Copyinstance.payments.refund(paymentId,{
    amount : 100,
    reverse_all : 1
})

Reverse Transfers from all Linked Accounts🔗

Copyinstance.transfers.reverse(transferId,{
    amount:100
})

Hold Settlements for Transfers🔗

Copyinstance.payments.transfer(paymentId,{
  "amount": 500,
  "currency": "INR",
  "on_hold": "1"
})

Modify Settlement Hold for Transfers🔗

Copyinstance.transfers.edit(paymentId,{
  "on_hold": "1",
  "on_hold_until": "1679691505"
})

Settlements🔗

Note:
Click here for request parameters and an example request and response.

Fetch All Settlements🔗

Copyinstance.settlements.all(options)

Fetch a settlement🔗

Copyinstance.settlements.fetch(settlementId)

Settlement recon🔗

Copyinstance.settlements.settlementRecon({
  year: 2020,
  month: 09,
  day:11
})

Create on-demand settlement🔗

Copyinstance.settlements.createOndemandSettlement({
  "amount": 1221,
  "settle_full_balance": false,
  "description": "Testing",
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
  }
})

Fetch all on-demand settlements🔗

Copyinstance.settlements.fetchAllOndemandSettlement(options)

Fetch on-demand settlement by ID🔗

Copyinstance.settlements.fetchOndemandSettlementById(settlementId);