Fetch All Orders

Fetch all Orders using Razorpay Orders API.

GET /v1/orders

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]\
-X GET https://api.razorpay.com/v1/orders?count=2&skip=1

Success

{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "order_EKzX2WiEWbMxmx",
      "entity": "order",
      "amount": 1234,
      "amount_paid": 0,
      "amount_due": 1234,
      "currency": "MYR",
      "receipt": "Receipt No. 1",
      "offer_id": null,
      "status": "created",
      "attempts": 0,
      "notes": [],
      "created_at": 1582637108
    },
    {
      "id": "order_EAI5nRfThga2TU",
      "entity": "order",
      "amount": 100,
      "amount_paid": 0,
      "amount_due": 100,
      "currency": "MYR",
      "receipt": "Receipt No. 1",
      "offer_id": null,
      "status": "created",
      "attempts": 0,
      "notes": [],
      "created_at": 1580300731
    }
  ]
}

Use this endpoint to retrieve the details of all the orders you created. In this example, count and skip query parameters have been used. You can invoke this API without these query parameters as well.

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]\
-X GET https://api.razorpay.com/v1/orders?count=2&skip=1

Success

{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "order_EKzX2WiEWbMxmx",
      "entity": "order",
      "amount": 1234,
      "amount_paid": 0,
      "amount_due": 1234,
      "currency": "MYR",
      "receipt": "Receipt No. 1",
      "offer_id": null,
      "status": "created",
      "attempts": 0,
      "notes": [],
      "created_at": 1582637108
    },
    {
      "id": "order_EAI5nRfThga2TU",
      "entity": "order",
      "amount": 100,
      "amount_paid": 0,
      "amount_due": 100,
      "currency": "MYR",
      "receipt": "Receipt No. 1",
      "offer_id": null,
      "status": "created",
      "attempts": 0,
      "notes": [],
      "created_at": 1580300731
    }
  ]
}

Query Parameters

authorized · integer

Possible values:

• 1 : Retrieves Orders for which payments have been authorized. Payment and order states differ. Know more about payment states.
• 0 : Retrieves orders for which payments have not been authorized.

receipt · string

Retrieves the orders that contain the provided value for receipt.

from · integer

Timestamp (in Unix format) from when the orders should be fetched.

to · integer

Timestamp (in Unix format) up till when orders are to be fetched.

count · integer

The number of orders to be fetched. The default value is 10. The maximum value is 100. This can be used for pagination, in combination with skip.

skip · integer

The number of orders to be skipped. The default value is 0. This can be used for pagination, in combination with count.

expand[] · array

Used to retrieve additional information about the payment. Using this parameter will cause a sub-entity to be added to the response. Supported values are:

• payments: Returns a collection of all payments made for each order.
• payments.card: Returns the card details of each payment made for each order.
• transfers: Returns a collection of transfers created for each order.
  For more information about creating transfers using orders, refer to the Route section of the Route API documentation.
• virtual_account: Returns the virtual account details created for each order.
  For more information about creating Virtual Accounts, refer to the Smart Collect API

Response Parameters

id · string

The unique identifier of the order.

amount · integer

The amount for which the order was created, in currency subunits. For example, for an amount of , enter 29500.

entity · string

Name of the entity. Here, it is order.

amount_paid · integer

The amount paid against the order.

amount_due · integer

The amount pending against the order.

currency · string · required

ISO code for the currency in which you want to accept the payment. The default length is 3 characters. Refer to the list of supported currencies.

receipt · string

Receipt number that corresponds to this order. Can have a maximum length of 40 characters and has to be unique.

status · string

The status of the order. Possible values:

• created: When you create an order it is in the created state. It stays in this state till a payment is attempted on it.
• attempted: An order moves from created to attempted state when a payment is first attempted on it. It remains in the attempted state till one payment associated with that order is captured.
• paid: After the successful capture of the payment, the order moves to the paid state. No further payment requests are permitted once the order moves to the paid state. The order stays in the paid state even if the payment associated with the order is refunded.

attempts · integer

The number of payment attempts, successful and failed, that have been made against this order.

notes · json object

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at · integer

Indicates the Unix timestamp when this order was created.

offer_id · string

Unique identifier of the offer associated with this order.

token · object

The recurring-payment token created when the order was authorised on a subscription / recurring flow. Present on orders that resulted in a token-bearing payment.

auth_type · string

The authentication type used to create the token. One of 3ds, otp, aadhaar, or physical for emandate / mandate_otp for UPI.

expire_at · integer

Unix timestamp when the token expires.

failure_reason · string

Human-readable reason if the token-creation flow failed. null on success.

first_payment_amount · integer

Amount of the first recurring payment, in the smallest currency unit (paise for INR).

frequency · string

Frequency of the recurring debit. One of as_presented, daily, weekly, monthly, yearly, etc.

max_amount · integer

Maximum amount that can be debited per cycle, in the smallest currency unit (paise for INR).

recurring_status · string

Lifecycle state of the recurring token. One of initiated, confirmed, rejected, cancelled, paused, or expired.

Errors

The API `<key/secret> ` provided is invalid.

Code: 400

The API credentials passed in the API call differ from the ones generated on the Dashboard. Possible reasons:

• Different keys for test mode and live modes.
• Expired API key.

Solution: The API keys must be active and entered correctly with no whitespace before or after the keys.

The count must be at least 1.

Code: 400

count=0 (or omitted with explicit zero) passed in the query string.

Solution: Pass count as a positive integer between 1 and 100.

The count may not be greater than 100.

Code: 400

count value above 100 in the query string. The Orders list endpoint caps per-page results at 100.

Solution: Use a count of 100 or fewer. For larger datasets, paginate using the skip parameter.

The count must be an integer.

Code: 400

count query parameter is non-numeric (for example, count=abc).

Solution: Pass count as a positive integer.

The from must be an integer.

Code: 400

from query parameter is not a UNIX-epoch integer (for example, an ISO date string was passed).

Solution: Pass from as a UNIX-epoch integer (for example, 1700000000), not a human-readable date.

Value of each expand must be one of following types.

Code: 400

An unsupported value was passed in the expand[] query parameter.

Solution: Only the following values are accepted in expand[]: payments, payments.card, virtual_account, transfers, offers.