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
    Min length: >= 1 characters

Query Parameters

  • pageNumberstring<integer>
  • pageSizestring
  • currenciesarray[string]
  • initiatedByarray[string]
    Min length: >= 1 characters
  • partnerIdsarray[string]
  • settlementIdsarray[string]
  • settlementStatusesarray[string]
    Enum: failed completed pending rejected
  • settlementUpdatedBeforestring<date-time>
  • settlementUpdatedOnOrAfterstring<date-time>
  • sortFieldstring
    Enum: updatedAt
  • sortDirectionstring
    Enum: ASC DESC

200 Response

settlementTransfers array[object] required
sourceTradingAccountId string
Min length: >= 1 characters
sourceNetworkAccountId string
destinationTradingAccountId string
Min length: >= 1 characters
destinationNetworkAccountId string
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
usdValueOne ofrequired
id string required
createdAt string <date-time>required
updatedAt string <date-time>required
settlementStatus string required
Allowed values: failed completed pending rejected
settlementNotes string
Min length: >= 1 characters
sourceClientName string
Min length: >= 1 characters
destinationClientName string
Min length: >= 1 characters
sourceConnectionName string
Min length: >= 1 characters
destinationConnectionName string
Min length: >= 1 characters

400 Response

401 Response

error string required

404 Response

error string required

500 Response

error string required