Cashfree Payments Orders API is one of 23 APIs that Cashfree Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
4 operations
across 3 paths,
and defines 47 schemas.
It is described by OpenAPI 3.0.0, at version 2025-01-01.
Requests are made against 2 base URLs: https://sandbox.cashfree.com/pg, https://api.cashfree.com/pg.
4 operations3 paths47 schemas2 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Cashfree Payments Orders API declares
5 security schemes
for authenticating requests.
An API key is passed in the header as x-client-id (XClientID).
An API key is passed in the header as x-client-secret (XClientSecret).
An API key is passed in the header as x-client-signature (XClientSignatureHeader).
An API key is passed in the header as x-partner-apikey (XPartnerAPIKey).
An API key is passed in the header as x-partner-merchantid (XPartnerMerchantID).
XClientID — Client app ID. You can find your app id in the [merchant dashboard](https://merchant.cashfree.com/merchants/pg/developers/api-keys?env=prod").
XClientSecret — Client secret key. You can find your secret in the [merchant dashboard](https://merchant.cashfree.com/merchants/pg/developers/api-keys?env=prod").
XClientSignatureHeader — Use this if you do not want to pass the secret key and instead want to use the signature.
XPartnerAPIKey — If you are partner and you are making an api call on behalf of a merchant
XPartnerMerchantID — If you are partner use this to specify the merchant id if you don't have the merchant client app id
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are OrderEntity (17 properties), CreateOrderRequest (12 properties), AddressDetails (11 properties), OrderExtendedDataEntity (11 properties). Each schema is shown below with its type and property counts.
RateLimitError
object
Error when rate limit is breached for your api
3 properties
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.
8 properties
OrderEntity
object
The complete order entity
17 properties
OfferMeta
object
Offer meta details object
5 properties5 required
OfferTnc
object
Offer terms and condition object
2 properties2 required
TerminalDetails
object
Use this if you are creating an order for cashfree's softPOS
10 properties1 required
OfferEMI
object
EMI offer object
1 property1 required
OfferWallet
object
Offer object for wallet payment method
1 property1 required
ExtendedCartDetails
object
The cart details that are necessary like shipping address, billing address and more.
2 properties
CardArray
string
short code for credit card, debit card, prepaid card
CreateOrderRequest
object
Request body to create an order at cashfree
12 properties3 required
CartDetails
object
The cart details that are necessary like shipping address, billing address and more.
6 properties
OfferCard
object
Offers related to cards
1 property1 required
BadRequestError
object
Invalid request received from client
4 properties
OfferUPI
object
Offer object for UPI
1 property1 required
DiscountDetails
object
detils of the discount object of offer
3 properties3 required
ProductDetails
object
Specify the required configurations for this feature
2 properties
OfferDetails
object
Offer details and type
3 properties1 required
IdempotencyError
object
Error when idempotency fails. Different request body with the same idempotent key
4 properties
TerminalData
object
Terminal Data in the create order response
4 properties
OrderExtendedDataEntity
object
The complete order extended data entity
11 properties
CartAddress
object
Address given for cart details.
7 properties
OfferExtendedDetails
object
Details of the offer which got applied to the paid order.
6 properties
ProductConditions
object
3 properties
SchemeArray
string
array of card schemes like visa, master etc
CustomerDetails
object
The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.
8 properties2 required
ApiError409
object
duplicate request
4 properties
CartDetailsEntity
object
Cart Details in the Order Entity Response
1 property
AuthenticationError
object
Error if api keys are wrong
3 properties
AddressDetails
object
Address associated with the customer.
11 properties
OfferPaylater
object
Offer object for paylater
1 property1 required
OrderTags
object
Custom Tags in thr form of {"key":"value"} which can be passed for an order. A maximum of 10 tags can be added
CashbackDetails
object
Cashback detail boject
3 properties3 required
OfferValidations
object
Offer validation object
3 properties2 required
ProductDetailsEntity
object
Configurations for this feature
2 properties
VendorSplit
object
Use to split order when cashfree's Easy Split is enabled for your account.
4 properties1 required
OrderMeta
object
Optional meta details to control how the customer pays and how payment journey completes
4 properties
ExtendedCustomerDetails
object
Recent Customer details associated with the order.
5 properties
CartItem
object
Each item in the cart.
10 properties
OfferNB
object
Offer object ofr NetBanking
1 property1 required
ApiError
object
Error at cashfree's server
4 properties
ApiError404
object
Error when resource requested is not found
4 properties
ProductConditionsEntity
object
3 properties
TerminateOrderRequest
object
Request to terminate an active order at Cashfree
1 property1 required
OfferAll
object
returns all offers
1 property1 required
AllOffers
object
All offers applicable
ChargesEntity
object
Charges accociated with the order
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
