Payments

This section contains the details of the Payment APIs that are used for making a payment in Razorpay.

Payment Entity#

To ease your understanding, the response for each request is shown on the right panel. The responses can be formatted either in JSON, the default pattern, or the object form, if you are using the language SDKs.

The various parameters are explained below:

id: string Unique identifier of the payment.
entity: string Indicates the type of entity.
amount: string The payment amount represented in smallest unit of the currency passed. For example, amount = 100 translates to 100 paisa, that is ₹1 (default currency is INR).
currency: string The currency in which the payment is made. Refer the list of international currencies that we support.
status: string The status of the payment. Possible values:
-created
-authorized
-captured
-refunded
-failed
method: string The payment method used for making the payment. Possible values:
-card
-netbanking
-wallet
- emi
-upi
order_id: string Order ID, if provided. Read Orders API to learn more.
description `: string Description of the payment, if any.
international: boolean Indicates whether the payment is done via an international card or a domestic one.
refund_status: string The refund status of the payment. Possible values include:
- null
- partial
- full.
amount_refunded: integer The amount refunded in smallest unit of the currency passed.
For example, if amount_refunded = 100, here 100 stands for 100 paise, which is equal to ₹1. INR is the default currency.
captured: boolean Indicates if the payment has been captured.
email: string Customer email address used for the payment.
contact: string Customer contact number used for the payment.
fee: string Fee (including GST) charged by Razorpay.
tax: integer GST charged for the payment.
error_code: string Code for the error that occurred during payment. For example, BAD_GATEWAY_ERROR.
error_description: string Description of the error that occurred during payment.
notes: dictionary Contains user-defined fields, stored for reference purposes.
created_at: integer Timestamp, in UNIX format, on which the payment was created.

 Example Payment Entity
Copy{
  "id": "pay_29QQoUBi66xm2f",
  "entity": "payment",
  "amount": 5000,
  "currency": "INR",
  "status": "captured",
  "method": "card",
  "order_id": "order_CjCr5oKh4AVC51",
  "description": "Payment for Adidas shoes",
  "amount_refunded": 0,
  "refund_status": null,
  "email": "test@razorpay.com",
  "contact": "9364591752",
  "notes": {},
  "fee": 1145,
  "tax": 145,
  "error_code": null,
  "error_description": null,
  "created_at": 1400826750
}

Capture a Payment#

The below endpoint captures a payment.

/payments/:id/capture

 CURL Python PHP Ruby Node.JS dotnet Java Response
Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
   -X POST \
   --data "amount=5000" \
   https://api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f/capture
Copy# do easy_install razorpay or
#    pip install razorpay

import razorpay

client = razorpay.Client(auth=("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>"))

payment_id = "<PAYMENT_ID>"

payment_amount = <PAYMENT AMOUNT>

resp = client.payment.capture(payment_id, payment_amount)
Copy<?php

use Razorpay\Api\Api;

$api = new Api("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>");

$payment = $api->payment->fetch('pay_29QQoUBi66xm2f');
$payment->capture(array('amount' => 5000));

?>
Copyrequire 'razorpay'

Razorpay.setup("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>")

Razorpay::Payment.fetch("pay_29QQoUBi66xm2f").capture({amount:5000})
Copyvar request = require('request');

request({
  method: 'POST',
  url: 'https://<YOUR_KEY_ID>:<YOUR_KEY_SECRET>@api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f/capture',
  form: {
    amount: 5000
  }
}, function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});
CopyRazorpayClient client = new RazorpayClient("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>");
Payment payment = client.Payment.Fetch(paymentId);

Dictionary<`string`, object> options = new Dictionary<`string`, object>();
options.Add("amount", "<amount>");

Payment paymentCaptured = payment.Capture(options);
Copyimport org.json.JSONObject;
import com.razorpay.Payment;
import com.razorpay.RazorpayClient;
import com.razorpay.RazorpayException;

RazorpayClient razorpay = new RazorpayClient("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>");
try {
  JSONObject captureRequest = new JSONObject();
  captureRequest.put("amount", amount); // Amount should be in paise
  Payment payment = razorpay.Payments.capture("<payment_id>", captureRequest);
} catch (RazorpayException e) {
  // Handle Exception
  System.out.println(e.getMessage());
}
Copy{
    "id": "pay_29QQoUBi66xm2f",
    "entity": "payment",
    "amount": 5000,
    "currency": "INR",
    "status": "captured",
    "order_id": null,
    "invoice_id": null,
    "international": false,
    "method": "wallet",
    "amount_refunded": 0,
    "refund_status": null,
    "captured": true,
    "description": "Purchase Description",
    "card_id": null,
    "bank": null,
    "wallet": "freecharge",
    "vpa": null,
    "email": "a@b.com",
    "contact": "91xxxxxxxx",
    "notes": {
        "merchant_order_id": "order id"
    },
    "fee": 1438,
    "tax": 188,
    "error_code": null,
    "error_description": null,
    "created_at": 1400826750
}

Path Parameters#

id mandatory: string Unique identifier of the payment to be captured.

Request Parameters#

amount mandatory: string The amount to be captured (should be equal to the authorized amount, in the smallest unit of the chosen currency).

This endpoint captures a specific payment. Capture is done after a payment status has been successfully set as “authorized”.

After the capture, the funds are transferred to your account in T + 3 days. The amount sent in the capture request must come from a verified source and be the amount that you are expecting to receive.

Recommendation:
While creating a capture request, in the amount field enter only the amount associated with the Order that is stored in your database.

Note:
Attempting to capture a payment whose status is not authorized will produce an error.

Fetch a Payment#

The following endpoint is used for retrieving a specific payment object using its id.

/payments/:id

 CURL Python PHP Ruby Node.JS dotnet Java Response
Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X GET https://api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f
Copy# do easy_install razorpay or
#    pip install razorpay

import razorpay

client = razorpay.Client(auth=("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>"))

payment_id = "<PAYMENT_ID>"

resp = client.payment.fetch(payment_id)
Copy<?php

use Razorpay\Api\Api;

$api = new Api('YOUR_KEY_ID', 'YOUR_KEY_SECRET');

$payment = $api->payment->fetch('pay_29QQoUBi66xm2f');

?>
Copyrequire 'razorpay'

Razorpay.setup("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>")

Razorpay::Payment.fetch("pay_29QQoUBi66xm2f")
Copyvar request = require('request');

request('https://<YOUR_KEY_ID>:<YOUR_KEY_SECRET>@api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f', function (error, response, body) {
  console.log('Response:', body);
});
CopyRazorpayClient client = new RazorpayClient("<YOUR_KEY_ID>","<YOUR_KEY_SECRET>");
Payment payment = client.Payment.Fetch(paymentId);
Copyimport com.razorpay.Payment;
import com.razorpay.RazorpayClient;
import com.razorpay.RazorpayException;

RazorpayClient razorpay = new RazorpayClient(<YOUR_KEY_ID,<YOUR_KEY_SECRET>);
try {
  Payment payment = razorpay.Payments.fetch("<payment_id>");
} catch (RazorpayException e) {
  // Handle Exception
  System.out.println(e.getMessage());
}
Copy{
    "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": "gaurav@example.com",
    "contact": "+919972000005",
    "notes": [],
    "fee": null,
    "tax": null,
    "error_code": null,
    "error_description": null,
    "created_at": 1568026077
}

Path Parameters#

id: string The id of the payment to be retrieved.

Query Parameters#

expand[]: array Used to retrieve additional information about the payment, specifically the method used to make the payment. Using this parameter will cause a sub-entity to be added to the response.

Supported values are:
-card - Expanded card details, applicable for card and EMI payments.
-emi - Expanded EMI plan details, applicable for EMI payments.

Example#

The usage of expand[] parameter in retrieving the card and the emi details of a payment is shown in the sample requests shown in the right panel.

Request #1 is for retrieving the expanded card details when the payment method is emi. Request #2 is for retrieving expanded EMI plan details when the payment method is emi.

 Request #1 Response Request #2 Response
Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X GET https://api.razorpay.com/v1/payments/pay_DG4a4vAWvKrh79/?expand[]=card
Copy{
    "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",
    "card": {
        "id": "card_DG4ZdUO3xABb20",
        "entity": "card",
        "name": "gaurav",
        "last4": "9003",
        "network": "Visa",
        "type": "credit",
        "issuer": "ICIC",
        "international": false,
        "emi": true
    },
    "bank": "ICIC",
    "wallet": null,
    "vpa": null,
    "email": "gaurav@example.com",
    "contact": "+919972000005",
    "notes": [],
    "fee": null,
    "tax": null,
    "error_code": null,
    "error_description": null,
    "created_at": 1568026077
}
Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X GET https://api.razorpay.com/v1/payments/pay_DG4a4vAWvKrh79/?expand[]=emi
Copy{
    "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": "gaurav@example.com",
    "contact": "+919972000005",
    "notes": [],
    "fee": null,
    "tax": null,
    "error_code": null,
    "error_description": null,
    "emi": {
        "issuer": "ICIC",
        "rate": 1300,
        "duration": 6
    },
    "created_at": 1568026077
}

Fetch Multiple Payments#

The following endpoint is used for retrieving all the payments:

/payments

 RequestPHP Python Ruby Node.JS dotnet Java Response
Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X GET https://api.razorpay.com/v1/payments
Copy<?php

use Razorpay\Api\Api;

$api = new Api("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>");

$params = array(
    'count' => 2,
    'skip'  => 1,
    'from'  => 1400826740
);

$payments = $api->payment->all($params);

?>
Copy# do easy_install razorpay or
#    pip install razorpay

import razorpay

client = razorpay.Client(auth=("<YOUR_KEY_ID>","<YOUR_KEY_SECRET>"))

resp = client.payment.fetch_all()
Copyrequire 'razorpay'

Razorpay.setup("<YOUR_KEY_ID>", "<YOUR_KEY_SECRET>")

Razorpay::Payment.all({from:1400826740, count:2, skip:1})
Copyvar request = require('request');

request(<YOUR_KEY_ID>,<YOUR_KEY_SECRET>@api.razorpay.com/v1/payments/?from=1400826740&count=2&skip=1', function (error, response, body) {
  console.log('Response:', body);
});
CopyDictionary<`string`, object> options = new Dictionary<`string`, object>();

//supported option filters (from, to, count, skip)
options.Add("count", 5);
options.Add("skip", 1000);

RazorpayClient client = new RazorpayClient("<>", "<YOUR_KEY_SECRET>");
List<Payment> result = client.Payment.All(options);

import java.util.List;
import org.json.JSONObject;
import com.razorpay.Payment;
import com.razorpay.RazorpayClient;
import com.razorpay.RazorpayException;
CopyRazorpayClient razorpay = new RazorpayClient(<YOUR_KEY_ID>,<YOUR_KEY_SECRET>);
try {
  JSONObject paymentRequest = new JSONObject();

    //supported option filters (from, to, count, skip)
  paymentRequest.put("count", 2);
  paymentRequest.put("skip", 1);

  List<Payment> payments = razorpay.Payments.fetchAll(paymentRequest);
} catch (RazorpayException e) {
  // Handle Exception
    System.out.println(e.getMessage());
}
Copy{
  "entity":"collection",
  "count":2,
  "items":[
    {
      "id":"pay_DG4a4vAWvKrh79",
      "entity":"payment",
      "amount":200010,
      "currency":"INR",
      "status":"authorized",
      "order_id":null,
      "invoice_id":null,
      "international":false,
      "method":"card",
      "amount_refunded":0,
      "refund_status":null,
      "captured":false,
      "description":null,
      "card_id":"card_DG4a4zHtV31t56",
      "bank":null,
      "wallet":null,
      "vpa":null,
      "email":"gaurav@razorpay.com",
      "contact":"+919972000005",
      "notes":[],
      "fee":null,
      "tax":null,
      "error_code":null,
      "error_description":null,
      "created_at":1568026102
    },
    {
      "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":"gaurav@example.com",
      "contact":"+919972000005",
      "notes":[],
      "fee":null,
      "tax":null,
      "error_code":null,
      "error_description":null,
      "created_at":1568026077
    }
  ]
}

Query Parameters#

from: integer Timestamp, in seconds, from when payments are to be fetched.
to: integer Timestamp, in seconds, till when payments are to be fetched.
count: integer Number of payments to be fetched.
Default value is 10. Maximum value is 100. This can be used for pagination, in combination with the skip parameter.
skip: integer Number of records to be skipped while fetching the payments.
expand[]: array Used to retrieve additional information about the payment, specifically the method used to make the payment. Using this parameter will cause a sub-entity to be added to the response.

Supported values are:
-card - Expanded card details, usable for card and EMI payments.
-emi - Expanded EMI plan details, usable for EMI payments.

Note:
By default only last 10 are returned. You can use the count and skip parameters to retrieve the specific number of records that you need.

Example#

The usage of the expand[] parameter in retrieving the card or the EMI plan details of the payments is shown in the example, displayed on the right.

Request #1 is for retrieving the expanded card details of the payments, in which the payment method is card or emi. Request #2 is for retrieving the expanded EMI plan details of the payments, in which the payment method is emi.

 Request #1 Response Request #2 Response
Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X GET https://api.razorpay.com/v1/payments/?expand[]=card
Copy{
  "entity":"collection",
  "count":2,
  "items":[
    {
      "id":"pay_DG4a4vAWvKrh79",
      "entity":"payment",
      "amount":200010,
      "currency":"INR",
      "status":"authorized",
      "order_id":null,
      "invoice_id":null,
      "international":false,
      "method":"card",
      "amount_refunded":0,
      "refund_status":null,
      "captured":false,
      "description":null,
      "card_id":"card_DG4a4zHtV31t56",
      "card":{
        "id":"card_DG4a4zHtV31t56",
        "entity":"card",
        "name":"gaurav",
        "last4":"9003",
        "network":"Visa",
        "type":"credit",
        "issuer":"ICIC",
        "international":false,
        "emi":true
      },
      "bank":null,
      "wallet":null,
      "vpa":null,
      "email":"gaurav@example.com",
      "contact":"+91997200005",
      "notes":[],
      "fee":null,
      "tax":null,
      "error_code":null,
      "error_description":null,
      "created_at":1568026102
    },
    {
      "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",
      "card":{
        "id":"card_DG4ZdUO3xABb20",
        "entity":"card",
        "name":"gaurav",
        "last4":"9003",
        "network":"Visa",
        "type":"credit",
        "issuer":"ICIC",
        "international":false,
        "emi":true
      },
      "bank":"ICIC",
      "wallet":null,
      "vpa":null,
      "email":"gaurav@example.com",
      "contact":"+919972000005",
      "notes":[],
      "fee":null,
      "tax":null,
      "error_code":null,
      "error_description":null,
      "created_at":1568026077
    }
  ]
}
Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X GET https://api.razorpay.com/v1/payments/?expand[]=emi
Copy{
  "entity":"collection",
  "count":2,
  "items":[
    {
      "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":"gaurav@example.com",
      "contact":"+919972000005",
      "notes":[],
      "fee":null,
      "tax":null,
      "error_code":null,
      "error_description":null,
      "emi":{
        "issuer":"ICIC",
        "rate":1300,
        "duration":6
      },
      "created_at":1568026077
    },
      {
      "id":"pay_DG4a4vAWvKrh79",
      "entity":"payment",
      "amount":200010,
      "currency":"INR",
      "status":"authorized",
      "order_id":null,
      "invoice_id":null,
      "international":false,
      "method":"card",
      "amount_refunded":0,
      "refund_status":null,
      "captured":false,
      "description":null,
      "card_id":"card_DG4a4zHtV31t56",
      "bank":null,
      "wallet":null,
      "vpa":null,
      "email":"gaurav@example.com",
      "contact":"+919972000005",
      "notes":[],
      "fee":null,
      "tax":null,
      "error_code":null,
      "error_description":null,
      "emi":null,
      "created_at":1568026102
    }
  ]
}

Fetch Payments based on Orders#

The following endpoint retrieves payments corresponding to an Order:

/orders/:id/payments

 JSON
Copy{
  "count": 1,
  "entity": "collection",
  "items": [
    {
      "id": "pay_29QQoUBi66xm2f",
      "entity": "payment",
      "amount": 600,
      "currency": "INR",
      "status": "captured",
      "amount_refunded": 0,
      "refund_status": null,
      "email": "test@razorpay.com",
      "contact": "9364591752",
      "error_code": null,
      "error_description": null,
      "notes": {},
      "created_at": 1400826750
    },
  ]
}

Fetch the Card Details for a Payment#

You can retrieve the details of the card that has been used to make a payment.

Request Parameters#

The following endpoint is used for retrieving the card details of a payment:

/payments/:id/card

 Response
Copy{
	"id": "card_6krZ6bcjoeqyV9",
	"entity": "card",
	"name": "Gaurav",
	"last4": "3335",
	"network": "Visa",
	"type": "debit",
  "issuer": "SBIN",
	"international": false,
  "emi": null

Response Entities#

id: string Unique ID of a card used for the payment.
entity: string The value for this attribute will always be card.
name: string Name of the card holder.
last4: string The last 4 digits of the card number.
network: string The card network

Possible values:
- American Express
- Diners Club
- Maestro
- MasterCard
- RuPay
- Unknown
- Visa
type: string Possible values include:
- Credit
- Debit
- Unknown
issuer: string The card issuer

4-character code denoting the issuing bank

This attribute will not be set for the card that has been issued by a foreign bank.
international: boolean This attribute will be set to true if the card has been issued by a foreign bank.
emi: boolean This attribute is set to true if the card can be used for EMI payment method.

Update the Payment#

You can modify an existing payment to update the Notes field only. Notes can be used to record additional information about the payment. You can add up to 15 key-value pairs with each value of the key not exceeding 256 characters.

Using the PATCH operation, you can replace the entire notes object for the entity.

Request Parameters#

To modify the Notes field in a particular payment, construct the API request as follows:

/payments/:id/

id mandatory: string ID of the payment, which requires the Notes field to be updated
notes mandatory: string Notes of the entity to be modified

 Request Response
Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> -X POST https://api.razorpay.com/v1/payments/:id/
-d {
	"notes": {
		"key1": "value1",
		"key2": "value2"
	}
}
Copy{
    "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": "testme@acme.com",
    "notes": {
        "key1": "value1",
        "key2": "value2"
    },
    "fee": null,
    "tax": null,
    "error_code": null,
    "error_description": null,
    "created_at": 1553504328
}