Ctrl+K

List settlement requests

get/trade-falcon/api/v1/admin/settlementrequests

Retrieve settlement requests with optional filtering and sorting

Query Parameters

  • statusstring
    Filter by settlement request status
  • accountIdstring
    Filter by account ID
  • enterpriseIdstring
    Filter by enterprise ID
  • currencystring
    Filter by currency
  • trustOrgstringRequired
    Trust organization (required)
  • tradingTypestring
    Filter by trading type
  • limitstring
    Maximum number of results to return
  • offsetstring
    Number of results to skip for pagination
  • orderBystring
    Sorting specification (field:direction,field:direction)

200 Response

Array of
id string <uuid>required
Unique identifier for the settlement request
Example: 550e8400-e29b-41d4-a716-446655440000
precipitatingEventKind string required
Type of event that triggered the settlement request
Example: TRADE_SETTLEMENT
precipitatingEventId string required
ID of the event that triggered the settlement request
Example: 550e8400-e29b-41d4-a716-446655440001
precipitatingEventDate string <date-time>required
Date when the precipitating event occurred
Example: 2024-12-01T10:00:00.000Z
precipitatingEventTxid string
Transaction ID of the precipitating event (optional)
Example: abc123def456
trustOrg string required
Trust organization identifier
Example: BitGo Trust
currency string required
Currency of the settlement request
Example: BTC
targetAmount string required
Target amount for settlement
Example: 1000000
requestedAmount string required
Requested amount for settlement
Example: 1000000
remainingAmount string required
Remaining amount to be settled
Example: 500000
status string required
Current status of the settlement request
Allowed values: CREATED FAILED PARTIALLY_SETTLED SETTLED CANCELED
Example: CREATED
accountId string required
Account ID associated with the settlement request
Example: account123
enterpriseId string required
Enterprise ID associated with the settlement request
Example: enterprise456
tradingType string required
Type of trading
Allowed values: FUNDED MARGIN
Example: FUNDED
createdAt string <date-time>required
Timestamp when the settlement request was created
Example: 2024-12-01T10:00:00.000Z
updatedAt string <date-time>required
Timestamp when the settlement request was last updated
Example: 2024-12-01T10:30:00.000Z

400 Response

error string required
Human-readable error message
errorName string required
Immutable error code for API integration
reqId string required
Client request id

403 Response

error string required
Human-readable error message
errorName string required
Immutable error code for API integration
reqId string required
Client request id