List Settlement transfers

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
• settlementTransferStatusesarray[string]
  Optional array of settlement transfer statuses. If provided will only return settlement transfers with those statuses.
  Enum: pending pending_onchain onchain_initiated onchain_failed completed failed rejected disputed pending_settlement_assignment
• 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
• createdBeforestring<date-time>
• createdOnOrAfterstring<date-time>
• destinationNetworkAccountIdsarray[string]
• destinationTradingAccountIdsarray[string]
  Min length: >= 1 characters
• settlementTransferIdsarray[string]
• sourceNetworkAccountIdsarray[string]
• sourceTradingAccountIdsarray[string]
  Min length: >= 1 characters
• trustOrgstringRequired
  Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1