Create a Collection Group

Last updated
Save as PDF

Overview

You can create a collection group (also known as a "collection account group") by following the steps in this article.

For collection group settings specific to your payment gateway, please see Payment Gateway Configuration by Client.

Creating a Collection Group

Getting Here: Click Configuration > Payments > Collection Groups.

Click New.
Enter a descriptive Group Name, such as a name that reflects the purpose of the collection group.

For example, you may wish to enter Paymentech for your customers on the east coast, Paymentech – WC for transactions for your customers on the west coast, and Paymentech – CAD for your customers who make payments in Canadian dollars.

Enter a unique Client Group ID with which to identify the collection group.

Aria assigns different, unique collection group numbers in each environment. You can assign collection group IDs in your Stage Current, Stage Future, and Production environments that remain consistent across all environments. This ensures that any functionality that you set up will work with the designated client group IDs across all of your environments.

Using API calls or Direct Post, you can pass in a client group ID (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 group instead of the default Aria collection account group or the collection account group to which a customer is assigned.

In addition, using API calls you can pass a client group ID (client_acct_group_id) or an array of client group IDs (client_coll_acct_group_ids) to assign a customer to the corresponding collection group(s). Please see API Calls for Working with Client Group IDs for a list of API calls into which you can pass a client group ID.

Enter the purpose of the collection group in the Description field.
Choose the payment gateway for which you are creating the collection group from the Select Payment Processor drop-down.
Configure the Collection Group Options for your chosen Payment Gateway, if any are available. These can include gateway-specific variables or features for API calls or "Fraud Options."
Enter values for Bill Lag Days and Days Until Due, if applicable, for supported electronic payments.

Bill Lag Days: The number of days prior to (negative) or after (positive) an account billing date at which an invoice should be generated. The Bill Lag Days setting in the Collection Group screen will override the Bill Lag Days setting in the Payment Method screen, and the Bill Lag Days setting in the Payment Method screen will override the Bill Lag Days setting in the Billing Recurring Interval screen (Configuration > Billing > Bill Lag Days).

Days Until Due: The number of days after an invoice is generated that payment is due. For electronic payment methods, this will determine which day the electronic collection is attempted. The Days Until Due setting in the Collection Group screen will override the Days Until Due setting in the Payment Method screen.
Configure Payment Gateway-specific fields listed under Processor/Gateway Details.
Configure System Overrides, if available, for your chosen Payment Gateway. Here, you can specify authorization behavior for each supported card:

Account Verification Zero Amount Authorization: Specifies whether your chosen Payment Gateway should attempt a zero-value authorization of a card to verify an account. Some Payment Gateways do not allow zero-value authorizations.

Automatic Reverse of an Authorization: Specifies whether your chosen Payment Gateway should automatically reverse an Account Verification Authorization Amount if it is greater than zero. Some Payment Gateways do not support this feature.

You may also be presented configuration options for handling errors returned by your chosen Payment Gateway related to Card Verification Value (CVV) and Address Verification System (AVS)values:
Specify Advanced Options, if available. Here, you can specify values for fields sent to your chosen Payment Gateway via payment-related API calls. Field names are listed along the left. Values can be specified in two ways:

1. Type in a static text value to be sent for the corresponding field name.

2. Choose a pre-configured Account Field from the drop-down menu.
Click Save.

The collections group is saved. Be sure to add all applicable accounts to the collection group during the account registration process or soon afterward.