Get Partner Settlement

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

Returns a settlement for your BitGo Network partner account.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters
  • settlementIdstringRequired

Query Parameters

  • sourceNetworkAccountIdsarray[string]
  • sourceTradingAccountIdsarray[string]
  • destinationNetworkAccountIdsarray[string]
  • destinationTradingAccountIdsarray[string]
  • currenciesarray[string]
  • pageNumberstring<integer>
  • pageSizestring

200 Response

settlementOne ofrequired
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
rtId string
lossSLAAlertSent boolean required
gainSLAAlertSent boolean required
settlementTransfers array[object] required
id string required
createdAt string <date-time>required
updatedAt string <date-time>required
currency string required
Min length: >= 1 characters
settlementId string required
quantity string required
txIds array[string] required
status string required
Allowed values: pending pending_onchain onchain_initiated onchain_failed completed failed rejected
sourceTradingAccountId string required
Min length: >= 1 characters
sourceNetworkAccountId string
destinationTradingAccountId string required
Min length: >= 1 characters
destinationNetworkAccountId string required

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required