API Test Keys

Contest a Dispute

PATCH

/v1/disputes/:id/contest

Click to copy

Use this endpoint to contest a dispute, indicating that you would like to challenge the dispute raised against a payment.

In addition to explicitly contesting a dispute, the contest process can also be triggered by:

Attaching an evidence document using
Documents API
with having a purpose set to dispute_evidence.
Providing the evidence in textual format.
Specifying the contest amount (partial or full). The default choice is contesting the full amount if it is not specifically mentioned.
Ensure you pass the action parameter as submit to confirm the contest of the dispute. Dispute evidence draft does not get auto-submitted.
Ensure you provide a minimum of one document for contesting a dispute. Add as many relevant documents as possible to maximise the chances of dispute resolution in your favor.

Is this page helpful?

Curl

change language

1// This sample code is for drafting a dispute.
2
3curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
4-X PATCH https://api.razorpay.com/v1/disputes/disp_AHfqOvkldwsbqt/contest \
5-H "Content-Type: application/json"
6-d'{
7  "amount": 5000,
8  "summary": "goods delivered",
9  "shipping_proof": [
10    "doc_EFtmUsbwpXwBH9",
11    "doc_EFtmUsbwpXwBH8"
12  ],
13  "others": [
14    {
15      "type": "receipt_signed_by_customer",
16      "document_ids": [
17        "doc_EFtmUsbwpXwBH1",
18        "doc_EFtmUsbwpXwBH7"
19      ]
20    }
21  ],
22  "action": "draft"
23}'
24
25// This sample code is for submitting a dispute.
26
27curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
28-X PATCH https://api.razorpay.com/v1/disputes/disp_AHfqOvkldwsbqt/contest \
29-H "Content-Type: application/json"
30-d'{
31  "billing_proof": [
32    "doc_EFtmUsbwpXwBG9",
33    "doc_EFtmUsbwpXwBG8"
34  ],
35  "action": "submit"
36}'

Draft

Submit

Failure

1{
2  "id": "disp_AHfqOvkldwsbqt",
3  "entity": "dispute",
4  "payment_id": "pay_EsyWjHrfzb59eR",
5  "amount": 10000,
6  "currency": "",
7  "amount_deducted": 0,
8  "reason_code": "chargeback",
9  "respond_by": 1590604200,
10  "status": "open",
11  "phase": "chargeback",
12  "created_at": 1590059211,
13  "evidence": {
14    "amount": 5000,
15    "summary": "goods delivered",
16    "shipping_proof": [
17      "doc_EFtmUsbwpXwBH9",
18      "doc_EFtmUsbwpXwBH8"
19    ],
20    "billing_proof": null,
21    "cancellation_proof": null,
22    "customer_communication": null,
23    "proof_of_service": null,
24    "explanation_letter": null,
25    "refund_confirmation": null,
26    "access_activity_log": null,
27    "refund_cancellation_policy": null,
28    "term_and_conditions": null,
29    "others": [
30      {
31        "type": "receipt_signed_by_customer",
32        "document_ids": [
33          "doc_EFtmUsbwpXwBH1",
34          "doc_EFtmUsbwpXwBH7"
35        ]
36      }
37    ],
38    "submitted_at": null
39  }
40}

Path Parameters

id

string

The unique identifier of the dispute.

Request Parameters

amount

integer

The amount being contested. If the contest amount is not mentioned, we will assume it to be a full dispute contest.

summary

string

The explanation provided by you for contesting the dispute. It can have a maximum length of 1000 characters.

shipping_proof

list

List of document ids which serves as proof that the product was shipped to the customer at their provided address. It should show their complete shipping address, if possible.

billing_proof

list

List of document ids which serves as proof of order confirmation, such as a receipt.

cancellation_proof

list

List of document ids that serves as proof that this product/service was cancelled.

customer_communication

list

List of document ids listing any written/email communication from the customer confirming that the customer received the product/service or is satisfied with the product/service.

proof_of_service

list

List of document ids showing proof of service provided to the customer.

explanation_letter

list

(List of document ids) Any letter(s) from you specifying information pertinent to the dispute/payment that needs to be considered for processing the dispute.

refund_confirmation

list

List of document ids showing proof that the refund was provided to the customer.

access_activity_log

list

List of document ids of any server or activity logs which prove that the customer accessed or downloaded the purchased digital product.

refund_cancellation_policy

list

List of document ids listing your refund and/or cancellation policy, as shown to the customer.

term_and_conditions

list

List of document ids listing your sales terms and conditions, as shown to the customer.

Show child parameters (1)

action

string

The action to be taken for this contest. Possible values:

draft: Allows you to contest the dispute by updating the dispute entity. This action does not submit the dispute yet. The absence of the key action or a corresponding value would default the action to draft.
submit: Allows you to contest the dispute by updating the dispute entity and submitting the same to Razorpay. You need to provide a minimum of one document id (across any of the evidence object attributes) for a successful submission:
- Submitting for review would change the status of your dispute from open to under_review.
- It triggers the webhook event payment.dispute.under_review.

Add as many relevant documents as possible to maximise the chances of dispute resolution in your favour.

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

invalid_proof_type is/are not required and should not be sent.

Error Status: 400

Incorrect parameters are passed in the request body.

Solution

Action not allowed as deadline to respond has elapsed.

Error Status: 400

The deadline to respond for a dispute has elapsed.

Solution

Action not allowed when dispute is in lost status.

Error Status: 400

This error occurs when you try to perform an action on a dispute with lost status.

Solution

Action not allowed when dispute is in won status.

Error Status: 400

This error occurs when you try to perform an action on a dispute with won status.

Solution

Action not allowed when dispute is in closed status.

Error Status: 400

This error occurs when you try to perform an action on a closed dispute.

Solution

Action not allowed when dispute is in under_review status.

Error Status: 400

This error occurs when you try to perform an action on a dispute under review.

Solution

contest amount cannot be greater than dispute amount.

Error Status: 400

This error occurs when the contest amount is greater than the dispute amount.

Solution

The selected action is invalid.

Error Status: 400

This error occurs when you try to perform an invalid action.

Solution

Invalid file id provided or merchant is unauthorized to access the fileId(s) provided

Error Status: 400

This error occurs when you try to access invalid or unauthorised files.

Solution

Contest a Dispute

PATCH

/v1/disputes/:id/contest

Click to copy

Use this endpoint to contest a dispute, indicating that you would like to challenge the dispute raised against a payment.

In addition to explicitly contesting a dispute, the contest process can also be triggered by:

Attaching an evidence document using
Documents API
with having a purpose set to dispute_evidence.
Providing the evidence in textual format.
Specifying the contest amount (partial or full). The default choice is contesting the full amount if it is not specifically mentioned.
Ensure you pass the action parameter as submit to confirm the contest of the dispute. Dispute evidence draft does not get auto-submitted.
Ensure you provide a minimum of one document for contesting a dispute. Add as many relevant documents as possible to maximise the chances of dispute resolution in your favor.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the dispute.

Request Parameters

amount

integer

The amount being contested. If the contest amount is not mentioned, we will assume it to be a full dispute contest.

summary

string

The explanation provided by you for contesting the dispute. It can have a maximum length of 1000 characters.

shipping_proof

list

List of document ids which serves as proof that the product was shipped to the customer at their provided address. It should show their complete shipping address, if possible.

billing_proof

list

List of document ids which serves as proof of order confirmation, such as a receipt.

cancellation_proof

list

List of document ids that serves as proof that this product/service was cancelled.

customer_communication

list

List of document ids listing any written/email communication from the customer confirming that the customer received the product/service or is satisfied with the product/service.

proof_of_service

list

List of document ids showing proof of service provided to the customer.

explanation_letter

list

(List of document ids) Any letter(s) from you specifying information pertinent to the dispute/payment that needs to be considered for processing the dispute.

refund_confirmation

list

List of document ids showing proof that the refund was provided to the customer.

access_activity_log

list

List of document ids of any server or activity logs which prove that the customer accessed or downloaded the purchased digital product.

refund_cancellation_policy

list

List of document ids listing your refund and/or cancellation policy, as shown to the customer.

term_and_conditions

list

List of document ids listing your sales terms and conditions, as shown to the customer.

Show child parameters (1)

action

string

The action to be taken for this contest. Possible values:

draft: Allows you to contest the dispute by updating the dispute entity. This action does not submit the dispute yet. The absence of the key action or a corresponding value would default the action to draft.
submit: Allows you to contest the dispute by updating the dispute entity and submitting the same to Razorpay. You need to provide a minimum of one document id (across any of the evidence object attributes) for a successful submission:
- Submitting for review would change the status of your dispute from open to under_review.
- It triggers the webhook event payment.dispute.under_review.

Add as many relevant documents as possible to maximise the chances of dispute resolution in your favour.

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

invalid_proof_type is/are not required and should not be sent.

Error Status: 400

Incorrect parameters are passed in the request body.

Solution

Action not allowed as deadline to respond has elapsed.

Error Status: 400

The deadline to respond for a dispute has elapsed.

Solution

Action not allowed when dispute is in lost status.

Error Status: 400

This error occurs when you try to perform an action on a dispute with lost status.

Solution

Action not allowed when dispute is in won status.

Error Status: 400

This error occurs when you try to perform an action on a dispute with won status.

Solution

Action not allowed when dispute is in closed status.

Error Status: 400

This error occurs when you try to perform an action on a closed dispute.

Solution

Action not allowed when dispute is in under_review status.

Error Status: 400

This error occurs when you try to perform an action on a dispute under review.

Solution

contest amount cannot be greater than dispute amount.

Error Status: 400

This error occurs when the contest amount is greater than the dispute amount.

Solution

The selected action is invalid.

Error Status: 400

This error occurs when you try to perform an invalid action.

Solution

Invalid file id provided or merchant is unauthorized to access the fileId(s) provided

Error Status: 400

This error occurs when you try to access invalid or unauthorised files.

Solution

Curl

change language

1// This sample code is for drafting a dispute.
2
3curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
4-X PATCH https://api.razorpay.com/v1/disputes/disp_AHfqOvkldwsbqt/contest \
5-H "Content-Type: application/json"
6-d'{
7  "amount": 5000,
8  "summary": "goods delivered",
9  "shipping_proof": [
10    "doc_EFtmUsbwpXwBH9",
11    "doc_EFtmUsbwpXwBH8"
12  ],
13  "others": [
14    {
15      "type": "receipt_signed_by_customer",
16      "document_ids": [
17        "doc_EFtmUsbwpXwBH1",
18        "doc_EFtmUsbwpXwBH7"
19      ]
20    }
21  ],
22  "action": "draft"
23}'
24
25// This sample code is for submitting a dispute.
26
27curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
28-X PATCH https://api.razorpay.com/v1/disputes/disp_AHfqOvkldwsbqt/contest \
29-H "Content-Type: application/json"
30-d'{
31  "billing_proof": [
32    "doc_EFtmUsbwpXwBG9",
33    "doc_EFtmUsbwpXwBG8"
34  ],
35  "action": "submit"
36}'

Draft

Submit

Failure

1{
2  "id": "disp_AHfqOvkldwsbqt",
3  "entity": "dispute",
4  "payment_id": "pay_EsyWjHrfzb59eR",
5  "amount": 10000,
6  "currency": "",
7  "amount_deducted": 0,
8  "reason_code": "chargeback",
9  "respond_by": 1590604200,
10  "status": "open",
11  "phase": "chargeback",
12  "created_at": 1590059211,
13  "evidence": {
14    "amount": 5000,
15    "summary": "goods delivered",
16    "shipping_proof": [
17      "doc_EFtmUsbwpXwBH9",
18      "doc_EFtmUsbwpXwBH8"
19    ],
20    "billing_proof": null,
21    "cancellation_proof": null,
22    "customer_communication": null,
23    "proof_of_service": null,
24    "explanation_letter": null,
25    "refund_confirmation": null,
26    "access_activity_log": null,
27    "refund_cancellation_policy": null,
28    "term_and_conditions": null,
29    "others": [
30      {
31        "type": "receipt_signed_by_customer",
32        "document_ids": [
33          "doc_EFtmUsbwpXwBH1",
34          "doc_EFtmUsbwpXwBH7"
35        ]
36      }
37    ],
38    "submitted_at": null
39  }
40}