Disputes
List Disputes
Any disputes associated with a payment are also included in the response of the get payment API and the list payments API response
get/disputes
Request
- Base URLhttps://api.justifi.ai/v1
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Authorizationstring required
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)
Sub-Accountstring
the id of the sub account that this request applies to
Response
Successfully list disputes
Example response
{
"id": 1,
"type": "array",
"data": [
{
"id": "dp_xyz",
"payment_id": "py_xyz",
"account_id": "acc_xyz",
"amount": 100,
"currency": "usd",
"reason": "fraudulent",
"due_date": "2025-02-23",
"status": "won",
"metadata": {},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z",
"dispute_response": {
"service_date": "2024-10-31",
"shipping_date": "2024-10-31"
},
"dispute_reversal": {
"description": "Dispute was reversed",
"created_at": "2021-01-01T12:00:00Z"
}
}
],
"page_info": {
"end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
"start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.