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

List of Endpoints

API Endpoint	Description
Create an Order	Creates an order by providing basic details such as amount and currency.
Fetch all Orders	Retrieves details of all the orders.
Fetch all Orders (With Expanded Payments)	Retrieves details of all the orders and expands the payments object.
Fetch all Orders (With Expanded Card Payments)	Retrieves details of all the orders and expands cards parameter in the payments object.
Fetch an Order	Retrieves details of a particular order.
Fetch all Payments for an Order	Retrieves all the payments made for an order.
Update an Order	Modifies an existing order.

Order Entity

The Order entity has the following fields:

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 ₹295.00, enter 29500.

partial_payment

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.

amount_paid

integer The amount paid against the order.

amount_due

integer The amount pending against the order.

currency

string The currency associated with the order's amount. 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.

You can view orders, subscribe to Webhook Events related to orders and view reports related to orders from the

Razorpay Dashboard

Webhooks

Set up Razorpay Webhooks

to configure and receive notifications when a specific

event

occurs. When one of these events is triggered, we send an HTTP POST

payload

in JSON to the webhook's configured URL.