|Creates an order by providing basic details such as amount and currency.|
|Retrieves details of all the orders.|
|Retrieves details of all the orders and expands the payments object.|
|Retrieves details of all the orders and expands cards parameter in the payments object.|
|Retrieves details of a particular order.|
|Retrieves all the payments made for an order.|
|Modifies an existing order.|
Create, view and update an Order using Razorpay APIs.
You can create
Orders APIs are used to create, update and retrieve details of Orders. Also, you can retrieve details of payments made towards these Orders.
Explore the Orders API collection below in the Razorpay Postman Public Workspace. Fork the workspace and test the APIs with your
The Order entity has the following fields:
string The unique identifier of the order.
integer The amount for which the order was created, in currency subunits. For example, for an amount of ₹295.00, enter
boolean Indicates whether the customer can make a partial payment. Possible values:
true: The customer can make partial payments.
false(default): The customer cannot make partial payments.
integer The amount paid against the order.
integer The amount pending against the order.
string The currency associated with the order's amount. The default length is 3 characters. Refer to the
string Receipt number that corresponds to this order. Can have a maximum length of 40 characters and has to be unique.
string The status of the order. Possible values:
created: When you create an order it is in the
createdstate. It stays in this state till a payment is attempted on it.
attempted: An order moves from
attemptedstate when a payment is first attempted on it. It remains in the
attemptedstate till one payment associated with that order is captured.
paid: After the successful capture of the payment, the order moves to the
paidstate. No further payment requests are permitted once the order moves to the
paidstate. The order stays in the
paidstate even if the payment associated with the order is refunded.
integer The number of payment attempts, successful and failed, that have been made against this order.
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”.
integer Indicates the Unix timestamp when this order was created.
You can view orders, subscribe to Webhook Events related to orders and view reports related to orders from the
Was this page helpful?