Get Account Balance - GetBalance

Overview

Get Account Balance

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetBalance`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
AccountInfo	AccountInfo	Account Balance Information	Yes

Data Model

AccountInfo

Field Name	Type	Description Information	Required
AmountFreeze	string	Freeze Account Amount	No
AmountCredit	string	Credit Account Balance	No
AmountFree	string	Gift Account Balance	No
Amount	string	Account Balance	No
AmountAvailable	string	Available Account Balance	No

Example

Request Example


https://api.sigcalcloud.com/?Action=GetBalance

Response Example


{
  "Action": "GetBalanceResponse",
  "Amount": 3.99529,
  "AmountCredit": "yAMrPpUv",
  "AmountFree": 1.18659,
  "AmountFreeze": 6.51374,
  "RetCode": 0
}