Skip to main content
POST
/
orders
/
sessions
curl --request POST \
  --url https://sandbox.cashfree.com/pg/orders/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "payment_session_id": "session__someidwhichislongandhasnumbers1232132andcharacterscn",
  "payment_method": {
    "upi": {
      "channel": "link"
    }
  }
}
'
{
  "action": "link",
  "cf_payment_id": "4105073870",
  "channel": "link",
  "payment_amount": 1.75,
  "payment_method": "card",
  "data": {
    "url": "https://api.cashfree.com/pg/view/gateway/session_FEeYTISZ-xOJcuR7YeOZOm1MhVIrjHa2l1G79Pg_ZktVJxPSdu7oAKf9RTFZQlR19lkBU7VGIh8dARedu9otO8VstZVT3-HpjLpIn75v-hKCNOxYuEOV_wJ975ed89f2-ad57-4094-8728-7cff9f1928f2",
    "payload": null,
    "content_type": null,
    "method": null
  }
}
Run in Postman: You can also try this API in our Postman Collection.

​
Error codes

The following table lists the error codes, descriptions, and types you may encounter when initiating a payment:
CodeDescriptionTypeStatus
channel_missingThe channel field is required but was not included in the request.invalid_request_error400
phone_invalidThe phone field must contain a valid 10-digit Indian phone number (for example, 9090407368). Value received: 1234567890invalid_request_error400
phone_missingThe phone field is required but was not included in the request.invalid_request_error400
provider_missingThe provider field is required but was not included in the request.invalid_request_error400
version_missingThe version field must be one of the following supported values: 2021-05-21, 2022-01-01, 2022-09-01, 2023-08-01, 2025-01-01, or 2026-01-01.invalid_request_error400
card_cvv_invalidThe card_cvv field must be at least 3 characters long. Value received: 12invalid_request_error400
card_cvv_missingThe card_cvv field is required but was not included in the request.invalid_request_error400
card_invalidThe card field is invalid. Provide payment details using one of the following: card details, card_alias, instrument_id, or cryptogram.invalid_request_error400
bank_processing_failureThe transaction could not be created at the banking partner. Retry the request or contact support if the issue persists.api_error502
request_invalidCards issued in India cannot be used for transactions where the order currency is non-INR. Value received: AUDinvalid_request_error400
orderpay_not_foundThe specified order is no longer active and cannot be used to initiate a payment.invalid_request_error404
card_bank_name_missingThe card_bank_name field is required but was not included in the request.invalid_request_error400
card_bank_name_invalidThe card_bank_name field contains an unrecognized value. Accepted values are: hdfc, icici, kotak, rbl, bob, axis, standard chartered, au, yes, indus, fed, hsbc, citi, sbi, amex, onecard, or idfc. Value received: INVALID$BANKinvalid_request_error400
card_expiry_yy_missingThe card_expiry_yy field is required but was not included in the request.invalid_request_error400
card_expiry_yy_invalidThe card_expiry_yy field must be at least 2 characters long. Value received: 0invalid_request_error400
card_expiry_mm_missingThe card_expiry_mm field is required but was not included in the request.invalid_request_error400
card_expiry_mm_invalidThe card_expiry_mm field must be at least 2 characters long. Value received: 0invalid_request_error400
card_number_invalidThe card_number field contains an invalid card number. Verify the card number and try again. Value received: INVALIDinvalid_request_error400
card_number_missingThe card_number field is required but was not included in the request.invalid_request_error400
card_not_foundThe card details could not be retrieved. Verify the card information and try again.invalid_request_error404
emi_tenure_missingThe emi_tenure field is required but was not included in the request.invalid_request_error400
order_amount_invalidThe order amount exceeds the maximum allowed value. The amount must be less than 1,000,000.invalid_request_error400
netbanking_account_number_invalidThe netbanking_account_number field must be at least 9 characters long. Value received: testinvalid_request_error400
netbanking_bank_code_invalidThe netbanking_bank_code field contains an invalid value. Provide a supported bank code and try again.invalid_request_error400
netbanking_ifsc_invalidThe netbanking_ifsc field contains an invalid IFSC code. Verify the IFSC and try again. Value received: INVALIDinvalid_request_error400
request_failedThe selected payment mode is not configured for this account. Enable the payment mode or contact support.invalid_request_error400
currency_invalidThe currency field does not accept INR for this request. Use a supported non-INR currency. Value received: INRinvalid_request_error400
currency_missingThe currency field is required but was not included in the request.invalid_request_error400
risk_data.customer_ip_invalidThe risk_data.customer_ip field contains an invalid IP address. Provide a valid IPv4 or IPv6 address. Value received: 1.1.1invalid_request_error400
risk_data_ip_address_request_failedThe IP address could not be resolved. Verify the IP address and try again.invalid_request_error400
order_token_missingThe order_token field is required but was not included in the request.invalid_request_error400
payment_method_invalidThe payment_method field contains an unrecognized value. Provide a valid payment method and try again.invalid_request_error400
payment_method_missingThe payment_method field is required but was not included in the request.invalid_request_error400
payment_method_unsupportedThe specified payment method is not supported for this request. Use a supported payment method and try again.invalid_request_error400

Headers

​
x-api-version
string
default:2025-01-01
required

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.

Body

application/json

Request body to create a transaction at Cashfree using payment_session_id.

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

​
payment_method
CardPaymentMethod · object
required

Payload for different payment methods is given below.

​
save_instrument
boolean

Send as true if the customer has given consent to save or tokenise the card; otherwise, send as false.

​
offer_id
string

This is required if any offers needs to be applied to the order.

Example:

"faa6cc05-d1e2-401c-b0cf-0c9db3ff0f0b"

Response

Success response for order pay.

Order pay response once you create a transaction for that order.

​
payment_amount
number

Total amount payable.

​
cf_payment_id
string<int64>

Payment identifier created by Cashfree.

​
payment_method
enum<string>

The payment method used for this transaction.

  • netbanking: Net banking payment.
  • card: Credit or debit card payment.
  • upi: UPI payment via collect, intent, or QR code.
  • app: Wallet-based payment.
  • cardless_emi: Cardless EMI payment.
  • paylater: Pay later payment.
  • banktransfer: Direct bank transfer payment.
  • applepay: Apple Pay payment.
Available options:
netbanking,
card,
upi,
app,
cardless_emi,
paylater,
banktransfer,
applepay
​
channel
enum<string>

The channel used for the payment method.

  • link: Redirect-based flow where the customer is taken to an external page.
  • post: Native OTP flow where the merchant renders a custom UI to collect OTP.
  • collect: UPI collect request sent to the customer's VPA.
  • qrcode: UPI QR code for the customer to scan.
  • podQrCode: Pay on delivery QR code.
Available options:
link,
post,
collect,
qrcode,
podQrCode
​
action
enum<string>

The action to complete the payment.

  • link: Redirect the customer to data.url using a browser or in-app webview.
  • post: Render a native UI, collect required input, and POST it to data.url.
  • form: Render the form from data.payload and auto-submit it to data.url.
  • custom: Follow integration-specific instructions or SDK handling.
Available options:
link,
post,
custom,
form
​
data
OrderPayData · object

The data object of Order Pay API.