added dispute endpoint (#309)

razorpay · Apr 1, 2024 · e74c3ca · e74c3ca
1 parent 2896eb1
commit e74c3ca
Show file tree

Hide file tree

Showing 6 changed files with 568 additions and 3 deletions.
diff --git a/documents/dispute.md b/documents/dispute.md
@@ -0,0 +1,242 @@
+## Document
+
+### Fetch All Disputes
+
+```java
+Dispute dispute = instance.dispute.fetchAll();
+```
+
+**Response:**
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "disp_Esz7KAitoYM7PJ",
+      "entity": "dispute",
+      "payment_id": "pay_EsyWjHrfzb59eR",
+      "amount": 10000,
+      "currency": "INR",
+      "amount_deducted": 0,
+      "reason_code": "pre_arbitration",
+      "respond_by": 1590604200,
+      "status": "open",
+      "phase": "pre_arbitration",
+      "created_at": 1590059211,
+      "evidence": {
+        "amount": 10000,
+        "summary": null,
+        "shipping_proof": null,
+        "billing_proof": null,
+        "cancellation_proof": null,
+        "customer_communication": null,
+        "proof_of_service": null,
+        "explanation_letter": null,
+        "refund_confirmation": null,
+        "access_activity_log": null,
+        "refund_cancellation_policy": null,
+        "term_and_conditions": null,
+        "others": null,
+        "submitted_at": null
+      }
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Fetch a Dispute
+
+```java
+String disputeId = "disp_0000000000000";
+
+Dispute dispute = instance.dispute.fetchAll(disputeId);
+```
+
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| disputeId*  | string | The unique identifier of the dispute.  |
+
+**Response:**
+```json
+{
+  "id": "disp_AHfqOvkldwsbqt",
+  "entity": "dispute",
+  "payment_id": "pay_EsyWjHrfzb59eR",
+  "amount": 10000,
+  "currency": "INR",
+  "amount_deducted": 0,
+  "reason_code": "pre_arbitration",
+  "respond_by": 1590604200,
+  "status": "open",
+  "phase": "pre_arbitration",
+  "created_at": 1590059211,
+  "evidence": {
+    "amount": 10000,
+    "summary": "goods delivered",
+    "shipping_proof": null,
+    "billing_proof": null,
+    "cancellation_proof": null,
+    "customer_communication": null,
+    "proof_of_service": null,
+    "explanation_letter": null,
+    "refund_confirmation": null,
+    "access_activity_log": null,
+    "refund_cancellation_policy": null,
+    "term_and_conditions": null,
+    "others": null,
+    "submitted_at": null
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
+### Contest a Dispute
+
+```java
+// Use this API sample code for draft
+
+String disputeId = "disp_0000000000000";
+
+JSONObject disputeRequest = new JSONObject();
+disputeRequest.put("amount",5000);
+disputeRequest.put("summary","goods delivered");
+List<Object> shipping_proof = new ArrayList<>();
+shipping_proof.add("doc_EFtmUsbwpXwBH9")
+shipping_proof.add("doc_EFtmUsbwpXwBH8")
+disputeRequest.put("shipping_proof", shipping_proof);
+List<Object> others = new ArrayList<>();
+JSONObject otherParam = new JSONObject();
+otherParam.put("type","receipt_signed_by_customer");
+List<Object> doc = new ArrayList<>();
+doc.add("doc_EFtmUsbwpXwBH1");
+doc.add("doc_EFtmUsbwpXwBH7");
+otherParam.put("document_ids",doc);
+others.add(otherParam)
+disputeRequest.put("others", others);
+disputeRequest.put("action", "submit");
+
+Dispute dispute = instance.dispute.contest(disputeId, disputeRequest)
+```
+
+**Parameters:**
+
+| Name  | Type      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| disputeId*  | string | The unique identifier of the dispute.  |
+| 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  | array | 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. |
+| others  | array | All keys listed [here](https://razorpay.com/docs/api/disputes/contest) are supported |
+
+```java
+// Use this API sample code for submit
+
+String disputeId = "disp_0000000000000";
+
+JSONObject disputeRequest = new JSONObject();
+List<Object> billing_proof = new ArrayList<>();
+billing_proof.add("doc_EFtmUsbwpXwBH9")
+billing_proof.add("doc_EFtmUsbwpXwBH8")
+disputeRequest.put("billing_proof", billing_proof);
+disputeRequest.put("action", "submit");
+
+Dispute dispute = instance.dispute.contest(disputeId, disputeRequest)
+```
+
+**Response:**
+```json
+// Draft
+{
+  "id": "disp_AHfqOvkldwsbqt",
+  "entity": "dispute",
+  "payment_id": "pay_EsyWjHrfzb59eR",
+  "amount": 10000,
+  "currency": "INR",
+  "amount_deducted": 0,
+  "reason_code": "chargeback",
+  "respond_by": 1590604200,
+  "status": "open",
+  "phase": "chargeback",
+  "created_at": 1590059211,
+  "evidence": {
+    "amount": 5000,
+    "summary": "goods delivered",
+    "shipping_proof": [
+      "doc_EFtmUsbwpXwBH9",
+      "doc_EFtmUsbwpXwBH8"
+    ],
+    "billing_proof": null,
+    "cancellation_proof": null,
+    "customer_communication": null,
+    "proof_of_service": null,
+    "explanation_letter": null,
+    "refund_confirmation": null,
+    "access_activity_log": null,
+    "refund_cancellation_policy": null,
+    "term_and_conditions": null,
+    "others": [
+      {
+        "type": "receipt_signed_by_customer",
+        "document_ids": [
+          "doc_EFtmUsbwpXwBH1",
+          "doc_EFtmUsbwpXwBH7"
+        ]
+      }
+    ],
+    "submitted_at": null
+  }
+}
+
+//Submit 
+{
+  "id": "disp_AHfqOvkldwsbqt",
+  "entity": "dispute",
+  "payment_id": "pay_EsyWjHrfzb59eR",
+  "amount": 10000,
+  "currency": "INR",
+  "amount_deducted": 0,
+  "reason_code": "chargeback",
+  "respond_by": 1590604200,
+  "status": "under_review",
+  "phase": "chargeback",
+  "created_at": 1590059211,
+  "evidence": {
+    "amount": 5000,
+    "summary": "goods delivered",
+    "shipping_proof": [
+      "doc_EFtmUsbwpXwBH9",
+      "doc_EFtmUsbwpXwBH8"
+    ],
+    "billing_proof": [
+      "doc_EFtmUsbwpXwBG9",
+      "doc_EFtmUsbwpXwBG8"
+    ],
+    "cancellation_proof": null,
+    "customer_communication": null,
+    "proof_of_service": null,
+    "explanation_letter": null,
+    "refund_confirmation": null,
+    "access_activity_log": null,
+    "refund_cancellation_policy": null,
+    "term_and_conditions": null,
+    "others": [
+      {
+        "type": "receipt_signed_by_customer",
+        "document_ids": [
+          "doc_EFtmUsbwpXwBH1",
+          "doc_EFtmUsbwpXwBH7"
+        ]
+      }
+    ],
+    "submitted_at": 1590603200
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/documents)**
diff --git a/src/main/java/com/razorpay/Constants.java b/src/main/java/com/razorpay/Constants.java
@@ -170,11 +170,13 @@ public class Constants {
   static final String TOKEN     = "/token";
   static final String REVOKE     = "/revoke";
 
-  static final String ADD_BANK_ACCOUNT = "customers/%s/bank_account";
+  static final String DISPUTE  = "/disputes";
+  static final String DISPUTE_FETCH = "/disputes/%s";
+  static final String DISPUTE_ACCEPT = "/disputes/%s/accept";
+  static final String DISPUTE_CONTEST = "/disputes/%s/contest";
 
+  static final String ADD_BANK_ACCOUNT = "customers/%s/bank_account";
   static final String DELETE_BANK_ACCOUNT = "customers/%s/bank_account/%s";
-
   static final String ELIGIBILITY = "customers/eligibility";
-
   static final String ELIGIBILITY_FETCH = "customers/eligibility/%s";
 }
diff --git a/src/main/java/com/razorpay/Dispute.java b/src/main/java/com/razorpay/Dispute.java
@@ -0,0 +1,11 @@
+package com.razorpay;
+
+import org.json.JSONObject;
+
+public class Dispute extends Entity {
+
+    public Dispute(JSONObject jsonObject) {
+        super(jsonObject);
+    }
+}
+
diff --git a/src/main/java/com/razorpay/DisputeClient.java b/src/main/java/com/razorpay/DisputeClient.java
@@ -0,0 +1,41 @@
+package com.razorpay;
+
+import java.util.List;
+
+import org.json.JSONObject;
+
+public class DisputeClient extends ApiClient {
+
+    DisputeClient(String auth) {
+        super(auth);
+    }
+
+    public Dispute fetch(String id) throws RazorpayException {
+        return get(Constants.VERSION, String.format(Constants.DISPUTE_FETCH, id), null);
+    }
+
+    /**
+     * It is wrapper of fetchAll with parameter here sending null defines fetchAll
+     * with a default values without filteration
+     * @throws RazorpayException
+     */
+    public List<Dispute> fetchAll() throws RazorpayException {
+        return fetchAll(null);
+    }
+
+    /**
+     * This method get list of disputes filtered by parameters @request
+     * @throws RazorpayException
+     */
+    public List<Dispute> fetchAll(JSONObject request) throws RazorpayException {
+        return getCollection(Constants.VERSION, Constants.DISPUTE, request);
+    }
+
+    public Dispute accept(String id) throws RazorpayException {
+        return post(Constants.VERSION, String.format(Constants.DISPUTE_ACCEPT, id), null);
+    }
+
+    public Dispute contest(String id, JSONObject request) throws RazorpayException {
+        return patch(Constants.VERSION, String.format(Constants.DISPUTE_CONTEST, id), request);
+    }
+}
diff --git a/src/main/java/com/razorpay/RazorpayClient.java b/src/main/java/com/razorpay/RazorpayClient.java
@@ -28,6 +28,8 @@ public class RazorpayClient {
   public StakeholderClient stakeholder;
   public ProductClient product;
   public WebhookClient webhook;
+
+  public DisputeClient dispute;
   public TncMap tncMap;
   public BankAccountClient bankAccount;
   public RazorpayClient(String key, String secret) throws RazorpayException {
@@ -67,6 +69,7 @@ private void initializeResources(String auth, Boolean enableLogging) throws Razo
     stakeholder = new StakeholderClient(auth);
     product = new ProductClient(auth);
     webhook = new WebhookClient(auth);
+    dispute = new DisputeClient(auth);
     bankAccount = new BankAccountClient(auth);
   }