Create an Order

Creates a new order. An order represents a payment intent. You must create an order before accepting a payment from a customer.

POST /orders

Create an Order

cURL

curl --request POST \
  --url https://api.razorpay.com/v1/orders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 50000,
  "currency": "INR",
  "receipt": "receipt_1001",
  "notes": {
    "customer_name": "John Doe",
    "order_type": "premium"
  },
  "partial_payment": false
}
'

200

{
  "id": "order_IluGWxBm9U8zJ8",
  "entity": "order",
  "amount": 50000,
  "amount_paid": 0,
  "amount_due": 50000,
  "currency": "INR",
  "receipt": "receipt_1001",
  "status": "created",
  "attempts": 0,
  "notes": {
    "customer_name": "John Doe",
    "order_type": "premium"
  },
  "created_at": 1595491008
}

Authorizations

Authorization · string · header · required

Use your Razorpay Key ID as the username and Key Secret as the password.

Body

application/json

Request body for creating a new order.

amount · integer · required

The transaction amount in the smallest currency sub-unit (e.g., paise for INR). For example, 50000 represents ₹500. Must be a positive integer.

Example:

50000

currency · string · required

The ISO 4217 currency code for the transaction. Currently only INR is supported.

Example:

"INR"

receipt · string

A unique receipt number for the order, for your internal reference. Maximum length is 40 characters.

Example:

"receipt_1001"

notes · object

A key-value store of custom metadata to attach to the order. Maximum 15 key-value pairs, with keys and values up to 256 characters each.

Show child attributes

Example:

{
  "customer_name": "John Doe",
  "order_type": "premium"
}

partial_payment · boolean

Whether the order allows partial payments. If true, the customer can pay the amount in multiple installments.

Example:

false

Response

200

application/json

The order was successfully created.

A Razorpay Order object representing a payment order.

id · string

Unique identifier for the order.

Example:

"order_IluGWxBm9U8zJ8"

entity · string

Entity type, always order for order objects.

Example:

"order"

amount · integer

The order amount in the smallest currency sub-unit (e.g., paise for INR). For example, 50000 represents ₹500.

Example:

50000

amount_paid · integer

The amount paid against the order, in the smallest currency sub-unit.

Example:

0

amount_due · integer

The remaining amount to be paid against the order, in the smallest currency sub-unit.

Example:

50000

currency · string

The ISO 4217 currency code for the order.

Example:

"INR"

receipt · string

A unique receipt number provided by the merchant for internal reference.

Example:

"receipt_1001"

status · enum<string>

The current status of the order.

Available options: created, attempted, paid

Example:

"created"

attempts · integer

The number of payment attempts made against this order.

Example:

0

notes · object

A key-value store of custom metadata to attach to the order. Values must be strings.

Show child attributes

Example:

{
  "customer_name": "John Doe",
  "order_type": "premium"
}

created_at · integer

Unix timestamp (in seconds) at which the order was created.

Example:

1595491008