Orders

The following section will explain the order entity and their associated API

Order Entity#

The order entity consists of the following fields:

id: string The order id of this particular order.
amount: integer The amount for which the Order was created.
currency: string The currency associated with the Order's amount. Refer the list of supported currencies.
attempts: integer The number of payment attempts that have been made against this order.
status: string The status of the Order.
Possible values:
- created
- attempted
- paid Notes:
An Order moves from created to attempted state when a payment request is first made on that Order. It remains in the attempted state till any payment associated with that Order is captured. After the successful capture of the payment, Order moves to the paid state. No further payment requests are permitted after the Order attains the paid state.
receipt: string Your receipt id corresponding to this order. Maximum length 40 chars.
payment_capture: boolean Flag for auto capturing the payment.
created_at: integer The timestamp corresponding to this order's creation time.
notes: dictionary Object consisting of notes passed while creating an order Entity.

 Sample Entity
Copy{
  "id": "order_4xbQrmEoA5WJ0G",
  "entity": "order",
  "amount": 50000,
  "currency": "INR",
  "receipt": "Receipt #20",
  "status": "created",
  "attempts": 0,
  "created_at": 1455696638,
  "notes": {}
}

Create an Order#

The following endpoint creates an order:

/orders

Request Parameters#

Following are the parameters that can be passed:

amount required: Amount for the order in paisa. Payment can only be made for this amount against the order.
currency required: INR is the only supported currency currently.
receipt required: Your receipt id for this order should be passed in here. Maximum length 40 characters.
payment_capture optional: Payment capture flag for auto capturing payment.
notes optional: Object consisting of key value pairs as notes. To read more, refer Notes.

Below are sample requests for creating an order:

CurlJavaPythonPHP.NETRuby.lang.Node.JS
Copycurl -u rzp_test_26ccbdbfe0e84b:69b2e24411e384f91213f22a \
    https://api.razorpay.com/v1/orders
    -X POST \
    --data "amount=50000" \
    --data "currency=INR" \
    --data "receipt=Receipt #20" \
    --data "payment_capture=1"
    https://api.razorpay.com/v1/orders
Copytry {
  JSONObject orderRequest = new JSONObject();
  // amount in the smallest currency unit
  orderRequest.put("amount", amount);
  orderRequest.put("currency", "INR");
  orderRequest.put("receipt", "test_1");
  orderRequest.put("payment_capture", true);

  Order order = razorpay.Orders.create(orderRequest);
} catch (RazorpayException e) {
  // Handle Exception
  System.out.println(e.getMessage());
}
Copyorder_amount =<ORDER AMOUNT>
order_currency = 'INR'
order_receipt = '<ORDER_RECEIPT>'
notes = {'key': 'value'}   # OPTIONAL

client.order.create(amount=order_amount, currency=order_currency, receipt=order_receipt, notes=notes, payment_capture='1')
Copy$order  = $client->order->create([
  'receipt'         => '<ORDER_RECEIPT>',
  // amount in the smallest currency unit
  'amount'          => 100,
  'currency'        => 'INR',
  'payment_capture' =>  '1'
]);
CopyDictionary<string, object> options = new Dictionary<string,object>();
// amount in the smallest currency unit
options.Add("amount", 100);
options.add("receipt", "<ORDER_RECEIPT");
options.add("currency", "INR");
options.add("payment_capture", "1");
Order order = client.Order.Create(options);
Copyoptions = amount: 5000, currency: 'INR', receipt: '<ORDER_RECEIPT>', payment_capture: '1'
order = Razorpay::Order.create

Copyvar options = {
  // amount in pase
  amount: 100,
  currency: "INR",
  receipt: "<ORDER_RECEIPT>",
  payment_capture: '1'
};
instance.orders.create(options, function(err, order) {
  console.log(order);
});

 JSON Response
Copy{
  "id": "order_4xbQrmEoA5WJ0G",
  "entity": "order",
  "amount": 50000,
  "currency": "INR",
  "receipt": "Receipt #20",
  "status": "created",
  "attempts": 0,
  "created_at": 1455696638,
  "notes": {}
}

Fetch Orders#

The following endpoint retrieves the details of all orders created by you:

/orders

Request Parameters#

from optional: Timestamp from when orders are to be fetched
to optional: Timestamp up till when orders are to be fetched
count optional: Count of orders to be fetched. Default Count is 10
skip optional: Numbers of orders to be skipped. Default Skip is 0
authorized optional: Orders for which payments are currently in authorized state.
receipt optional: Orders with the provided value for receipt

JavaPython
Copyimport java.util.List;
import com.razorpay.Order;
import org.json.JSONObject;
import com.razorpay.RazorpayClient;
import com.razorpay.RazorpayException;

RazorpayClient razorpay = new RazorpayClient("<api_key>", "<api_secret>");
try {
  JSONObject orderRequest = new JSONObject();

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

  List<Order> orders = razorpay.Orders.fetchAll(orderRequest);
} catch (RazorpayException e) {
  // Handle Exception
  System.out.println(e.getMessage());
}
Copy# do easy_install razorpay or
#    pip install razorpay

import razorpay

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

resp = client.order.fetch_all()

 JSON
Copy{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "order_4xbVikJiVknbcr",
      "entity": "order",
      "amount": 500,
      "currency": "INR",
      "receipt": "order36",
      "status": "created",
      "attempts": 0,
      "created_at": 1455696913,
      "notes": {}
    },
    {
      "id": "order_4xbSwsPABDJ8oK",
      "entity": "order",
      "amount": 500,
      "currency": "INR",
      "receipt": "order33",
      "status": "created",
      "attempts": 0,
      "created_at": 1455696756,
      "notes": {}
    }
  ]
}

Fetch an Order with Id#

The following endpoint retrieves the order details of a particular order:

/orders/:id

Request Parameters#

id required: Id of order to be fetched.

JavaPython
Copyimport com.razorpay.Order;
import com.razorpay.RazorpayClient;
import com.razorpay.RazorpayException;

RazorpayClient razorpay = new RazorpayClient("<api_key>", "<api_secret>");
try {
  Order order = razorpay.Orders.fetch("<order_id>");
} catch (RazorpayException e) {
  // Handle Exception
  System.out.println(e.getMessage());
}
Copy# do easy_install razorpay or
#    pip install razorpay

import razorpay

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

order_id = <ORDER_ID>

resp = client.order.fetch(order_id)

JSON
Copy{
  "id": "order_4xbVikJiVknbcr",
  "entity": "order",
  "amount": 600,
  "currency": "INR",
  "receipt": "order33",
  "status": "created",
  "attempts": 0,
  "notes": {},
  "created_at": 1455696913
}

Update the Order#

You can modify an existing Order to update the Notes field only. Notes can be used to record additional information about the Order. 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 Order, construct the API request as follows:

/orders/:id/

id required: ID of the order in which the Notes field to be updated
notes required: Notes of the entity to be modified

 Request Response
Copycurl -X PATCH \
  https://api.razorpay.com/v1/orders/:id \
  -H 'Content-Type: application/json' \
  -d '{
	"notes": {
		"key1": "value3", 
		"key2": "value2"
	}
}'
Copy{
    "id": "order_CU613W3rcJhd0B",
    "entity": "order",
    "amount": 5000,
    "amount_paid": 5000,
    "amount_due": 0,
    "currency": "INR",
    "receipt": "BILL13375649",
    "offer_id": null,
    "status": "paid",
    "attempts": 1,
    "notes": {
        "key1": "value3",
        "key2": "value2"
    },
    "created_at": 1557550831
}

Fetch Payments for an Order#

You can retrieve all the payments made for an Order. The response contains multiple payment attempts, authorized and failed, for that Order.

/orders/:id/payments

Path Parameters#

id mandatory: string Unique identifier of the order for which the payments should be retrieved.

 Response
Copy{
    "entity": "collection",
    "count": 2,
    "items": [
        {
            "id": "pay_D2xKAb5FOoxdSV",
            "entity": "payment",
            "amount": 200,
            "currency": "INR",
            "status": "authorized",
            "order_id": "order_D2x2t1kks0P3yK",
            "invoice_id": null,
            "international": false,
            "method": "netbanking",
            "amount_refunded": 0,
            "refund_status": null,
            "captured": false,
            "description": null,
            "card_id": null,
            "bank": "HDFC",
            "wallet": null,
            "vpa": null,
            "email": "gaurav.kumar@acme.com",
            "contact": "+919972006858",
            "notes": [],
            "fee": null,
            "tax": null,
            "error_code": null,
            "error_description": null,
            "created_at": 1565162126
        },
        {
            "id": "pay_D2xIkEAhIgqNhH",
            "entity": "payment",
            "amount": 200,
            "currency": "INR",
            "status": "failed",
            "order_id": "order_D2x2t1kks0P3yK",
            "invoice_id": null,
            "international": false,
            "method": "netbanking",
            "amount_refunded": 0,
            "refund_status": null,
            "captured": false,
            "description": null,
            "card_id": null,
            "bank": "HDFC",
            "wallet": null,
            "vpa": null,
            "email": "gaurav.kumar@acme.com",
            "contact": "+919972006858",
            "notes": [],
            "fee": null,
            "tax": null,
            "error_code": "BAD_REQUEST_ERROR",
            "error_description": "Payment failed",
            "created_at": 1565162045
        }
    ]
}```

Curl

Java

Python

PHP

.NET

Ruby