docs
api
Billing Management(UBill)
GetBalance

Get Account Balance - GetBalance

Overview

Get Account Balance

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetBalance.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
AccountInfoAccountInfoAccount Balance InformationYes

Data Model

AccountInfo

Field NameTypeDescription InformationRequired
AmountFreezestringFreeze Account AmountNo
AmountCreditstringCredit Account BalanceNo
AmountFreestringGift Account BalanceNo
AmountstringAccount BalanceNo
AmountAvailablestringAvailable Account BalanceNo

Example

Request Example

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

Response Example

{
  "Action": "GetBalanceResponse",
  "Amount": 3.99529,
  "AmountCredit": "yAMrPpUv",
  "AmountFree": 1.18659,
  "AmountFreeze": 6.51374,
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved