Home > Aria6 User Documentation > Processing Payments > Electronic Payments > Card-Present Transactions > API Calls for Working with Client Group IDs

API Calls for Working with Client Group IDs

alt_client_acct_group_id                         

You can pass an input parameter called alt_client_acct_group_id into the API methods listed below. alt_client_acct_group_id is a client group ID used to uniquely identify a collection account group. When you call the API methods listed below, you can pass in an alt_client_acct_group_id to specify that the payment or validation you are currently submitting should be processed using the payment gateway information associated with the corresponding collection account group instead of the default Aria collection account group or the collection account group to which a customer is assigned.

Note: Passing in an alt_client_acct_group_id will not assign a customer to the corresponding collection account group unless you use the update_acct_complete API call.

  • alt_client_acct_group_id can be passed into any of the following API methods:
  • assign_supp_plan
  • authorize_electronic_payment
  • collect_from_account
  • create_order
  • replace_supp_plan
  • settle_acct_balance
  • update_acct_complete
  • update_master_plan
  • validate_payment_information

client_acct_group_id

  • assign_collections_acct_group: You can pass in a client_acct_group_id (client group ID) to assign a customer to the corresponding collection account group.
  • remove_acct_from_group: You can pass in a client_acct_group_id (client group ID)to remove a customer from the corresponding collection account group or functional account group.
  • client_acct_group_id (client group ID) is returned by the following API methods:
    • get_acct_groups_by_client
    • get_acct_groups_by_acct

client_coll_acct_group_ids

client_coll_acct_group_ids is an array of client group IDs that uniquely identify collection account groups. You can pass client_func_acct_group_ids into the API calls listed below to assign a customer to the corresponding collection account groups:

  • create_acct_complete
  • update_acct_complete
Last modified

Tags

Classifications

This page has no classifications.