XML-RPC API - Listing Accounts

S
Written by Sergiiy
Updated 11 months ago

listAccounts()

This application is used to get list of accounts belonged to customer.

Implementation details

From version 2.2

  • This function supports trusted mode in which case i_customer (integer) parameter should be supplied.

Parameters:

  • offset - skip fist offset records. Integer. Optional.
  • limit - return only limit records. Integer. Optional.

Returns:

  • result - OK means that query was successful. String.
  • accounts - an array containing structures:
    • i_account - Integer.
    • username - String.
    • description - String.
    • blocked - Boolean.
    • expired - Boolean. 
    • balance - Double.
    • credit_limit - Double.
    • base_currency - String.
    • registration_status - Structure as returns getRegistrationStatus() or Null if account is not registered.
  • XMLRPC fault in case of any error.

Did this answer your question?