API References

List Settlement Disputes for a Partner

get
https://app.bitgo-test.com/api/network/v1/enterprises//partners/settlement/disputes

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

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

Query Params
settlementIds
array of strings

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

settlementIds
settledInSettlementIds
array of strings

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

settledInSettlementIds
connectionIds
array of strings

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

connectionIds
partnerIds
array of strings

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.

partnerIds
boolean

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.

disputeIds
array of strings

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

disputeIds
disputeClosureIds
array of strings

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

disputeClosureIds
string

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.

string

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.

settlementExternalIds
array of strings

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.

settlementExternalIds
settledInSettlementExternalIds
array of strings

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.

settledInSettlementExternalIds
boolean

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.

clientIds
array of strings

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.

clientIds
Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago