Reporting

Get disputes

Retrieves a paginated list of disputes for reporting purposes with filtering options.

get/v1/reporting/disputes

Request

Base URL
https://integration.api.scalapay.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/scalapay/apis/scalapay-api/docs/v1/reporting/disputes/get.ts
A function with typed inputs. Its response is checked against the schema.

startDatestring date required

ISO 8601 date string for filtering disputes from this date.

endDatestring date required

ISO 8601 date string for filtering disputes to this date.

disputeStatus'open' | 'processing' | 'won' | 'lost' | 'closed'

Filter by dispute status.

pageinteger

Page number, zero-based (default 0).

sizeinteger

Number of items per page (default 20, max 100).

Disputes retrieved successfully.

totalinteger required

Total number of disputes matching filters

pageinteger required

Current page number (zero-based)

sizeinteger required

Number of items per page

hasMoreboolean required

Whether there are more pages available