Skip to main content
GET
/
orders
/
{order_id}
Get Order
curl --request GET \
  --url https://sandbox.cashfree.com/pg/orders/{order_id} \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "cf_order_id": 2149460581,
  "created_at": "2023-08-11T18:02:46+05:30",
  "customer_details": {
    "customer_id": "409128494",
    "customer_name": "Johmn Doe",
    "customer_email": "pmlpayme@ntsas.com",
    "customer_phone": "9876543210"
  },
  "entity": "order",
  "order_amount": 22,
  "order_currency": "INR",
  "order_expiry_time": "2023-09-09T18:02:46+05:30",
  "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij",
  "order_meta": {
    "return_url": "https://example.com/return/{order_id}",
    "notify_url": "https://example.com/notify",
    "payment_methods": "cc"
  },
  "order_note": "some order note LIST",
  "order_splits": [],
  "order_status": "ACTIVE",
  "order_tags": {
    "name": "John",
    "age": "19"
  },
  "payment_session_id": "session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH",
  "payments": {
    "url": "https://sandbox.cashfree.com/pg/orders/order_3242Tq4Edj9CC5RDcMeobmJOWOBJij/payments"
  },
  "refunds": {
    "url": "https://sandbox.cashfree.com/pg/orders/order_3242Tq4Edj9CC5RDcMeobmJOWOBJij/refunds"
  },
  "settlements": {
    "url": "https://sandbox.cashfree.com/pg/orders/order_3242Tq4Edj9CC5RDcMeobmJOWOBJij/settlements"
  },
  "terminal_data": null
}

Authorizations

ā€‹
x-client-id
string
header
required

Client app ID. You can find your app id in the Merchant Dashboard.

ā€‹
x-client-secret
string
header
required

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

ā€‹
x-api-version
string
default:2022-09-01
required

API version to be used. Format is in YYYY-MM-DD

ā€‹
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

ā€‹
x-idempotency-key
string<UUID>

Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors.

Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders

Path Parameters

ā€‹
order_id
string
required

The id which uniquely identifies your order

Response

OK

The complete order entity

ā€‹
cf_order_id
integer

unique id generated by cashfree for your order

ā€‹
order_id
string

order_id sent during the api request

ā€‹
entity
string

Type of the entity.

ā€‹
order_currency
string

Currency of the order. Example INR

ā€‹
order_amount
number
ā€‹
order_status
string

Possible values are

  • ACTIVE: Order does not have a sucessful transaction yet
  • PAID: Order is PAID with one successful transaction
  • EXPIRED: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order.
ā€‹
payment_session_id
string
ā€‹
order_expiry_time
string<date-time>
ā€‹
order_note
string | null

Additional note for order

ā€‹
created_at
string<date-time>

When the order was created at cashfree's server

Example:

"2022-08-16T14:45:38+05:30"

ā€‹
order_splits
VendorSplit Ā· object[]
ā€‹
customer_details
object

The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.

Example:
{
  "customer_id": "7112AAA812234",
  "customer_email": "john@cashfree.com",
  "customer_phone": "9908734801",
  "customer_name": "John Doe",
  "customer_bank_account_number": "1518121112",
  "customer_bank_ifsc": "XITI0000001",
  "customer_bank_code": 3333
}
ā€‹
order_meta
object

Optional meta details to control how the customer pays and how payment journey completes

ā€‹
payments
object

URL for payment retrieval for an order

ā€‹
settlements
object

Settlement URL object

ā€‹
refunds
object

URL to get refunds for order

ā€‹
order_tags
object | null

Custom Tags in thr form of {"key":"value"} which can be passed for an order. A maximum of 10 tags can be added

Example:
{
  "product": "Laptop",
  "shipping_address": "123 Main St"
}