API Test Keys

Fetch All Disputes

GET

/v1/disputes

Click to copy

Use this endpoint to retrieve all the disputes raised by your customers.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X GET https://api.razorpay.com/v1/disputes \
3-H "Content-Type: application/json"

Success

Failure

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "disp_Esz7KAitoYM7PJ",
7      "entity": "dispute",
8      "payment_id": "pay_EsyWjHrfzb59eR",
9      "amount": 10000,
10      "currency": "INR",
11      "amount_deducted": 0,
12      "reason_code": "pre_arbitration",
13      "respond_by": 1590604200,
14      "status": "open",
15      "phase": "pre_arbitration",
16      "created_at": 1590059211,
17      "evidence": {
18        "amount": 10000,
19        "summary": null,
20        "shipping_proof": null,
21        "billing_proof": null,
22        "cancellation_proof": null,
23        "customer_communication": null,
24        "proof_of_service": null,
25        "explanation_letter": null,
26        "refund_confirmation": null,
27        "access_activity_log": null,
28        "refund_cancellation_policy": null,
29        "term_and_conditions": null,
30        "others": null,
31        "submitted_at": null
32      }
33    },
34    {
35      "id": "disp_Esyvk3kZj0isXk",
36      "entity": "dispute",
37      "payment_id": "pay_EsyWjHrfzb59eR",
38      "amount": 5000,
39      "currency": "INR",
40      "amount_deducted": 0,
41      "reason_code": "warning_bulletin_or_exception_file",
42      "respond_by": 1590604200,
43      "status": "won",
44      "phase": "chargeback",
45      "created_at": 1590058554,
46      "evidence": {
47        "amount": 5000,
48        "summary": null,
49        "shipping_proof": [
50          "doc_EFtmUsbwpXwBH9",
51          "doc_EFtmUsbwpXwBH8"
52        ],
53        "billing_proof": null,
54        "cancellation_proof": null,
55        "customer_communication": null,
56        "proof_of_service": null,
57        "explanation_letter": null,
58        "refund_confirmation": null,
59        "access_activity_log": null,
60        "refund_cancellation_policy": null,
61        "term_and_conditions": null,
62        "others": null,
63        "submitted_at": 1590604100
64      }
65    }
66  ]
67}

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 api key provided is invalid

Error Status: 401

This error occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.

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 All Disputes

GET

/v1/disputes

Click to copy

Use this endpoint to retrieve all the disputes raised by your customers.

Is this page helpful?

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 api key provided is invalid

Error Status: 401

This error occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.

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

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X GET https://api.razorpay.com/v1/disputes \
3-H "Content-Type: application/json"

Success

Failure

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "disp_Esz7KAitoYM7PJ",
7      "entity": "dispute",
8      "payment_id": "pay_EsyWjHrfzb59eR",
9      "amount": 10000,
10      "currency": "INR",
11      "amount_deducted": 0,
12      "reason_code": "pre_arbitration",
13      "respond_by": 1590604200,
14      "status": "open",
15      "phase": "pre_arbitration",
16      "created_at": 1590059211,
17      "evidence": {
18        "amount": 10000,
19        "summary": null,
20        "shipping_proof": null,
21        "billing_proof": null,
22        "cancellation_proof": null,
23        "customer_communication": null,
24        "proof_of_service": null,
25        "explanation_letter": null,
26        "refund_confirmation": null,
27        "access_activity_log": null,
28        "refund_cancellation_policy": null,
29        "term_and_conditions": null,
30        "others": null,
31        "submitted_at": null
32      }
33    },
34    {
35      "id": "disp_Esyvk3kZj0isXk",
36      "entity": "dispute",
37      "payment_id": "pay_EsyWjHrfzb59eR",
38      "amount": 5000,
39      "currency": "INR",
40      "amount_deducted": 0,
41      "reason_code": "warning_bulletin_or_exception_file",
42      "respond_by": 1590604200,
43      "status": "won",
44      "phase": "chargeback",
45      "created_at": 1590058554,
46      "evidence": {
47        "amount": 5000,
48        "summary": null,
49        "shipping_proof": [
50          "doc_EFtmUsbwpXwBH9",
51          "doc_EFtmUsbwpXwBH8"
52        ],
53        "billing_proof": null,
54        "cancellation_proof": null,
55        "customer_communication": null,
56        "proof_of_service": null,
57        "explanation_letter": null,
58        "refund_confirmation": null,
59        "access_activity_log": null,
60        "refund_cancellation_policy": null,
61        "term_and_conditions": null,
62        "others": null,
63        "submitted_at": 1590604100
64      }
65    }
66  ]
67}