For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set Margin Mode

Set the futures margin mode on PointPay Exchange.

Details

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

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

mode*

STRING

Margin mode. Available values: ISOLATED_MARGIN, REGULAR_MARGIN

ISOLATED_MARGIN

Fields marked with * are required.

CURL Example
curl -X POST "https://api.pointpay.io/fapi/v1/private/trade/margin-mode" \
  -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 '{
    "mode": "ISOLATED_MARGIN"
  }'

Response parameters:

Name
Type
Description

response

ARRAY

Empty array returned when the request succeeds

Response example:

{
    "notification": null,
    "warning": null,
    "variables": null,
    "status": "000000",
    "response": [],
    "errors": null
}

Response example

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

Returned when the request is invalid.

Common reasons:

  • Invalid request format

  • Invalid headers

Response example

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

Last updated