latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Margin

Transfer collateral for margin

Transfers collateral for the specified account.

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

Path parameters

accountIdstring required

The ID of the account

Request body

currencystring
quantitystring

Example request

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

Response

Collateral transfer response

transferIdstring uuid

The margin transfer ID (UUID) from Trade Falcon

currencystring required

Symbol of the collateral asset

quantitystring required

Number representing the balance for the specified collateral

Example response

{
  "transferId": "2bf68bb7-513d-40af-9fc9-249060c3c7ac",
  "currency": "BTC",
  "quantity": "2",
  "balanceValue": {
    "quantity": "1000000",
    "currency": "USD"
  }
}