v8
OpenAPI 3.1.02026-08-033623795.0 MBDispute alerts
List dispute alerts
Returns a paginated list of dispute alerts for a company, with optional filtering by creation date.
Required permissions:
- payment:dispute_alert:read
- payment:basic:read
- payment:dispute:read
get/dispute_alerts
Query parameters
afterstring nullable
Returns the elements in the list that come after the specified cursor.
beforestring nullable
Returns the elements in the list that come before the specified cursor.
firstinteger nullable
Returns the first n elements from the list.
Example:42
lastinteger nullable
Returns the last n elements from the list.
Example:42
company_idstring required
The unique identifier of the company to list dispute alerts for.
Example:biz_xxxxxxxxxxxxxx
direction'asc' | 'desc'
The direction of the sort.
created_beforestring date-time nullable
Only return dispute alerts created before this timestamp.
Example:2023-12-01T05:00:00.401Z
created_afterstring date-time nullable
Only return dispute alerts created after this timestamp.
Example:2023-12-01T05:00:00.401Z
Response
A successful response
Example response
{
"data": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"dispute": {
"id": "dspt_xxxxxxxxxxxxx"
},
"id": "dspa_xxxxxxxxxxxxx",
"payment": {
"id": "pay_xxxxxxxxxxxxxx"
},
"transaction_date": "2023-12-01T05:00:00.401Z"
}
]
}