Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates Flow

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Orders

Update

API Test Keys

Update an Order

PATCH
/v1/orders/:id

Click to copy

Use this endpoint to update an 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).

Is this page helpful?

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]\
2
-X PATCH https://api.razorpay.com/v1/orders/order_DaaS6LOUAASb7Y \
3
-d '{
4
  "notes": {
5
    "key1": "value3",
6
    "key2": "value2"
7
  }
8
}'

Success

Failure

1
{
2
  "id": "order_DaaS6LOUAASb7Y",
3
  "entity": "order",
4
  "amount": 2200,
5
  "amount_paid": 0,
6
  "amount_due": 2200,
7
  "currency": "MYR",
8
  "receipt": "Receipt #211",
9
  "offer_id": null,
10
  "status": "attempted",
11
  "attempts": 1,
12
  "notes": {
13
    "key1": "value3",
14
    "key2": "value2"
15
  },
16
  "created_at": 1572505143
17
}
Path Parameters
id

*

string

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

Request Parameters
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”.

Response Parameters
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 RM 295.00, enter 29500.

entity
string

Name of the entity. Here, it is order.

amount_paid
integer

The amount paid against the order.

amount_due
integer

The amount pending against the order.

currency

*

string

ISO code for the currency in which you want to accept the payment. The default length is 3 characters.

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.

Errors

The API <key/secret> provided is invalid.

Error Status: 400

The API credentials passed in the API call differ from the ones generated on the Dashboard. Possible reasons:

  • Different keys for test mode and live modes.
  • Expired API key.

Solution

id is not a valid id.

Error Status: 400

The order_id passed is invalid.

Solution

The id provided does not exist

Error Status: 400

The order_id does not exist or does not belong to the requestor.

Solution

Update an Order

PATCH
/v1/orders/:id

Click to copy

Use this endpoint to update an 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).

Is this page helpful?

Path Parameters
id

*

string

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

Request Parameters
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”.

Response Parameters
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 RM 295.00, enter 29500.

entity
string

Name of the entity. Here, it is order.

amount_paid
integer

The amount paid against the order.

amount_due
integer

The amount pending against the order.

currency

*

string

ISO code for the currency in which you want to accept the payment. The default length is 3 characters.

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.

Errors

The API <key/secret> provided is invalid.

Error Status: 400

The API credentials passed in the API call differ from the ones generated on the Dashboard. Possible reasons:

  • Different keys for test mode and live modes.
  • Expired API key.

Solution

id is not a valid id.

Error Status: 400

The order_id passed is invalid.

Solution

The id provided does not exist

Error Status: 400

The order_id does not exist or does not belong to the requestor.

Solution

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]\
2
-X PATCH https://api.razorpay.com/v1/orders/order_DaaS6LOUAASb7Y \
3
-d '{
4
  "notes": {
5
    "key1": "value3",
6
    "key2": "value2"
7
  }
8
}'

Success

Failure

1
{
2
  "id": "order_DaaS6LOUAASb7Y",
3
  "entity": "order",
4
  "amount": 2200,
5
  "amount_paid": 0,
6
  "amount_due": 2200,
7
  "currency": "MYR",
8
  "receipt": "Receipt #211",
9
  "offer_id": null,
10
  "status": "attempted",
11
  "attempts": 1,
12
  "notes": {
13
    "key1": "value3",
14
    "key2": "value2"
15
  },
16
  "created_at": 1572505143
17
}