Create a Configuration Set with the set_reg_uss_config_params_m API

Use the set type number to identify a configuration set as being generic or for Direct Post.

You will see your specified type of configuration set in the Set Type column in Aria under Configuration > Client Settings > USS Reg Configuration.

The default value is 1 (generic).

This is a user self-service feature that requires a form field named collection_amount.

If this is set to 1 (true):

• Direct Post calls collect_from_account_m using the amount entered in the collection_amount form field, with the entered credit card or ACH information. If no collection_amount is provided, then the sum of the amount due for all invoice numbers provided will be collected (see pending_invoice_no and full_invoice_no). If no invoice numbers are provided, then the sum of the balances for all MPI (master plan instance) IDs provided will be collected (see master_plan_instance_no and client_master_plan_instance_id). If no MPI IDs are provided, the account balance will be collected.
• This takes priority over all other directives (including min_collect_threshold), which will not be used.

The collection amount must be a positive numeric value to be entered in the collection_amount field.

The form of payment on file is not changed. The payment will be processed at the account level and applied to open charge transactions in a FIFO (first-in, first-out) manner.

You can use this field only with credit card and Automated Clearing House (ACH) forms of payment. Net terms is not supported, so any net terms form of payment must not be selectable on a payment page that contains this field.

By default, do_one_time_collection is set to 1 (true).

Note: This parameter applies only to USS Direct Post configurations. If you need more functionality, you can use the collect_from_account_m API. You can call this API for both USS and registration use cases, and it also allows you to use an alternate payment method.

The Aria-assigned number of the pending invoice(s) for which a payment should be collected.

If authorization or collection is successful, then the payment method provided in the Direct Post form will be saved as the primary payment method for all billing groups on the account that are associated with the  invoice(s) provided.

Notes:

• One of the following fields is required only when the do_one_time_collection parameter is set to 0 (false): pending_invoice_no OR full_invoice_no OR master_plan_instance_no OR client_master_plan_instance_id. The fields mentioned above will be evaluated in the order in which they are listed.
• If the do_one_time_collection parameter is set to 1 (true), the amount of any pending invoice(s) provided will be used to determine the collection amount in addition to any amount specified in the  collection_amount form field (see do_one_time_collection).
• If multiple pending invoices are provided, there will be separate collection attempts – one for each pending invoice specified.

The Aria-assigned number of the non-pending invoice(s) for which a payment should be collected.

If authorization or collection is successful, then the payment method provided in the Direct Post form will be saved as the primary payment method for all billing groups on the account that are associated with the  invoice(s) provided.

Notes:

• One of the following fields is required only when the do_one_time_collection parameter is set to 0 (false): pending_invoice_no OR full_invoice_no OR master_plan_instance_no OR client_master_plan_instance_id. The fields mentioned above will be evaluated in the order in which they are listed.
• If the do_one_time_collection parameter is set to 1 (true), the amount of any full invoice(s) provided will be used to determine the collection amount in addition to any amount specified in the  collection_amount form field (see do_one_time_collection).
• If multiple invoices are provided, there will be only one collection attempt for the combined amount due for all invoices specified.

The Aria-assigned number of the master plan instance(s) (MPIs) for which the payment is being collected.

If authorization or collection is successful, then the payment method provided in the Direct Post form will be saved as the primary payment method for all billing groups on the account that are associated with the MPIs provided.

Notes:

• One of the following fields is required only when the do_one_time_collection parameter is set to 0 (false): pending_invoice_no OR full_invoice_no OR master_plan_instance_no OR client_master_plan_instance_id. The fields mentioned above will be evaluated in the order in which they are listed.
• If the do_one_time_collection parameter is set to 1 (true), the amount of any MPIs provided will be used to determine the collection amount in addition to any amount specified in the  collection_amount form field (see do_one_time_collection).
• There will be only one collection attempt for the combined total of the MPIs specified.

The client-defined identifier for the master plan instance(s) (MPIs) for which the payment is being collected.

If authorization or collection is successful, then the payment method provided in the Direct Post form will be saved as the primary payment method for all billing groups on the account that are associated with the MPIs provided.

Notes:

• One of the following fields is required only when the do_one_time_collection parameter is set to 0 (false): pending_invoice_no OR full_invoice_no OR master_plan_instance_no OR client_master_plan_instance_id. The fields mentioned above will be evaluated in the order in which they are listed.
• If the do_one_time_collection parameter is set to 1 (true), the amount of any MPIs provided will be used to determine the collection amount in addition to any amount specified in the  collection_amount form field (see do_one_time_collection).
• There will be only one collection attempt for the combined total of the MPIs specified.

This is the minimum transaction amount necessary before credit card authorization occurs.  For instance, if you want a minimum $10 transaction to occur before authorizing an electronic payment, set this field to 10.  min_cc_auth_threshold takes precedence over min_cc_auth_threshold as described below.

By default, the min_cc_auth_threshold parameter is set to 1.

Determines whether a full authorization or a $0 authorization is performed for credit card payment methods.

Set it to 1 (true) to perform a full authorization.

By default, do_cc_auth_full_amount is set to 0 (false) and a $0 authorization is performed.

Note: min_cc_auth_threshold takes precedence over min_cc_auth_threshold. Example: if you set min_cc_auth_threshold to 10 and the transaction amount is $9, then no credit card authorization is performed regardless of what you pass into do_cc_auth_full_amount.

This is the minimum transaction amount above which collections occur. For instance, if you want at least $10 of transactions to occur before collecting an electronic payment, set this field to 10.

By default, min_collect_threshold is set to 1.

Determines whether to perform both an authorization and collection when a credit card is provided.

Note: min_collect_threshold is honored for all collection attempts, so in cases where the amount to be collected falls below the min_collect_threshold, no collection is performed.

The default for this field is 1 (true).

This field indicates that the master plan instance status changes if a collection and/or authorization succeeds as part of the Direct Post process.

Set it to 0 (false) if you do not want to change the master plan instance status.

The default for this field is 0 (false).

This field indicates that the master plan instance status changes if a collection and/or authorization fails as part of the Direct Post process.

Set it to 0 (false) if you do not want to change the master plan instance status.

The default for this field is 0 (false).

Set this value only if change_mp_status_on_failure is set to 1 (true). This value must be a valid Aria master plan instance status code. 

The default for this field is null, which means that the master plan instance status will not be changed.

By default, the payment method provided via Direct Post is saved as an active payment method on the account in Aria. This parameter determines, in cases where the collection or authorization fails, if the payment method remains in an active status on the account, making it available for use in the future.

Set this to 1 (true) to disable the payment method in cases of authorization or collection failure. This makes the payment method unavailable for future use.

The default for this field is 0 (false).

If you enabled fraud scoring/filtering in your Direct Post configuration, you can use this field to also specify whether to disable or enable a payment method after fraud scoring/filtering failure (if your payment gateway supports fraud scoring/filtering). 

Indicates whether the master plan instance status should be changed if a collection is not attempted.

Set it to 0 (false) if you do not want to change the status of the master plan instance(s).

This field indicates whether Direct Post should kill the current session after it has submitted its transactions, either successfully or unsuccessfully.

If this field is set to 1 (true), Direct Post calls the kill_session_m API method, which disables the current session ID. After the session ID is disabled, you must call set_session_m or set_session_auth_m again to start a new session if you want to reattempt any unsuccessful transactions. This allows you to verify the validity of a session every time a customer resubmits payment information. In addition, disabling a session ID prevents that session ID from being used for any transactions other than the ones triggered by Direct Post in your account registration or user self-service application.

The default for this field is 0 (false). This allows the same session to be reused if a customer attempts to resubmit payment information.

Note: If you call the set_session_m or set_session_auth_m API for something other than Direct Post, and you want to utilize this field, you must call a separate instance of set_session_m or set_session_auth_m specifically for Direct Post.

Example: You set this field to automatically disable a session ID. When Direct Post attempts to authorize a credit card and the authorization fails, the session ID is disabled. You must then call set_session_m again to start a new session and allow the customer to resubmit credit card information.

This is a client group ID, which is your chosen unique ID code with which to identify a collection group. You add a client group ID when you create or edit a collection group.

Pass in a client group ID to specify that, for a payment that you are currently submitting to Direct Post, Aria should process the transaction using the payment gateway information associated with the corresponding collection group instead of the default Aria collection group or the collection group to which a customer is assigned.

Note: Passing in alt_client_acct_group_id does not assign a customer to the corresponding collection group. Unless you specify otherwise, future payments are processed using the default Aria collection group or the collection group to which a customer is assigned.

Determines whether to perform a collection when ACH details are provided. Note that the min_collect_threshold will be honored for all collection attempts, so in cases where the amount to be collected falls below the min_collect_threshold, no collection will be performed.

Set this field to 0 (false) if you do not want to perform an ACH collection.

By default, do_ach_collect is set to 1 (true), which will perform an ACH collection.

no_reuse_session_ind

If this field is set to 1 (true), Direct Post calls the kill_session_m API method, which disables the current session ID after Direct Post has completed its transactions successfully or unsuccessfully. After the session ID is disabled, you must call set_session_m or set_session_auth_m again to start a new session if you want to reattempt any unsuccessful transactions. This allows you to verify the validity of a session every time a customer resubmits payment information. In addition, disabling a session ID prevents that session ID from being used for any transactions other than the ones triggered by Direct Post in your account registration or user self-service application.

This field is set to 0 (false) by default. This allows the same session to be reused if a customer attempts to resubmit payment information.

Note: If you call the set_session_m or set_session_auth_m API method for something other than Direct Post and you want to utilize the no_reuse_session_ind field, you must call a separate instance of set_session_m or set_session_auth_m specifically for Direct Post.

For example, if you set up the no_reuse_session_ind field to automatically disable a session ID. When Direct Post attempts to authorize a credit card and the authorization fails, the session ID is disabled. You must then call set_session_m again to start a new session and allow the customer to resubmit credit card information.

alt_caller_id

You can use this parameter to pass in your chosen value to associate with an API call used to create or modify your customer data. For example, you can pass in the user ID of the person making an API call. 

The value that you pass into the alt_caller_id parameter is displayed in your API call logs in Aria in a column named Caller ID. 

Note: To be able to pass a value into the alt_caller_id parameter, you must first contact Aria Customer Support to enable the parameter for your company.

track_data1

If credit card numbers are added to your accounts via a swipe machine (card-present transactions), Direct Post accepts inputs consisting of the track 1 and track 2 data retrieved from the swiped credit cards. You can pass the track 1 and track 2 data into the track_data1 and track_data2 parameters in Direct Post.

track_data2

If credit card numbers are added to your accounts via a swipe machine (card-present transactions), Direct Post accepts inputs consisting of the track 1 and track 2 data retrieved from the swiped credit cards. You can pass the track 1 and track 2 data into the track_data1 and track_data2 parameters in Direct Post.

track_data2

If credit card numbers are added to your accounts via a swipe machine (card-present transactions), Direct Post accepts inputs consisting of the track 1 and track 2 data retrieved from the swiped credit cards. You can pass the track 1 and track 2 data into the track_data1 and track_data2 parameters in Direct Post.

To collect a payment made using Direct Debit, pass 1 into this field and complete the additional steps described in Use Direct Post to Collect Direct Debit Payments.

Allowable Values

Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs.

The allowable field(s) and values for the key-value pairs are listed below.

If you use Chase Paymentech, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's  payment information.

This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings).

Aria will use this order of precedence to determine the transaction type:

1. value passed into this field
2. collection group configuration
3. payment gateway configuration
4. transaction type that you specified in the <recurring_processing_model_ind> field