DescribeCustomerBalance

1. API Description

This API is used to query account financial information, including balance, credit limit, purchase power, temporary hold, etc.

2. Input Parameters

No request parameter related to the API request parameters.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

accountUid

String

Team CID.

cashBalance

Double

Account balance.

creditValue

Double

Credit limit.

purchasingPower

Double

Purchase power.

orderFrozenAmount

Double

Temporary hold.

4. Code Example

Query account financial information.

POST /api/v2/zbc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeCustomerBalance
<Common Request Params>

Request:
{}

Response:
{
    "requestId": "T8069671F-CB61-4368-8EB3-9807C92714EF",
    "response": {
        "requestId": "T8069671F-CB61-4368-8EB3-9807C92714EF",
        "cashBalance": -1177.520000,
        "orderFrozenAmount": 12.800000,
        "creditValue": 0.000000,
        "accountUid": "cccbf4c0-12ab-417a-95ba-0bf8e60a55d1",
        "purchasingPower": -1177.520000
    }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​​

Last updated