Ctrl+K

List collateral withdrawal requests

get/api/prime/trading/v1/accounts/{accountId}/margin/collateral/withdrawalrequests

List all collateral withdrawal requests for an account.

Path Parameters

  • accountIdstringRequired
    The ID of the account

Query Parameters

  • offsetintegerDefault: 0
    Pagination offset
  • limitintegerDefault: 50
    Number of items per page
    Maximum: <= 100

200 Response

data array[object] required
Example: {"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","accountId":"account123","enterpriseId":"enterprise456","currency":"BTC","quantity":"0.5","status":"pending","createdBy":"user789","creationDate":"2024-01-15T10:30:00.000Z","modifiedDate":"2024-01-15T10:30:00.000Z"}
id string <uuid>required
Unique identifier for the withdrawal request
accountId string required
Account ID associated with the withdrawal request
enterpriseId string required
Enterprise ID associated with the withdrawal request
currency string required
Currency symbol for the withdrawal
quantity string <decimal>required
Amount requested for withdrawal
status string required
Current status of the withdrawal request
Allowed values: pending approved rejected completed cancelled
createdBy string required
User who created the withdrawal request
canceledBy
string or null
User who canceled the withdrawal request, if applicable
creationDate string <date-time>required
Timestamp when the request was created
modifiedDate string <date-time>required
Timestamp when the request was last modified