Orders APIs are used to create, update and retrieve details of Orders. Also, you can retrieve details of payments made towards these Orders.
Upgrade your Orders API Integration:
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.
Looking to integrate your website, ecommerce store or mobile app with Razorpay Payment Gateway? Visit our Introduction to Razorpay page to find the right integration method for you.
If you want to directly integrate with our APIs, reach out to our Support team with your requirements.
string Receipt number that corresponds to this order. Can have a maximum length of 40 characters.
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.
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 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).
Using the PATCH operation, you can replace the entire notes object for the entity.
To modify the notes field in a particular order, construct the API request as follows:
json object Notes of the entity to be modified. Learn more about notes in the API documentation.
string Unique identifier of the order in which the Notes field must be updated.