GetFundAccountAvailableAmount - Expenses and Costs - Alibaba Cloud Documentation Center

Query available balance of fund account

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribeBillingAccount

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FundAccountId	string	No	Account ID. If not specified, the account ID owned by the current account (owner) is used by default.	12332112

Response elements

Element	Type	Description	Example
	object	BssApiPlainResult
Metadata	any	Response metadata	{}
RequestId	string	Request ID	F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8
FundAccountId	string	Account ID	12332112
FundAccountOwnerAccountId	string	Account ID of the fund account owner	1344312434
FundAccountStatus	string	Account status	valid
FundAccountType	string	Fund account type. Valid values: DIRECT_USER: Alibaba Cloud direct customer account. RESELLER_QUOTA: ecosystem account.	REDIRECT_USER
AvailableAmount	string	Available amount	100
CashAmount	string	Cash balance	50
NegativeBillAmount	string	Negative bill amount	0
CreditAmount	string	Credit quota	100
AvailableCreditAmount	string	Available credit amount	50
CreditRefundAmount	string	Credit refund balance	0
UnclearedAmount	string	Uncleared amount (current month uncleared + historical months uncleared)	50
CurrentMonthUnclearedAmount	string	Current month uncleared amount	20
HistoryMonthUnclearedAmount	string	Historical months uncleared amount	30
BankAcceptanceAmount	string	Bank acceptance bill amount	0
ExtendLedgerList	array<object>	Extended ledger list
	object
Currency	string	Currency of the ledger amount, such as CNY and USD.	CNY
LedgerName	string	Ledger name	应付对冲账本
OriginalAmount	string	Ledger balance	50
QuotaAmount	string	Ecosystem end customer quota	20
QuotaConsumedAmount	string	Consumed quota of ecosystem end customer	10
Currency	string	Currency	CNY
OriginalCashAmountList	array<object>	Original cash ledger list. International site users may have cash ledgers in multiple currencies.
	object
Amount	string	Amount	10
Currency	string	Currency	USD
CreditUser	boolean	Indicates whether credit control is enabled

Examples

Success response

JSON format

{
  "Metadata": "{}",
  "RequestId": "F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8",
  "FundAccountId": "12332112",
  "FundAccountOwnerAccountId": "1344312434",
  "FundAccountStatus": "valid",
  "FundAccountType": "REDIRECT_USER",
  "AvailableAmount": "100",
  "CashAmount": "50",
  "NegativeBillAmount": "0",
  "CreditAmount": "100",
  "AvailableCreditAmount": "50",
  "CreditRefundAmount": "0",
  "UnclearedAmount": "50",
  "CurrentMonthUnclearedAmount": "20",
  "HistoryMonthUnclearedAmount": "30",
  "BankAcceptanceAmount": "0",
  "ExtendLedgerList": [
    {
      "Currency": "CNY",
      "LedgerName": "应付对冲账本",
      "OriginalAmount": "50"
    }
  ],
  "QuotaAmount": "20",
  "QuotaConsumedAmount": "10",
  "Currency": "CNY",
  "OriginalCashAmountList": [
    {
      "Amount": "10",
      "Currency": "USD"
    }
  ],
  "CreditUser": false
}

Error codes

HTTP status code	Error code	Error message	Description
400	RequestTimeout	Request timed out. Please try again later.	Request timed out, please try again later
400	AccountNoQueryPricePermission	This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.	This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.
400	SubAccountNoQueryPricePermission	This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.	This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.
400	NoFundAccountPermission	The caller does not have permission for the specified fund account.	The current login account does not have permission to operate the specified account.
400	NoPermission	You are not authorized to perform this action.	You do not have permissions to perform the operation.
400	InnerAccountNoQueryPricePermission	In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group's cloud account. More questions please refer to the document.	Due to data security and compliance requirements, the Group's cloud account amount information permissions are controlled. Please understand the inconvenience caused. You can view it through HCRM/cloud platform. For details, please refer to: https://aliyuque.antfin.com/yunfei.xyf/kr0b8h/yvdm6izaeulmq8g2 。
400	InnerSubAccountNoQueryPricePermission	In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group's cloud account.	Due to data security and compliance requirements, the Group's cloud account amount information permissions are controlled. Please understand the inconvenience caused. You can view it through HCRM/cloud platform. For details, please refer to: https://aliyuque.antfin.com/yunfei.xyf/kr0b8h/yvdm6izaeulmq8g2 。

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.