update_acct_complete_m Guide

Last updated
Save as PDF

This API allows you to update a broad range of information associated with an account. This information includes:

User ID and related login information: Add or change user ID, password and secret question information for the account.
Contact information: Add or change account, billing and statement contact information, including name, address, email and phone number.
Statement information: Specify the statement notification method and format, such as HTML or PDF, and the associated template used to generate a statement for this account.
Billing Group information: Update or create a new billing group, including the ability to update a Client Billing Group ID.
Payment Method information: Update or create a new payment method.
Parent and child plan assignment: Specify which plans on this account are parent plans or child plans
and the relationships between them. You can also assign standard and custom rate schedules to plans on the account.
Collection, dunning and functional account group assignment: Specify the collection, dunning or functional account groups to which this account is assigned.
Payment method/term and taxation status: Specify if the account payment method is a credit card, direct debit, or a payment term, an whether the account is tax-exempt.
Invoicing/billing information: Specify proration policy and account or billing start/end dates.
Surcharges: Specify the type and amount of surcharges applied to the account.
Usage: Specify whether unbilled usage is invoiced and if usage pooling is enabled for the account,
Coupons and promotions: Specify coupons and promotions to be applied to the account.
Revenue recognition: Specify the revenue recognition profile assigned to this account.

Any field on an account can be updated. You can clear the value in any field with a type of "string", provided that the field is nullable for an account, by entering a '~' in that field.

API Specification:	update_acct_complete_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id>
Error Messages:	update_acct_complete_m Error Messages

Additional Guidance

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 the primary and secondary payment method.

<billing_groups_array>

<billing_group_directive>

Allowable Values

Values	Description
1	Create new billing group
2	Update billing group

<payment_methods_array>

<payment_method_directive>

Allowable Values

Values	Description
1	Create new payment method
2	Update payment method

<billing_groups_array>

<existing_client_billing_group_id>
<new_client_billing_group_id>

If you want to update the Client Billing Group ID, you can specify the existing Client Billing Group ID (<existing_client_billing_group_id>), then the newly desired Client Billing Group ID (<new_client_billing_group_id>).

The field <client_billing_group_id> is DEPRECATED in favor of these two fields.

<status_cd>

Allowable Values

Values	Description
0	DEACTIVATED
1	ACTIVE
32	REGISTERED PENDING ACTIVATION
51	TEMPORARY SERVICE BAN
99	PERMANENT
-99	ARCHIVED

<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

<test_acct_ind>

Allowable Values

Values	Description
1	test
0	live

<tax_exemption_level>

Allowable Values

Values	Description
0	Account is not exempt from taxation (default).
1	Account is exempt from state/province taxation.
2	Account is exempt from federal/national taxation.
3	Account is exempt from both federal/national and state/province taxation.

<reset_dates_after_status>

Allowable Values

Values	Description
true	true
false	false

<invoicing_option>

Allowable Values

Values	Description
1	Perform full invoicing
2	Perform prorated invoicing
3	use client default
4	None

<functional_acct_grp_directive>

Allowable Values

Values	Description
1	Assign the account to the group.
2	Remove the account from the group.

<collection_acct_grp_directive>

Allowable Values

Values	Description
1	Assign the account to the group.
2	Remove the account from the group.

<acct_supp_field_directive>

Allowable Values

Values	Description
1	Add the supplemental field and value to the account (default).
2	Replace all instances of the supplemental field with the given value.
3	Remove the supplemental field and value. If the supplemental field exists with values other than the one given, those will remain untouched.
4	Remove all instances of the supplemental field. Any given value is ignored.

<surcharge_directive>

Allowable Values

Values	Description
1	Apply surcharge to account
2	Remove surcharge from account

<master_plan_instance_status>

Allowable Values

Values	Description
-3	Terminated
-2	Cancelled
-1	Suspended
0	Inactive
1	Active
2	Pending Cancellation
3	Pending Termination
31	Pending Installation
32	Pending Activation
41	Trial
61	Active Non-billable

<resp_level_cd>

Allowable Values

Values	Description
1	Standard Self-Pay (default)
2	Parent Pay: Usage accrues under self, invoices are generated per self's plan rules BUT are presented for payment against parent account'
3	Parent Usage & Pay: Usage accrues under parent and applied only to parent's plan rules and presented to parent for payment'

<master_plan_assign_directive>

Allowable Values

Values	Description
1	(Default) Perform the requested plan update on the account's next scheduled billing anniversary date. The account will not receive service under this plan (for master plan number updates) until that date. Initial billing for a full period of the given plan update will be performed on the account's next scheduled anniversary date. No charge or credit proration effect.
2	Perform the requested plan update immediately, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan update.
3	Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION
4	Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
5	Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY.
6	Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY.
7	Perform the requested plan assignment/de-assignment on the specified effective_date, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment.
8	Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION.
9	Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
10	Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when calling the cancel_supp_plan API.
11	Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when calling the assign_supp_plan API.

<invoice_unbilled_usage>

Allowable Values

Values	Description
false	Do not allow invoicing the unbilled usage during mid-term plan termination.
true	Allow invoicing the unbilled usage during mid-term plan termination.

<invoice_approval_required>

Allowable Values

Values	Description
true	Attempts to create a pending invoice. Note: if client is configured for real invoices, passing "True" here overrides the client setting.
false	Attempts to create a real invoice. Note: if client is configured for pending invoices, passing "False" here overrides the client setting.
null	If NULL, defaults to the client configuration setting

<usage_pooling>

Allowable Values

Values	Description
true	Usage pooling is enabled for this plan instance.
false	Usage pooling is not enabled for this plan instance. (default)

<usage_threshold_applicability>

Allowable Values

Values	Description
UT	Usage Type
UP	Usage Pool

<plan_instance_field_directive>

Allowable Values

Values	Description
1	Add name and value for a new plan instance field.'
2	Replace value of an existing plan instance field.
3	Remove the value of an existing plan instance field, note that if the plan instance field is required based on the field definition, the Replace directive should be used.
4	Remove the name and value of an existing plan instance field from the plan instance.

<mp_surcharge_directive>

Allowable Values

Values	Description
1	Apply surcharge to account
2	Remove surcharge from account

<bg_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

<payment_option>

Allowable Values

Values	Description
Methods	Methods
Terms	Terms

<bg_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.

<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.

<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
21	FIK
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

<do_collect>

Allowable Values

Values	Description
true	true
false	false

<change_status_after_coll>

Allowable Values

Values	Description
0	Do not reset the MPI status to active
1	Reset the MPI status to active when its current status is any non-active status.
2	Reset the MPI status to active only when its current status "Suspended" (default).
3	Reset the MPI status to active only when its current is either "Suspended" or "Terminated"

<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

<mp_proration_invoice_timing>

Allowable Values

Values	Description
Null(default)	Honor Proration Invoice Timing configuration saved with the plan in the product catalog.
0	Generate the invoice immediately for the pro-rated charges.
1	Generate the invoice on the next anniversary date for the pro-rated charges.

<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.

<plan_instance_supp_field_update_only>

Allowable Values

Values	Description
	This input will not allow plan instance fields to be update for plans that are in a non-provisioned status
0	This input will not allow plan instance fields to be update for plans that are in a non-provisioned status
1	This input will allow plan instance fields to be update for plans that are in a non-provisioned status

<remove_pi_custom_rates>

Allowable Values

Values	Description
true	Remove the custom rates and use the default rates of the new rate schedule that you assigned.
false (default)	Keep the custom rates currently assigned to the plan instance.

<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

<force_currency_change>

Allowable Values

Values	Description
true	When the plan being updated has a rate schedule with a different currency or the supplied alternate rate schedule has rates defined in different currency, a 'true' value will allow the currency change provided that there are no transactions (or only $0 transaction present) for that account and the new plan/alt rate schedule has the rates defined in the target currency.
false	When the plan being updated has a rate schedule with a different currency the supplied alternate rate schedule has rates defined in different currency, a 'false' value will not allow the currency change.

<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.

<usage_accumulation_reset_months_renewal_option>

Allowable Values

Values	Description
NULL or 1	Recurring / Auto Renew.(Default)
2	Single Use.

<include_plan_instance_queue>

Allowable Values

Values	Description
false	Scheduled plan changes will not be returned in the plan_instance_queue array (default).
true	Scheduled plan changes will be returned in the plan_instance_queue array.

<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.