Update Margin

Manually add or reduce margin for a futures position on PointPay Exchange.

Details

POST https://api.pointpay.io/fapi/v1/private/trade/update-margin

Headers

Name	Type	Description
X-TXC-APIKEY*	STRING	Public API key
X-TXC-PAYLOAD*	STRING	Base64-encoded request body
X-TXC-SIGNATURE*	STRING	HmacSHA512 signature of the request body

Request Body

Name	Type	Description	Example
symbol*	STRING	Trading pair	BTCUSDT
margin*	NUMERIC	Add or reduce. To add, then 10; To reduce, then -10. Support up to 4 decimal	50
positionIdx	INTEGER	Position index. Available values: - 0: one-way mode - 1: hedge-mode Buy side - 2: hedge-mode Sell side	0

Fields marked with * are required.

CURL Example

curl -X POST "https://api.pointpay.io/fapi/v1/private/trade/update-margin" \
  -H "accept: application/json" \
  -H "X-TXC-APIKEY: <api-key>" \
  -H "X-TXC-PAYLOAD: <base64-payload>" \
  -H "X-TXC-SIGNATURE: <signature>" \
  -H "Content-Type: application/json" \
  -d '{
    "symbol": "BTCUSDT",
    "margin": 50,
    "positionIdx": 0
  }'

200: OK Successful

Response parameters:

Name	Type	Description
category	STRING	Product category
positionIdx	INTEGER	Position index
riskLimitValue	STRING	Risk limit value
symbol	STRING	Trading pair
size	STRING	Position size
positionValue	STRING	Position value
avgPrice	STRING	Average entry price
liqPrice	STRING	Liquidation price
bustPrice	STRING	Bankruptcy price
markPrice	STRING	Mark price
leverage	STRING	Applied leverage
autoAddMargin	INTEGER	Auto-add-margin flag
positionStatus	STRING	Position status
positionIM	STRING	Initial margin
positionMM	STRING	Maintenance margin
unrealisedPnl	STRING	Unrealized profit and loss
cumRealisedPnl	STRING	Cumulative realized profit and loss
takeProfit	STRING	Take-profit price
stopLoss	STRING	Stop-loss price
trailingStop	STRING	Trailing stop value
createdTime	STRING	Position creation time in milliseconds
updatedTime	STRING	Last update time in milliseconds

Response example:

{
  "notification": null,
  "warning": null,
  "variables": null,
  "status": "000000",
  "response": {
    "category": "linear",
    "positionIdx": 0,
    "riskLimitValue": "100000",
    "symbol": "SNXUSDT",
    "size": "25.0",
    "positionValue": "7.24000000",
    "avgPrice": "0.28960000",
    "liqPrice": "0.0795",
    "bustPrice": "0.0779",
    "markPrice": "0.2896",
    "leverage": "25.00",
    "autoAddMargin": 0,
    "positionStatus": "Normal",
    "positionIM": "5.29550784",
    "positionMM": "0.15070784",
    "unrealisedPnl": "0.0",
    "cumRealisedPnl": "-0.10489752",
    "takeProfit": "0.0",
    "stopLoss": "0.0",
    "trailingStop": "0.0",
    "createdTime": "1774506062923",
    "updatedTime": "1779307545414"
  },
  "errors": null
}

400: Bad Request

Response example

{
  "code": 400,
  "success": false,
  "message": "invalid input",
  "result": []
}

Returned when the request is invalid.

Common reasons:

• Invalid request format

• Invalid headers

401: Unauthorized

Response example

{"code":400,"success":false,"message":"authentication failure","result":[]}

Returned when authentication headers are missing / invalid or API Keys are not enabled.