List Partner Settlements

get/api/network/v1/enterprises/{enterpriseId}/partners/settlements

Lists all settlements for your BitGo Network partner account.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Query Parameters

  • pageNumberstring<integer>
  • pageSizestring
  • settlementIdsarray[string]
  • partnerIdsarray[string]
  • partyConnectionIdsarray[string]
  • counterpartyConnectionIdsarray[string]

200 Response

settlementsrequired
id string required
partnerId string required
externalId string required
Min length: >= 1 characters
status string required
Allowed value: pending
settlementType string required
Allowed values: onchain offchain
reconciled boolean required
initiatedBy string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
createdAt string <date-time>required
updatedAt string <date-time>required

400 Response

401 Response

error string required

500 Response

error string required