List Client Settlement Transfers

get/api/network/v1/enterprises/{enterpriseId}/clients/settlementTransfers

Lists all settlement transfers for your BitGo Network client account.

Path Parameters

  • enterpriseIdstringRequired

Query Parameters

  • pageNumberstring
  • pageSizestring
  • currenciesarray[string]
  • initiatedByarray[string]
  • partnerIdsarray[string]
  • settlementIdsarray[string]
  • settlementStatusesarray[string]
    Enum: failed completed pending rejected
  • settlementUpdatedBeforestring
  • settlementUpdatedOnOrAfterstring
  • sortFieldstring
    Enum: updatedAt
  • sortDirectionstring
    Enum: ASC DESC

200 Response

settlementTransfers array[object] required
sourceTradingAccountId string
sourceNetworkAccountId string
destinationTradingAccountId string
destinationNetworkAccountId string
currency string required
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
usdValue required
id string required
createdAt string required
updatedAt string required
settlementStatus string required
Allowed values: failed completed pending rejected
settlementNotes string
sourceClientName string
destinationClientName string
sourceConnectionName string
destinationConnectionName string

400 Response

401 Response

error string required

404 Response

error string required

500 Response

error string required