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 ID that identifies your payment on the gateway.
entity string: Indicates type of entity.
amount string: The amount of payment in paisa. e.g. If amount = 100, it means Rs 1.
currency string: The currency in which the payment is made. Refer the list of international cuurencies that we support.
status string: The status of payment. It can be created, authorized, captured, refunded, failed.
method string: Method used during payment, Can be card,netbanking, wallet or emi.
order string: Order ID if provided.
description string: Description, if any as provided.
international bool: Whether the payment is done via an international card.
refund_status string: The refund status of payment. Can be null, partial or full.
amount_refunded integer: The amount refunded in paisa.
For example, amount = 100, it means ₹ 1
captured bool: The payment has been captured or not.
email string: Customer email address used for the payment.
contact string: Customer contact number for the payment.
fee string: Indicates type of entity.
amount string: Fee charged by us including GST.
tax integer: GST charged.
error_code string: Error description of an error during payment.
notes json object: Contains user defined fields, stored for reference purposes.
created_at timestamp: Timestamp of payment creation.
Wallet string: Mobikwik, PayUMoney, JioMoney
UPI Hot: Universal Payments Interface Can be spread in multiple lines

 Example Payment Entity
Copy{
  "id": "pay_29QQoUBi66xm2f",
  "entity": "payment",
  "amount": 5000,
  "currency": "INR",
  "status": "captured",
  "method": "card",
  "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 end-point captures a payment.

/payments/:id/capture

Request Parameters#

id string: The ID of the payment to capture
amount string: The amount to be captured (should be equal to the authorized amount, in paise.)

CurlPHPPythonRuby.NETJava
Copycurl -u rzp_test_26ccbdbfe0e84b:69b2e24411e384f91213f22a \
   -X POST \
   --data "amount=500" \
   https://api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f/capture
Copy<?php

use Razorpay\Api\Api;

$api = new Api('rzp_test_26ccbdbfe0e84b', '69b2e24411e384f91213f22a');

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

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

import razorpay

client = razorpay.Client(auth=("<YOUR_API_KEY>", "<YOUR_API_SECRET>"))

payment_id = "<PAYMENT_ID>"

payment_amount = <PAYMENT AMOUNT>

resp = client.payment.capture(payment_id, payment_amount)
Copyrequire 'razorpay'

Razorpay.setup("rzp_test_26ccbdbfe0e84b", "69b2e24411e384f91213f22a")

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

request({
  method: 'POST',
  url: 'https://rzp_test_26ccbdbfe0e84b:69b2e24411e384f91213f22a@api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f/capture',
  form: {
    amount: 500
  }
}, function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});
CopyRazorpayClient client = new RazorpayClient("<api-key>", "<api-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("<api_key>", "<api_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());
}

 response
Copy{
    "id": "pay_7IZD7aJ2kkmOjk",
    "entity": "payment",
    "amount": 50000,
    "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
}

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

After 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. This could be from the database order amount, for eg.

Please do not accept the capture amount from the user, for security reasons.

Note:
Check the status of payment has been successfully set to captured after the request and there is no error in response.

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 payment id.

/payment/:id

Request Parameters#

id: string The id of the payment to be retrieved. A sample payment id: pay_29QQoUBi66xm2f

CurlPHPPython.lang.ruby.lang.node.lang.dotnet.lang.java
Copycurl -u rzp_test_26ccbdbfe0e84b:69b2e24411e384f91213f22a \
https://api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f
Copy<?php

use Razorpay\Api\Api;

$api = new Api('rzp_test_26ccbdbfe0e84b', '69b2e24411e384f91213f22a');

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

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

import razorpay

client = razorpay.Client(auth=("<YOUR_API_KEY>", "<YOUR_API_SECRET>"))

payment_id = "<PAYMENT_ID>"

resp = client.payment.fetch(payment_id)
Copyrequire 'razorpay'

Razorpay.setup("rzp_test_26ccbdbfe0e84b", "69b2e24411e384f91213f22a")

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

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

RazorpayClient razorpay = new RazorpayClient("<api_key>", "<api_secret>");
try {
	Payment payment = razorpay.Payments.fetch("<payment_id>");
} catch (RazorpayException e) {
	// Handle Exception
	System.out.println(e.getMessage());
}

 Response
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
}

Fetch Multiple Payments#

The following endpoint is used for retrieving list of payments based on optional parameters:

/payments

Request Parameters#

from timestamp: The timestamp in seconds after which the payments were created.
to timestamp: The timestamp in seconds after which the payments were created.
count integer: The number of payments to fetch.
skip integer: The number of payments to be skipped.

Note:
By default only last 10 are returned. You can use count and skip parameters to change that behavior.

CurlPHPPythonRubyNode.NETJava
Copycurl -u rzp_test_32hsbEKriO6ai4:SC6d7z4FcgX2wJj49obRRT4M -X POST https://api.razorpay.com/v1/payments/
Copy<?php

use Razorpay\Api\Api;

$api = new Api('rzp_test_26ccbdbfe0e84b', '69b2e24411e384f91213f22a');

$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_API_KEY>", "<YOUR_API_SECRET>"))

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

Razorpay.setup("rzp_test_26ccbdbfe0e84b", "69b2e24411e384f91213f22a")

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

request('rzp_test_26ccbdbfe0e84b:69b2e24411e384f91213f22a@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("<api-key>", "<api-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("<api_key>", "<api_secret>");
try {
  JSONObject payemntRequest = new JSONObject();

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

  List<Payment> payments = razorpay.Payments.fetchAll(payemntRequest);
} catch (RazorpayException e) {
  // Handle Exception
    System.out.println(e.getMessage());
}

 Response
Copy{
  "count": 2,
  "entity": "collection",
  "items": [
    {
      "id": "pay_7IZD7aJ2kkmOjk",
      "entity": "payment",
      "amount": 500,
      "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": 12,
      "tax": 2,
      "error_code": null,
      "error_description": null,
      "created_at": 1487348129
    },
    {
      "id": "pay_19btGlBig6xZ2f",
      "entity": "payment",
      "amount": 500,
      "currency": "INR",
      "status": "captured",
      "order_id": null,
      "invoice_id": null,
      "international": false,
      "method": "card",
      "amount_refunded": 0,
      "refund_status": null,
      "captured": true,
      "description": "Purchase Description",
      "card_id": "card_12abClEig3hi2k",
      "bank": null,
      "wallet": null,
      "vpa": null,
      "email": "a@b.com",
      "contact": "91xxxxxxxx",
      "notes": {
        "merchant_order_id": "order id"
      }
    },
    {
      "fee": 12,
      "tax": 2,
      "error_code": null,
      "error_description": null,
      "created_at": 1400826750
    }
  ]
}

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#

Attribute	Type	Description
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 - Discover - JCB - Maestro - MasterCard - RuPay - Unknown - Visa - Union Pay
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 required: ID of the payment, which requires the Notes field to be updated
notes required: Notes of the entity to be modified

 Request Response
Copycurl -u rzp_test_32hsbEKriO6ai4:SC6d7z4FcgX2wJj49obRRT4M -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
}

Curl

PHP

Python

Ruby

.NET

Java

Node