Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added dispute #247

Merged
merged 7 commits into from
May 27, 2024
Merged

added dispute #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7c1aafb
added dispute
ankitdas13 Apr 24, 2024
53f13c7
Merge branch 'master' into added_dispute
ankitdas13 May 15, 2024
ec847c6
added failure test cases
ankitdas13 May 23, 2024
32ce570
update title
ankitdas13 May 24, 2024
e9c6f0c
update title
ankitdas13 May 24, 2024
2e0b54f
update doc
ankitdas13 May 27, 2024
3f93a82
Merge branch 'master' into added_dispute
ankitdas13 May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
301 changes: 301 additions & 0 deletions documents/dispute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,301 @@
## Document

### Fetch All Disputes

bhavyay marked this conversation as resolved.
Show resolved Hide resolved
```rb
Razorpay::Dispute.all()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we allow any params for pagination ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No params according to this doc https://razorpay.com/docs/api/disputes/fetch-all

```

**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

```rb
disputeId = "disp_0000000000000"

Razorpay::Dispute.fetch(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
}
}
```
-------------------------------------------------------------------------------------------------------

### Accept a Dispute

```rb
disputeId = "disp_0000000000000"

Razorpay::Dispute.accept(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": 10000,
"reason_code": "pre_arbitration",
"respond_by": 1590604200,
"status": "lost",
"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
}
}
```
-------------------------------------------------------------------------------------------------------
### Contest a Dispute (Draft)

```rb
# Use this API sample code for draft

disputeId = "disp_0000000000000"

Razorpay::Dispute.contest(disputeId,{
"amount": 5000,
"summary": "goods delivered",
"shipping_proof": [
"doc_EFtmUsbwpXwBH9",
"doc_EFtmUsbwpXwBH8"
],
"others": [
{
"type": "receipt_signed_by_customer",
"document_ids": [
"doc_EFtmUsbwpXwBH1",
"doc_EFtmUsbwpXwBH7"
]
}
],
"action": "draft"
})
```

**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 |
| action | string | Possible value is `draft` or `submit` |

**Response:**
```json
{
"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
}
}
```

-------------------------------------------------------------------------------------------------------
### Contest a Dispute (Submit)

```rb
# Use this API sample code for submit

disputeId = "disp_0000000000000"

Razorpay::Dispute.contest(disputeId, {
"billing_proof": [
"doc_EFtmUsbwpXwBG9",
"doc_EFtmUsbwpXwBG8"
],
"action": "submit"
})
```

**Parameters:**

| Name | Type | Description |
|-----------------|---------|--------------------------------------------------------------------------------------|
| disputeId* | string | The unique identifier of the dispute. |
| billing_proof | integer | List of document ids which serves as proof of order confirmation, such as a receipt. |
| action | string | Possible value is `draft` or `submit` |

**Response:**
```json
{
"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)**
1 change: 1 addition & 0 deletions lib/razorpay.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
require 'razorpay/product'
require 'razorpay/stakeholder'
require 'razorpay/account'
require 'razorpay/dispute'
require 'razorpay/oauth_token'

# Base Razorpay module
Expand Down
26 changes: 26 additions & 0 deletions lib/razorpay/dispute.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
require 'razorpay/request'
require 'razorpay/entity'

module Razorpay
class Dispute < Entity
def self.request
Razorpay::Request.new('disputes')
end

def self.fetch(id)
request.fetch id
end

def self.all(options = {})
request.all options
end

def self.accept(id, options={})
request.post "#{id}/accept", options
end

def self.contest(id, options)
request.patch "#{id}/contest", options
end
end
end
Loading
Loading