create_acct_complete_m Guide

Last updated
Save as PDF

This API creates multiple accounts within a parent-child account hierarchy and assigns multiple master plans and, optionally, multiple supplemental plans to each account in the parent-child account hierarchy for Aria clients.

All of the following information can be assigned to the account as it is created using this API.

User ID and related login information: User ID, password and secret question information for the account.
Contact information: 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.
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.

API Specification:	create_acct_complete_m
Required Fields:	<client_no> <auth_key> <acct> (array) <dunning_group> <master_plans_detail> (array) <plan_no> <resp_master_plan_instance_no> or <resp_client_master_plan_instance_id> or <resp_master_plan_instance_idx> or <client_billing_group_id> or <billing_group_idx> <client_dunning_group_id> or <dunning_group_idx>
Error Messages:	create_acct_complete_m Error Messages

Additional Guidance

You are required to associate a dunning group with parent-pay Master Plan Instances. If you do not specify a dunning group when assigning a Master Plan Instance, Aria creates an empty dunning group (i.e., without any values in the attributes) and assigns it to that Master Plan Instance automatically.
There is a visual representation of this API call in the article create_acct_complete_m API Walkthrough.
Learn more about formatting recursive arrays in this article.
There are many account creation use cases in the Account Registration Best Practices article.

Input Fields

Field Name

Notes

<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

<invoicing_option>

Allowable Values

Values	Description
1	Perform full invoicing
2	Perform prorated invoicing
3	Use client default configuration setting
4	None

<test_acct_ind>

Allowable Values

Values	Description
1	test
0	live

<acct_currency>

3-character ISO-compliant currency code in lowercase for monetary values used for this account (a list of codes can be accessed here).

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

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

<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

<create_session>

Allowable Values

Values	Description
true	Create an Aria session for the new account.
false	Do not create an Aria session for the new account.
null	If NULL, do not create an Aria session for the new account.

<pay_method_type>

Allowable Values

Values	Description
1	Credit Card
2	Electronic Check (ACH)
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

<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

<payment_option>

Allowable Values

Values	Description
Methods	Methods
Terms	Terms

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

<contract_type_no>

Allowable Values

Values	Description
2	Continue existing service without contract
3	Renew existing contract automatically
6	Terminate service and billing
7	Terminate service and billing and prorate final invoice

<cascade_action>

Allowable Values

Values	Description
true	true
false	false

<fulfillment_directive>

Allowable Values

Values	Description
1	If the account does not have a retroactive start date, then complete fulfillment with immediate affect (Default option). If no fulfillment date is provided, use the current date as the fulfillment date. If the account has a retroactive start date, then the fulfillment date can be any date between the account's retroactive start date and the current date (inclusive). If no fulfillment date is provided, use the account's retroactive start date as the fulfillment date.
2	Complete fulfillment with effective date specified in future. A user must specify service_fulfillment_date with this directive.
3	Remove the already assigned fulfillment date.

<plan_unit_inst_directive>

Allowable Values

Values	Description
1	Add Value
2	Replace Value
3	Remove Value

<plan_instance_status>

Allowable Values

Values	Description
1	ACTIVE
2	PENDING CANCELLATION
3	PENDING TERMINATION
31	PENDING INSTALLATION
32	PENDING ACTIVATION
41	TRIAL
61	ACTIVE NON-BILLABLE
-1	SUSPENDED
-2	CANCELLED
-3	TERMINATED

<resp_level_cd>

Allowable Values

Values	Description
1	Standard Self Pay
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'

<status_until_alt_start>

Allowable Values

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

<nso_bill_immediately>

Allowable Values

Values	Description
0	Fulfill immediately. Bill on next anniversary. (default)
1	Fulfill immediately. Bill immediately.
2	Order Held.
3	Fulfill on fulfillment date. Bill on the next anniversary bill after the fulfillment date. Note that if the fulfilled date is in the past/current day, then the fulfillment will happen in API itself as in nso_bill_immediately = 0.
4	Fulfill on fulfillment date. Bill on the fulfillment date. Note that if the fulfilled date is in the past/current day, then the fulfillment and billing will happen in API itself as in nso_bill_immediately = 1.
5	Fulfill on fulfillment date. Bill on the next anniversary bill that bills arrears services through the fulfillment date. Note that if the fulfilled date is in the past/current day, then the fulfillment will happen in API itself as in nso_bill_immediately = 0.

<usage_accumulation_reset_months_renewal_option>

Allowable Values

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

<acct> (array)

<master_plans_detail> (array)

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

<acct> (array)

<master_plans_detail> (array)

<usage_threshold_applicability>

Allowable Values

Values	Description
UT	Usage Type
UP	Usage Pool

<fulfillment_directive>

Allowable Values

Values	Description
1	If the account does not have a retroactive start date, then complete fulfillment with immediate affect (Default option). If no fulfillment date is provided, use the current date as the fulfillment date. If the account has a retroactive start date, then the fulfillment date can be any date between the account's retroactive start date and the current date (inclusive). If no fulfillment date is provided, use the account's retroactive start date as the fulfillment date.
2	Complete fulfillment with effective date specified in future. A user must specify service_fulfillment_date with this directive.
3	Remove the already assigned fulfillment date.

<plan_unit_inst_directive>

Allowable Values

Values	Description
1	Add Value
2	Replace Value
3	Remove Value

<acct> (array)

<master_plans_detail> (array)

<supp_plan> (array)

<usage_pooling>

Allowable Values

Values	Description
true	Usage pooling is active for this account.
false	Usage pooling is not active for this accout. (default)

<consumer_acct_ind>

Allowable Values

Values	Description
false	false
true	true

<combine_invoices>

Allowable Values

Values	Description
1	Combine Invoices (long cycle)
2	Do Not Combine Invoices (short cycle)
3	Use client default configuration setting

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

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

<auto_assign_mandatory_supp_plans>

Allowable Values

Values	Description
true	Automatically assign mandatory Supplemental Plans.
false	Do not automatically assign mandatory Supplemental Plans. (default)

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

Output Fields

Field Name

Notes

<queue_type_ind>

Allowable Values

Values	Description
1	Plan rollover
2	Future Plan replacement
3	Future Plan assignment
4	Future Plan cancellation
5	Future Plan update