logo

Disputes

A customer may dispute their payment with the card issuer/bank if they believe the charge is erroneous. When this happens, a dispute record is created and associated with their original payment.

List Disputes

List the disputes for your account. This endpoint supports pagination. The disputes for a specific payment are also included in the payments API response.

Request
header Parameters
Authorization
required
string

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Example: Bearer {access_token}
Sub-Account
string

for platforms, the id of the sub account that this request applies to

Example: acc_2IdMEOjIG6lJAncakgdBF2
Seller-Account
string
Deprecated

for platforms, the id of the seller account that this request applies to
Note: seller account is deprecated, please use sub account

Responses
200

Successfully list disputes

get/disputes
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "array",
  • "data": [
    ],
  • "page_info": {
    }
}
Get a Dispute
Get information about a dispute.


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Responses 
200
Successfully get a dispute


get/disputes/{id}
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "dispute",
  • "data": {
    },
  • "page_info": "string"
}
Update a Dispute
Change a dispute's metadata.


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Idempotency-Key
required
string <uuid> 
a string to identify your request (we recommend using a generated uuid, but you may use any unique string) see Idempotent Requests


 
 Example:  my-request-123abc
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Request Body schema: application/json
metadata
object <json> 
any useful information you'd like to store alongside this dispute; when you update metadata, any previous metadata will be overwritten


 
Responses 
200
Dispute update was successful


patch/disputes/{id}
Request samples 
application/json
{
  • "metadata": { }
}
Response samples 
application/json
{
  • "id": 1,
  • "type": "dispute",
  • "data": {
    },
  • "page_info": "string"
}
➔ Next to Payouts