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<integer>
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.
settlementIdsarray[string]
Filter by specific settlement IDs. When provided, only settlements matching these IDs will be returned.
onlyShowDisputedboolean
Filter to show only disputed settlements. When set to true, only settlements that have disputes will be returned. Setting to false will have no effect.
sortFieldstring
Field to sort settlements by. Can be either 'createdAt' or 'updatedAt'.
Enum: createdAt updatedAt
sortDirectionstring
Direction to sort settlements. Can be either 'ASC' (ascending) or 'DESC' (descending).
Enum: ASC DESC
createdBeforestring<date-time>
Filter for settlements created before this date. Format: ISO 8601 date string.
createdOnOrAfterstring<date-time>
Filter for settlements created on or after this date. Format: ISO 8601 date string.
partnerIdsarray[string]
Filter by specific partner IDs. When provided, only settlements involving these partners will be returned.
statusesarray[string]
Filter by settlement statuses. When provided, only settlements with these statuses will be returned.
Enum: failed completed pending rejected
updatedBeforestring<date-time>
Filter for settlements updated before this date. Format: ISO 8601 date string.
updatedOnOrAfterstring<date-time>
Filter for settlements updated on or after this date. Format: ISO 8601 date string.
trustOrgstringRequired
Trust organization identifier. Used for filtering by the trust organization the settlements belong to.
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