API Test Keys

Disputes Entity

The Disputes entity has the following parameters:

Is this page helpful?

Entity

1{
2  "id":"disp_AHfqOvkldwsbqt",
3  "entity":"dispute",
4  "payment_id":"pay_EsyWjHrfzb59eR",
5  "amount":10000,
6  "currency":"INR",
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":9000,
15    "summary":"goods delivered",
16    "shipping_proof":[
17      "doc_EFtmUsbwpXwBH9",
18      "doc_EFtmUsbwpXwBH8"
19    ],
20    "billing_proof":[
21      "doc_EFtmUsbwpXwBG9",
22      "doc_EFtmUsbwpXwBG8"
23    ],
24    "cancellation_proof":null,
25    "customer_communication":null,
26    "proof_of_service":null,
27    "explanation_letter":null,
28    "refund_confirmation":null,
29    "access_activity_log":null,
30    "refund_cancellation_policy":null,
31    "term_and_conditions":null,
32    "others":[
33      {
34        "type":"receipt_signed_by_customer",
35        "document_ids":[
36          "doc_EFtmUsbwpXwBH1",
37          "doc_EFtmUsbwpXwBH7"
38        ]
39      }
40    ],
41    "submitted_at":null
42  }
43}

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)

Disputes Entity

The Disputes entity has the following parameters:

Is this page helpful?

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)

Entity

1{
2  "id":"disp_AHfqOvkldwsbqt",
3  "entity":"dispute",
4  "payment_id":"pay_EsyWjHrfzb59eR",
5  "amount":10000,
6  "currency":"INR",
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":9000,
15    "summary":"goods delivered",
16    "shipping_proof":[
17      "doc_EFtmUsbwpXwBH9",
18      "doc_EFtmUsbwpXwBH8"
19    ],
20    "billing_proof":[
21      "doc_EFtmUsbwpXwBG9",
22      "doc_EFtmUsbwpXwBG8"
23    ],
24    "cancellation_proof":null,
25    "customer_communication":null,
26    "proof_of_service":null,
27    "explanation_letter":null,
28    "refund_confirmation":null,
29    "access_activity_log":null,
30    "refund_cancellation_policy":null,
31    "term_and_conditions":null,
32    "others":[
33      {
34        "type":"receipt_signed_by_customer",
35        "document_ids":[
36          "doc_EFtmUsbwpXwBH1",
37          "doc_EFtmUsbwpXwBH7"
38        ]
39      }
40    ],
41    "submitted_at":null
42  }
43}