Ctrl+K

List Settlement Disputes for a Partner

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

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

Path Parameters

  • enterpriseIdstringRequired
    The enterprise identifier of the partner. This identifies the partner enterprise making the API request.
    Min length: >= 1 characters

Query Parameters

  • settlementIdsarray[string]
    Optional array of settlement ids. If provided will only return disputes with a disputedSettlementId matching one of the provided settlementIds.
  • settledInSettlementIdsarray[string]
    Optional array of settlement ids. If provided will only return disputes with a settledInSettlementId matching one of the provided settlementIds.
  • connectionIdsarray[string]
    Optional array of connection ids. If provided will only return disputes with a connectionId matching one of the provided connectionIds.
  • partnerIdsarray[string]
    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.
  • disputeIdsarray[string]
    Optional array of disputeIds. If provided will only return disputes with an id matching one of the provided disputeIds.
  • disputeClosureIdsarray[string]
    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.
  • settlementExternalIdsarray[string]
    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.
    Min length: >= 1 characters
  • settledInSettlementExternalIdsarray[string]
    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.
    Min length: >= 1 characters
  • 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.
  • clientIdsarray[string]
    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.

200 Response

disputes array[object] required
disputeClosure object
id string required
createdAt string <date-time>required
updatedAt string <date-time>required
connectionId string required
disputedSettlementId string required
userId string required
Min length: >= 1 characters
expectedTransfers dictionary<string, string> required
retracted boolean required
settledInSettlementId string
reason string
Min length: >= 1 characters
retractedBy string
Min length: >= 1 characters
retractedAt string <date-time>
disputeClosureId string
retractedReason string
Min length: >= 1 characters

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

409 Response

error string required

422 Response

error string required

500 Response

error string required