Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Settlement Disputes

List Settlement Disputes for a Partner

This API call allows partners to list disputes associated with their settlements.

Requires access token scope: settlement_network_read

get/api/network/v1/enterprises/{enterpriseId}/partners/settlement/disputes

Path parameters

enterpriseIdstring required

The enterprise identifier of the partner. This identifies the partner enterprise making the API request.

Query parameters

settlementIdsstring[]

Optional array of settlement ids. If provided will only return disputes with a disputedSettlementId matching one of the provided settlementIds.

settledInSettlementIdsstring[]

Optional array of settlement ids. If provided will only return disputes with a settledInSettlementId matching one of the provided settlementIds.

connectionIdsstring[]

Optional array of connection ids. If provided will only return disputes with a connectionId matching one of the provided connectionIds.

partnerIdsstring[]

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.

closedboolean

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.

disputeIdsstring[]

Optional array of disputeIds. If provided will only return disputes with an id matching one of the provided disputeIds.

disputeClosureIdsstring[]

Optional array of disputeClosureIds. If provided will only return disputes with a disputeClosureId matching one of the provided disputeClosureIds.

pageNumberstring integer

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.

pageSizestring

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.

settlementExternalIdsstring[]

Optional array of settlement externalIds. If provided will only return disputes with a disputedSettlementId of a settlement with an externalId matching one of the provided settlementExternalIds.

settledInSettlementExternalIdsstring[]

Optional array of settlement externalIds. If provided will only return disputes with a settledInSettlementId of a settlement with an externalId matching one of the provided settlementExternalIds.

showRetractedboolean

Optional boolean value indicating whether to include only retracted disputes in the response. If true is provided, retracted and non-retracted disputes will be returned. If false is provided or not provided, only non-retracted disputes will be returned.

clientIdsstring[]

Optional array of clientIds. If provided will only return disputes for settlements initiated by a client with an id matching one of the provided clientIds.

Response

OK