Cashfree Payments Developer Documentation

curl --request POST \
  --url https://sandbox.cashfree.com/pg/orders/sessions/authorize \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '{
  "payment_session_id": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn",
  "authorization_data": {
    "authentication_token": "BwABBJQ1AgAAAAAgJDUCAAAAAAA=",
    "directory_server_transaction_id": "8ac7b70f-9c5c-4e8f-9f4a-6d7c8b2a1e3f",
    "three_ds_server_transaction_id": "9b8a7c6d-5e4f-3210-9876-543210fedcba",
    "eci": "02",
    "token_number": "4111111111111111",
    "token_expiry_year": "2029",
    "token_expiry_month": "09",
    "token_cryptogram": "/wAAAAAAUSwFGXgAAAAAgPAAAA=",
    "transaction_type": "TOKEN"
  }
}'

{
  "auth_id": "302651",
  "authorization": null,
  "bank_reference": "524410198110",
  "cf_payment_id": "4304193706",
  "entity": "payment",
  "error_details": null,
  "international_payment": {
    "international": false
  },
  "is_captured": false,
  "order_amount": 1,
  "order_currency": "INR",
  "order_id": "CFPay_payme_rohittest_3vv0ethp9r",
  "payment_amount": 1,
  "payment_completion_time": "2025-09-01T15:42:38+05:30",
  "payment_currency": "INR",
  "payment_gateway_details": {
    "gateway_name": "CASHFREE",
    "gateway_order_id": "CF_ORDER_987654321",
    "gateway_payment_id": "CF_PAY_123456789",
    "gateway_order_reference_id": "REF_ORD_2025010112345",
    "gateway_status_code": "SUCCESS",
    "gateway_settlement": "cashfree",
    "gateway_reference_name": "APPLE_PAY_TXN_REF"
  },
  "payment_group": "debit_card",
  "payment_message": "PRE_AUTH|Transaction Success",
  "payment_method": {
    "card": {
      "card_bank_name": "KOTAK MAHINDRA BANK",
      "card_country": "IN",
      "card_network": "visa",
      "card_network_reference_id": "VIS_REF_20250101123456",
      "card_number": "XXXXXXXXXXXX4738",
      "card_sub_type": "R",
      "card_type": "debit_card",
      "channel": "link",
      "instrument_id": "0dca46b1-01f7-4a60-9e4a-ae5474603563",
      "par": "V0010014623022637739353641436"
    }
  },
  "payment_offers": [],
  "payment_status": "SUCCESS",
  "payment_surcharge": {
    "payment_surcharge_service_charge": 0,
    "payment_surcharge_service_tax": 0
  },
  "payment_time": "2025-09-01T15:40:58+05:30"
}

POST

orders

sessions

authorize

curl --request POST \
  --url https://sandbox.cashfree.com/pg/orders/sessions/authorize \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '{
  "payment_session_id": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn",
  "authorization_data": {
    "authentication_token": "BwABBJQ1AgAAAAAgJDUCAAAAAAA=",
    "directory_server_transaction_id": "8ac7b70f-9c5c-4e8f-9f4a-6d7c8b2a1e3f",
    "three_ds_server_transaction_id": "9b8a7c6d-5e4f-3210-9876-543210fedcba",
    "eci": "02",
    "token_number": "4111111111111111",
    "token_expiry_year": "2029",
    "token_expiry_month": "09",
    "token_cryptogram": "/wAAAAAAUSwFGXgAAAAAgPAAAA=",
    "transaction_type": "TOKEN"
  }
}'

{
  "auth_id": "302651",
  "authorization": null,
  "bank_reference": "524410198110",
  "cf_payment_id": "4304193706",
  "entity": "payment",
  "error_details": null,
  "international_payment": {
    "international": false
  },
  "is_captured": false,
  "order_amount": 1,
  "order_currency": "INR",
  "order_id": "CFPay_payme_rohittest_3vv0ethp9r",
  "payment_amount": 1,
  "payment_completion_time": "2025-09-01T15:42:38+05:30",
  "payment_currency": "INR",
  "payment_gateway_details": {
    "gateway_name": "CASHFREE",
    "gateway_order_id": "CF_ORDER_987654321",
    "gateway_payment_id": "CF_PAY_123456789",
    "gateway_order_reference_id": "REF_ORD_2025010112345",
    "gateway_status_code": "SUCCESS",
    "gateway_settlement": "cashfree",
    "gateway_reference_name": "APPLE_PAY_TXN_REF"
  },
  "payment_group": "debit_card",
  "payment_message": "PRE_AUTH|Transaction Success",
  "payment_method": {
    "card": {
      "card_bank_name": "KOTAK MAHINDRA BANK",
      "card_country": "IN",
      "card_network": "visa",
      "card_network_reference_id": "VIS_REF_20250101123456",
      "card_number": "XXXXXXXXXXXX4738",
      "card_sub_type": "R",
      "card_type": "debit_card",
      "channel": "link",
      "instrument_id": "0dca46b1-01f7-4a60-9e4a-ae5474603563",
      "par": "V0010014623022637739353641436"
    }
  },
  "payment_offers": [],
  "payment_status": "SUCCESS",
  "payment_surcharge": {
    "payment_surcharge_service_charge": 0,
    "payment_surcharge_service_tax": 0
  },
  "payment_time": "2025-09-01T15:40:58+05:30"
}

Headers

x-api-version

string

default:2026-01-01

required

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

x-request-id

string

Request id for the API call. Can be used to resolve tech issues.

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.

Body

application/json

Request body to authorise the payment transaction.

payment_session_id

string

required

Unique identifier for the payment session, returned in the response of the Create Order API.

Example:

"session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn"

authorization_data

any

required

Response

Payment authorised successfully.

auth_id

string

Example:

"302651"

authorization

any

Additional authorisation object if available.

bank_reference

string

Example:

"524410198110"

cf_payment_id

string

Example:

"4304193706"

entity

string

Example:

"payment"

error_details

any

international_payment

object

Show child attributes

is_captured

boolean

Example:

false

order_amount

number

Example:

1

order_currency

string

Example:

"INR"

order_id

string

Example:

"CFPay_payme_rohittest_3vv0ethp9r"

payment_amount

number

Example:

1

payment_completion_time

string<date-time>

Example:

"2025-09-01T15:42:38+05:30"

payment_currency

string

Example:

"INR"

payment_gateway_details

object

Show child attributes

payment_group

string

Example:

"debit_card"

payment_message

string

Example:

"PRE_AUTH|Transaction Success"

payment_method

object

Show child attributes

payment_offers

object[]

payment_status

string

Example:

"SUCCESS"

payment_surcharge

object

Show child attributes

payment_time

string<date-time>

Example:

"2025-09-01T15:40:58+05:30"

⌘I

Payments API

v2025-01-01

Other Versions

Authorisation Only

Headers

Body

Response