Inputs passed to this API call will override any fraud options that you specified in your payment gateway, collection group, or Direct Post settings, unless stated otherwise below.
create_acct_billing_group_m Guide
This API is used to create a new billing group, optionally assign a new payment method to this billing group, and to optionally assign this new billing group to a plan instance.
| API Specification: | |
| Required Fields: |
|
Error Codes
Click here
Additional Guidance:
Input Fields
| Field Name: | Notes: |
| <fraud_filter> |
Enables or disables fraud filtering. If no value is provided, the system will default to 2. To use fraud filtering, you must have it enabled and configured in your payment gateway. Contact your payment gateway representative for setup information and additional documentation.
|
| <collection_group_bg_row> |
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 values into the <collection_group_bg_row> array. Aria will use this order of precedence when selecting the payment gateway to use for processing a payment:
Aria allows 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. |
|
<proc_field_override> (array) <transaction_type> |
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). The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
Currently, only Chase Paymentech and Vantiv support this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation. Aria will use this order of precedence to determine the transaction type:
|
Allowable Values:
Input Fields
| Field Name: | Notes: | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| <notify_method> |
How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email). Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <payment_option> |
This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group. Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <pay_method_type> |
This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, etc. Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <bank_acct_type> |
The type of bank account used (for <pay_method_type> 2). Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <list_start_master_file> |
Indicates whether the account is listed at the start of a master file. Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <cc_id> |
A numeric code indicating the type of credit card. Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <fraud_filter> |
Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <fraud_filtering_enabled> |
Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <change_status_on_fraud_filtering_failure> |
Indicates whether to change the status of the account or master plan instance(s) if:
Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <change_status_on_fraud_filtering_review> |
Indicates whether to change the status of the account or master plan instance(s) if fraud_filtering_enabled is set to 1 (enable). Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <change_mp_status_on_fraud_filtering_cc_prefix_failure> |
Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <change_mp_status_on_fraud_filtering_cc_number_failure> |
Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card number. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <change_mp_status_on_fraud_filtering_cc_issuing_country_failure> |
Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <change_mp_status_on_fraud_filtering_cc_issuing_country_suspect> |
Indicates whether to change the status of the master plan instance(s) if the fraud filtering check for the credit card issuing country returned a "suspect" value. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <recurring_process_model_ind> |
Defines a recurring payment type for Credit Card and Tokenized Credit Cards. Allowable values:
|
||||||||||||||||||||||||||||||||||||
| <transaction_type> |
Allowable values:
|