All Products
Search
Document Center

BSS OpenAPI:QueryAccountBalance

Last Updated:Jul 18, 2024

Queries the balance of your account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code returned.

200
Messagestring

The message returned.

success
RequestIdstring

The ID of the request.

16176743-6DC7-4CB3-BB25-A13982D8DFAD
Successboolean

Indicates whether the request is successful.

true
Dataobject

The data returned.

AvailableAmountstring

The available balance of the account.

10000.00
CreditAmountstring

The credit balance of the account.

0.00
MybankCreditAmountstring

The credit line controlled by MYbank.

0.00
Currencystring

The type of the currency. Valid values:

  • CNY: Chinese Yuan
  • USD: US dollar
  • JPY: Japanese Yen
CNY
AvailableCashAmountstring

The available balance in cash.

10000.00
QuotaLimitstring

The quota limit for eco customers.

10000.00

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "success",
  "RequestId": "16176743-6DC7-4CB3-BB25-A13982D8DFAD",
  "Success": true,
  "Data": {
    "AvailableAmount": "10000.00",
    "CreditAmount": "0.00",
    "MybankCreditAmount": "0.00",
    "Currency": "CNY",
    "AvailableCashAmount": "10000.00",
    "QuotaLimit": "10000.00\n"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NotApplicableThis API is not applicable for caller.-
400NotAuthorizedThis API is not authorized for caller.-
400MissingParameter Some parameters arte mandatoryfor this request.-
400InvalidParameterSome parametersare not valid.-
400InvalidOwnerThe specifiedowner doesn’t belong to caller-
400InternalErrorThe request processing has failed due to some unknown error, exception or failure.-
400NoPermissionYou are not authorized to perform this action.You do not have permissions to perform the operation.
500UndefinedErrorThe request processing has failed due to some unknown error.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-06-25The Error code has changedView Change Details
2023-12-12The Error code has changed. The response structure of the API has changedView Change Details