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: {"requestId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","currency":"BTC","quantity":"0.5","status":"pending","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z"}
requestId string <uuid>required
Unique identifier for 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
createdAt string <date-time>required
Timestamp when the request was created
updatedAt string <date-time>
Timestamp when the request was last updated
approvedAt string <date-time>
Timestamp when the request was approved
completedAt string <date-time>
Timestamp when the request was completed
rejectionReason string
Reason for rejection if status is rejected
pagination object
offset integer
Current offset for pagination
limit integer
Number of items per page
total integer
Total number of withdrawal requests