Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates Flow

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Custom Payment Links

Postman Collection

Implement Thematic Changes in Payment Links Checkout Section

Change Business Name and Description

Customize Payment Methods

Prefill Checkout Fields

Rename Labels in Checkout Section

Advanced Options

Receive Payments via Bank Transfer

Offers on Payment Links

Managing Reminders for Payment Links

Perform Third-Party Validation Using Payment Links

Transfer Payments Received Using Payment Links

Api

Orders

Fetch All

API Test Keys

Fetch All Orders

GET
/v1/orders

Click to copy

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.

Is this page helpful?

Curl

change language

change language

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

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 2,
4
  "items": [
5
    {
6
      "id": "order_LOWd2oQUw06ytP",
7
      "entity": "order",
8
      "amount": 200000,
9
      "amount_paid": null,
10
      "amount_due": 200000,
11
      "currency": "MYR",
12
      "receipt": "OLps1X8ySGXBy0bPp5qfk",
13
      "offer_id": null,
14
      "status": "attempted",
15
      "attempts": 1,
16
      "notes": [],
17
      "created_at": 1678168289
18
    },
19
    {
20
      "id": "order_LOWc64onz1VpYU",
21
      "entity": "order",
22
      "amount": 200000,
23
      "amount_paid": null,
24
      "amount_due": 200000,
25
      "currency": "MYR",
26
      "receipt": "IPS2aD-aY5f6yw84wJspo",
27
      "offer_id": null,
28
      "status": "attempted",
29
      "attempts": 1,
30
      "notes": [],
31
      "created_at": 1678168235
32
    }
33
  ]
34
}
Query Parameters
authorized
boolean

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.

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 RM 295.00, 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

ISO code for the currency in which you want to accept the payment. The default length is 3 characters.

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.

Errors

The API <key/secret> provided is invalid.

Error Status: 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

Fetch All Orders

GET
/v1/orders

Click to copy

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.

Is this page helpful?

Query Parameters
authorized
boolean

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.

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 RM 295.00, 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

ISO code for the currency in which you want to accept the payment. The default length is 3 characters.

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.

Errors

The API <key/secret> provided is invalid.

Error Status: 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

Curl

change language

change language

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

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 2,
4
  "items": [
5
    {
6
      "id": "order_LOWd2oQUw06ytP",
7
      "entity": "order",
8
      "amount": 200000,
9
      "amount_paid": null,
10
      "amount_due": 200000,
11
      "currency": "MYR",
12
      "receipt": "OLps1X8ySGXBy0bPp5qfk",
13
      "offer_id": null,
14
      "status": "attempted",
15
      "attempts": 1,
16
      "notes": [],
17
      "created_at": 1678168289
18
    },
19
    {
20
      "id": "order_LOWc64onz1VpYU",
21
      "entity": "order",
22
      "amount": 200000,
23
      "amount_paid": null,
24
      "amount_due": 200000,
25
      "currency": "MYR",
26
      "receipt": "IPS2aD-aY5f6yw84wJspo",
27
      "offer_id": null,
28
      "status": "attempted",
29
      "attempts": 1,
30
      "notes": [],
31
      "created_at": 1678168235
32
    }
33
  ]
34
}