Vesicash API V1
Vesicash API V1
Vesicash API V1
Vesicash API V1
Overview
API DOCUMENTATION
API Basics
Authentication
Errors
User Management
Transactions Management
Dispute Management
Disbursement
Other Tools
Other Integration Methods
Widget
Plugins
Libraries
Customizations
Basics
Payment System
Custom Notifications
Powered by GitBook

Dispute Management

Sometimes, disputes may arise in a transaction so we have made provision for businesses who integrate our escrow API to monitor disputes that arises in their customers transactions.

post
create a dispute

https://api.vesicash.com/v1/transactions/dispute
Request
Response
Request
Headers
Accept
required
string
application/json
V-PRIVATE-KEY
required
string
your vesicash private key
Form Data Parameters
transaction_id
required
string
The id of that transaction.
reason
optional
string
The reason for the dispute.
dispute_status
optional
string
The dispute status. For example "open"
Response
200: OK
{
    "status": "ok",
    "code": 200,
    "message": "Transaction Disputed",
    "data": null
}

For example, you can a make a post request to the endpoint above and pass in the json data below to create a dispute for a transaction.

{
    "transaction_id":"QvC8epu9UT8OtTCCjmQI",
    "reason":"I am no longer interested.",
    "dispute_status":"open"
}

Similarly, you can update the status of a dispute using the endpoint below

post
update a dispute

https://api.vesicash.com/v1/transactions/dispute/update
Request
Response
Request
Headers
Accept
required
string
application/json
V-PRIVATE-KEY
required
string
your vesicash private key
Form Data Parameters
transaction_id
required
string
The id of that transaction.
decision
optional
string
The decision that was made concerning the dispute.
dispute_status
optional
string
The dispute status. For example "resolved"
Response
200: OK
{
    "status": "ok",
    "code": 200,
    "message": "Transaction Disputed",
    "data": null
}

For example, you can a make a post request to the endpoint above and pass in the json data below to create a dispute for a transaction.

{
    "transaction_id":"QvC8epu9UT8OtTCCjmQI",
    "decision":"The buyer has been refunded",
    "dispute_status":"resolved"
}

Finally, you can list all the disputes that your customers have created using the endpoint below:

post
List disputes created by your customers

https://api.vesicash.com/v1/admin/business/customers/disputes
Request
Response
Request
Headers
Content-Type
optional
string
application/json
V-PRIVATE-KEY
optional
string
your vesicash private key
Form Data Parameters
business_id
required
string
The id of that business.
Response
200: OK
{
    "status": "ok",
    "code": 200,
    "message": "Data Retrieved",
    "data": [
        {
            "dispute_id": "IntV313tYRf8jLnf",
            "transaction_id": "QvC8epu9UT8OtTCCjmQI",
            "reason": "I don't like the item",
            "dispute_status": "open",
            "decision": null,
            "mediator_id": null,
            "created_at": "2020-07-10T13:05:49.000000Z"
        },
        {
            "dispute_id": "s1Edcb5arIbukYJw",
            "transaction_id": "QvC8epu9UT8OtTCCjmQI",
            "reason": "The buyer has been refunded",
            "dispute_status": "closed",
            "decision": "completed",
            "mediator_id": null,
            "created_at": "2020-05-01T14:57:40.000000Z"
        },
        {
            "dispute_id": "ZcpW5dsupIIJ8uK9",
            "transaction_id": "QvC8epu9UT8OtTCCjmQI",
            "reason": null,
            "dispute_status": "closed",
            "decision": "completed",
            "mediator_id": null,
            "created_at": "2020-05-01T14:58:02.000000Z"
        }
    ]
}
Previous
listing transactions
Next - API DOCUMENTATION
Disbursement
Last updated 1 month ago
Contents
post
create a dispute
post
update a dispute
post
List disputes created by your customers