Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Margin

Create collateral withdrawal request

Create a collateral withdrawal request.

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

Path parameters

accountIdstring required

The ID of the account

Request body

currencystring required

Currency symbol for withdrawal

quantitystring decimal required

Amount to withdraw

Example request

{
  "currency": "BTC",
  "quantity": "0.5"
}

Response

Collateral withdrawal request accepted for processing

idstring uuid required

Unique identifier for the withdrawal request

accountIdstring required

Account ID associated with the withdrawal request

enterpriseIdstring required

Enterprise ID associated with the withdrawal request

currencystring required

Currency symbol for the withdrawal

quantitystring decimal required

Amount requested for withdrawal

status'pending' | 'approved' | 'rejected' | 'completed' | 'cancelled' required

Current status of the withdrawal request

createdBystring required

User who created the withdrawal request

canceledBystring nullable

User who canceled the withdrawal request, if applicable

creationDatestring date-time required

Timestamp when the request was created

modifiedDatestring date-time required

Timestamp when the request was last modified

Example response

{
  "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"
}