e445c15e5bee
List Settlement Disputes for a Client
This API call allows clients to list disputes associated with their settlements.
Requires access token scope: settlement_network_read
Path parameters
The enterprise identifier of the client. This identifies the client enterprise that owns the allocation.
Query parameters
Optional array of settlement ids. If provided will only return disputes with a disputedSettlementId matching one of the provided settlementIds.
Optional array of settlement ids. If provided will only return disputes with a settledInSettlementId matching one of the provided settlementIds.
Optional array of connection ids. If provided will only return disputes with a connectionId matching one of the provided connectionIds.
Optional array of partner ids. If provided will only return disputes for settlements initiated by a partner with an id matching one of the provided partnerIds.
Optional boolean value indicating whether to include only closed/open disputes in the response. If true is provided, only closed disputes will be returned. If false is provided, only open disputes will be returned. If not provided, all disputes will be returned.
Optional array of disputeIds. If provided will only return disputes with an id matching one of the provided disputeIds.
Optional array of disputeClosureIds. If provided will only return disputes with a disputeClosureId matching one of the provided disputeClosureIds.
The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.
Response
OK