Ctrl+K

Create collateral withdrawal request

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

Create a collateral withdrawal request.

Path Parameters

  • accountIdstringRequired
    The ID of the account

Request Body

currency string required
Currency symbol for withdrawal
quantity string <decimal>required
Amount to withdraw

201 Response

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