Home > Aria6 User Documentation > Aria6 core api > create_acct_hierarchy

create_acct_hierarchy

Table of contents
  1. Input Arguments
    1. Allowable values for do_write:
    2. Allowable values for a1_status_cd:
    3. Allowable values for a1_notify_method:
    4. Allowable values for a1_pay_method:
    5. Allowable values for a1_resp_level_cd:
    6. Allowable values for a1_test_acct_ind:
    7. Allowable values for a1_status_until_alt_start:
    8. Allowable values for a1_do_full_invoicing:
    9. Allowable values for a1_do_prorated_invoicing:
    10. Allowable values for a1_bank_acct_type:
    11. Allowable values for usage_accumulation_reset_months_ renewal_option:
    12. Allowable values for a1_usage_threshold_applicability:
    13. Allowable values for a1_tax_exemption_level:
    14. Allowable values for a1_invoice_approval_required:
    15. Allowable values for a1_create_session:
    16. Allowable values for a1_bkup_pay_method:
    17. Allowable values for a1_bkup_bank_acct_type:
    18. Allowable values for a1_invoice_posting_method_cd:
    19. Allowable values for a1_defer_full_statements_only:
    20. Allowable values for a1_cc_id:
    21. Allowable values for a1_bkup_cc_id:
    22. Allowable values for a2_status_cd:
    23. Allowable values for a2_notify_method:
    24. Allowable values for a2_pay_method:
    25. Allowable values for a2_resp_level_cd:
    26. Allowable values for a2_test_acct_ind:
    27. Allowable values for a2_status_until_alt_start:
    28. Allowable values for a2_do_full_invoicing:
    29. Allowable values for a2_do_prorated_invoicing:
    30. Allowable values for a2_bank_acct_type:
    31. Allowable values for a2_usage_threshold_applicability:
    32. Allowable values for a2_tax_exemption_level:
    33. Allowable values for a2_invoice_approval_required:
    34. Allowable values for a2_create_session:
    35. Allowable values for a2_bkup_pay_method:
    36. Allowable values for a2_bkup_bank_acct_type:
    37. Allowable values for a2_invoice_posting_method_cd:
    38. Allowable values for a2_defer_full_statements_only:
    39. Allowable values for a2_cc_id:
    40. Allowable values for a2_bkup_cc_id:
    41. Allowable values for a3_status_cd:
    42. Allowable values for a3_notify_method:
    43. Allowable values for a3_pay_method:
    44. Allowable values for a3_resp_level_cd:
    45. Allowable values for a3_test_acct_ind:
    46. Allowable values for a3_status_until_alt_start:
    47. Allowable values for a3_do_full_invoicing:
    48. Allowable values for a3_do_prorated_invoicing:
    49. Allowable values for a3_bank_acct_type:
    50. Allowable values for a3_usage_threshold_applicability:
    51. Allowable values for a3_tax_exemption_level:
    52. Allowable values for a3_invoice_approval_required:
    53. Allowable values for a3_create_session:
    54. Allowable values for a3_bkup_pay_method:
    55. Allowable values for a3_bkup_bank_acct_type:
    56. Allowable values for a3_invoice_posting_method_cd:
    57. Allowable values for a3_defer_full_statements_only:
    58. Allowable values for a3_cc_id:
    59. Allowable values for a3_bkup_cc_id:
    60. Allowable values for a4_status_cd:
    61. Allowable values for a4_notify_method:
    62. a4_bill_cell_phone
    63. Allowable values for a4_pay_method:
    64. Allowable values for a4_resp_level_cd:
    65. Allowable values for a4_test_acct_ind:
    66. Allowable values for a4_status_until_alt_start:
    67. Allowable values for a4_do_full_invoicing:
    68. Allowable values for a4_do_prorated_invoicing:
    69. Allowable values for a4_bank_acct_type:
    70. Allowable values for a4_usage_threshold_applicability:
    71. Allowable values for a4_tax_exemption_level:
    72. Allowable values for a4_invoice_approval_required:
    73. Allowable values for a4_create_session:
    74. Allowable values for a4_bkup_pay_method:
    75. Allowable values for a4_bkup_bank_acct_type:
    76. Allowable values for a4_invoice_posting_method_cd:
    77. Allowable values for a4_defer_full_statements_only:
    78. Allowable values for a4_cc_id:
    79. 4
    80. Allowable values for a4_bkup_cc_id:
    81. Allowable values for a5_status_cd:
    82. Allowable values for a5_notify_method:
    83. Allowable values for a5_pay_method:
    84. Allowable values for a5_resp_level_cd:
    85. Allowable values for a5_test_acct_ind:
    86. Allowable values for a5_status_until_alt_start:
    87. Allowable values for a5_do_full_invoicing:
    88. Allowable values for a5_do_prorated_invoicing:
    89. Allowable values for a5_bank_acct_type:
    90. Allowable values for a5_usage_threshold_applicability:
    91. Allowable values for a5_tax_exemption_level:
    92. Allowable values for a5_invoice_approval_required:
    93. Allowable values for a5_create_session:
    94. Allowable values for a5_bkup_pay_method:
    95. Allowable values for a5_bkup_bank_acct_type:
    96. Allowable values for a5_invoice_posting_method_cd:
    97. Allowable values for a5_defer_full_statements_only:
    98. Allowable values for a5_cc_id:
    99. Allowable values for a5_bkup_cc_id:
    100. Allowable values for usage_threshold_applicability_cd:
    101. Allowable values for fraud_filter:
    102. Allowable values for fraud_filtering_enabled:
    103. Allowable values for change_status_on_fraud_filtering_failure:
    104. Allowable values for change_status_on_fraud_filtering_review:
    105. Allowable values for change_status_on_fraud_filtering_cc_prefix_failure:
    106. Allowable values for change_status_on_fraud_filtering_cc_number_failure:
    107. Allowable values for change_status_on_fraud_filtering_cc_issuing_country_failure:
    108. Allowable values for change_status_on_fraud_filtering_cc_issuing_country_suspect:
    109. Allowable values for recurring_processing_model_ind:
    110. Allowable values for transaction_type:
  2. Output Arguments

Creates a hierarchy of accounts with a single call

Note: 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 Arguments

Req Field Name Field Type Max Length Description
Asterisk_0807a.jpg client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
Asterisk_0807a.jpg auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
  do_write string 1000 Boolean indicator informing Aria whether or not to actually perform the requested operation. If 'false' is passed in this field Aria will, if applicable, calculate any potential effects stemming from this call such as pro-ration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it. Do_write defaults to 'true'  

Allowable values for do_write:

Values Description
true true
false false
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  a1_alt_start_date string 14 This is an alternative start date for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated).
  a1_client_acct_id string 50 This is the client-assigned identifier for the account.
  a1_userid string 32 The users unique identifier.
  a1_status_cd long 8 This is the status of the object in question for the current API call.  

Allowable values for a1_status_cd:

Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
  a1_master_plan_no long 22 The Master Subscription plan number.
  OR      
  a1_client_master_plan_id string 100 Client-defined Master plan Subscription plan ID.
  a1_master_plan_units long 8 This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.
  Subarray_0807a.jpga1_supp_plans long array 38 An array of supplemental plan numbers to assign to this account
  OR      
  Subarray_0807a.jpga1_client_supp_plan_ids string array 100 The array of client-defined supplemental plan IDs.
  Subarray_0807a.jpga1_supp_plan_units long array 38 The units of each plan in the above supp_plans array to assign to this account
  a1_notify_method long 38 If notification method is not provided, value will default to 1 (HTML emal).  

Allowable values for a1_notify_method:

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
  a1_promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  a1_password string 100 Password for the given user
  a1_secret_question string 300 The users secret question recorded to recover a password.
  a1_secret_question_answer string 300 The response to a users 'secret_question
  a1_first_name string 32 Contact first name
  a1_mi string 1 The Middle Initial of the contact.
  a1_last_name string 32 Contact last name
  a1_company_name string 100 Company name of the contact
  a1_address1 string 100 First address line of the contact
  a1_address2 string 100 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a1_city string 32 City of the contact
  a1_locality string 32 Locality of the contact. Use this field instead of the <a1_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a1_state_prov string 2

State or province of the contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a1_locality> field for addresses in those countries.
  a1_country string 2 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a1_postal_cd string 14 Postal/Zip code for the contact address.
  a1_phone string 25 The phone number of the contact
  a1_phone_ext string 10 The extension for the contact phone
  a1_cell_phone string 20 The contact cell phone.
  a1_work_phone string 25 Work phone number of the contact.
  a1_work_phone_ext string 10 The extension for the contact work phone
  a1_email string 320 Email of the contact
  a1_birthdate string 14 Contact date of birth
  a1_bill_first_name string 32 First name of the billing contact
  a1_bill_mi string 1 Middle Initial of the billing contact
  a1_bill_last_name string 32 Last name of the billing contact
  a1_bill_company_name string 100 Company name of the billing contact
  a1_bill_address1 string 100 First address line of the billing contact
  a1_bill_address2 string 100 Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a1_bill_city string 32 City of the billing contact
  a1_bill_locality string 32 Locality of the billing contact. Use this field instead of the <a1_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a1_bill_state_prov string 2 State or province of the billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a1_bill_locality> field for addresses in those countries.
  a1_bill_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a1_bill_postal_cd string 14 This is the postal code for the billing contact address.
  a1_bill_phone string 25 Phone of the billing contact
  a1_bill_phone_ext string 10 This is the billing contacts extension for the bill_phone given.
  a1_bill_cell_phone string 25 Cell phone of the billing contact
  a1_bill_work_phone string 25 Work phone of the billing contact
  a1_bill_work_phone_ext string 100 This is the work phone extension for the billing contact work phone.
  a1_bill_email string 320 Email of the billing contact
  a1_pay_method long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a1_pay_method:

Values Description
-1 External Payment
0 Other
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
8 Click&Buy
9 Net Terms 0
10 PayByCash
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35
16 Net Terms 75
17 Net Terms 90
18 Net Terms 120
19 Net Terms 25
26 Direct Debit
29 Reserve Account
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
48 Tokenized ACH
  a1_cc_number string 24 Credit card number.
  a1_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a1_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a1_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. This field along with <a1_bank_routing_no> and <a1_bill_agreement_id> along with the <bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a1_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. This field along with <a1_bank_acct_no> and <a1_bill_agreement_id> along with the <bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a1_resp_level_cd long 8 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  

Allowable values for a1_resp_level_cd:

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
4 Parent Usage & Pay w/note: Same as "Parent Usage & Pay", except that usage will also be accrued under self for notational purposes only
  Subarray_0807a.jpga1_functional_acct_groups long array 38 Array of functional account groups.
  OR      
  Subarray_0807a.jpga1_client_func_acct_group_ids string array 38 The functional account group ID to which this account should be assigned
  Subarray_0807a.jpga1_collections_acct_groups long array 38 The group ID for the collections account groups in which to place this account
  OR      
  Subarray_0807a.jpga1_client_coll_acct_group_ids string array 100 The collections account group ID to which this account should be assigned
  Subarray_0807a.jpga1_supp_field_names string array 100 The names of the supplemental fields for which values are to be stored for this account
  Subarray_0807a.jpga1_supp_field_values string array 300 The values for the supplemental field names given in supp_field_names
  a1_test_acct_ind long 1 This argument indicates the account is a test account and is treated as such in the system. 

Allowable values for a1_test_acct_ind:

Values Description
1 test
0 live
  a1_status_until_alt_start long 8 The status for the account prior to alt_start_date. This is only used if the alternate start date is used.  

Allowable values for a1_status_until_alt_start:

Values Description
0 Inactive
  a1_balance_forward double 12 A fixed amount, positive or negative, that the newly created account should owe (or be owed) immediately upon creation. Generally used when converting accounts from other systems into Aria.
  a1_alt_bill_day long 2 The day of the month that will act in perpetuity as the account's billing anniversary day.
  a1_do_full_invoicing string 5 Boolean indicator to override client's default configured behavior for performing full invoicing on this account as part of this call.  

Allowable values for a1_do_full_invoicing:

Values Description
true Immediately invoice and collect from the new account.
false Do not immediately invoice the new account.
null If NULL, defaults to the client configuration setting
  a1_do_prorated_invoicing string 5 Prorate the invoice to the end of the billing cycle  

Allowable values for a1_do_prorated_invoicing:

Values Description
true Immediately prorate and collect from the new account.
false Do not immediately prorate the new account.
null If NULL, defaults to the client configuration setting
  a1_master_plan_alt_rate_sched_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  a1_client_mp_alt_rate_sched_id string 100 The client alternate rate schedule ID for the master subscription plan being considered.
  Subarray_0807a.jpga1_supp_plan_alt_rate_sched_no long array   The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
  a1_currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  a1_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  a1_taxpayer_id string 32 Taxpayer Identification number.
  a1_bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token). This field along with <a1_bank_acct_no> and <a1_bank_routing_no> along with the <bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a1_retroactive_start_date string 14 Date to set for retroactive start.
  Subarray_0807a.jpga1_coupon_codes string array 30 The coupon codes to assign to this account, if any
  a1_new_acct_custom_rates array    
  Subarray_0807a.jpga1_custom_rate_plan_no long 22 The unique identifier for the plan to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga1_client_custom_rate_plan_id string 100 The client-defined unique identifier for the plan to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga1_custom_rate_service_no long 22 The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga1_client_custom_rate_service_id string 100 The client-defined unique identifier for the service no to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga1_custom_rate_seq_no long 22 The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga1_custom_rate_from_unit long 12 The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga1_custom_rate_to_unit long 12 The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga1_custom_rate_per_unit double 12 The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.
  a1_alt_msg_template_no long 22 Email template number assigned to this account.
  OR      
  a1_client_alt_msg_template_id string 100 Client specifies alternate Email template ID assigned to this account.
  a1_seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  a1_seq_func_group_id string 32 Unique Functional account group ID specifically designated for statement sequence number assignment.
  a1_new_acct_plan_contracts array    
  Subarray_0807a.jpga1_contract_plan_no long   The unique identifier of this contract
  OR      
  Subarray_0807a.jpga1_client_contract_plan_id string 100 The client-defined unique ID for the plan to which this contract applies
  Subarray_0807a.jpga1_contract_type_no long   The type ID of this contract
  Subarray_0807a.jpga1_contract_alt_recur_fee double 12 This amount will be billed each month instead of the current recurring service rate. If there are multiple recurring services related to this plan, the rate associated with the current recurring service that has the lowest service_no will be replaced. This alternate recurring fee will go into effect starting on the new contract's effective date.
  Subarray_0807a.jpga1_contract_length_months long 4 The number of months this contract should remain on the account
  Subarray_0807a.jpga1_contract_cancel_fee double 38 The fee charged to the account for prematurely ending this contract
  Subarray_0807a.jpga1_contract_comments string 300 Any client-defined comments stored on this contract at the account level
  Subarray_0807a.jpga1_contract_start_date string   The date on which this contract takes effect
  Subarray_0807a.jpga1_contract_end_date string   Allows the caller to set a specific end date when creating or modifying plan contracts.
  a1_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a1_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a1_address3 string 300 The third line of the address
  a1_bill_address3 string 300 The third line of the billing address
  a1_usage_accumulation_config array   The array of plans for which to enable usage accumulation
  Subarray_0807a.jpga1_usage_accumulation_plan_no long   The plan ID for which to enable usage accumulation
  OR      
  Subarray_0807a.jpga1_client_usg_accum_plan_id string 100 The client-defined plan ID for which to enable usage accumulation
  Subarray_0807a.jpga1_usage_accumulation_reset_months long 2 The number of reset months for each plan.
 

 brd_arrow.gifa1_usage_accumulation_reset_months_

renewal_option

 long 2 Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period.  

Allowable values for usage_accumulation_reset_months_ renewal_option:

Values Description
1 Recurring / Auto Renew.
NULL or 2 Single Use. (Default)
  a1_enable_usage_pooling_plan_no array   This array is DEPRECATED in favor of the create_usage_pooling_data array.
  Subarray_0807a.jpga1_enable_usage_pooling_plan_no long   DEPRECATED. You should use the create_usage_pooling_data array. The plan ID for which to enable usage pooling
  OR      
  Subarray_0807a.jpga1_client_enable_usg_pool_plan_id string 100 DEPRECATED. You should use the create_usage_pooling_data array. The client-defined plan ID for which to enable usage pooling
  Subarray_0807a.jpga1_usage_threshold_applicability string 100 DEPRECATED. You should use the create_usage_pooling_data array. Usage tracking options on the plans in the account  

Allowable values for a1_usage_threshold_applicability:

Values Description
UT Usage Type
UP Usage Pool
  a1_track_data1 string 1000 The raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  a1_track_data2 string 1000 The raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  a1_tax_exemption_level long 1 To provide Tax Exemption Level for the account  

Allowable values for a1_tax_exemption_level:

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.
  a1_cn_alt_msg_template_no long   The alternate email template number to use for this account
  OR      
  a1_client_cn_alt_msg_template_no string 100 The client alternate email template number to use for this account.
  a1_invoice_approval_required string 5 Boolean indicator to override client's default configured behavior for creating Pending/Real invoice.  

Allowable values for a1_invoice_approval_required:

Values Description
true Attempts to create a pending invoice. Note: if client is configured for real invoices, passing "True" here will override the client setting.
false Attempts to create a real invoice. Note: if client is configured for pending invoices, passing "False" here will override the client setting.
null If NULL, defaults to the client configuration setting
  a1_create_session string 5 Creates an Aria session for the newly created account. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications.  

Allowable values for a1_create_session:

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.
  Subarray_0807a.jpga1_client_sp_alt_rate_sched_ids string array 100 The array of client-defined alternate rate schedule ID for the supplementary subscription plan being considered.
  a1_iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  a1_bank_check_digit long 2 Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
  a1_bank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  a1_bank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  a1_mandate_id string 50

Used for the Direct Debit payment method, including UK-based payments for the Basic Bank Account Number (BBAN) payment method for payments and refunds (max 35-character alphanumeric value).

A mandate is signed by the debtor to authorise the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  a1_bank_id_cd string 15 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  a1_bank_branch_cd string 15 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank branch code.
  a1_bank_name string 100 Bank name for the account payment method
  a1_bank_city string 100 Bank city for the account payment method
  a1_surcharge_no array    
  Subarray_0807a.jpga1_surcharge_no long   The Surcharge number to be attached to the account
  Subarray_0807a.jpga1_rate_schedule_no long   The Schedule number for this surcharge
  a1_bkup_bill_first_name string 32 First name of the secondary billing contact
  a1_bkup_bill_mi string 1 Middle Initial of the secondary billing contact
  a1_bkup_bill_last_name string 32 Last name of the secondary billing contact
  a1_bkup_bill_company_name string 100 Company name of the secondary billing contact
  a1_bkup_bill_address1 string 100 First address line of the secondary billing contact
  a1_bkup_bill_address2 string 100 Second address line of the secondary billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a1_bkup_bill_address3 string 100 second address line of the secondary billing contact
  a1_bkup_bill_city string 32 City of the secondary billing contact
  a1_bkup_bill_locality string 32 Locality of the secondary billing contact. Use this field instead of the <a1_bkup_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a1_bkup_bill_state_prov string 2 State or province of the secondary billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a1_bkup_bill_locality> field for addresses in those countries.
  a1_bkup_bill_country string 2 Country of the secondary billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a1_bkup_bill_postal_cd string 14 This is the postal code for the secondary billing contact address.
  a1_bkup_bill_phone string 25 Phone of the secondary billing contact
  a1_bkup_bill_phone_ext string 10 This is the secondary billing contacts extension for the bill_phone given.
  a1_bkup_bill_cell_phone string 25 Cell phone of the secondary billing contact
  a1_bkup_bill_work_phone string 25 Work phone of the secondary billing contact
  a1_bkup_bill_work_phone_ext string 100 This is the work phone extension for the secondary billing contact work phone.
  a1_bkup_bill_email string 320 Email of the secondary billing contact
  a1_bkup_pay_method long 8 This is the method_id corresponding to a secondary payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a1_bkup_pay_method:

Values Description
1 Credit card
2 Electronic Check (ACH)
13 Tokenized Credit Card
48 Tokenized ACH
  a1_bkup_cc_number string 24 Credit card number.
  a1_bkup_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a1_bkup_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a1_bkup_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. Along with the <a1_bkup_bank_routing_no>  <a1_bkup_bill_agreeent_id> and <a1_bkup_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a1_bkup_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. Along with the <a1_bkup_bank_acct_no>  <a1_bkup_bill_agreeent_id> and <a1_bkup_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a1_bkup_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a1_bkup_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a1_bkup_bill_agreement_id string 32 Unique ID of the secondary bill agreement (also referred to as a token). Along with the <a1_bkup_bank_acct_no>  <a1_bkup_bank_routing_no> and <a1_bkup_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a1_bkup_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the secondary card holder since this value is physically printed on the credit card.
  a1_revrec_profile_id long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  a1_revrec_client_defined_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_id.
  a1_stmnt_email_list string 3000 Deprecated(Deprecated) An array containing the list of additional email addresses
  a1_stmnt_email_list_cc string 3000 An array containing the list of additional cc email addresses
  a1_stmnt_email_list_bcc string 3000 An array containing the list of additional bcc email addresses
  a1_invoice_posting_method_cd long   This configuration specifies whether invoices for this Account need to be manually posted. This setting supersedes the standard client setting for this specific Account.  

Allowable values for a1_invoice_posting_method_cd:

Values Description
0 Follow the standard client defined setting.
1 Auto post all invoices.
2 All invoices require manual posting.
3 Only invoices paid via non-electronic payment methods require manual posting.
null If none is passed, then by default the account will be set to follow the standard client defined setting.
  a1_acct_start_date string 14 This is the date this account was originally started.
  a1_min_statement_threshold long   Use this field to specify the balance threshold amount under which a statement should not be sent to the customer. This applies to all customers regardless of payment method.
  a1_max_statements_to_defer long   Use this field to specify the number of statements to skip sending to the customer. Applies only if min_statement_threshold is specified. If left blank, statements shall be suppressed indefinitely as long as the balance is below the threshold.
  a1_defer_full_statements_only long   Use this field to only suppress anniversary statements if the balance is below the min_statement_threshold. If left blank, all generated statements, including mid-cycle statements, shall not be sent to the customer if the balance is below the min_statement_threshold. Applies only if a min_statement_threshold is specified.  

Allowable values for a1_defer_full_statements_only:

Values Description
0 Open for all invoice.
1 Apply only for anniversary invoice.
  a1_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a1_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a1_bkup_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a1_bkup_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a2_alt_start_date string 14 This is an alternative start date for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated).
  a2_client_acct_id string 50 This is the client-assigned identifier for the account.
  a2_userid string 32 The users unique identifier.
  a2_status_cd long 8 This is the status of the object in question for the current API call.  

Allowable values for a2_status_cd:

Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
  a2_master_plan_no long 22 The Master Subscription plan number.
  OR      
  a2_client_master_plan_id string 100 Client-defined Master plan Subscription plan ID.
  a2_master_plan_units long 8 This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.
  Subarray_0807a.jpga2_supp_plans long array 38 An array of supplemental plan numbers to assign to this account
  OR      
  Subarray_0807a.jpga2_client_supp_plan_ids string array 100 The array of client-defined supplemental plan IDs.
  Subarray_0807a.jpga2_supp_plan_units long array 38 The units of each plan in the above supp_plans array to assign to this account
  a2_notify_method long 38 If notification method is not provided, value will default to 1 (HTML email).  

Allowable values for a2_notify_method:

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
  a2_promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  a2_password string 100 Password for the given user
  a2_secret_question string 300 The users secret question recorded to recover a password.
  a2_secret_question_answer string 300 The response to a users 'secret_question
  a2_first_name string 32 Contact first name
  a2_mi string 1 The Middle Initial of the contact.
  a2_last_name string 32 Contact last name
  a2_company_name string 100 Company name of the contact
  a2_address1 string 100 First address line of the contact
  a2_address2 string 100 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a2_city string 32 City of the contact
  a2_locality string 32 Locality of the contact. Use this field instead of the <a2_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a2_state_prov string 2 State or province of the contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a2_locality> field for addresses in those countries.
  a2_country string 2 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a2_postal_cd string 14 Postal/Zip code for the contact address.
  a2_phone string 25 The phone number of the contact
  a2_phone_ext string 10 The extension for the contact phone
  a2_cell_phone string 20 The contact cell phone.
  a2_work_phone string 25 Work phone number of the contact.
  a2_work_phone_ext string 10 The extension for the contact work phone
  a2_email string 320 Email of the contact
  a2_birthdate string 14 Contact date of birth
  a2_bill_first_name string 32 First name of the billing contact
  a2_bill_mi string 1 Middle Initial of the billing contact
  a2_bill_last_name string 32 Last name of the billing contact
  a2_bill_company_name string 100 Company name of the billing contact
  a2_bill_address1 string 100 First address line of the billing contact
  a2_bill_address2 string 100 Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a2_bill_city string 32 City of the billing contact
  a2_bill_locality string 32 Locality of the billing contact. Use this field instead of the <a2_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a2_bill_state_prov string 2 State or province of the billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a2_bill_locality> field for addresses in those countries.
  a2_bill_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a2_bill_postal_cd string 14 This is the postal code for the billing contact address.
  a2_bill_phone string 25 Phone of the billing contact
  a2_bill_phone_ext string 10 This is the billing contacts extension for the bill_phone given.
  a2_bill_cell_phone string 25 Cell phone of the billing contact
  a2_bill_work_phone string 25 Work phone of the billing contact
  a2_bill_work_phone_ext string 100 This is the work phone extension for the billing contact work phone.
  a2_bill_email string 320 Email of the billing contact
  a2_pay_method long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a2_pay_method:

Values Description
-1 External Payment
0 Other
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
8 Click&Buy
9 Net Terms 0
10 PayByCash
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35
16 Net Terms 75
17 Net Terms 90
18 Net Terms 120
19 Net Terms 25
26 Direct Debit
29 Reserve Account
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
48 Tokenized ACH
  a2_cc_number string 24 Credit card number.
  a2_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a2_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a2_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. Along with the <a2_bank_routing_no>  <a2_bill_agreeent_id> and <a2_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a2_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. Along with the <a2_bank_acct_no>  <a2_bill_agreeent_id> and <a2_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a2_resp_level_cd long 8 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  

Allowable values for a2_resp_level_cd:

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
4 Parent Usage & Pay w/note: Same as "Parent Usage & Pay", except that usage will also be accrued under self for notational purposes only
  Subarray_0807a.jpga2_functional_acct_groups long array 38 Array of functional account groups.
  OR      
  Subarray_0807a.jpga2_client_func_acct_group_ids string array 38 The functional account group ID to which this account should be assigned
  Subarray_0807a.jpga2_collections_acct_groups long array 38 The group ID for the collections account groups in which to place this account
  OR      
  Subarray_0807a.jpga2_client_coll_acct_group_ids string array 100 The collections account group ID to which this account should be assigned
  Subarray_0807a.jpga2_supp_field_names string array 100 The names of the supplemental fields for which values are to be stored for this account
  Subarray_0807a.jpga2_supp_field_values string array 300 The values for the supplemental field names given in supp_field_names
  a2_test_acct_ind long 1 This argument indicates the account is a test account and is treated as such in the system. 

Allowable values for a2_test_acct_ind:

Values Description
1 test
0 live
  a2_status_until_alt_start long 8 The status for the account prior to alt_start_date. This is only used if the alternate start date is used.  

Allowable values for a2_status_until_alt_start:

Values Description
0 Inactive
  a2_balance_forward double 12 A fixed amount, positive or negative, that the newly created account should owe (or be owed) immediately upon creation. Generally used when converting accounts from other systems into Aria.
  a2_alt_bill_day long 2 The day of the month that will act in perpetuity as the account's billing anniversary day.
  a2_do_full_invoicing string 5 Boolean indicator to override client's default configured behavior for performing full invoicing on this account as part of this call.  

Allowable values for a2_do_full_invoicing:

Values Description
true Immediately invoice and collect from the new account.
false Do not immediately invoice the new account.
null If NULL, defaults to the client configuration setting
  a2_do_prorated_invoicing string 5 Prorate the invoice to the end of the billing cycle  

Allowable values for a2_do_prorated_invoicing:

Values Description
true Immediately prorate and collect from the new account.
false Do not immediately prorate the new account.
null If NULL, defaults to the client configuration setting
  a2_master_plan_alt_rate_sched_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  a2_client_mp_alt_rate_sched_id string 100 The client alternate rate schedule ID for the master subscription plan being considered.
  Subarray_0807a.jpga2_supp_plan_alt_rate_sched_no long array   The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
  a2_currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  a2_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  a2_taxpayer_id string 32 Taxpayer Identification number.
  a2_bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token). Along with the <a2_bank_acct_no>, <a2_bank_routing_no> and <a2_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a2_retroactive_start_date string 14 Date to set for retroactive start.
  Subarray_0807a.jpga2_coupon_codes string array 30 The coupon codes to assign to this account, if any
  a2_new_acct_custom_rates array    
  Subarray_0807a.jpga2_custom_rate_plan_no long 22 The unique identifier for the plan to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga2_client_custom_rate_plan_id string 100 The client-defined unique identifier for the plan to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga2_custom_rate_service_no long 22 The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga2_client_custom_rate_service_id string 100 The client-defined unique identifier for the service no to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga2_custom_rate_seq_no long 22 The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga2_custom_rate_from_unit long 12 The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga2_custom_rate_to_unit long 12 The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga2_custom_rate_per_unit double 12 The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.
  a2_alt_msg_template_no long 22 Email template number assigned to this account.
  OR      
  a2_client_alt_msg_template_id string 100 Client specifies alternate Email template ID assigned to this account.
  a2_seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  a2_seq_func_group_id string 32 Unique Functional account group ID specifically designated for statement sequence number assignment.
  a2_new_acct_plan_contracts array    
  Subarray_0807a.jpga2_contract_plan_no long   The unique identifier of this contract
  OR      
  Subarray_0807a.jpga2_client_contract_plan_id string 100 The client-defined unique ID for the plan to which this contract applies
  Subarray_0807a.jpga2_contract_type_no long   The type ID of this contract
  Subarray_0807a.jpga2_contract_alt_recur_fee double 12 This amount will be billed each month instead of the current recurring service rate. If there are multiple recurring services related to this plan, the rate associated with the current recurring service that has the lowest service_no will be replaced. This alternate recurring fee will go into effect starting on the new contract's effective date.
  Subarray_0807a.jpga2_contract_length_months long 4 The number of months this contract should remain on the account
  Subarray_0807a.jpga2_contract_cancel_fee double 38 The fee charged to the account for prematurely ending this contract
  Subarray_0807a.jpga2_contract_comments string 300 Any client-defined comments stored on this contract at the account level
  Subarray_0807a.jpga2_contract_start_date string   The date on which this contract takes effect
  Subarray_0807a.jpga2_contract_end_date string   Allows the caller to set a specific end date when creating or modifying plan contracts.
  a2_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a2_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a2_address3 string 300 The third line of the address
  a2_bill_address3 string 300 The third line of the billing address
  a2_usage_accumulation_config array   The array of plans for which to enable usage accumulation
  Subarray_0807a.jpga2_usage_accumulation_plan_no long   The plan ID for which to enable usage accumulation
  OR      
  Subarray_0807a.jpga2_client_usg_accum_plan_id string 100 The client-defined plan ID for which to enable usage accumulation
  brd_arrow.gifa2_usage_accumulation_reset_months long 2 The number of reset months for each plan
 

brd_arrow.gifa2_usage_accumulation_reset_months

_renewal_option
long 2 Determines whether the usage accumulation reset months value will automatically reset to same value at the end of the current period or will expire at the end of the current period.
  a2_enable_usage_pooling_plan_no array   This array is DEPRECATED in favor of the create_usage_pooling_data array.
  Subarray_0807a.jpga2_enable_usage_pooling_plan_no long   DEPRECATED. You should use the create_usage_pooling_data array. The plan ID for which to enable usage pooling
  OR      
  Subarray_0807a.jpga2_client_enable_usg_pool_plan_id string 100 DEPRECATED. You should use the create_usage_pooling_data array. The client-defined plan ID for which to enable usage pooling
  Subarray_0807a.jpga2_usage_threshold_applicability string 100 DEPRECATED. You should use the create_usage_pooling_data array. Usage tracking options on the plans in the account  

Allowable values for a2_usage_threshold_applicability:

Values Description
UT Usage Type
UP Usage Pool
  a2_track_data1 string 1000 The raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  a2_track_data2 string 1000 The raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  a2_tax_exemption_level long 1 To provide Tax Exemption Level for the account  

Allowable values for a2_tax_exemption_level:

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.
  a2_cn_alt_msg_template_no long   The alternate email template number to use for this account
  OR      
  a2_client_cn_alt_msg_template_no string 100 The client alternate email template number to use for this account
  a2_invoice_approval_required string 5 Boolean indicator to override client's default configured behavior for creating Pending/Real invoice.  

Allowable values for a2_invoice_approval_required:

Values Description
true Attempts to create a pending invoice. Note: if client is configured for real invoices, passing "True" here will override the client setting.
false Attempts to create a real invoice. Note: if client is configured for pending invoices, passing "False" here will override the client setting.
null If NULL, defaults to the client configuration setting
  a2_create_session string 5 Creates an Aria session for the newly created account. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications.  

Allowable values for a2_create_session:

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.
  Subarray_0807a.jpga2_client_sp_alt_rate_sched_ids string array 100 The array of client-defined alternate rate schedule ID for the supplementary subscription plan being considered.
  a2_iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  a2_bank_check_digit long 2 Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
  a2_bank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  a2_bank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  a2_mandate_id string 50

Used for the Direct Debit payment method, including UK-based payments for the Basic Bank Account Number (BBAN) payment method for payments and refunds (max 35-character alphanumeric value).

A mandate is signed by the debtor to authorize the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  a2_bank_id_cd string 15 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  a2_bank_branch_cd string 15 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank branch code.
  a2_bank_name string 100 Bank name for the account payment method
  a2_bank_city string 100 Bank city for the account payment method
  a2_surcharge_no array    
  Subarray_0807a.jpga2_surcharge_no long   The Surcharge number to be attached to the account
  Subarray_0807a.jpga2_rate_schedule_no long   The Schedule number for this surcharge
  a2_bkup_bill_first_name string 32 First name of the secondary billing contact
  a2_bkup_bill_mi string 1 Middle Initial of the secondary billing contact
  a2_bkup_bill_last_name string 32 Last name of the secondary billing contact
  a2_bkup_bill_company_name string 100 Company name of the secondary billing contact
  a2_bkup_bill_address1 string 100 First address line of the secondary billing contact
  a2_bkup_bill_address2 string 100 Second address line of the secondary billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a2_bkup_bill_address3 string 100 second address line of the secondary billing contact
  a2_bkup_bill_city string 32 City of the secondary billing contact
  a2_bkup_bill_locality string 32 Locality of the secondary billing contact. Use this field instead of the <a2_bkup_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a2_bkup_bill_state_prov string 2 State or province of the secondary billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a2_bkup_bill_locality> field for addresses in those countries.
  a2_bkup_bill_country string 2 Country of the secondary billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a2_bkup_bill_postal_cd string 14 This is the postal code for the secondary billing contact address.
  a2_bkup_bill_phone string 25 Phone of the secondary billing contact
  a2_bkup_bill_phone_ext string 10 This is the secondary billing contacts extension for the bill_phone given.
  a2_bkup_bill_cell_phone string 25 Cell phone of the secondary billing contact
  a2_bkup_bill_work_phone string 25 Work phone of the secondary billing contact
  a2_bkup_bill_work_phone_ext string 100 This is the work phone extension for the secondary billing contact work phone.
  a2_bkup_bill_email string 320 Email of the secondary billing contact
  a2_bkup_pay_method long 8 This is the method_id corresponding to a secondary payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a2_bkup_pay_method:

Values Description
1 Credit card
2 Electronic Check (ACH)
13 Tokenized Credit Card
48 Tokenized ACH
  a2_bkup_cc_number string 24 Credit card number.
  a2_bkup_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a2_bkup_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a2_bkup_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. Along with the <a2_bkup_bank_routing_no>  <a2_bkup_bill_agreeent_id> and <a2_bkup_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a2_bkup_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. Along with the <a2_bkup_bank_acct_no>  <a2_bkup_bill_agreeent_id> and <a2_bkup_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a2_bkup_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a2_bkup_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a2_bkup_bill_agreement_id string 32 Unique ID of the secondary bill agreement (also referred to as a token). Along with the <a2_bkup_bank_acct_no>  <a2_bkup_bank_routing_no> and <a2_bkup_bank_acct_type>, this field must be populated for payment method 48 (Tokenized ACH).
  a2_bkup_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the secondary card holder since this value is physically printed on the credit card.
  a2_revrec_profile_id long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  a2_revrec_client_defined_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_id.
  a2_stmnt_email_list string 3000 (Deprecated) An array containing the list of additional email addresses
  a2_stmnt_email_list_cc string 3000 An array containing the list of additional cc email addresses
  a2_stmnt_email_list_bcc string 3000 An array containing the list of additional bcc email addresses
  a2_invoice_posting_method_cd long   This configuration specifies whether invoices for this Account need to be manually posted. This setting supersedes the standard client setting for this specific Account.  

Allowable values for a2_invoice_posting_method_cd:

Values Description
0 Follow the standard client defined setting.
1 Auto post all invoices.
2 All invoices require manual posting.
3 Only invoices paid via non-electronic payment methods require manual posting.
null If none is passed, then by default the account will be set to follow the standard client defined setting.
  a2_acct_start_date string 14 This is the date this account was originally started.
  a2_min_statement_threshold long   Use this field to specify the balance threshold amount under which a statement should not be sent to the customer. This applies to all customers regardless of payment method.
  a2_max_statements_to_defer long   Use this field to specify the number of statements to skip sending to the customer. Applies only if min_statement_threshold is specified. If left blank, statements shall be suppressed indefinitely as long as the balance is below the threshold.
  a2_defer_full_statements_only long   Use this field to only suppress anniversary statements if the balance is below the min_statement_threshold. If left blank, all generated statements, including mid-cycle statements, shall not be sent to the customer if the balance is below the min_statement_threshold. Applies only if a min_statement_threshold is specified.  

Allowable values for a2_defer_full_statements_only:

Values Description
0 Open for all invoice.
1 Apply only for anniversary invoice.
  a2_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a2_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a2_bkup_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a2_bkup_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a3_alt_start_date string 14 This is an alternative start date for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated).
  a3_client_acct_id string 50 This is the client-assigned identifier for the account.
  a3_userid string 32 The users unique identifier.
  a3_status_cd long 8 This is the status of the object in question for the current API call.  

Allowable values for a3_status_cd:

Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
  a3_master_plan_no long 22 The Master Subscription plan number.
  OR      
  a3_client_master_plan_id string 100 Client-defined Master plan Subscription plan ID.
  a3_master_plan_units long 8 This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.
  Subarray_0807a.jpga3_supp_plans long array 38 An array of supplemental plan numbers to assign to this account
  OR      
  Subarray_0807a.jpga3_client_supp_plan_ids string array 100 The array of client-defined supplemental plan IDs.
  Subarray_0807a.jpga3_supp_plan_units long array 38 The units of each plan in the above supp_plans array to assign to this account
  a3_notify_method long 38 If notification method is not provided, value will default to 1 (HTML email).  

Allowable values for a3_notify_method:

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
  a3_promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  a3_password string 100 Password for the given user
  a3_secret_question string 300 The users secret question recorded to recover a password.
  a3_secret_question_answer string 300 The response to a users 'secret_question
  a3_first_name string 32 Contact first name
  a3_mi string 1 The Middle Initial of the contact.
  a3_last_name string 32 Contact last name
  a3_company_name string 100 Company name of the contact
  a3_address1 string 100 First address line of the contact
  a3_address2 string 100 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a3_city string 32 City of the contact
  a3_locality string 32 Locality of the contact. Use this field instead of the <a3_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a3_state_prov string 2 State or province of the contact. 

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a3_locality> field for addresses in those countries.
  a3_country string 2 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a3_postal_cd string 14 Postal/Zip code for the contact address.
  a3_phone string 25 The phone number of the contact
  a3_phone_ext string 10 The extension for the contact phone
  a3_cell_phone string 20 The contact cell phone.
  a3_work_phone string 25 Work phone number of the contact.
  a3_work_phone_ext string 10 The extension for the contact work phone
  a3_email string 320 Email of the contact
  a3_birthdate string 14 Contact date of birth
  a3_bill_first_name string 32 First name of the billing contact
  a3_bill_mi string 1 Middle Initial of the billing contact
  a3_bill_last_name string 32 Last name of the billing contact
  a3_bill_company_name string 100 Company name of the billing contact
  a3_bill_address1 string 100 First address line of the billing contact
  a3_bill_address2 string 100 Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a3_bill_city string 32 City of the billing contact
  a3_bill_locality string 32 Locality of the billing contact. Use this field instead of the <a3_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a3_bill_state_prov string 2 State or province of the billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a3_bill_locality> field for addresses in those countries.
  a3_bill_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a3_bill_postal_cd string 14 This is the postal code for the billing contact address.
  a3_bill_phone string 25 Phone of the billing contact
  a3_bill_phone_ext string 10 This is the billing contacts extension for the bill_phone given.
  a3_bill_cell_phone string 25 Cell phone of the billing contact
  a3_bill_work_phone string 25 Work phone of the billing contact
  a3_bill_work_phone_ext string 100 This is the work phone extension for the billing contact work phone.
  a3_bill_email string 320 Email of the billing contact
  a3_pay_method long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a3_pay_method:

Values Description
-1 External Payment
0 Other
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
8 Click&Buy
9 Net Terms 0
10 PayByCash
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35
16 Net Terms 75
17 Net Terms 90
18 Net Terms 120
19 Net Terms 25
26 Direct Debit
29 Reserve Account
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
48 Tokenized ACH
  a3_cc_number string 24 Credit card number.
  a3_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a3_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a3_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. This field along with <a3_bank_routing_no> and <a3_bill_agreement_id> along with the <a3_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a3_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. This field along with <a3_bank_acct_no> and <a3_bill_agreement_id> along with the <a3_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a3_resp_level_cd long 8 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  

Allowable values for a3_resp_level_cd:

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'
4 Parent Usage & Pay w/note: Same as "Parent Usage & Pay", except that usage will also be accrued under self for notational purposes only
  Subarray_0807a.jpga3_functional_acct_groups long array 38 Array of functional account groups.
  OR      
   Subarray_0807a.jpg a3_client_func_acct_group_ids string array 38 The functional account group ID to which this account should be assigned
   Subarray_0807a.jpg a3_collections_acct_groups long array 38 The group ID for the collections account groups in which to place this account
  OR      
   Subarray_0807a.jpg a3_client_coll_acct_group_ids string array 100 The collections account group ID to which this account should be assigned
   Subarray_0807a.jpg a3_supp_field_names string array 100 The names of the supplemental fields for which values are to be stored for this account
   Subarray_0807a.jpg a3_supp_field_values string array 300 The values for the supplemental field names given in supp_field_names
  a3_test_acct_ind long 1 This argument indicates the account is a test account and is treated as such in the system. 

Allowable values for a3_test_acct_ind:

Values Description
1 test
0 live
  a3_status_until_alt_start long 8 The status for the account prior to alt_start_date. This is only used if the alternate start date is used.  

Allowable values for a3_status_until_alt_start:

Values Description
0 Inactive
  a3_balance_forward double 12 A fixed amount, positive or negative, that the newly created account should owe (or be owed) immediately upon creation. Generally used when converting accounts from other systems into Aria.
  a3_alt_bill_day long 2 The day of the month that will act in perpetuity as the account's billing anniversary day.
  a3_do_full_invoicing string 5 Boolean indicator to override client's default configured behavior for performing full invoicing on this account as part of this call.  

Allowable values for a3_do_full_invoicing:

Values Description
true Immediately invoice and collect from the new account.
false Do not immediately invoice the new account.
null If NULL, defaults to the client configuration setting
  a3_do_prorated_invoicing string 5 Prorate the invoice to the end of the billing cycle  

Allowable values for a3_do_prorated_invoicing:

Values Description
true Immediately prorate and collect from the new account.
false Do not immediately prorate the new account.
null If NULL, defaults to the client configuration setting
  a3_master_plan_alt_rate_sched_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  a3_client_mp_alt_rate_sched_id string 100 The client alternate rate schedule ID for the master subscription plan being considered.
  Subarray_0807a.jpga3_supp_plan_alt_rate_sched_no long array   The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
  a3_currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  a3_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  a3_taxpayer_id string 32 Taxpayer Identification number.
  a3_bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token). This field along with <a3_bank_acct_no> and <a3_bank_rouitng_no> along with the <a3_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a3_retroactive_start_date string 14 Date to set for retroactive start.
  Subarray_0807a.jpga3_coupon_codes string array 30 The coupon codes to assign to this account, if any
  a3_new_acct_custom_rates array    
  Subarray_0807a.jpga3_custom_rate_plan_no long 22 The unique identifier for the plan to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga3_client_custom_rate_plan_id string 100 The client-defined unique identifier for the plan to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga3_custom_rate_service_no long 22 The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga3_client_custom_rate_service_id string 100 The client-defined unique identifier for the service no to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga3_custom_rate_seq_no long 22 The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga3_custom_rate_from_unit long 12 The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga3_custom_rate_to_unit long 12 The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga3_custom_rate_per_unit double 12 The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.
  a3_alt_msg_template_no long 22 Email template number assigned to this account.
  OR      
  a3_client_alt_msg_template_id string 100 Client specifies alternate Email template ID assigned to this account.
  a3_seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  a3_seq_func_group_id string 32 Unique Functional account group ID specifically designated for statement sequence number assignment.
  a3_new_acct_plan_contracts array    
  Subarray_0807a.jpga3_contract_plan_no long   The unique identifier of this contract
  OR      
  Subarray_0807a.jpga3_client_contract_plan_id string 100 The client-defined unique ID for the plan to which this contract applies
  Subarray_0807a.jpga3_contract_type_no long   The type ID of this contract
  Subarray_0807a.jpga3_contract_alt_recur_fee double 12 This amount will be billed each month instead of the current recurring service rate. If there are multiple recurring services related to this plan, the rate associated with the current recurring service that has the lowest service_no will be replaced. This alternate recurring fee will go into effect starting on the new contract's effective date.
  Subarray_0807a.jpga3_contract_length_months long 4 The number of months this contract should remain on the account
  Subarray_0807a.jpga3_contract_cancel_fee double 38 The fee charged to the account for prematurely ending this contract
  Subarray_0807a.jpga3_contract_comments string 300 Any client-defined comments stored on this contract at the account level
  Subarray_0807a.jpga3_contract_start_date string   The date on which this contract takes effect
  Subarray_0807a.jpga3_contract_end_date string   Allows the caller to set a specific end date when creating or modifying plan contracts.
  a3_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a3_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a3_address3 string 300 The third line of the address
  a3_bill_address3 string 300 The third line of the billing address
  a3_usage_accumulation_config array   The array of plans for which to enable usage accumulation
  Subarray_0807a.jpga3_usage_accumulation_plan_no long   The plan ID for which to enable usage accumulation
  OR      
  Subarray_0807a.jpga3_client_usg_accum_plan_id string 100 The client-defined plan ID for which to enable usage accumulation
  brd_arrow.gifa3_usage_accumulation_reset_months long 2 The number of reset months for each plan
 

 brd_arrow.gifa3_usage_accumulation_reset_months_

renewal_option

 long 2 Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period.
  a3_enable_usage_pooling_plan_no array   This array is DEPRECATED in favor of the create_usage_pooling_data array.
  Subarray_0807a.jpga3_enable_usage_pooling_plan_no long   DEPRECATED. You should use the create_usage_pooling_data array. The plan ID for which to enable usage pooling
  OR      
  Subarray_0807a.jpga3_client_enable_usg_pool_plan_id string 100 DEPRECATED. You should use the create_usage_pooling_data array. The client-defined plan ID for which to enable usage pooling
  Subarray_0807a.jpga3_usage_threshold_applicability string 100 DEPRECATED. You should use the create_usage_pooling_data array. Usage tracking options on the plans in the account  

Allowable values for a3_usage_threshold_applicability:

Values Description
UT Usage Type
UP Usage Pool
  a3_track_data1 string 1000 The raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  a3_track_data2 string 1000 The raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  a3_tax_exemption_level long 1 To provide Tax Exemption Level for the account  

Allowable values for a3_tax_exemption_level:

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.
  a3_cn_alt_msg_template_no long   The alternate email template number to use for this account
  OR      
  a3_client_cn_alt_msg_template_no string 100 The client alternate email template number to use for this account.
  a3_invoice_approval_required string 5 Boolean indicator to override client's default configured behavior for creating Pending/Real invoice.  

Allowable values for a3_invoice_approval_required:

Values Description
true Attempts to create a pending invoice. Note: if client is configured for real invoices, passing "True" here will override the client setting.
false Attempts to create a real invoice. Note: if client is configured for pending invoices, passing "False" here will override the client setting.
null If NULL, defaults to the client configuration setting
  a3_create_session string 5 Creates an Aria session for the newly created account. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications.  

Allowable values for a3_create_session:

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.
  Subarray_0807a.jpga3_client_sp_alt_rate_sched_ids string array 100 The array of client-defined alternate rate schedule ID for the supplementary subscription plan being considered.
  a3_iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  a3_bank_check_digit long 2 Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
  a3_bank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  a3_bank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  a3_mandate_id string 50

Used for the Direct Debit payment method, including UK-based payments for the Basic Bank Account Number (BBAN) payment method for payments and refunds (max 35-character alphanumeric value).

A mandate is signed by the debtor to authorize the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  a3_bank_id_cd string 15 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  a3_bank_branch_cd string 15 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method.  Only hyphen and space are allowed to format the bank branch code.
  a3_bank_name string 100 Bank name for the account payment method
  a3_bank_city string 100 Bank city for the account payment method
  a3_surcharge_no array    
  Subarray_0807a.jpga3_surcharge_no long   The Surcharge number to be attached to the account
  Subarray_0807a.jpga3_rate_schedule_no long   The Schedule number for this surcharge
  a3_bkup_bill_first_name string 32 First name of the secondary billing contact
  a3_bkup_bill_mi string 1 Middle Initial of the secondary billing contact
  a3_bkup_bill_last_name string 32 Last name of the secondary billing contact
  a3_bkup_bill_company_name string 100 Company name of the secondary billing contact
  a3_bkup_bill_address1 string 100 First address line of the secondary billing contact
  a3_bkup_bill_address2 string 100 Second address line of the secondary billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a3_bkup_bill_address3 string 100 second address line of the secondary billing contact
  a3_bkup_bill_city string 32 City of the secondary billing contact
  a3_bkup_bill_locality string 32 Locality of the secondary billing contact. Use this field instead of the <a3_bkup_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a3_bkup_bill_state_prov string 2 State or province of the secondary billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a3_bkup_bill_locality> field for addresses in those countries.
  a3_bkup_bill_country string 2 Country of the secondary billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a3_bkup_bill_postal_cd string 14 This is the postal code for the secondary billing contact address.
  a3_bkup_bill_phone string 25 Phone of the secondary billing contact
  a3_bkup_bill_phone_ext string 10 This is the secondary billing contacts extension for the bill_phone given.
  a3_bkup_bill_cell_phone string 25 Cell phone of the secondary billing contact
  a3_bkup_bill_work_phone string 25 Work phone of the secondary billing contact
  a3_bkup_bill_work_phone_ext string 100 This is the work phone extension for the secondary billing contact work phone.
  a3_bkup_bill_email string 320 Email of the secondary billing contact
  a3_bkup_pay_method long 8 This is the method_id corresponding to a secondary payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a3_bkup_pay_method:

Values Description
1 Credit card
2 Electronic Check (ACH)
13 Tokenized Credit Card
48 Tokenized ACH
  a3_bkup_cc_number string 24 Credit card number.
  a3_bkup_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a3_bkup_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a3_bkup_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. This field along with <a3_bkup_bank_routing_no> and <a3_bkup_bill_agreement_id> along with the <a3_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a3_bkup_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution.This field along with <a3_bkup_bank_acct_no> and <a3_bkup_bill_agreement_id> along with the <a3_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a3_bkup_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a3_bkup_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a3_bkup_bill_agreement_id string 32 Unique ID of the secondary bill agreement (also referred to as a token). This field along with <a3_bkup_bank_acct_no> and <a3_bkup_bank_routing_no> along with the <a3_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a3_bkup_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the secondary card holder since this value is physically printed on the credit card.
  a3_revrec_profile_id long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  a3_revrec_client_defined_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_id.
  a3_stmnt_email_list string 3000 Deprecated(Deprecated) An array containing the list of additional email addresses
  a3_stmnt_email_list_cc string 3000 An array containing the list of additional cc email addresses
  a3_stmnt_email_list_bcc string 3000 An array containing the list of additional bcc email addresses
  a3_invoice_posting_method_cd long   This configuration specifies whether invoices for this Account need to be manually posted. This setting supersedes the standard client setting for this specific Account.  

Allowable values for a3_invoice_posting_method_cd:

Values Description
0 Follow the standard client defined setting.
1 Auto post all invoices.
2 All invoices require manual posting.
3 Only invoices paid via non-electronic payment methods require manual posting.
null If none is passed, then by default the account will be set to follow the standard client defined setting.
  a3_acct_start_date string 14 This is the date this account was originally started.
  a3_min_statement_threshold long   Use this field to specify the balance threshold amount under which a statement should not be sent to the customer. This applies to all customers regardless of payment method.
  a3_max_statements_to_defer long   Use this field to specify the number of statements to skip sending to the customer. Applies only if min_statement_threshold is specified. If left blank, statements shall be suppressed indefinitely as long as the balance is below the threshold.
  a3_defer_full_statements_only long   Use this field to only suppress anniversary statements if the balance is below the min_statement_threshold. If left blank, all generated statements, including mid-cycle statements, shall not be sent to the customer if the balance is below the min_statement_threshold. Applies only if a min_statement_threshold is specified.  

Allowable values for a3_defer_full_statements_only:

Values Description
0 Open for all invoice.
1 Apply only for anniversary invoice.
  a3_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a3_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a3_bkup_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a3_bkup_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a4_alt_start_date string 14 This is an alternative start date for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated).
  a4_client_acct_id string 50 This is the client-assigned identifier for the account.
  a4_userid string 32 The users unique identifier.
  a4_status_cd long 8 This is the status of the object in question for the current API call.  

Allowable values for a4_status_cd:

Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
  a4_master_plan_no long 22 The Master Subscription plan number.
  OR      
  a4_client_master_plan_id string 100 Client-defined Master plan Subscription plan ID.
  a4_master_plan_units long 8 This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.
  Subarray_0807a.jpga4_supp_plans long array 38 An array of supplemental plan numbers to assign to this account
  OR      
  Subarray_0807a.jpga4_client_supp_plan_ids string array 100 The array of client-defined supplemental plan IDs.
  Subarray_0807a.jpga4_supp_plan_units long array 38 The units of each plan in the above supp_plans array to assign to this account
  a4_notify_method long 38 If notification method is not provided, value will default to 1 (HTML email).  

Allowable values for a4_notify_method:

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
  a4_promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  a4_password string 100 Password for the given user
  a4_secret_question string 300 The users secret question recorded to recover a password.
  a4_secret_question_answer string 300 The response to a users 'secret_question
  a4_first_name string 32 Contact first name
  a4_mi string 1 The Middle Initial of the contact.
  a4_last_name string 32 Contact last name
  a4_company_name string 100 Company name of the contact
  a4_address1 string 100 First address line of the contact
  a4_address2 string 100 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a4_city string 32 City of the contact
  a4_locality string 32 Locality of the contact. Use this field instead of the <a4_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a4_state_prov string 2 State or province of the contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a4_locality> field for addresses in those countries.
  a4_country string 2 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a4_postal_cd string 14 Postal/Zip code for the contact address.
  a4_phone string 25 The phone number of the contact
  a4_phone_ext string 10 The extension for the contact phone
  a4_cell_phone string 20 The contact cell phone.
  a4_work_phone string 25 Work phone number of the contact.
  a4_work_phone_ext string 10 The extension for the contact work phone
  a4_email string 320 Email of the contact
  a4_birthdate string 14 Contact date of birth
  a4_bill_first_name string 32 First name of the billing contact
  a4_bill_mi string 1 Middle Initial of the billing contact
  a4_bill_last_name string 32 Last name of the billing contact
  a4_bill_company_name string 100 Company name of the billing contact
  a4_bill_address1 string 100 First address line of the billing contact
  a4_bill_address2 string 100 Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a4_bill_city string 32 City of the billing contact
  a4_bill_locality string 32 Locality of the billing contact. Use this field instead of the <a4_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a4_bill_state_prov string 2 State or province of the billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a4_bill_locality> field for addresses in those countries.
  a4_bill_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a4_bill_postal_cd string 14 This is the postal code for the billing contact address.
  a4_bill_phone string 25 Phone of the billing contact
  a4_bill_phone_ext string 10 This is the billing contacts extension for the bill_phone given.
 

a4_bill_cell_phone

 string 25 Cell phone of the billing contact
  a4_bill_work_phone string 25 Work phone of the billing contact
  a4_bill_work_phone_ext string 100 This is the work phone extension for the billing contact work phone.
  a4_bill_email string 320 Email of the billing contact
  a4_pay_method long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a4_pay_method:

Values Description
-1 External Payment
0 Other
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
8 Click&Buy
9 Net Terms 0
10 PayByCash
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35
16 Net Terms 75
17 Net Terms 90
18 Net Terms 120
19 Net Terms 25
26 Direct Debit
29 Reserve Account
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
48 Tokenized ACH
  a4_cc_number string 24 Credit card number.
  a4_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a4_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a4_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. This field along with <a4_bank_routing_no> and <a4_bill_agreement_id> along with the <a4_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a4_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. This field along with <a4_bank_acct_no> and <a4_bill_agreement_id> along with the <a4_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a4_resp_level_cd long 8 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  

Allowable values for a4_resp_level_cd:

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'
4 Parent Usage & Pay w/note: Same as "Parent Usage & Pay", except that usage will also be accrued under self for notational purposes only
  Subarray_0807a.jpga4_functional_acct_groups long array 38 Array of functional account groups.
  OR      
  Subarray_0807a.jpga4_client_func_acct_group_ids string array 38 The functional account group ID to which this account should be assigned
  Subarray_0807a.jpga4_collections_acct_groups long array 38 The group ID for the collections account groups in which to place this account
  OR      
  Subarray_0807a.jpga4_client_coll_acct_group_ids string array 100 The collections account group ID to which this account should be assigned
  Subarray_0807a.jpga4_supp_field_names string array 100 The names of the supplemental fields for which values are to be stored for this account
  Subarray_0807a.jpga4_supp_field_values string array 300 The values for the supplemental field names given in supp_field_names
  a4_test_acct_ind long 1 This argument indicates the account is a test account and is treated as such in the system. 

Allowable values for a4_test_acct_ind:

Values Description
1 test
0 live
  a4_status_until_alt_start long 8 The status for the account prior to alt_start_date. This is only used if the alternate start date is used.  

Allowable values for a4_status_until_alt_start:

Values Description
0 Inactive
  a4_balance_forward double 12 A fixed amount, positive or negative, that the newly created account should owe (or be owed) immediately upon creation. Generally used when converting accounts from other systems into Aria.
  a4_alt_bill_day long 2 The day of the month that will act in perpetuity as the account's billing anniversary day.
  a4_do_full_invoicing string 5 Boolean indicator to override client's default configured behavior for performing full invoicing on this account as part of this call.  

Allowable values for a4_do_full_invoicing:

Values Description
true Immediately invoice and collect from the new account.
false Do not immediately invoice the new account.
null If NULL, defaults to the client configuration setting
  a4_do_prorated_invoicing string 5 Prorate the invoice to the end of the billing cycle  

Allowable values for a4_do_prorated_invoicing:

Values Description
true Immediately prorate and collect from the new account.
false Do not immediately prorate the new account.
null If NULL, defaults to the client configuration setting
  a4_master_plan_alt_rate_sched_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  a4_client_mp_alt_rate_sched_id string 100 The client alternate rate schedule ID for the master subscription plan being considered.
  Subarray_0807a.jpga4_supp_plan_alt_rate_sched_no long array   The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
  a4_currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  a4_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  a4_taxpayer_id string 32 Taxpayer Identification number.
  a4_bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token). This field along with <a4_bank_acct_no> and <a4_bank_routing_no> along with the <a4_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a4_retroactive_start_date string 14 Date to set for retroactive start.
  Subarray_0807a.jpga4_coupon_codes string array 30 The coupon codes to assign to this account, if any
  a4_new_acct_custom_rates array    
  Subarray_0807a.jpga4_custom_rate_plan_no long 22 The unique identifier for the plan to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga4_client_custom_rate_plan_id string 100 The client-defined unique identifier for the plan to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga4_custom_rate_service_no long 22 The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga4_client_custom_rate_service_id string 100 The client-defined unique identifier for the service no to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga4_custom_rate_seq_no long 22 The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga4_custom_rate_from_unit long 12 The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga4_custom_rate_to_unit long 12 The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga4_custom_rate_per_unit double 12 The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.
  a4_alt_msg_template_no long 22 Email template number assigned to this account.
  OR      
  a4_client_alt_msg_template_id string 100 Client specifies alternate Email template ID assigned to this account.
  a4_seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  a4_seq_func_group_id string 32 Unique Functional account group ID specifically designated for statement sequence number assignment.
  a4_new_acct_plan_contracts array    
  Subarray_0807a.jpga4_contract_plan_no long   The unique identifier of this contract
  OR      
  Subarray_0807a.jpga4_client_contract_plan_id string 100 The client-defined unique ID for the plan to which this contract applies
  Subarray_0807a.jpga4_contract_type_no long   The type ID of this contract
  Subarray_0807a.jpga4_contract_alt_recur_fee double 12 This amount will be billed each month instead of the current recurring service rate. If there are multiple recurring services related to this plan, the rate associated with the current recurring service that has the lowest service_no will be replaced.This alternate recurring fee will go into effect starting on the new contract's effective date.
  Subarray_0807a.jpga4_contract_length_months long 4 The number of months this contract should remain on the account
  Subarray_0807a.jpga4_contract_cancel_fee double 38 The fee charged to the account for prematurely ending this contract
  Subarray_0807a.jpga4_contract_comments string 300 Any client-defined comments stored on this contract at the account level
  Subarray_0807a.jpga4_contract_start_date string   The date on which this contract takes effect
  Subarray_0807a.jpga4_contract_end_date string   Allows the caller to set a specific end date when creating or modifying plan contracts.
  a4_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a4_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a4_address3 string 300 The third line of the address
  a4_bill_address3 string 300 The third line of the billing address
  a4_usage_accumulation_config array   The array of plans for which to enable usage accumulation
  Subarray_0807a.jpga4_usage_accumulation_plan_no long   The plan ID for which to enable usage accumulation
  OR      
  Subarray_0807a.jpga4_client_usg_accum_plan_id string 32100 The client-defined plan ID for which to enable usage accumulation
  brd_arrow.gifa4_usage_accumulation_reset_months long 2 The number of reset months for each plan
 

 brd_arrow.gifa4_usage_accumulation_reset_months_

renewal_option

 long 2 Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period.
  a4_enable_usage_pooling_plan_no array   This array is DEPRECATED in favor of the create_usage_pooling_data array.
  Subarray_0807a.jpga4_enable_usage_pooling_plan_no long   DEPRECATED. You should use the create_usage_pooling_data array. The plan ID for which to enable usage pooling
  OR      
  Subarray_0807a.jpga4_client_enable_usg_pool_plan_id string 100 DEPRECATED. You should use the create_usage_pooling_data array. The client-defined plan ID for which to enable usage pooling
  Subarray_0807a.jpga4_usage_threshold_applicability string 100 DEPRECATED. You should use the create_usage_pooling_data array. Usage tracking options on the plans in the account  

Allowable values for a4_usage_threshold_applicability:

Values Description
UT Usage Type
UP Usage Pool
  a4_track_data1 string 1000 The raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  a4_track_data2 string 1000 The raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  a4_tax_exemption_level long 1 To provide Tax Exemption Level for the account  

Allowable values for a4_tax_exemption_level:

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.
  a4_cn_alt_msg_template_no long   The alternate email template number to use for this account
  OR      
  a4_client_cn_alt_msg_template_no string 100 The client alternate email template number to use for this account.
  a4_invoice_approval_required string 5 Boolean indicator to override client's default configured behavior for creating Pending/Real invoice.  

Allowable values for a4_invoice_approval_required:

Values Description
true Attempts to create a pending invoice. Note: if client is configured for real invoices, passing "True" here will override the client setting.
false Attempts to create a real invoice. Note: if client is configured for pending invoices, passing "False" here will override the client setting.
null If NULL, defaults to the client configuration setting
  a4_create_session string 5 Creates an Aria session for the newly created account. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications.  

Allowable values for a4_create_session:

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.
  Subarray_0807a.jpga4_client_sp_alt_rate_sched_ids string array 100 The array of client-defined alternate rate schedule ID for the supplementary subscription plan being considered.
  a4_iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  a4_bank_check_digit long 2 Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
  a4_bank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  a4_bank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  a4_mandate_id string 50

Used for the Direct Debit payment method, including UK-based payments for the Basic Bank Account Number (BBAN) payment method for payments and refunds (max 35-character alphanumeric value).

A mandate is signed by the debtor to authorise the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  a4_bank_id_cd string 15 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  a4_bank_branch_cd string 15 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank branch code.
  a4_bank_name string 100 Bank name for the account payment method
  a4_bank_city string 100 Bank city for the account payment method
  a4_surcharge_no array    
  Subarray_0807a.jpga4_surcharge_no long   The Surcharge number to be attached to the account
  Subarray_0807a.jpga4_rate_schedule_no long   The Schedule number for this surcharge
  a4_bkup_bill_first_name string 32 First name of the secondary billing contact
  a4_bkup_bill_mi string 1 Middle Initial of the secondary billing contact
  a4_bkup_bill_last_name string 32 Last name of the secondary billing contact
  a4_bkup_bill_company_name string 100 Company name of the secondary billing contact
  a4_bkup_bill_address1 string 100 First address line of the secondary billing contact
  a4_bkup_bill_address2 string 100 Second address line of the secondary billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a4_bkup_bill_address3 string 100 second address line of the secondary billing contact
  a4_bkup_bill_city string 32 City of the secondary billing contact
  a4_bkup_bill_locality string 32 Locality of the secondary billing contact. Use this field instead of the <a4_bkup_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a4_bkup_bill_state_prov string 2 State or province of the secondary billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a4_bkup_bill_locality> field for addresses in those countries.
  a4_bkup_bill_country string 2 Country of the secondary billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a4_bkup_bill_postal_cd string 14 This is the postal code for the secondary billing contact address.
  a4_bkup_bill_phone string 25 Phone of the secondary billing contact
  a4_bkup_bill_phone_ext string 10 This is the secondary billing contacts extension for the bill_phone given.
  a4_bkup_bill_cell_phone string 25 Cell phone of the secondary billing contact
  a4_bkup_bill_work_phone string 25 Work phone of the secondary billing contact
  a4_bkup_bill_work_phone_ext string 100 This is the work phone extension for the secondary billing contact work phone.
  a4_bkup_bill_email string 320 Email of the secondary billing contact
  a4_bkup_pay_method long 8 This is the method_id corresponding to a secondary payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a4_bkup_pay_method:

Values Description
1 Credit card
2 Electronic Check (ACH)
13 Tokenized Credit Card
48 Tokenized ACH
  a4_bkup_cc_number string 24 Credit card number.
  a4_bkup_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a4_bkup_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a4_bkup_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. This field along with <a4_bkup_bank_routing_no> and <a4_bkup_bill_agreement_id> along with the <a4_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a4_bkup_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. This field along with <a4_bkup_bank_acct_no> and <a4_bkup_bill_agreement_id> along with the <a4_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a4_bkup_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a4_bkup_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a4_bkup_bill_agreement_id string 32 Unique ID of the secondary bill agreement (also referred to as a token). This field along with <a4_bkup_bank_acct_no> and <a4_bkup_bank_routing_no> along with the <a4_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a4_bkup_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the secondary card holder since this value is physically printed on the credit card.
  a4_revrec_profile_id long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  a4_revrec_client_defined_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_id.
  a4_stmnt_email_list string 3000 (Deprecated) An array containing the list of additional email addresses
  a4_stmnt_email_list_cc string 3000 An array containing the list of additional cc email addresses
  a4_stmnt_email_list_bcc string 3000 An array containing the list of additional bcc email addresses
  a4_invoice_posting_method_cd long   This configuration specifies whether invoices for this Account need to be manually posted. This setting supersedes the standard client setting for this specific Account.  

Allowable values for a4_invoice_posting_method_cd:

Values Description
0 Follow the standard client defined setting.
1 Auto post all invoices.
2 All invoices require manual posting.
3 Only invoices paid via non-electronic payment methods require manual posting.
null If none is passed, then by default the account will be set to follow the standard client defined setting.
  a4_acct_start_date string 14 This is the date this account was originally started.
  a4_min_statement_threshold long   Use this field to specify the balance threshold amount under which a statement should not be sent to the customer. This applies to all customers regardless of payment method.
  a4_max_statements_to_defer long   Use this field to specify the number of statements to skip sending to the customer. Applies only if min_statement_threshold is specified. If left blank, statements shall be suppressed indefinitely as long as the balance is below the threshold.
  a4_defer_full_statements_only long   Use this field to only suppress anniversary statements if the balance is below the min_statement_threshold. If left blank, all generated statements, including mid-cycle statements, shall not be sent to the customer if the balance is below the min_statement_threshold. Applies only if a min_statement_threshold is specified.  

Allowable values for a4_defer_full_statements_only:

Values Description
0 Open for all invoice.
1 Apply only for anniversary invoice.
  a4_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a4_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express

4

 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a4_bkup_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a4_bkup_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a5_alt_start_date string 14 This is an alternative start date for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated).
  a5_client_acct_id string 50 This is the client-assigned identifier for the account.
  a5_userid string 32 The users unique identifier.
  a5_status_cd long 8 This is the status of the object in question for the current API call.  

Allowable values for a5_status_cd:

Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
  a5_master_plan_no long 22 The Master Subscription plan number.
  OR      
  a5_client_master_plan_id string 100 The client-defined Master Subscription plan ID.
  a5_master_plan_units long 8 This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.
  Subarray_0807a.jpga5_supp_plans long array 38 An array of supplemental plan numbers to assign to this account
  OR      
  Subarray_0807a.jpga5_client_supp_plan_ids string array 100 The array of client-defined supplemental plan IDs.
  Subarray_0807a.jpga5_supp_plan_units long array 38 The units of each plan in the above supp_plans array to assign to this account
  a5_notify_method long 38 If notification method is not provided, value will default to 1 (HTML email).  

Allowable values for a5_notify_method:

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
  a5_promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  a5_password string 100 Password for the given user
  a5_secret_question string 300 The users secret question recorded to recover a password.
  a5_secret_question_answer string 300 The response to a users 'secret_question
  a5_first_name string 32 Contact first name
  a5_mi string 1 The Middle Initial of the contact.
  a5_last_name string 32 Contact last name
  a5_company_name string 100 Company name of the contact
  a5_address1 string 100 First address line of the contact
  a5_address2 string 100 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a5_city string 32 City of the contact
  a5_locality string 32 Locality of the contact. Use this field instead of the <a5_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a5_state_prov string 2 State or province of the contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a5_locality> field for addresses in those countries.
  a5_country string 2 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a5_postal_cd string 14 Postal/Zip code for the contact address.
  a5_phone string 25 The phone number of the contact
  a5_phone_ext string 10 The extension for the contact phone
  a5_cell_phone string 20 The contact cell phone.
  a5_work_phone string 25 Work phone number of the contact.
  a5_work_phone_ext string 10 The extension for the contact work phone
  a5_email string 320 Email of the contact
  a5_birthdate string 14 Contact date of birth
  a5_bill_first_name string 32 First name of the billing contact
  a5_bill_mi string 1 Middle Initial of the billing contact
  a5_bill_last_name string 32 Last name of the billing contact
  a5_bill_company_name string 100 Company name of the billing contact
  a5_bill_address1 string 100 First address line of the billing contact
  a5_bill_address2 string 100 Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a5_bill_city string 32 City of the billing contact
  a5_bill_locality string 32 Locality of the billing contact. Use this field instead of the <a5_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a5_bill_state_prov string 2 State or province of the billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a5_bill_locality> field for addresses in those countries.
  a5_bill_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a5_bill_postal_cd string 14 This is the postal code for the billing contact address.
  a5_bill_phone string 25 Phone of the billing contact
  a5_bill_phone_ext string 10 This is the billing contacts extension for the bill_phone given.
  a5_bill_cell_phone string 25 Cell phone of the billing contact
  a5_bill_work_phone string 25 Work phone of the billing contact
  a5_bill_work_phone_ext string 100 This is the work phone extension for the billing contact work phone.
  a5_bill_email string 320 Email of the billing contact
  a5_pay_method long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a5_pay_method:

Values Description
-1 External Payment
0 Other
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
8 Click&Buy
9 Net Terms 0
10 PayByCash
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35
16 Net Terms 75
17 Net Terms 90
18 Net Terms 120
19 Net Terms 25
26 Direct Debit
29 Reserve Account
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
48 Tokenized ACH
  a5_cc_number string 24 Credit card number.
  a5_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a5_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a5_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. This field along with <a5_bank_routing_no> and <a5_bill_agreement_id> along with the <a5_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a5_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. This field along with <a5_bank_acct_no> and <a5_bill_agreement_id> along with the <a5_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a5_resp_level_cd long 8 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  

Allowable values for a5_resp_level_cd:

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'
4 Parent Usage & Pay w/note: Same as "Parent Usage & Pay", except that usage will also be accrued under self for notational purposes only
  Subarray_0807a.jpga5_functional_acct_groups long array 38 Array of functional account groups.
  OR      
  Subarray_0807a.jpga5_client_func_acct_group_ids string array 38 The functional account group ID to which this account should be assigned
  Subarray_0807a.jpga5_collections_acct_groups long array 38 The group ID for the collections account groups in which to place this account
  OR      
  Subarray_0807a.jpga5_client_coll_acct_group_ids string array 100 The collections account group ID to which this account should be assigned
  Subarray_0807a.jpga5_supp_field_names string array 100 The names of the supplemental fields for which values are to be stored for this account
  Subarray_0807a.jpga5_supp_field_values string array 300 The values for the supplemental field names given in supp_field_names
  a5_test_acct_ind long 1 This argument indicates the account is a test account and is treated as such in the system. 

Allowable values for a5_test_acct_ind:

Values Description
1 test
0 live
  a5_status_until_alt_start long 8 The status for the account prior to alt_start_date. This is only used if the alternate start date is used.  

Allowable values for a5_status_until_alt_start:

Values Description
0 Inactive
  a5_balance_forward double 12 A fixed amount, positive or negative, that the newly created account should owe (or be owed) immediately upon creation. Generally used when converting accounts from other systems into Aria.
  a5_alt_bill_day long 2 The day of the month that will act in perpetuity as the account's billing anniversary day.
  a5_do_full_invoicing string 5 Boolean indicator to override client's default configured behavior for performing full invoicing on this account as part of this call.  

Allowable values for a5_do_full_invoicing:

Values Description
true Immediately invoice and collect from the new account.
false Do not immediately invoice the new account.
null If NULL, defaults to the client configuration setting
  a5_do_prorated_invoicing string 5 Prorate the invoice to the end of the billing cycle  

Allowable values for a5_do_prorated_invoicing:

Values Description
true Immediately prorate and collect from the new account.
false Do not immediately prorate the new account.
null If NULL, defaults to the client configuration setting
  a5_master_plan_alt_rate_sched_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  a5_client_mp_alt_rate_sched_id string 100 The client alternate rate schedule ID for the master subscription plan being considered.
  Subarray_0807a.jpga5_supp_plan_alt_rate_sched_no long array   The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
  a5_currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  a5_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  a5_taxpayer_id string 32 Taxpayer Identification number.
  a5_bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token). This field along with <a5_bank_acct_no> and <a5_bank_routing_no> along with the <a5_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a5_retroactive_start_date string 14 Date to set for retroactive start.
  Subarray_0807a.jpga5_coupon_codes string array 30 The coupon codes to assign to this account, if any
  a5_new_acct_custom_rates array    
  Subarray_0807a.jpga5_custom_rate_plan_no long 22 The unique identifier for the plan to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga5_client_custom_rate_plan_id string 100 The client-defined unique identifier for the plan to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga5_custom_rate_service_no long 22 The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.
  OR      
  Subarray_0807a.jpga5_client_custom_rate_service_id string 100 The client-defined unique identifier for the service no to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga5_custom_rate_seq_no long 22 The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga5_custom_rate_from_unit long 12 The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga5_custom_rate_to_unit long 12 The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.
  Subarray_0807a.jpga5_custom_rate_per_unit double 12 The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.
  a5_alt_msg_template_no long 22 Email template number assigned to this account.
  OR      
  a5_client_alt_msg_template_id string 100 Client-defined email template ID assigned to this account.
  a5_seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  a5_seq_func_group_id string 32 Unique Functional account group ID specifically designated for statement sequence number assignment.
  a5_new_acct_plan_contracts array    
  Subarray_0807a.jpga5_contract_plan_no long   The unique identifier of this contract
  OR      
  Subarray_0807a.jpga5_client_contract_plan_id string 100 The client-defined unique ID for the plan to which this contract applies
  Subarray_0807a.jpga5_contract_type_no long   The type ID of this contract
  Subarray_0807a.jpga5_contract_alt_recur_fee double 12 This amount will be billed each month instead of the current recurring service rate. If there are multiple recurring services related to this plan, the rate associated with the current recurring service that has the lowest service_no will be replaced. This alternate recurring fee will go into effect starting on the new contract's effective date.
  Subarray_0807a.jpga5_contract_length_months long 4 The number of months this contract should remain on the account
  Subarray_0807a.jpga5_contract_cancel_fee double 38 The fee charged to the account for prematurely ending this contract
  Subarray_0807a.jpga5_contract_comments string 300 Any client-defined comments stored on this contract at the account level
  Subarray_0807a.jpga5_contract_start_date string   The date on which this contract takes effect
  Subarray_0807a.jpga5_contract_end_date string   Allows the caller to set a specific end date when creating or modifying plan contracts.
  a5_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a5_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a5_address3 string 300 The third line of the address
  a5_bill_address3 string 300 The third line of the billing address
  a5_usage_accumulation_config array   The array of plans for which to enable usage accumulation
  Subarray_0807a.jpga5_usage_accumulation_plan_no long   The plan ID for which to enable usage accumulation
  OR      
  Subarray_0807a.jpga5_client_usg_accum_plan_id string 100 The client-defined plan ID for which to enable usage accumulation
  Subarray_0807a.jpga5_usage_accumulation_reset_months long 2 The number of reset months for each plan
 

 brd_arrow.gifa5_usage_accumulation_reset_months_

renewal_option

 long 2 Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period.
  a5_enable_usage_pooling_plan_no array    
  Subarray_0807a.jpga5_enable_usage_pooling_plan_no long   DEPRECATED. You should use the create_usage_pooling_data array. The plan ID for which to enable usage pooling
  OR      
  Subarray_0807a.jpga5_client_enable_usg_pool_plan_id string 100 DEPRECATED. You should use the create_usage_pooling_data array. The client-defined plan ID for which to enable usage pooling
  Subarray_0807a.jpga5_usage_threshold_applicability string 100 DEPRECATED. You should use the create_usage_pooling_data array. Usage tracking options on the plans in the account  

Allowable values for a5_usage_threshold_applicability:

Values Description
UT Usage Type
UP Usage Pool
  a5_track_data1 string 1000 The raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  a5_track_data2 string 1000 The raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  a5_tax_exemption_level long 1 To provide Tax Exemption Level for the account  

Allowable values for a5_tax_exemption_level:

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.
  a5_cn_alt_msg_template_no long   The alternate email template number to use for this account
  OR      
  a5_client_cn_alt_msg_template_no string 100 The client-defined alternate email template number to use for this account
  a5_invoice_approval_required string 5 Boolean indicator to override client's default configured behavior for creating Pending/Real invoice.  

Allowable values for a5_invoice_approval_required:

Values Description
true Attempts to create a pending invoice. Note: if client is configured for real invoices, passing "True" here will override the client setting.
false Attempts to create a real invoice. Note: if client is configured for pending invoices, passing "False" here will override the client setting.
null If NULL, defaults to the client configuration setting
  a5_create_session string 5 Creates an Aria session for the newly created account. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications.  

Allowable values for a5_create_session:

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.
  Subarray_0807a.jpga5_client_sp_alt_rate_sched_ids string array 100 The array of client-defined alternate rate schedule ID for the supplementary subscription plan being considered.
  a5_iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  a5_bank_check_digit long 2 Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
  a5_bank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  a5_bank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  a5_mandate_id string 50

Used for the Direct Debit payment method, including UK-based payments for the Basic Bank Account Number (BBAN) payment method for payments and refunds (max 35-character alphanumeric value).

A mandate is signed by the debtor to authorise the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  a5_bank_id_cd string 15 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  a5_bank_branch_cd string 15 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank branch code.
  a5_bank_name string 100 Bank name for the account payment method
  a5_bank_city string 100 Bank city for the account payment method
  a5_surcharge_no array    
  Subarray_0807a.jpga5_surcharge_no long   The Surcharge number to be attached to the account
  Subarray_0807a.jpga5_rate_schedule_no long   The Schedule number for this surcharge
  a5_bkup_bill_first_name string 32 First name of the secondary billing contact
  a5_bkup_bill_mi string 1 Middle Initial of the secondary billing contact
  a5_bkup_bill_last_name string 32 Last name of the secondary billing contact
  a5_bkup_bill_company_name string 100 Company name of the secondary billing contact
  a5_bkup_bill_address1 string 100 First address line of the secondary billing contact
  a5_bkup_bill_address2 string 100 Second address line of the secondary billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  a5_bkup_bill_address3 string 100 second address line of the secondary billing contact
  a5_bkup_bill_city string 32 City of the secondary billing contact
  a5_bkup_bill_locality string 32 Locality of the secondary billing contact. Use this field instead of the <a5_bkup_bill_state_prov> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada.
  a5_bkup_bill_state_prov string 2 State or province of the secondary billing contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <a5_bkup_bill_locality> field for addresses in those countries.
  a5_bkup_bill_country string 2 Country of the secondary billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  a5_bkup_bill_postal_cd string 14 This is the postal code for the secondary billing contact address.
  a5_bkup_bill_phone string 25 Phone of the secondary billing contact
  a5_bkup_bill_phone_ext string 10 This is the secondary billing contacts extension for the bill_phone given.
  a5_bkup_bill_cell_phone string 25 Cell phone of the secondary billing contact
  a5_bkup_bill_work_phone string 25 Work phone of the secondary billing contact
  a5_bkup_bill_work_phone_ext string 100 This is the work phone extension for the secondary billing contact work phone.
  a5_bkup_bill_email string 320 Email of the secondary billing contact
  a5_bkup_pay_method long 8 This is the method_id corresponding to a secondary payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for a5_bkup_pay_method:

Values Description
1 Credit card
2 Electronic Check (ACH)
13 Tokenized Credit Card
48 Tokenized ACH
  a5_bkup_cc_number string 24 Credit card number.
  a5_bkup_cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  a5_bkup_cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  a5_bkup_bank_acct_no string 19 This is the bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions. This field along with <a5_bkup_bank_routing_no> and <a5_bkup_bill_agreement_id> along with the <a5_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a5_bkup_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. This field along with <a5_bkup_bank_acct_no> and <a5_bkup_bill_agreement_id> along with the <a5_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a5_bkup_bank_acct_type string 32 The type of bank account being used.  

Allowable values for a5_bkup_bank_acct_type:

Values Description
savings savings
checking checking
business business
  a5_bkup_bill_agreement_id string 32 Unique ID of the secondary bill agreement (also referred to as a token). This field along with <a5_bkup_bank_acct_no> and <a5_bkup_bank_routing_no> along with the <a5_bkup_bank_acct_type> field must be passed in for payment method 48 (Tokenized ACH).
  a5_bkup_cvv string 5 Card Verification Value, used to help verify a transaction is being requested by the secondary card holder since this value is physically printed on the credit card.
  a5_revrec_profile_id long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  a5_revrec_client_defined_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_id.
  a5_stmnt_email_list string 3000 Deprecated(Deprecated) An array containing the list of additional email addresses
  a5_stmnt_email_list_cc string 3000 An array containing the list of additional cc email addresses
  a5_stmnt_email_list_bcc string 3000 An array containing the list of additional bcc email addresses
  a5_invoice_posting_method_cd long   This configuration specifies whether invoices for this Account need to be manually posted. This setting supersedes the standard client setting for this specific Account.  

Allowable values for a5_invoice_posting_method_cd:

Values Description
0 Follow the standard client defined setting.
1 Auto post all invoices.
2 All invoices require manual posting.
3 Only invoices paid via non-electronic payment methods require manual posting.
null If none is passed, then by default the account will be set to follow the standard client defined setting.
  a5_acct_start_date string 14 This is the date this account was originally started.
  a5_min_statement_threshold long   Use this field to specify the balance threshold amount under which a statement should not be sent to the customer. This applies to all customers regardless of payment method.
  a5_max_statements_to_defer long   Use this field to specify the number of statements to skip sending to the customer. Applies only if min_statement_threshold is specified. If left blank, statements shall be suppressed indefinitely as long as the balance is below the threshold.
  a5_defer_full_statements_only long   Use this field to only suppress anniversary statements if the balance is below the min_statement_threshold. If left blank, all generated statements, including mid-cycle statements, shall not be sent to the customer if the balance is below the min_statement_threshold. Applies only if a min_statement_threshold is specified.  

Allowable values for a5_defer_full_statements_only:

Values Description
0 Open for all invoice.
1 Apply only for anniversary invoice.
  a5_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a5_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  a5_bkup_cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for a5_bkup_cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club / Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
  create_usage_pooling_data array    
  Subarray_0807a.jpgclient_usage_pool_plan_id string   The client-defined plan ID on which to enable usage pooling
  Subarray_0807a.jpgusage_threshold_applicability_cd string   Usage tracking options on the plans in the account

Allowable values for usage_threshold_applicability_cd:

Values Description
UT Usage Type (default)
UP Usage Pool
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Subarray_0807a.jpg qualifier_name string 100 Name of the field you want to associate with this API call.
  Subarray_0807a.jpg qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.
  fraud_filter long 1

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.


Notes:

  • If you set this field to 0, then Aria will ignore all other fraud filtering fields.
  • 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.
  • If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.

Allowable values for fraud_filter:

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_control_fields array  

Your chosen fraud protection options passed as an array of fraud_control_field_name/fraud_control_field_value key-value pairs. This array allows you to specify your fraud filtering options.

To use fraud filtering, you must have fraud functionality enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation.

The allowable fields and values for the key-value pairs are highlighted in blue below.
  fraud_control_field_name Field Type Max Length fraud_control_field_value:
  • Field Type: string
  • Max Length: 100
  brd_arrow.gif
fraud_filtering_enabled		 string 100 Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (disable), then Aria will ignore all other fraud filtering fields.

Allowable values for fraud_filtering_enabled:

Values Description
0 disable
1 enable
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifchange_status_on_fraud_filtering_failure string 100 Indicates whether to change the status of the account or master plan instance(s) if:
  • The fraud filtering request returns a failure response; and
  • 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 for change_status_on_fraud_filtering_failure:

Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gif
status_on_fraud_filtering_failure		 string 100 If change_status _on_fraud_filtering_failure is set to true and the fraud filtering request returns a failure response, use this field to indicate the desired status of the account.
  brd_arrow.gifchange_status_on_fraud_filtering_review string 100 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 for change_status_on_fraud_filtering_review:

Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gif
status_on_fraud_filtering_review		 string 100 If change_status _on_fraud_filtering_review is set to 1 (true), use this field to indicate the desired status of the account.
  brd_arrow.gif
change_status_on_fraud_filtering_cc_prefix_failure		 string 100 Indicates whether to change the status of the account 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 for change_status_on_fraud_filtering_cc_prefix_failure:

Values Description
0 false
1 true
  brd_arrow.gif
status_on_fraud_filtering_cc_prefix_failure		 string 100 If change_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post)
  brd_arrow.gif
change_status_on_fraud_filtering_cc_number_failure		 string 100 Indicates whether to change the status of the account 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 for change_status_on_fraud_filtering_cc_number_failure:

Values Description
0 false
1 true
  brd_arrow.gif
status_on_fraud_filtering_cc_number_failure		 string 100 If change_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post)
  brd_arrow.gif
change_status_on_fraud_filtering_cc_issuing_country_failure		 string 100 Indicates whether to change the status of the account 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 for change_status_on_fraud_filtering_cc_issuing_country_failure:

Values Description
0 false
1 true
  brd_arrow.gif
status_on_fraud_filtering_cc_issuing_country_failure		 string 100 If change_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post)
  brd_arrow.gifchange_status_on_fraud_filtering_cc_issuing_country_suspect string 100 Indicates whether to change the status of the account 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 for change_status_on_fraud_filtering_cc_issuing_country_suspect:

Values Description
0 false
1 true
  brd_arrow.gif
status_on_fraud_filtering_cc_issuing_country_suspect		 string 100 If: change_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post)
End of fraud_control_fields array
Req Field Name Field Type Max Length Description
  recurring_processing_model_ind long 1 Defines a recurring payment type for Credit Card and Tokenized Credit Cards. 

Allowable values for recurring_processing_model_ind:

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.
Start of proc_field_override array
  brd_arrow.gif proc_field_override array  

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.
  Field Name Field Type Max Length Description
    brd_arrow.gifbrd_arrow.gif transaction_type string 2

If you use Chase Paymentech or Vantiv, 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).

 

Notes:

  • The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
    • Configuration > Payments > Payment Gateways > Chase Paymentech > Gateway Options; and
    • Configuration > Payments > Collection Groups > Chase Paymentech > Collection Group Options.
  • Currently, only Chase Paymentech supports 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:

  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

Allowable values for transaction_type:

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 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 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 Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4 Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time.
5 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 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 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 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 IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system.
R 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 Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
a1_error_code long Aria-assigned error identifier. 0 indicates no error.
a1_error_msg string Description of any error that occurred. "OK" if there was no error.
a1_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
a1_out_userid string The user ID, unique among all accounts for this Aria client, assigned to the newly created account. If input parameter "user_id" was provided, the same value will be returned. If no "user_id" was provided as input and the client is configured within Aria for automatic generation of random user_id values OR is configured to use account email addresses as user_ids, the generated value will be returned.
a1_out_client_acct_id string The client_acct_id of this account, if one was supplied by the client.
a1_invoicing_error_code long Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call.
a1_invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
a1_invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call.
a1_proc_cvv_response string The processor return code from CVV validation.
a1_proc_avs_response string Processor return code from address validation
a1_proc_cavv_response string The processors return code for security validation.
a1_proc_status_code string The processor status code
a1_proc_status_text string The processors status description
a1_proc_payment_id string The processor payment ID
a1_proc_auth_code string Authorization code provided by the issuing bank
a1_proc_merch_comments string Additional information passed to payment processor
a1_out_new_acct_plan_contracts hash  
Subarray_0807a.jpg a1_out_contract_no long The unique ID of the contract assigned to this account
Subarray_0807a.jpg a1_out_contract_plan_no long The unique ID of the plan to which this contract applies
Subarray_0807a.jpg a1_out_client_contract_plan_id string The client-defined unique ID of the plan to which this contract applies
a1_invoice_charges_before_tax double Charges before tax on the initial invoice for this account
a1_invoice_tax_charges double Tax charges on the initial invoice for this account
a1_invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
a1_invoice_credit_amount double The amount of credit on the initial invoice for this account
a1_invoice_total_amount double The total owed on the initial invoice for this account
a1_new_acct_invoice_line_items hash  
Subarray_0807a.jpg a1_invoice_line_no long The line number on the initial invoice
Subarray_0807a.jpg a1_invoice_plan_no long The unique ID plan this line represents
Subarray_0807a.jpg a1_invoice_plan_name string The name of the plan this line represents
Subarray_0807a.jpg a1_invoice_service_no long The unique ID for the service this line represents
Subarray_0807a.jpg a1_invoice_service_name string The name of the service this line represents
Subarray_0807a.jpg a1_invoice_service_coa_id long The Chart of Accounts ID for the service this line represents
Subarray_0807a.jpg a1_invoice_units double The number of units of the item or plan on this line
Subarray_0807a.jpg a1_invoice_rate_per_unit double The charge per unit of the item or plan on this line
Subarray_0807a.jpg a1_invoice_line_amount double The subtotal amount of this line
Subarray_0807a.jpg a1_invoice_line_description string The long description of this line, used when printing or otherwise displaying invoices
Subarray_0807a.jpg a1_invoice_start_date_range string The starting date range for the item or plan on this line
Subarray_0807a.jpg a1_invoice_end_date_range string If any, the ending date range for the item or plan on this line.
Subarray_0807a.jpg a1_client_invoice_plan_id string The client-defined unique ID plan this line represents
Subarray_0807a.jpg a1_client_invoice_service_id string The client-defined unique ID for the service this line represents
Subarray_0807a.jpg a1_client_invoice_service_coa_code string The Chart of Accounts ID for the service this line represents
a1_third_party_errors hash Errors from third-party systems like taxation engines are returned here, whereas the Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
Subarray_0807a.jpg error_class string The type of error code being represented, such as taxation
Subarray_0807a.jpg error_code string The error code returned by the third party system
Subarray_0807a.jpg error_msg string The error message returned by the third party system
a1_session_id string Returns the newly created Cookie ID of the account.
a2_error_code long Aria-assigned error identifier. 0 indicates no error.
a2_error_msg string Description of any error that occurred. "OK" if there was no error.
a2_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
a2_out_userid string The user ID, unique among all accounts for this Aria client, assigned to the newly created account. If input parameter "user_id" was provided, the same value will be returned. If no "user_id" was provided as input and the client is configured within Aria for automatic generation of random user_id values OR is configured to use account email addresses as user_ids, the generated value will be returned.
a2_out_client_acct_id string The client_acct_id of this account, if one was supplied by the client.
a2_invoicing_error_code long Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call.
a2_invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
a2_invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call.
a2_proc_cvv_response string The processor return code from CVV validation.
a2_proc_avs_response string Processor return code from address validation
a2_proc_cavv_response string The processors return code for security validation.
a2_proc_status_code string The processor status code
a2_proc_status_text string The processors status description
a2_proc_payment_id string The processor payment ID
a2_proc_auth_code string Authorization code provided by the issuing bank
a2_proc_merch_comments string Additional information passed to payment processor
a2_out_new_acct_plan_contracts hash  
Subarray_0807a.jpg a2_out_contract_no long The unique ID of the contract assigned to this account
Subarray_0807a.jpg a2_out_contract_plan_no long The unique ID of the plan to which this contract applies
Subarray_0807a.jpg a2_out_client_contract_plan_id string The client-defined unique ID of the plan to which this contract applies
a2_invoice_charges_before_tax double Charges before tax on the initial invoice for this account
a2_invoice_tax_charges double Tax charges on the initial invoice for this account
a2_invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
a2_invoice_credit_amount double The amount of credit on the initial invoice for this account
a2_invoice_total_amount double The total owed on the initial invoice for this account
a2_new_acct_invoice_line_items hash  
Subarray_0807a.jpg a2_invoice_line_no long The line number on the initial invoice
Subarray_0807a.jpg a2_invoice_plan_no long The unique ID plan this line represents
Subarray_0807a.jpg a2_invoice_plan_name string The name of the plan this line represents
Subarray_0807a.jpg a2_invoice_service_no long The unique ID for the service this line represents
Subarray_0807a.jpg a2_invoice_service_name string The name of the service this line represents
Subarray_0807a.jpg a2_invoice_service_coa_id long The Chart of Accounts ID for the service this line represents
Subarray_0807a.jpg a2_invoice_units double The number of units of the item or plan on this line
Subarray_0807a.jpg a2_invoice_rate_per_unit double The charge per unit of the item or plan on this line
Subarray_0807a.jpg a2_invoice_line_amount double The subtotal amount of this line
Subarray_0807a.jpg a2_invoice_line_description string The long description of this line, used when printing or otherwise displaying invoices
Subarray_0807a.jpg a2_invoice_start_date_range string The starting date range for the item or plan on this line
Subarray_0807a.jpg a2_invoice_end_date_range string If any, the ending date range for the item or plan on this line.
Subarray_0807a.jpg a2_client_invoice_plan_id string The client-defined unique ID plan this line represents
Subarray_0807a.jpg a2_client_invoice_service_id string The client-defined unique ID for the service this line represents
Subarray_0807a.jpg a2_client_invoice_service_coa_code string The Chart of Accounts ID for the service this line represents
a2_third_party_errors hash Errors from third-party systems like taxation engines are returned here, whereas the Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
Subarray_0807a.jpg error_class string The type of error code being represented, such as taxation
Subarray_0807a.jpg error_code string The error code returned by the third party system
Subarray_0807a.jpg error_msg string The error message returned by the third party system
a2_session_id string Returns the newly created Cookie ID of the account.
a3_error_code long Aria-assigned error identifier. 0 indicates no error.
a3_error_msg string Description of any error that occurred. "OK" if there was no error.
a3_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
a3_out_userid string The user ID, unique among all accounts for this Aria client, assigned to the newly created account. If input parameter "user_id" was provided, the same value will be returned. If no "user_id" was provided as input and the client is configured within Aria for automatic generation of random user_id values OR is configured to use account email addresses as user_ids, the generated value will be returned.
a3_out_client_acct_id string The client_acct_id of this account, if one was supplied by the client.
a3_invoicing_error_code long Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call.
a3_invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
a3_invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call.
a3_proc_cvv_response string The processor return code from CVV validation.
a3_proc_avs_response string Processor return code from address validation
a3_proc_cavv_response string The processors return code for security validation.
a3_proc_status_code string The processor status code
a3_proc_status_text string The processors status description
a3_proc_payment_id string The processor payment ID
a3_proc_auth_code string Authorization code provided by the issuing bank
a3_proc_merch_comments string Additional information passed to payment processor
a3_out_new_acct_plan_contracts hash  
Subarray_0807a.jpg a3_out_contract_no long The unique ID of the contract assigned to this account
Subarray_0807a.jpg a3_out_contract_plan_no long The unique ID of the plan to which this contract applies
Subarray_0807a.jpg a3_out_client_contract_plan_id string The client-defined unique ID of the plan to which this contract applies
a3_invoice_charges_before_tax double Charges before tax on the initial invoice for this account
a3_invoice_tax_charges double Tax charges on the initial invoice for this account
a3_invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
a3_invoice_credit_amount double The amount of credit on the initial invoice for this account
a3_invoice_total_amount double The total owed on the initial invoice for this account
a3_new_acct_invoice_line_items hash  
Subarray_0807a.jpg a3_invoice_line_no long The line number on the initial invoice
Subarray_0807a.jpg a3_invoice_plan_no long The unique ID plan this line represents
Subarray_0807a.jpg a3_invoice_plan_name string The name of the plan this line represents
Subarray_0807a.jpg a3_invoice_service_no long The unique ID for the service this line represents
Subarray_0807a.jpg a3_invoice_service_name string The name of the service this line represents
Subarray_0807a.jpg a3_invoice_service_coa_id long The Chart of Accounts ID for the service this line represents
Subarray_0807a.jpg a3_invoice_units double The number of units of the item or plan on this line
Subarray_0807a.jpg a3_invoice_rate_per_unit double The charge per unit of the item or plan on this line
Subarray_0807a.jpg a3_invoice_line_amount double The subtotal amount of this line
Subarray_0807a.jpg a3_invoice_line_description string The long description of this line, used when printing or otherwise displaying invoices
Subarray_0807a.jpg a3_invoice_start_date_range string The starting date range for the item or plan on this line
Subarray_0807a.jpg a3_invoice_end_date_range string If any, the ending date range for the item or plan on this line.
Subarray_0807a.jpg a3_client_invoice_plan_id string The client-defined unique ID plan this line represents
Subarray_0807a.jpg a3_client_invoice_service_id string The client-defined unique ID for the service this line represents
Subarray_0807a.jpg a3_client_invoice_service_coa_code string The Chart of Accounts ID for the service this line represents
a3_third_party_errors hash Errors from third-party systems like taxation engines are returned here, whereas the Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
Subarray_0807a.jpg error_class string The type of error code being represented, such as taxation
Subarray_0807a.jpg error_code string The error code returned by the third party system
Subarray_0807a.jpg error_msg string The error message returned by the third party system
a3_session_id string Returns the newly created Cookie ID of the account.
a4_error_code long Aria-assigned error identifier. 0 indicates no error.
a4_error_msg string Description of any error that occurred. "OK" if there was no error.
a4_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
a4_out_userid string The user ID, unique among all accounts for this Aria client, assigned to the newly created account. If input parameter "user_id" was provided, the same value will be returned. If no "user_id" was provided as input and the client is configured within Aria for automatic generation of random user_id values OR is configured to use account email addresses as user_ids, the generated value will be returned.
a4_out_client_acct_id string The client_acct_id of this account, if one was supplied by the client.
a4_invoicing_error_code long Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call.
a4_invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
a4_invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call.
a4_proc_cvv_response string The processor return code from CVV validation.
a4_proc_avs_response string Processor return code from address validation
a4_proc_cavv_response string The processors return code for security validation.
a4_proc_status_code string The processor status code
a4_proc_status_text string The processors status description
a4_proc_payment_id string The processor payment ID
a4_proc_auth_code string Authorization code provided by the issuing bank
a4_proc_merch_comments string Additional information passed to payment processor
a4_out_new_acct_plan_contracts hash  
Subarray_0807a.jpg a4_out_contract_no long The unique ID of the contract assigned to this account
Subarray_0807a.jpg a4_out_contract_plan_no long The unique ID of the plan to which this contract applies
Subarray_0807a.jpg a4_out_client_contract_plan_id string The client-defined unique ID of the plan to which this contract applies
a4_invoice_charges_before_tax double Charges before tax on the initial invoice for this account
a4_invoice_tax_charges double Tax charges on the initial invoice for this account
a4_invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
a4_invoice_credit_amount double The amount of credit on the initial invoice for this account
a4_invoice_total_amount double The total owed on the initial invoice for this account
a4_new_acct_invoice_line_items hash  
Subarray_0807a.jpg a4_invoice_line_no long The line number on the initial invoice
Subarray_0807a.jpg a4_invoice_plan_no long The unique ID plan this line represents
Subarray_0807a.jpg a4_invoice_plan_name string The name of the plan this line represents
Subarray_0807a.jpg a4_invoice_service_no long The unique ID for the service this line represents
Subarray_0807a.jpg a4_invoice_service_name string The name of the service this line represents
Subarray_0807a.jpg a4_invoice_service_coa_id long The Chart of Accounts ID for the service this line represents
Subarray_0807a.jpg a4_invoice_units double The number of units of the item or plan on this line
Subarray_0807a.jpg a4_invoice_rate_per_unit double The charge per unit of the item or plan on this line
Subarray_0807a.jpg a4_invoice_line_amount double The subtotal amount of this line
Subarray_0807a.jpg a4_invoice_line_description string The long description of this line, used when printing or otherwise displaying invoices
Subarray_0807a.jpg a4_invoice_start_date_range string The starting date range for the item or plan on this line
Subarray_0807a.jpg a4_invoice_end_date_range string If any, the ending date range for the item or plan on this line.
Subarray_0807a.jpg a4_client_invoice_plan_id string The client-defined unique ID plan this line represents
Subarray_0807a.jpg a4_client_invoice_service_id string The client-defined unique ID for the service this line represents
Subarray_0807a.jpg a4_client_invoice_service_coa_code string The Chart of Accounts ID for the service this line represents
a4_third_party_errors hash Errors from third-party systems like taxation engines are returned here, whereas the Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
Subarray_0807a.jpg error_class string The type of error code being represented, such as taxation
Subarray_0807a.jpg error_code string The error code returned by the third party system
Subarray_0807a.jpg error_msg string The error message returned by the third party system
a4_session_id string Returns the newly created Cookie ID of the account.
a5_error_code long Aria-assigned error identifier. 0 indicates no error.
a5_error_msg string Description of any error that occurred. "OK" if there was no error.
a5_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
a5_out_userid string The user ID, unique among all accounts for this Aria client, assigned to the newly created account. If input parameter "user_id" was provided, the same value will be returned. If no "user_id" was provided as input and the client is configured within Aria for automatic generation of random user_id values OR is configured to use account email addresses as user_ids, the generated value will be returned.
a5_out_client_acct_id string The client_acct_id of this account, if one was supplied by the client.
a5_invoicing_error_code long Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call.
a5_invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
a5_invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call.
a5_proc_cvv_response string The processor return code from CVV validation.
a5_proc_avs_response string Processor return code from address validation
a5_proc_cavv_response string The processors return code for security validation.
a5_proc_status_code string The processor status code
a5_proc_status_text string The processors status description
a5_proc_payment_id string The processor payment ID
a5_proc_auth_code string Authorization code provided by the issuing bank
a5_proc_merch_comments string Additional information passed to payment processor
proc_fraud_filter_response string The fraud filtering information provided by the payment processor in response to a fraud filtering request.
a5_out_new_acct_plan_contracts hash  
Subarray_0807a.jpg a5_out_contract_no long The unique ID of the contract assigned to this account
Subarray_0807a.jpg a5_out_contract_plan_no long The unique ID of the plan to which this contract applies
Subarray_0807a.jpg a5_out_client_contract_plan_id string The client-defined unique ID of the plan to which this contract applies
a5_invoice_charges_before_tax double Charges before tax on the initial invoice for this account
a5_invoice_tax_charges double Tax charges on the initial invoice for this account
a5_invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
a5_invoice_credit_amount double The amount of credit on the initial invoice for this account
a5_invoice_total_amount double The total owed on the initial invoice for this account
a5_new_acct_invoice_line_items hash  
Subarray_0807a.jpg a5_invoice_line_no long The line number on the initial invoice
Subarray_0807a.jpg a5_invoice_plan_no long The unique ID plan this line represents
Subarray_0807a.jpg a5_invoice_plan_name string The name of the plan this line represents
Subarray_0807a.jpg a5_invoice_service_no long The unique ID for the service this line represents
Subarray_0807a.jpg a5_invoice_service_name string The name of the service this line represents
Subarray_0807a.jpg a5_invoice_service_coa_id long The Chart of Accounts ID for the service this line represents
Subarray_0807a.jpg a5_invoice_units double The number of units of the item or plan on this line
Subarray_0807a.jpg a5_invoice_rate_per_unit double The charge per unit of the item or plan on this line
Subarray_0807a.jpg a5_invoice_line_amount double The subtotal amount of this line
Subarray_0807a.jpg a5_invoice_line_description string The long description of this line, used when printing or otherwise displaying invoices
Subarray_0807a.jpg a5_invoice_start_date_range string The starting date range for the item or plan on this line
Subarray_0807a.jpg a5_invoice_end_date_range string If any, the ending date range for the item or plan on this line.
Subarray_0807a.jpg a5_client_invoice_plan_id string The client-defined unique ID plan this line represents
Subarray_0807a.jpg a5_client_invoice_service_id string The client-defined unique ID for the service this line represents
Subarray_0807a.jpg a5_client_invoice_service_coa_code string The Chart of Accounts ID for the service this line represents
a5_third_party_errors hash Errors from third-party systems like taxation engines are returned here, whereas the Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
Subarray_0807a.jpg error_class string The type of error code being represented, such as taxation
Subarray_0807a.jpg error_code string The error code returned by the third party system
Subarray_0807a.jpg error_msg string The error message returned by the third party system
a5_session_id string Returns the newly created Cookie ID of the account.
proc_initial_auth_txn_id string Transaction ID from payment processor.  If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement.
proc_fraud_filtering_info array The fraud filtering information provided by the payment processor as described below.
Subarray_0807a.jpgproc_fraud_country_status string Fraud country status provided by the payment processor.
Subarray_0807a.jpgproc_fraud_country_code string Fraud country code provided by the payment processor.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®