API Test keys

API Test keys

Accept a Dispute

POST
/v1/disputes/:id/accept

Click to copy

Use this endpoint to accept a dispute charge, indicating that you do not wish to contest the dispute, acknowledging it as lost.

  • The dispute status will change from open to lost.
  • Accepting a dispute is irreversible.

Is this page helpful?

Curl

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

Success

Failure

1
{
2
"id": "disp_AHfqOvkldwsbqt",
3
"entity": "dispute",
4
"payment_id": "pay_EsyWjHrfzb59eR",
5
"amount": 10000,
6
"currency": "INR",
7
"amount_deducted": 10000,
8
"reason_code": "pre_arbitration",
9
"respond_by": 1590604200,
10
"status": "lost",
11
"phase": "pre_arbitration",
12
"created_at": 1590059211,
13
"evidence": {
14
"amount": 10000,
15
"summary": null,
16
"shipping_proof": null,
17
"billing_proof": null,
18
"cancellation_proof": null,
19
"customer_communication": null,
20
"proof_of_service": null,
21
"explanation_letter": null,
22
"refund_confirmation": null,
23
"access_activity_log": null,
24
"refund_cancellation_policy": null,
25
"term_and_conditions": null,
26
"others": null,
27
"submitted_at": null
28
}
29
}
Path Parameters
id

*

string

The unique identifier of the 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

.

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

.

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

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

Accept a Dispute

POST
/v1/disputes/:id/accept

Click to copy

Use this endpoint to accept a dispute charge, indicating that you do not wish to contest the dispute, acknowledging it as lost.

  • The dispute status will change from open to lost.
  • Accepting a dispute is irreversible.

Is this page helpful?

Path Parameters
id

*

string

The unique identifier of the 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

.

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

.

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

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

Curl

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

Success

Failure

1
{
2
"id": "disp_AHfqOvkldwsbqt",
3
"entity": "dispute",
4
"payment_id": "pay_EsyWjHrfzb59eR",
5
"amount": 10000,
6
"currency": "INR",
7
"amount_deducted": 10000,
8
"reason_code": "pre_arbitration",
9
"respond_by": 1590604200,
10
"status": "lost",
11
"phase": "pre_arbitration",
12
"created_at": 1590059211,
13
"evidence": {
14
"amount": 10000,
15
"summary": null,
16
"shipping_proof": null,
17
"billing_proof": null,
18
"cancellation_proof": null,
19
"customer_communication": null,
20
"proof_of_service": null,
21
"explanation_letter": null,
22
"refund_confirmation": null,
23
"access_activity_log": null,
24
"refund_cancellation_policy": null,
25
"term_and_conditions": null,
26
"others": null,
27
"submitted_at": null
28
}
29
}