Cashfree Payments Developer Documentation

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 key in the Merchant Dashboard.

Headers

x-api-version

string

default:2023-08-01

required

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

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>

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

Path Parameters

order_id

string

required

The id which uniquely identifies your order

Response

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<date-time>

order_note

string

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[]

Show child attributes

order_splits.vendor_id

string

required

Vendor id created in Cashfree system

order_splits.amount

number

Amount which will be associated with this vendor

order_splits.percentage

number

Percentage of order amount which shall get added to vendor account

order_splits.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

Show child attributes

order_splits.tags.{key}

object

customer_details

CustomerDetailsResponse · object

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

Show child attributes

customer_details.customer_id

string

A unique identifier for the customer. Use alphanumeric values only.

Required string length: 3 - 50

customer_details.customer_email

string

Customer email address.

Required string length: 3 - 100

customer_details.customer_phone

string

Customer phone number.

Required string length: 10

customer_details.customer_name

string

Name of the customer.

Required string length: 3 - 100

customer_details.customer_bank_account_number

string

Customer bank account. Required if you want to do a bank account check (TPV)

Required string length: 3 - 20

customer_details.customer_bank_ifsc

string

Customer bank IFSC. Required if you want to do a bank account check (TPV)

customer_details.customer_bank_code

number

Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV)

customer_details.customer_uid

string

Customer identifier at Cashfree. You will get this when you create/get customer

Example:

{
  "customer_id": "7112AAA812234",
  "customer_email": "[email protected]",
  "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

OrderMeta · object

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

Show child attributes

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

Example:

"cc,dc,upi"

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

Show child attributes

order_tags.{key}

string

Required string length: 1 - 255

Example:

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

cart_details

CartDetailsEntity · object

Cart Details in the Order Entity Response

Show child attributes

cart_details.cart_id

string

ID of the cart that was created

Payments API

v2025-01-01

Other Versions

Get Order

When to use this API

Authorizations

Headers

Path Parameters

Response