Orders APIs are used to create, update and retrieve details of Orders. Also, you can retrieve details of payments made towards these Orders.
You can try out our APIs on the Razorpay Postman Public Workspace.
Upgrade Your Orders API
The payment_capture parameter, earlier passed for automatic capture of payments, is being deprecated and hence no longer required. For automatically capturing the payments, visit our payment capture settings page.
Integrations
Looking to integrate your website, ecommerce store or mobile app with Razorpay Payment Gateway? Find the right integration method.
If you want to integrate with our APIs directly, reach out to our Support team with your requirements.
integer The amount for which the order was created, in currency subunits. For example, for an amount of βΉ295, enter 29500.
partial_paymentoptional
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.
integer The amount for which the order was created, in currency subunits. For example, for an amount of βΉ295, enter 29500. Payment can only be made for this amount against the Order.
currencymandatory
string 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.
receiptoptional
string Receipt number that corresponds to this order, set for your internal reference. Can have a maximum length of 40 characters and has to be unique.
notesoptional
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β.
partial_paymentoptional
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.
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.
receiptoptional
string Retrieves the orders that contain the provided value for receipt.
fromoptional
integer Timestamp (in Unix format) from when the orders should be fetched.
tooptional
integer Timestamp (in Unix format) up till when orders are to be fetched.
countoptional
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.
skipoptional
integer The number of orders to be skipped. The default value is 0. This can be used for pagination, in combination with count.
expand[]optional
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 Transfers 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 documentation.
The following endpoint helps you modify the notes field in a particular order:
/orders/:id/
You can modify an existing order to update the Notes field only. Notes can be used to record additional information about the order. A key-value store, the notes field can have a maximum of 15 key-value pairs, each of 256 characters (maximum).
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β.
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.