Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_balance_m


Use this API to return a given account number's currency_cd, full balance due, and balance per each Master Plan Instance subscribed to by an account.

For a list of error messages generated by this API, see get_acct_balance_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.




Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
required-icon.png client_acct_id string 50 Client-defined account identifier.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
acct_balance string The outstanding balance on the account.
master_plan_instances hash  
brd_arrow.gif master_plan_instance_no long Unique Plan instance number for each assigned Master Plan.
brd_arrow.gif client_def_master_plan_instance_id string Client-defined Plan instance ID for each assigned Master Plan.
brd_arrow.gif master_plan_name string Master Plan name
brd_arrow.gif master_plan_instance_desc string Description for each assigned Master Plan
brd_arrow.gif master_plan_instance_balance double Stack balance of each Master Plan
Last modified



This page has no classifications.