Ctrl+K

List client settlement transfers

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

Lists all settlement transfers for your OES client account.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Query Parameters

  • pageNumberstring<integer>
    The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
  • pageSizestring
    The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.
  • currenciesarray[string]
    Optional array of currencies. If provided will only return settlement transfers with those currencies.
  • initiatedByarray[string]
    Optional array of user ids. If provided will only return settlement transfers for settlements initiated by those users.
    Min length: >= 1 characters
  • partnerIdsarray[string]
    Optional array of partner ids. If provided will only return settlement transfers for settlements initiated by those partners.
  • settlementIdsarray[string]
    Optional array of settlement ids. If provided will only return settlement transfers for settlements with those ids.
  • settlementStatusesarray[string]
    Optional array of settlement statuses. If provided will only return settlement transfers for settlements in those statuses.
    Enum: failed completed pending rejected
  • settlementUpdatedBeforestring<date-time>
    optional date start range filter for updatedAt (ISO 8601 Date). If provided will only return settlement transfers for settlements updated before the provided date.
  • settlementUpdatedOnOrAfterstring<date-time>
    optional date start range filter for updatedAt (ISO 8601 Date). If provided will only return settlement transfers for settlements updated on or after the provided date.
  • sortFieldstring
    Enum: updatedAt
  • sortDirectionstring
    Enum: ASC DESC

200 Response

settlementTransfers array[object] required
sourceTradingAccountId string
The go account id of the source party.
Min length: >= 1 characters
sourceNetworkAccountId string
The network account id of the source party.
destinationTradingAccountId string
The go account id of the destination party.
Min length: >= 1 characters
destinationNetworkAccountId string
The network account id of the destination party (if the destination party is a connection).
currency string required
The currency involved in the settlement movement.
Min length: >= 1 characters
quantity string required
The amount of currency being transferred in the settlement transfer. This is a non-zero value represented as a string. If the value is positive, that means funds were moved from the source account to the destination account. If the value is negative, that means funds were moved from the destination account to the source account.
txIds array[string] required
The transaction IDs associated with the settlement transfer. Only populated once the transfer is completed.
status string required
The status of the settlement transfer. Possible values and implications are: - pending: The transfer is pending and has not yet been processed. - pending_onchain: The transfer is pending on-chain movement (only relevant to on-chain settlements). - onchain_initiated: The transfer has been initiated on-chain (only relevant to on-chain settlements). - onchain_failed: The on-chain transfer has failed (only relevant to on-chain settlements). - completed: The transfer has been completed successfully. - failed: The transfer has failed. - rejected: The transfer has been rejected. - disputed: The transfer is disputed.
Allowed values: pending pending_onchain onchain_initiated onchain_failed completed failed rejected disputed pending_settlement_assignment
usdValueOne ofrequired
The USD value of the settlement transfer in cents. This is a non-negative value represented as a string.
settlementId string required
The unique identifier of the settlement the settlement transfer is associated with. This is a UUID that uniquely identifies the settlement.
disputeClosureId string
The unique identifier of the dispute closure the settlement transfer was created from. This is a UUID that uniquely identifies dispute closure if the transfer was created as a result of closing a dispute.
id string required
The unique identifier of the settlement transfer. This is a UUID that uniquely identifies the settlement transfer record.
createdAt string <date-time>required
The date and time when the settlement transfer was created. Represented as an ISO 8601 formatted date string.
updatedAt string <date-time>required
The date and time when the settlement transfer was last updated. Represented as an ISO 8601 formatted date string.
settlementStatus string required
The status of the settlement the settlement transfer is associated with. Possible values and implications are: - pending: The settlement is pending and has not yet been processed. - failed: The settlement has failed to process. This is a non-terminal state and should be retried. - completed: The settlement has been completed successfully. - rejected: The settlement has been rejected by a BitGo admin (only relevant to on-chain settlements).
Allowed values: failed completed pending rejected
settlementNotes string
Optional notes for the settlement
Min length: >= 1 characters
sourceClientName string
The client name of the source party. Will be obfuscated if the source party is not the calling client.
Min length: >= 1 characters
destinationClientName string
The client name of the destination party. Will be obfuscated if the destination party is not the calling client.
Min length: >= 1 characters
sourceConnectionName string
The name of the source connection (if the source party is a connection). Will be obfuscated if the source party is not the calling client.
Min length: >= 1 characters
destinationConnectionName string
The name of the destination connection (if the destination party is a connection). Will be obfuscated if the destination party is not the calling client.
Min length: >= 1 characters

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required