Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cashfree Payments Disputes API

Collection of APIs to handle disputes.

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

This API exposes 5 operations across 5 paths, and defines 15 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.

5 operations 5 paths 15 schemas 3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.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 Disputes 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 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Disputes 5

Collection of APIs to handle disputes.

GET
/orders/{order_id}/disputes
Get Disputes by Order Id
PGFetchOrderDisputes 4 params → 200400401404409422429500
GET
/payments/{cf_payment_id}/disputes
Get Disputes by Payment ID
PGFetchPaymentDisputes 4 params → 200400401404409422429500
GET
/disputes/{dispute_id}
Get Disputes by Dispute ID
PGFetchDisputeByID 4 params → 200400401404409422429500
PUT
/disputes/{dispute_id}/accept
Accept Dispute by Dispute ID
PGAcceptDisputeByID 4 params → 200400401404409422429500
POST
/disputes/{dispute_id}/documents
Submit Evidence to contest the Dispute by Dispute ID
PGUploadDisputesDocuments 4 params body → 200400401404409422429500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are DisputesEntity (16 properties), DisputesEntityMerchantAccepted (15 properties), OrderDetailsInDisputesEntity (6 properties), BadRequestError (4 properties). Each schema is shown below with its type and property counts.

BadRequestError
object
Invalid request received from client
4 properties
RateLimitError
object
Error when rate limit is breached for your api
3 properties
PreferredEvidence
array
AuthenticationError
object
Error if api keys are wrong
3 properties
OrderDetailsInDisputesEntity
object
6 properties
CustomerDetailsInDisputesEntity
object
3 properties
DisputesEntityMerchantAccepted
object
15 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
ApiError404
object
Error when resource requested is not found
4 properties
DisputesEntity
object
16 properties
EvidencesToContestDispute
object
2 properties
DisputeEvidence
array
Evidence
object
3 properties
ApiError409
object
duplicate request
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cashfree-disputes-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 Easy-Split API
Cashfree Payments Eligibility API
Cashfree Payments Generate KYC Link API
Cashfree Payments Generate Static KYC Link API
Cashfree Payments Get KYC Link Status API