Get Client Settlement

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

This API call allows clients to get a list of settlement transactions for any connected network account, for a specific settlement. The settlement and its metadata will be returned along with all related settlement transfers in and out of the clients’ network accounts.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters
  • settlementIdstringRequired

Query Parameters

  • 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
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