How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cashfree Payments Payments API

Collection of APIs to handle payments.

Cashfree Payments Payments 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 Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 2025-01-01.

Requests are made against 2 base URLs: https://sandbox.cashfree.com/pg, https://api.cashfree.com/pg.

2 operations 2 paths 21 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-01-01
Base URL
https://api.cashfree.com
Authentication
API Key, API Key, API Key, API Key, API Key
License
Resource Areas
1

Authentication & Security 5

Cashfree Payments Payments 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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Payments 2

Collection of APIs to handle payments.

GET
/orders/{order_id}/payments
Get Payments for an Order
PGOrderFetchPayments 4 params → 200400401404409422429500
GET
/orders/{order_id}/payments/{cf_payment_id}
Get Payment by ID
PGOrderFetchPayment 5 params → 200400401404409422429500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are PaymentEntity (21 properties), AuthorizationInPaymentsEntity (8 properties), PaymentGatewayDetails (7 properties), ErrorDetailsInPaymentsEntity (7 properties). Each schema is shown below with its type and property counts.

AuthorizationInPaymentsEntity
object
If preauth enabled for account you will get this body
8 properties
InternationalPaymentEntity
object
International payment details
1 property
PaymentMethodPaylaterInPaymentsEntity
object
paylater payment method object for pay api
1 property
ApiError409
object
duplicate request
4 properties
PaymentMethodCardlessEMIInPaymentsEntity
object
payment method carless object in payment entity
1 property
BadRequestError
object
Invalid request received from client
4 properties
PaymentMethodAppInPaymentsEntity
object
payment method app object in payment entity
1 property
PaymentMethodBankTransferInPaymentsEntity
object
payment method bank transfer object in payment entity
1 property
PaymentGatewayDetails
object
payment gateway details present in the webhook response
7 properties
ApiError
object
Error at cashfree's server
4 properties
IdempotencyError
object
Error when idempotency fails. Different request body with the same idempotent key
4 properties
PaymentMethodCardEMIInPaymentsEntity
object
payment method card emi object in payment entity
1 property
ApiError404
object
Error when resource requested is not found
4 properties
PaymentMethodNetBankingInPaymentsEntity
object
netbanking payment method object for pay
1 property 3 required
ApiError502
object
Error when there is error at partner bank
4 properties
RateLimitError
object
Error when rate limit is breached for your api
3 properties
PaymentMethodCardInPaymentsEntity
object
payment method card object in payment entity
1 property
PaymentEntity
object
payment entity full object
21 properties
PaymentMethodUPIInPaymentsEntity
object
UPI payment method for pay api
1 property 1 required
AuthenticationError
object
Error if api keys are wrong
3 properties
ErrorDetailsInPaymentsEntity
object
The error details are present only for failed payments
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cashfree-payments-api-openapi.yml Raw ↑

Other APIs Cashfree Payments publishes across the network.

Cashfree Subscriptions API
Cashfree Platforms API
Cashfree Payments Authorize API
Cashfree Payments Beneficiary v2 API
Cashfree Payments CreateCashgram API
Cashfree Payments Deactivate Static KYC Link API
Cashfree Payments DeactivateCashgram API
Cashfree Payments Disputes API
Cashfree Payments Easy-Split API
Cashfree Payments Eligibility API
Cashfree Payments Generate KYC Link API
Cashfree Payments Generate Static KYC Link API
Where this information came from

This is an independent, third-party profile of Cashfree Payments Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.