update_acct_billing_group_m Guide

Last updated
Save as PDF

The update_acct_billing_group_m API updates information associated with a specified billing group.

API Specification:	update_acct_billing_group_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <billing_group_no> or <client_billing_group_id>

Additional Guidance

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.

Input Fields

Field Name

Notes

<primary_payment_method_no>
<client_primary_payment_method_id>
<backup_payment_method_no>
<client_backup_payment_method_id>

The same pay method sequence number cannot be used for a primary and secondary payment method.

<notify_method>

Allowable Values

Values	Description
0	None
1	HTML Email
2	Text Email
3	Text Email w/link to HTML
4	Data export
5	Printable (no Email) w/Surcharge
6	Printable & Text Email
7	Printable & HTML Email w/Surcharge
8	Printable (no Email)
9	PDF (Printing required, no Email)
10	PDF (delivered by Email)
11	PDF (Printing req & Email)w/surcharge
12	PDF (Printing req, no Email)w/surcharge
13	XML Master File
14	PDF Master File
15	XML Master File and HTML Email
16	XML Master File and Text Email
17	PDF Master File and HTML Email

<payment_option>

Allowable Values

Values	Description
Methods	Methods
Terms	Terms

<pay_method_type>

Allowable Values

Values	Description
-1	External Payment
1	Credit card
2	Electronic Check (ACH)
3	Pre-paid
8	Click&Buy
10	PayByCash
11	PayPal Express Checkout
13	Tokenized Credit Card
14	Purchase Power
20	NETS
26	Direct Debit
37	Tokenized Direct Debit
40	Merchant-Specific Gift Card
48	Tokenized ACH

<bank_acct_type>

Allowable Values

Values	Description
savings	savings
checking	checking
business	business

<billing_group_directive>

Allowable Values

Values	Description
0	Update billing group (default)
1	Disable billing group

<list_start_master_file>

Allowable Values

Values	Description
0	0
1	When value=1, account is listed at the top of the master file when generated.

<cc_id>

Allowable Values

Values	Description
1	Visa
2	MasterCard
3	American Express
4	Discover
5	Diners Club/Carte Blanche
6	Maestro
7	JCB
8	Laser
9	Dankoort

<fraud_filter>

Allowable Values

Values	Description
0	false (disable) Note: If you set this field to 0, then Aria will ignore all other fraud filtering fields.
1	true (enable) Note: If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will ignore that field.
2	Use settings specified at the collection group or payment gateway level. Note: If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.

<fraud_filtering_enabled>

Allowable Values

Values	Description
0	disable
1	enable
-1	Use settings specified at the collection group or payment gateway level.

<change_status_on_fraud_filtering_failure>

Allowable Values

Values	Description
0	false
1	true
-1	Use settings specified at the collection group or payment gateway level.

<change_status_on_fraud_filtering_review>

Allowable Values

Values	Description
0	false
1	true
-1	Use settings specified at the collection group or payment gateway level.

<change_mp_status_on_fraud_filtering_cc_prefix_failure>

Allowable Values

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_number_failure>

Allowable Values

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_issuing_country_failure>

Allowable Values

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_issuing_country_suspect>

Allowable Values

Values	Description
0	false
1	true

<recurring_processing_model_ind>

Allowable Values

Values	Description
0	Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1	Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2	Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3	Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.

<collections_grp_directive>

Allowable Values

Values	Description
1	Assign the collection group to the billing group.
2	Remove the collection group from the billing group.

<transaction_type>

Allowable Values

Values	Description
-1	Use client configuration settings for "Send Transaction Type as Recurring for Initial Request Where Possible" or "Send Transaction Type as Recurring for Subsequent Request" as applicable. (default)
1	(Chase) Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products and does not include sales that are processed via an installment plan.
2	(Chase) Recurring Transaction - Designates a transaction that represents an arrangement between an accountholder and the merchant where transactions are going to occur on a periodic basis.
3	(Chase) Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4	(Chase) Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time.
5	(Chase) Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy.)
6	(Chase) Non-Authenticated Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 3-D Secure includes Verified by Visa and Mastercard Identity Check.) Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy transactions in the event of: * A non-participating issuer * A non-participating accountholder of a participating issuer * A participating issuer, but the authentication server is not available
7	(Chase) Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), but authentication was not performed. The accountholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. For Discover, indicates an e-commerce Card Transaction with data protection in which ProtectBuy for Cardholder authentication was not used.
8	(Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where: * The transaction does not include the use of any transaction encryption such as SSL * Authentication is not performed * An accountholder certificate is not managed.
I	(Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system.
R	(Chase) Retail Transaction - Designates a transaction where the accountholder was present at a merchant location.
telephone	(Vantiv) The transaction is for a single telephone order.
mailorder	(Vantiv) The transaction is for a single mail order transaction.

<recalculate_installment_date>

Recalculate future notify dates and days until due for independent installment.

Allowable Values

Values	Description
Y	Recalculate future notify dates and days until due for independent installment.
N	Do not recalculate future notify dates and days until due for independent installment. (default)

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error	<auth_key>, <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)	<acct_no>, <client_acct_id>
1024: invalid date format Additional Comments: All date inputs must be in yyyy-mm-dd format.	<stmt_birthdate>, <application_date>
1053: invalid notification template group id	<notify_template_group>, <client_notification_template_group_id>
1500: Unsupported bank/country code for this payment method. Additional Comments: Added in support of ACH payments via Direct Debit (country code must be US).	<bank_country_cd>
4006: invalid pay method or alternate pay method	<pay_method_type>
4008: invalid expiration date Additional Comments: Dates must be in yyyy-mm-dd format. For update_payment_method_token_m, the date must be a future date.	<cc_expire_mm>, <cc_expire_yyyy>
4009: invalid cc number	<cc_num>
4010: invalid bank draft info Additional Comments: The client parameter BANK_DRAFT_INDICATOR must be enabled. Bank_acct_no and bank_routing_no are required. Valid bank_routing_no from Aria's ABA lookup in case of US address. Bank_routing_no must be numeric. For US, bank_routing_no should be 9 digits in length (left padded with zeros). Bank_routing_no must pass checksum validation.	<bank_acct_num>, <bank_routing_num>
4011: cc authorization failed Additional Comments: $1 authorization has failed.	<cc_num>, <cc_expire_mm>, <cc_expire_yyyy>, <pay_method_type>
4017: duplicate payment method client defined id. Additional Comments: This value must be unique at the client level.	<client_primary_payment_method_id>, <client_backup_payment_method_id>, <client_payment_method_id>
4019: Invalid Bank Account Type.	<bank_acct_type>
4022: invalid cc id	<cc_id>
4032: cc_id is required. Additional Comments: cc_id is required for this payment processor.	<cc_id>
4044: Missing a required value. Please check that either bank_account_no, bank_routing_number or agreement_id is present.	<bank_acct_num>, <bank_routing_num>, <bill_agreement_id>
5003: invalid notify method	<notify_method>
5017: invalid iso country code	<stmt_country>, <bill_country>, <bank_country_cd>
5075: Only self-pay Master Plan Instances can be assigned to a Billing Group.
5055: The first name, middle initial and last name of account contact, billing contact and statement contact must be the same when consumer_acct_ind = 1. Alt: Updating multiple contacts with different names on a consumer account is not allowed. Additional Comments: The first name, middle initial and last name of account contact, billing contact and statement contact must be same when consumer_acct_ind = 1.
6021: Invalid state_prov entered	<stmt_state_prov>, <bill_state_prov>
6027: IBAN is alphanumeric and is 15 to 34 characters in length	<iban>
6029: Bank swift code is alphanumeric and is 8 or 11 characters in length	<bank_swift_cd>
6031: BBAN is numeric and up to 16 digits	<bank_acct_num>
6032: Bank ID code is numeric and up to 10 digits	<bank_id_cd>
6033: Bank branch code is numeric and up to 10 digits	<bank_branch_cd>
6034: Basic bank account number or IBAN is required for Direct Debit	<iban>, <bank_acct_no>
6045: Account can have only one active NETS payment method.	<pay_method_type>
6053:Either IBAN or Agreement ID is required for this payment method.	<bill_agreement_id>, <iban>
7028: duplicate billing group client defined id. Additional Comments: This value must be unique at the client level.	<client_billing_group_id>, <new_client_billing_group_id>
1108: Invalid billing group, collection group directive.
12012: Collection group does not exist
12013: Collection group identifier does not exist
12017: Billing group is not assigned to this group
12018: Billing group already assigned to this group
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id". Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.	<plan_instance_no>, <client_plan_instance_id>
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".	<client_plan_instance_id>
18005: Invalid Template number	<notify_template_group>, <statement_template>, <credit_note_template>, <credit_memo_template>, <rebill_template>
18010: Invalid Credit Memo Template number Additional Comments: The credit memo template must be mapped to the "CM" template class.	<credit_memo_template>
18011: Invalid Rebill Template number Additional Comments: The rebill template must be mapped to "RB" template class.	<rebill_template>
20026: agreement id OR credit card info is required Additional Comments: The pay_method_type is "13", the bill_agreement_id is null and cc_num is null.	<bill_agreement_id>, <cc_num>, <cc_expire_mm>, <cc_expire_yyyy>, <pay_method_type>
25020: Illegal characters entered	<auth_key>, <billing_group_name>, <billing_group_description>, <client_billing_group_id>, <new_client_billing_group_id>, <client_primary_payment_method_id>, <client_backup_payment_method_id>, <stmt_first_name>, <stmt_mi>, <stmt_last_name>, <stmt_company_name>, <stmt_address1>, <stmt_address2>, <stmt_address3>, <stmt_city>, <stmt_locality>, <stmt_state_prov>, <stmt_country>, <stmt_postal_cd>, <stmt_phone>, <stmt_phone_ext>, <stmt_cell_phone>, <stmt_work_phone>, <stmt_work_phone_ext>, <stmt_fax>, <stmt_email>, <stmt_birthdate>, <bill_first_name>, <bill_middle_initial>, <bill_last_name>, <bill_company_name>, <bill_address1>, <bill_address2>, <bill_address3>, <bill_city>, <bill_locality>, <bill_state_prov>, <bill_country>, <bill_postal_cd>, <bill_phone>, <bill_phone_ext>, <bill_cell_phone>, <bill_work_phone>, <bill_work_phone_ext>, <bill_fax>, <bill_email>, <bill_birthdate>, <pay_method_name>, <client_payment_method_id>, <pay_method_description>, <cc_num>, <bank_acct_num>, <bank_routing_num>, <cvv>, <track_data1>, <track_data2>, <bill_agreement_id>, <iban>, <bank_swift_cd>, <bank_country_cd>, <mandate_id>, <bank_id_cd>, <bank_branch_cd>, <client_plan_instance_id client_receipt_id>, <payment_terms_name>, <client_payment_term_id>, <ean_gln_num>, <ean_gln_requisition_num>, <fraud_control_field_name>, <fraud_control_field_value stmt_email_list_cc>, <stmt_email_list_bcc>, <client_collections_group_bg_id>, <client_notification_template_group_id>, <proc_field_name>, <proc_field_value>, <bank_name>, <bank_city>, <client_acct_id>, <bank_acct_type>, <application_id>, <application_date>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value>
25025: Backup pay method cannot be different than primary pay method	<primary_payment_method_no>, <client_primary_payment_method_id>, <backup_payment_method_no>, <client_backup_payment_method_id>
25026: Primary pay method cannot be different than backup pay method	<primary_payment_method_no>, <client_primary_payment_method_id>, <backup_payment_method_no>, <client_backup_payment_method_id>
25043: Primary payment method does not support secondary pay method. Additional Comments: The primary_client_payment_method_id is not 1, 2, or 13) and the backup_client_payment_method_id is not null.	<primary_payment_method_no>, <client_primary_payment_method_id>, <backup_payment_method_no>, <client_backup_payment_method_id>, <pay_method_type>
25044: Secondary payment method type must match the primary. Additional Comments: The backup_client_payment_method_id is not 1, 2, or 13.	<primary_payment_method_no>, <client_primary_payment_method_id>, <backup_payment_method_no>, <client_backup_payment_method_id>
26007: Provided client defined pay method ID does not exist for this account.	<client_primary_payment_method_id>, <client_backup_payment_method_id>
26008: Provided payment_method_id does not exist for this account.	<client_primary_payment_method_id>, <client_backup_payment_method_id>
26010: Invalid billing group number	<billing_group_no>
26012: Invalid client-defined billing group ID.	<client_billing_group_id>
26016: This billing group cannot be disabled because it is associated with a provisioned Master Plan	<billing_group_directive>
26032: Payment terms is not available for the account. Additional Comments: The payment_terms_no must be mapped to the acct_group_no.	<payment_terms_no>, <payment_terms_name>, <client_payment_term_id>
26034: Payment terms not found.	<payment_terms_no>, <payment_terms_name>, <client_payment_term_id>
26037: EAN GLN number and EAN GLN requisition numbers are required for EAN GLN Payment Terms. Additional Comments: The payment_terms_no is valid and requires that ean_gln_num and ean_gln_requisition_num values are entered, but these values were not entered.	<payment_terms_no>, <payment_terms_name>, <client_payment_term_id>, <ean_gln_num>, <ean_gln_requisition_num>
29005: The contact number provided is invalid for the specified account.	<stmt_contact_no>, <bill_contact_no>