assign_collections_acct_group_m Guide

Last updated
Save as PDF

Assigns a specified account to a collections account group. If the account's payment method is credit card, a $1 authorization will be performed on the credit card using the new group's payment processor before the group assignment is completed. Please note: If you attempt to use this API call to assign an account to a functional account group, you will encounter an error. You can use the assign_functional_acct_group call to assign an account to a functional account group.

API Specification:	assign_collections_acct_group_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <group_no> or <client_acct_group_id>

Additional Guidance

Input Fields

Field Name:	Notes:
<client_acct_id>	If you pass in a <client_acct_id> and an <acct_no>, Aria will use this order of precedence to decide which account to take action on: <acct_no> <client_acct_id>
<client_billing_group_id>	For cost savings or for other reasons, you may choose to have payments made with a particular payment method (associated with a billing group) processed by a specific payment gateway. To do so, you can assign a collection group to a billing group by passing the following into this API: a <billing_group_no> or <client_billing_group_id>; and a <collections_group_bg_no> or <client_collections_group_bg_id> to identify the collection group to assign to the specified billing group. Aria will use this order of precedence when selecting the payment gateway to use for processing a payment: Collection group assigned to the billing group associated with the master plan instance being invoiced; Collection group to which the customer is assigned at the account level. Aria will allow accounts to have multiple billing groups with different collection groups when using tokenized credit cards that were tokenized outside of Aria. To facilitate multiple payment methods, the billing agreement ID (token) is validated against the specific collection group. When there is no collection group specified, then the agreement ID will be validated against the account level collection group. When no collection group at account level or billing group level is specified, then the agreement ID will be validated against the last processor mapped to that client.

Field Name:

Notes:

<client_acct_id>

If you pass in a <client_acct_id> and an <acct_no>, Aria will use this order of precedence to decide which account to take action on:

<acct_no>
<client_acct_id>

<client_billing_group_id>

For cost savings or for other reasons, you may choose to have payments made with a particular payment method (associated with a billing group) processed by a specific payment gateway. To do so, you can assign a collection group to a billing group by passing the following into this API:

a <billing_group_no> or <client_billing_group_id>; and
a <collections_group_bg_no> or <client_collections_group_bg_id> to identify the collection group to assign to the specified billing group.

Aria will use this order of precedence when selecting the payment gateway to use for processing a payment:

Collection group assigned to the billing group associated with the master plan instance being invoiced;
Collection group to which the customer is assigned at the account level.

Aria will allow accounts to have multiple billing groups with different collection groups when using tokenized credit cards that were tokenized outside of Aria. To facilitate multiple payment methods, the billing agreement ID (token) is validated against the specific collection group. When there is no collection group specified, then the agreement ID will be validated against the account level collection group. When no collection group at account level or billing group level is specified, then the agreement ID will be validated against the last processor mapped to that client.

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error Associated Inputs: auth_key, client_id, client_no	<auth_key>, <client_acct_id>, <client_no>
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id) Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no	<acct_no>, <client_acct_id>
6003: could not validate billing information Associated Inputs: pay_method_type, cc_auth_amount Additional Comments: There was an error during the $1 authorization attempt.
12001: Account group does not exist Associated Inputs: group_no, acct_group_id Additional Comments: An invalid seq_function group_id was entered.	<group_no>, <client_acct_group_id>
12003: Account group is not collections based Associated Inputs: collection_acct_group_no or client_collection_acct_group_id	<collection_group_bg_no> or <client_collection_group_bg_id>
12004: Account already assigned to this group Associated Inputs: collection_acct_group_no or client_collection_acct_group_id	<collection_group_bg_no> or <client_collection_group_bg_id>
12010: Client account group does not exist Associated Inputs: collections_acct_group_no, client_acct_group_id, alt_client_acct_group_id	<collections_group_bg_no>, <client_acct_group_id>, <client_acct_id>
12012: Collection group does not exist
12013: Collection group identifier does not exist
12015: Collection group details missing
12018: Billing group already assigned to this group
26041: Billing group details missing