My Specific Trade Balance

This method returns a user balance for a specific asset.

Details

POST https://api.pointpay.io/api/v1/account/balance

Headers

Name	Type	Description
X-TXC-APIKEY*	STRING	Public API key
X-TXC-PAYLOAD*	STRING	Сonverted Base64 string containing body JSON
X-TXC-SIGNATURE*	STRING	Encrypted HmacSHA512 string containing body JSON with a API secret key

Request Body

Name	Type	Description	Example
currency*	STRING	Ticker of asset	USDT
request*	STRING	A request path without the domain name	/api/v1/account/balance
nonce*	NUMERIC	A 13-character number that must always be greater than the nonce of the previous completed request (we suggest generating a nonce as the UNIX timestamp in milliseconds)	1704070810000

CURL Example

curl --location --request POST 'https://api.pointpay.io/api/v1/account/balance' \
--header 'Content-Type: application/json' \
--header 'X-TXC-APIKEY: 0000000000XXXXXXXXXXXXXXXXX' \
--header 'X-TXC-PAYLOAD: 0000000000XXXXXXXXXXXXXXXXX=' \
--header 'X-TXC-SIGNATURE: 0000000000XXXXXXXXXXXXXXXXX' \
--data-raw '{"request":"/api/v1/account/balance","currency":"USDT","nonce":1704070810000}'

200: OK Successful

Response parameters:

Name	Type	Description
available	NUMERIC	Aviailable amount (without active orders)
freeze	STRING	Freezed amount (in active orders)

Response example:

{
    "code": 200,
    "success": true,
    "message": "",
    "result": {
        "available": "0",
        "freeze": "0"
    }
}

400: Bad Request

Response example 1:

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

This error occurs in the following cases:

• The request was signed incorrectly.

• Some of the provided parameters are incorrect.

• Provided nonce is incorrect or less than on previous completed request

• The base URL or path is incorrect.

• The API keys are not activated.

Response example 2:

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

This error occurs in the following cases:

• One or more body params provided incorrectly

• Required body params are not provided

404: Not Found

Response example:

{    
    "timestamp": 1660811292806,
    "status": 404,
    "error": "Not Found",
    "message": "",
    "path": "/api/v1/order/test"
}

This error occurs in the following cases:

• The request was made with undefined data and the service cannot find the data for response.