Cashfree Payments Developer Documentation

POST

orders

curl --request POST \
  --url https://sandbox.cashfree.com/pg/orders \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "order_currency": "INR",
  "order_amount": 10.34,
  "customer_details": {
    "customer_id": "7112AAA812234",
    "customer_phone": "9898989898"
  }
}'

Copy
{
  "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",
    "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10"
  },
  "entity": "order",
  "order_amount": 22,
  "payment_session_id": "session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH",
  "order_currency": "INR",
  "order_expiry_time": "2023-09-09T18:02:46+05:30",
  "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij",
  "order_meta": {
    "return_url": "https://www.cashfree.com/devstudio/thankyou",
    "payment_methods": "cc",
    "notify_url": "https://example.com/cf_notify"
  },
  "order_note": "some order note LIST",
  "order_splits": [],
  "order_status": "ACTIVE",
  "order_tags": {
    "name": "John",
    "age": "19"
  },
  "terminal_data": null,
  "cart_details": {
    "cart_id": "1"
  }
}

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:2025-01-01

required

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

x-request-id

string

Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.

x-idempotency-key

string

An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.

Body

application/json

Request body to create an order at cashfree

order_amount

number

required

Bill amount for the order. Provide upto two decimals. 10.15 means Rs 10 and 15 paisa

Required range: x >= 1

Example:

10.15

order_currency

string

required

Currency for the order. INR if left empty. Contact care@cashfree.com to enable new currencies.

Example:

"INR"

customer_details

object

required

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,
  "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10"
}

order_id

string

Order identifier present in your system. Alphanumeric, '_' and '-' only

Required string length: 3 - 45

Example:

"your-order-id"

cart_details

object

The cart details that are necessary like shipping address, billing address and more.

terminal

object

Use this if you are creating an order for cashfree's softPOS

Example:

{
  "added_on": "2023-08-04T13:12:58+05:30",
  "cf_terminal_id": "31051123",
  "last_updated_on": "2023-09-06T14:07:00+05:30",
  "terminal_address": "Banglore",
  "terminal_id": "terminal-1212",
  "terminal_name": "test",
  "terminal_note": "POS vertical",
  "terminal_phone_no": "6309291183",
  "terminal_status": "ACTIVE",
  "terminal_type": "SPOS"
}

order_meta

object

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

order_meta.return_url

string

The URL to which user will be redirected to after the payment on bank OTP page. Maximum length: 250. We suggest to keep context of order_id in your return_url so that you can identify the order when customer lands on your page. Example of return_url format could be https://www.cashfree.com/devstudio/thankyou

Example:

"https://www.cashfree.com/devstudio/thankyou"

order_meta.notify_url

string

Notification URL for server-server communication. Useful when user's connection drops while re-directing. NotifyUrl should be an https URL. Maximum length: 250.

Example:

"https://example.com/cf_notify"

order_meta.payment_methods

any

Allowed payment modes for this order. Pass comma-separated values among following options - "cc", "dc", "ccc", "ppc","nb","upi","paypal","app","paylater","cardlessemi","dcemi","ccemi","banktransfer". Leave it blank to show all available payment methods

order_meta.payment_methods_filters

object

Allowed payment modes for this order. Along with multiple filters for cards can be added to this key. And this filtering will be honoured during transaction creation.

order_meta.payment_methods_filters.methods

object

Allowed payment modes for this order. credit_card, debit_card, netbanking, paylater, etc are the values that can be passed to this parameter.

order_meta.payment_methods_filters.filters

object

This object takes details of all the filtering that has to be done for this order. Filters on card bins, card schemes, card issuing bank and card suffixes

Example:

{
  "return_url": "https://www.cashfree.com/devstudio/thankyou",
  "payment_methods": "cc,dc"
}

order_expiry_time

string

Time after which the order expires. Customers will not be able to make the payment beyond the time specified here. We store timestamps in IST, but you can provide them in a valid ISO 8601 time format. Example 2021-07-02T10:20:12+05:30 for IST, 2021-07-02T10:20:12Z for UTC

Example:

"2021-07-02T10:20:12+05:30"

order_note

string

Order note for reference.

Required string length: 3 - 200

Example:

"Test order"

order_tags

object

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",
  "name": "John Doe",
  "city": "Bangalore"
}

order_splits

object[]

If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount.

Use to split order when cashfree's Easy Split is enabled for your account.

Example:

[{ "amount": 10, "vendor": "john" }]

products

object

Use this to set configurations for the products like One Click Checkout, Verify and Pay, if they are enabled for your account

Response

200

application/json

The complete order entity

cf_order_id

string

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. TERMINATED: Order terminated TERMINATION_REQUESTED: Order termination requested

payment_session_id

string

order_expiry_time

string

order_note

string

Additional note for order

created_at

string

When the order was created at cashfree's server

Example:

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

order_splits

object[]

Use to split order when cashfree's Easy Split is enabled for your account.

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,
  "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10"
}

order_meta

object

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

order_meta.return_url

string

Example:

"https://www.cashfree.com/devstudio/thankyou"

order_meta.notify_url

string

Notification URL for server-server communication. Useful when user's connection drops while re-directing. NotifyUrl should be an https URL. Maximum length: 250.

Example:

"https://example.com/cf_notify"

order_meta.payment_methods

any

order_meta.payment_methods_filters

object

Allowed payment modes for this order. Along with multiple filters for cards can be added to this key. And this filtering will be honoured during transaction creation.

order_meta.payment_methods_filters.methods

object

Allowed payment modes for this order. credit_card, debit_card, netbanking, paylater, etc are the values that can be passed to this parameter.

order_meta.payment_methods_filters.filters

object

This object takes details of all the filtering that has to be done for this order. Filters on card bins, card schemes, card issuing bank and card suffixes

order_tags

object

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"
}

cart_details

object

Cart Details in the Order Entity Response

terminal_data

object

Terminal Data in the create order response

Example:

{
  "agent_mobile_number": "9876543214",
  "cf_terminal_id": 1838,
  "merchant_terminal_id": "ahdsgadjhgfaj7137e",
  "terminal_type": "STOREFRONT"
}

products

object

Configurations for the products like One Click Checkout, Verify and Pay, if they are enabled for your account

Was this page helpful?

Overview Get Order

curl --request POST \
  --url https://sandbox.cashfree.com/pg/orders \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "order_currency": "INR",
  "order_amount": 10.34,
  "customer_details": {
    "customer_id": "7112AAA812234",
    "customer_phone": "9898989898"
  }
}'

Copy
{
  "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",
    "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10"
  },
  "entity": "order",
  "order_amount": 22,
  "payment_session_id": "session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH",
  "order_currency": "INR",
  "order_expiry_time": "2023-09-09T18:02:46+05:30",
  "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij",
  "order_meta": {
    "return_url": "https://www.cashfree.com/devstudio/thankyou",
    "payment_methods": "cc",
    "notify_url": "https://example.com/cf_notify"
  },
  "order_note": "some order note LIST",
  "order_splits": [],
  "order_status": "ACTIVE",
  "order_tags": {
    "name": "John",
    "age": "19"
  },
  "terminal_data": null,
  "cart_details": {
    "cart_id": "1"
  }
}

Payments API

v2025-01-01

Other Versions

Create Order

Order

Authorizations

Headers

Body

Response