API Endpoint | Description |
---|---|
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. |
Orders
Create, view and update an Order using Razorpay APIs.
You can create
and link them to payments.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:
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 ₹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
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 thecreated
state. It stays in this state till a payment is attempted on it.attempted
: An order moves fromcreated
toattempted
state when a payment is first attempted on it. It remains in theattempted
state till one payment associated with that order is captured.paid
: After the successful capture of the payment, the order moves to thepaid
state. No further payment requests are permitted once the order moves to thepaid
state. The order stays in thepaid
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
.to configure and receive notifications when a specific occurs. When one of these events is triggered, we send an HTTP POST in JSON to the webhook's configured URL.
Was this page helpful?
ON THIS PAGE