API Test Keys

Fetch a Dispute With ID (With Expanded transaction.settlement Details)

GET

/v1/disputes/:id?expand[]=transaction.settlement

Click to copy

Use this endpoint to retrieve the details of a specific dispute using expanded transaction.settlement details.

Is this page helpful?

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X GET https://dashboard.dev.razorpay.in/app/disputes/disp_K8bVLppJ8zp5Wp?expand[]=transaction.settlement \
3-H "Content-Type: application/json"

Success

Failure

1{
2   "status_code":200,
3   "success":true,
4   "data":{
5      "id":"disp_K8bVLppJ8zp5Wp",
6      "entity":"dispute",
7      "payment_id":"pay_K74a54NSclvx1M",
8      "amount":36800,
9      "currency":"USD",
10      "amount_deducted":0,
11      "gateway_dispute_id":"testtwo",
12      "reason_code":"2",
13      "reason_description":"live test",
14      "respond_by":1661711400,
15      "status":"under_review",
16      "phase":"chargeback",
17      "comments":null,
18      "evidence":{
19         "amount":368,
20         "summary":"testing",
21         "submitted_at":1661159542,
22         "shipping_proof":null,
23         "billing_proof":null,
24         "cancellation_proof":null,
25         "customer_communication":null,
26         "proof_of_service":[
27            "doc_K8cgi0fgjXk0En"
28         ],
29         "explanation_letter":null,
30         "refund_confirmation":[
31            "doc_K8chcnednNAcrD"
32         ],
33         "access_activity_log":null,
34         "refund_cancellation_policy":null,
35         "terms_and_conditions":null,
36         "others":[
37            {
38               "type":"second",
39               "document_ids":[
40                  "doc_K8cIsvjyHY5KuO"
41               ]
42            }
43         ]
44      },
45      "lifecycle":[
46         {
47            "change":{
48               "new":{
49                  "status":"under_review"
50               },
51               "old":{
52                  "status":"open"
53               }
54            },
55            "user_id":"AlNVTJfGQwKf7O",
56            "created_at":1661159543,
57            "merchant_id":"AlNVTRJpqd9sqB"
58         }
59      ],
60      "created_at":1661154932,
61      "reason":{
62         "gateway_code":"2",
63         "gateway_description":"livetest",
64         "code":"2",
65         "description":"live test",
66         "network":"Amex"
67      },
68      "transaction":null
69   }
70}

Path Parameters

id

string

The unique identifier of the dispute.

Query Parameters

expand[]=transaction.settlement

string

Use to expand the transaction.settlement details of a dispute.

Response Parameters

id

string

The unique identifier of the dispute generated by Razorpay. For example, disp_AHfqOvkldwsbqt.

entity

string

Indicates the type of entity. In this case, it is dispute.

payment_id

string

The unique identifier of the payment against which the dispute was created. For example, pay_EsyWjHrfzb59eR.

amount

integer

Amount, in currency subunits, for which the dispute was created.

currency

string

3-letter ISO currency code associated with the amount. Check the list of

supported currencies

amount_deducted

integer

The amount, in currency subunits, deducted from your Razorpay current balance when the dispute is lost. This amount will be 0 unless the status of dispute is updated to lost. Know about the different

states of disputes

reason_code

string

Code associated with the reason for the dispute.

reason_description

string

A brief description of the reason for dispute.

respond_by

integer

Unix timestamp by which a response should be sent to the customer.

status

string

The status of the dispute. Possible statuses are:

open: Indicates that the dispute has been created.
under_review: Indicates that the issuing bank is reviewing the dispute.
won: Indicates that the bank has accepted the remedial documents, and you have won the chargeback.
lost: Indicates that the bank did not accept the remedial documents, and you have lost the chargeback.
closed: Indicates that the fraudulent transaction was closed after you provided either the transaction details or made a refund to the customer.

phase

string

Phase associated with the dispute. Possible phases are:

fraud: A dispute raised by the bank when it suspects a transaction to be fraudulent based on the risk analysis.
retrieval: A request initiated by the customer with their issuer bank for additional information about a transaction.
chargeback: A refund claim initiated by the customers with their issuer banks. In such cases, the bank starts an official inquiry.
pre_arbitration: A chargeback that you have won is challenged by the customer for the second time.
arbitration: A chargeback that you have won is challenged for a third time by the customer and the card networks directly getting involved.

created_at

integer

Unix timestamp when the dispute was created.

evidence

object

Provides details of the evidence submitted/saved for contesting a dispute. Use the

Documents API

to securely share documents with Razorpay.

Show child parameters (14)

Errors

The id provided does not exist.

Error Status: 400

A wrong prefix is used.
The dispute id does not exist or does not belong to the requestor.

Solution

_id is not a valid id.

Error Status: 400

The id is not 14 characters long.
The id is not alphanumeric.

Solution

Value of each expand must be one of following types: payment, transaction.settlement

Error Status: 400

The value of the expand query parameter is neither payments nor transaction.settlement.

Solution

Fetch a Dispute With ID (With Expanded transaction.settlement Details)

GET

/v1/disputes/:id?expand[]=transaction.settlement

Click to copy

Use this endpoint to retrieve the details of a specific dispute using expanded transaction.settlement details.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the dispute.

Query Parameters

expand[]=transaction.settlement

string

Use to expand the transaction.settlement details of a dispute.

Response Parameters

id

string

The unique identifier of the dispute generated by Razorpay. For example, disp_AHfqOvkldwsbqt.

entity

string

Indicates the type of entity. In this case, it is dispute.

payment_id

string

The unique identifier of the payment against which the dispute was created. For example, pay_EsyWjHrfzb59eR.

amount

integer

Amount, in currency subunits, for which the dispute was created.

currency

string

3-letter ISO currency code associated with the amount. Check the list of

supported currencies

amount_deducted

integer

states of disputes

reason_code

string

Code associated with the reason for the dispute.

reason_description

string

A brief description of the reason for dispute.

respond_by

integer

Unix timestamp by which a response should be sent to the customer.

status

string

The status of the dispute. Possible statuses are:

open: Indicates that the dispute has been created.
under_review: Indicates that the issuing bank is reviewing the dispute.
won: Indicates that the bank has accepted the remedial documents, and you have won the chargeback.
lost: Indicates that the bank did not accept the remedial documents, and you have lost the chargeback.
closed: Indicates that the fraudulent transaction was closed after you provided either the transaction details or made a refund to the customer.

phase

string

Phase associated with the dispute. Possible phases are:

fraud: A dispute raised by the bank when it suspects a transaction to be fraudulent based on the risk analysis.
retrieval: A request initiated by the customer with their issuer bank for additional information about a transaction.
chargeback: A refund claim initiated by the customers with their issuer banks. In such cases, the bank starts an official inquiry.
pre_arbitration: A chargeback that you have won is challenged by the customer for the second time.
arbitration: A chargeback that you have won is challenged for a third time by the customer and the card networks directly getting involved.

created_at

integer

Unix timestamp when the dispute was created.

evidence

object

Provides details of the evidence submitted/saved for contesting a dispute. Use the

Documents API

to securely share documents with Razorpay.

Show child parameters (14)

Errors

The id provided does not exist.

Error Status: 400

A wrong prefix is used.
The dispute id does not exist or does not belong to the requestor.

Solution

_id is not a valid id.

Error Status: 400

The id is not 14 characters long.
The id is not alphanumeric.

Solution

Value of each expand must be one of following types: payment, transaction.settlement

Error Status: 400

The value of the expand query parameter is neither payments nor transaction.settlement.

Solution

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X GET https://dashboard.dev.razorpay.in/app/disputes/disp_K8bVLppJ8zp5Wp?expand[]=transaction.settlement \
3-H "Content-Type: application/json"

Success

Failure

1{
2   "status_code":200,
3   "success":true,
4   "data":{
5      "id":"disp_K8bVLppJ8zp5Wp",
6      "entity":"dispute",
7      "payment_id":"pay_K74a54NSclvx1M",
8      "amount":36800,
9      "currency":"USD",
10      "amount_deducted":0,
11      "gateway_dispute_id":"testtwo",
12      "reason_code":"2",
13      "reason_description":"live test",
14      "respond_by":1661711400,
15      "status":"under_review",
16      "phase":"chargeback",
17      "comments":null,
18      "evidence":{
19         "amount":368,
20         "summary":"testing",
21         "submitted_at":1661159542,
22         "shipping_proof":null,
23         "billing_proof":null,
24         "cancellation_proof":null,
25         "customer_communication":null,
26         "proof_of_service":[
27            "doc_K8cgi0fgjXk0En"
28         ],
29         "explanation_letter":null,
30         "refund_confirmation":[
31            "doc_K8chcnednNAcrD"
32         ],
33         "access_activity_log":null,
34         "refund_cancellation_policy":null,
35         "terms_and_conditions":null,
36         "others":[
37            {
38               "type":"second",
39               "document_ids":[
40                  "doc_K8cIsvjyHY5KuO"
41               ]
42            }
43         ]
44      },
45      "lifecycle":[
46         {
47            "change":{
48               "new":{
49                  "status":"under_review"
50               },
51               "old":{
52                  "status":"open"
53               }
54            },
55            "user_id":"AlNVTJfGQwKf7O",
56            "created_at":1661159543,
57            "merchant_id":"AlNVTRJpqd9sqB"
58         }
59      ],
60      "created_at":1661154932,
61      "reason":{
62         "gateway_code":"2",
63         "gateway_description":"livetest",
64         "code":"2",
65         "description":"live test",
66         "network":"Amex"
67      },
68      "transaction":null
69   }
70}