API ReferenceIntegrationsKnowledge Base

Orders

You can create orders and link them to payments. Order creation is an important step as it helps you associate every payment with an order, thus preventing multiple payments. It is compulsory to create orders to capture payments automatically. Know more about orders.

Orders and payments go hand-in-hand. Once a payment is captured, the order is marked paid. Know more about:

Orders APIπŸ”—

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
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? 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.
  • You can also collect payments without a website or app, using Razorpay products, such as Payment Links, Payment Pages, Subscription Links, Invoices and Smart Collect.

Postman CollectionπŸ”—

We have a Postman collection to make the integration quicker and easier. Click the Download Postman Collection button below to get started.

Instructions to Use Postman CollectionπŸ”—

  • All Razorpay APIs are authenticated using Basic Authentication.

    • Generate API Keys from the Dashboard.
    • Add your API Keys in Postman. Select the required API β†’ Auth β†’ Type = Basic Auth β†’ Username = [Your_Key_ID]; Password = [Your_Key_secret]
  • Some APIs in the collection require data specific to your account such as order_id (Order ID) as a path parameter.
    Example
    The Fetch Order by ID API requires you to add the order_id as a path parameter.These parameters are enclosed in {} in the collection. For example, {order_id}. The API throws an error if these are incorrect or do not exist in your system.

Order EntityπŸ”—

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, enter 29500.
partial_payment optional
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.

Create an OrderπŸ”—

Use the following endpoint to create an order:

/orders

Request ParametersπŸ”—

amount mandatory
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.
currency mandatory
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.
receipt optional
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.
notes optional
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_payment optional
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.

Fetch OrdersπŸ”—

Use the following endpoint to retrieve the details of all the orders that you created:

/orders

In this example, count and skip query parameters have been used. You can invoke this API without these query parameters as well.

Query ParametersπŸ”—

authorized
boolean Possible values:
  • 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.
receipt
string Retrieves the orders that contain the provided value for receipt.
from
integer Timestamp (in Unix format) from when the orders should be fetched.
to
integer Timestamp (in Unix format) up till when orders are to be fetched.
count
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.
skip
integer The number of orders to be skipped. The default value is 0. This can be used for pagination, in combination with count.
expand[]
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.

ExamplesπŸ”—

The expand[] parameter on the Orders endpoint returns expandable fields in the response:

expand[]=payments
Used to expand the payments made for an order.
expand[]=payments.card
Used to expand the details of the card used for making the payment for each order.

Fetch an Order With IdπŸ”—

Use the following endpoint to retrieve the details of a particular order:

/orders/:id

Path ParameterπŸ”—

id mandatory
string Unique identifier of the order to be retrieved.

Fetch Payments for an OrderπŸ”—

You can retrieve all the payments made for an order. The response contains all the payments, either authorized or failed, for that order.

Use the following endpoint to fetch payments for a particular order: /orders/:id/payments

Path ParameterπŸ”—

id mandatory
string Unique identifier of the order for which the payments should be retrieved.

Update OrderπŸ”—

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.

Use the following endpoint to modify the notes field in a particular order:

/orders/:id/

Path ParameterπŸ”—

id mandatory
string Unique identifier of the order in which the Notes field must be updated.

Request ParameterπŸ”—

notes mandatory
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”.
×