GET
/
payments
/
{cf_payment_id}
/
disputes
curl --request GET \
  --url https://sandbox.cashfree.com/pg/payments/{cf_payment_id}/disputes \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
[
  {
    "dispute_id": 433447817,
    "dispute_type": "DISPUTE",
    "reason_code": 1401,
    "reason_description": "Fraud Transaction",
    "dispute_amount": 10,
    "created_at": "2023-01-18T11:26:58",
    "respond_by": "2023-01-19T00:00:00",
    "updated_at": "2023-01-18T11:26:58",
    "resolved_at": "9999-09-09T00:00:00",
    "dispute_status": "DISPUTE_DOCS_RECEIVED",
    "cf_dispute_remarks": "Load Testing",
    "preferred_evidence": [
      {
        "document_type": "Delivery/Service Proof",
        "document_description": "Proof that the cardholder/customer received the goods or services."
      }
    ],
    "dispute_evidence": [
      {
        "document_id": 18150,
        "document_name": "disputeSampleFile.pdf",
        "document_type": "DeliveryProof"
      }
    ],
    "order_details": {
      "order_id": "Load_test_0103_FGA4HF12AC",
      "order_currency": "INR",
      "order_amount": 10,
      "cf_payment_id": 1489901523,
      "payment_currency": "INR",
      "payment_amount": 10
    },
    "customer_details": {
      "customer_name": "John Ellur",
      "customer_phone": 9876543210,
      "customer_email": "john@cashfree.com"
    }
  }
]

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2023-08-01
required

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

​
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

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.

Path Parameters

​
cf_payment_id
integer
required

Cashfree payment ID to view the payment details of an order.

Response

200
application/json
OK
​
dispute_id
integer
​
dispute_type
enum<string>
Available options:
DISPUTE,
CHARGEBACK,
RETRIEVAL,
PRE_ARBITRATION,
ARBITRATION
​
reason_code
string
​
reason_description
string
​
dispute_amount
number

Dispute amount may differ from transaction amount for partial cases.

​
created_at
string

This is the time when the dispute was created.

​
respond_by
string

This is the time by which evidence should be submitted to contest the dispute.

​
updated_at
string

This is the time when the dispute case was updated.

​
resolved_at
string

This is the time when the dispute case was closed.

​
dispute_status
enum<string>
Available options:
DISPUTE_CREATED,
DISPUTE_DOCS_RECEIVED,
DISPUTE_UNDER_REVIEW,
DISPUTE_MERCHANT_WON,
DISPUTE_MERCHANT_LOST,
DISPUTE_MERCHANT_ACCEPTED,
DISPUTE_INSUFFICIENT_EVIDENCE,
CHARGEBACK_CREATED,
CHARGEBACK_DOCS_RECEIVED,
CHARGEBACK_UNDER_REVIEW,
CHARGEBACK_MERCHANT_WON,
CHARGEBACK_MERCHANT_LOST,
CHARGEBACK_MERCHANT_ACCEPTED,
CHARGEBACK_INSUFFICIENT_EVIDENCE,
RETRIEVAL_CREATED,
RETRIEVAL_DOCS_RECEIVED,
RETRIEVAL_UNDER_REVIEW,
RETRIEVAL_MERCHANT_WON,
RETRIEVAL_MERCHANT_LOST,
RETRIEVAL_MERCHANT_ACCEPTED,
RETRIEVAL_INSUFFICIENT_EVIDENCE,
PRE_ARBITRATION_CREATED,
PRE_ARBITRATION_DOCS_RECEIVED,
PRE_ARBITRATION_UNDER_REVIEW,
PRE_ARBITRATION_MERCHANT_WON,
PRE_ARBITRATION_MERCHANT_LOST,
PRE_ARBITRATION_MERCHANT_ACCEPTED,
PRE_ARBITRATION_INSUFFICIENT_EVIDENCE,
ARBITRATION_CREATED,
ARBITRATION_DOCS_RECEIVED,
ARBITRATION_UNDER_REVIEW,
ARBITRATION_MERCHANT_WON,
ARBITRATION_MERCHANT_LOST,
ARBITRATION_MERCHANT_ACCEPTED,
ARBITRATION_INSUFFICIENT_EVIDENCE
​
cf_dispute_remarks
string
​
preferred_evidence
object[]
Example:
{
  "prefferred_evidence": [
    {
      "document_type": "Delivery/Service Proof",
      "document_description": "Proof that the cardholder/customer received the goods or services."
    },
    {
      "document_type": "Statement of Service",
      "document_description": "Account Statement of wallet where funds were loaded by customer."
    }
  ]
}
​
dispute_evidence
object[]
Example:
[
  {
    "document_id": 18150,
    "document_name": "disputeSampleFile.pdf",
    "document_type": "DeliveryProof"
  }
]
​
order_details
object
Example:
{
  "order_id": "Load_test_0103_FGA4HF12AC",
  "order_currency": "INR",
  "order_amount": 10,
  "cf_payment_id": 1489901523,
  "payment_currency": "INR",
  "payment_amount": 10
}
​
customer_details
object
Example:
{
  "customer_name": "Manideep Ellur",
  "customer_phone": 8281554863,
  "customer_email": "manideep.ellur@cashfree.com"
}

Was this page helpful?