POST

Transfer collateral for margin

Transfers collateral for the specified account.

Path Params

accountId string required

The ID of the account

Body Params

object

currency string
quantity string

Responses

200

Collateral transfer response

Response Body

object

transferId string uuid

The margin transfer ID (UUID) from Trade Falcon
currency string required

Symbol of the collateral asset
quantity string required

Number representing the balance for the specified collateral
balanceValue object required

Returns the value of the collateral.
balanceValue object
- quantity string decimal required
  
  The specified quantity.
- currency string required
  
  The specified quantity currency.

400

Bad request - Invalid parameters

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

401

Unauthorized - Invalid or missing authentication

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

403

Forbidden - Insufficient permissions

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

422

Unprocessable Entity - JSON payload is improperly formatted

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

429

Too Many Requests - Rate limit exceeded

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

500

Internal Server Error

Response Body

object

error string required
errorName string required
reqId string required
context object

Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
context object
- errorName string required
  
  Same value as the top-level errorName.
- field string
  
  Request field associated with the validation failure.
- message string
  
  Human-readable field-level validation message.

curl --request POST \ --url 'https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/collateral/transfer' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"currency":"BTC","quantity":"2"}'

const url = 'https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/collateral/transfer'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"currency":"BTC","quantity":"2"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/collateral/transfer") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"currency":"BTC","quantity":"2"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/collateral/transfer', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"currency":"BTC","quantity":"2"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/prime/trading/v1/accounts/accountId/margin/collateral/transfer" payload = {,"currency":"BTC","quantity":"2"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)