Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Crescendo APIs Bucket > AC-API DEV-10591 BT Tokenized ACH API r47 wk > update_acct_complete_m

update_acct_complete_m

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

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

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

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.

For information on error messages generated by this API, see update_acct_complete_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 This is the client-assigned identifier for the account.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  userid string 32 The user's unique identifier. Every account must have an associated user ID.
  password string 100 Password for the given user
  secret_question string 300 The user's secret question recorded to recover a password.
  secret_question_answer string 300 The response to a user's secret_question
  pin string 10 Persinal Identification number
  acct_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields are ignored.
  acct_contact_no long 100 The Aria-assigned unique identifier for the account contact saved on the account.
  first_name string 32 Contact First name
  mi string 2 The Middle Initial of the contact.
  last_name string 32 Contact last name
  company_name string 100 Company name of the contact
  address1 string 300 First address line of the contact.
  address2 string 300 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.
  address3 string 300 Third 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.
  city string 32 City of the contact
  locality string 32

Locality of the contact. Use this field instead of the <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.
  state_prov string 10 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 <locality> field for addresses in those countries.
  country_cd string 2 Country of the contact as the ISO-compliant 2-character country code abbreviation in uppercase. If you enter contact address information, but leave this field blank, then this field defaults to "US". If no contact address information is entered, this field remains blank.
  postal_cd string 15 Postal/Zip code for the contact address.
  phone string 25 The phone number of the contact
  phone_ext string 10 The extension for the contact phone
  cell_phone string 20 The contact cell phone.
  work_phone string 25 Work phone number of the contact.
  work_phone_ext string 10 The extension for the contact work phone
  fax string 25 The FAX phone number for the contact.
  email string 320 Email of the contact
  birthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  status_cd long 8 The status to which you are setting this account.  
Values Description
0 DEACTIVATED
1 ACTIVE
32 REGISTERED PENDING ACTIVATION
51 TEMPORARY SERVICE BAN
99 PERMANENT
-99 ARCHIVED
  notify_method long 2 How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).  
Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
15 XML Master File and HTML Email
16 XML Master File and Text Email
17 PDF Master File and HTML Email
  notification_template_group_no long 22 Notify template number. Aria-assigned unique identifier for the notification template group to be associated with the account.
  client_notification_template_group_id string 50

Client-defined unique identifier for the notification template group to be associated with the account.
  senior_acct_no long 22 The senior_acct_no is the unique account number for the parent account and is used to establish parent-child billing relationships. To remove a parent account from a child account, you must enter '-999' in this field.
  senior_acct_userid string 32 User ID of the parent account
  senior_client_acct_id string 50 Client-account ID of the parent account
  test_acct_ind long 1 Indicates that the account is a test account and is treated as such in the system. The default value is 0.  
Values Description
1 test
0 live
  taxpayer_id string 32 Taxpayer Identification number.
  alt_client_acct_group_id string 100 One-time collections account group to use for this specific call. Default collections group on the account is not changed.
  acct_coupon_cd string array 30 The coupon codes to assign to this account, if any
  acct_start_date string 10 Date, in yyyy-mm-dd format, on which the account was first created outside of Aria
  alt_msg_template_no long 22 Email template number to assign to this account.
  OR      
  client_alt_msg_template_id string 100 Client-defined email template ID assigned to this account.
  cn_alt_msg_template_no long 22 Email template number to assign to this account.
  OR      
  client_cn_alt_msg_template_id string 100 The client-defined alternate email template ID to use for this account
  seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  client_seq_func_group_id string 100 Client-defined functional account group number specifically designated for statement sequence number assignment.
  tax_exemption_level long 1 Provides the Tax Exemption Level for the account. This field only applies to the Aria internal tax engine.  
Values Description
0 Account is not exempt from taxation (default).
1 Account is exempt from state/province taxation.
2 Account is exempt from federal/national taxation.
3 Account is exempt from both federal/national and state/province taxation.
  reset_dates_after_status string 5 If 'true', resets the billing dates after an account status change.  
Values Description
true true
false false
  new_client_acct_id string 50 New Client-defined account ID for updating existing Client-defined account ID.
  invoicing_option long 1 Indicator for performing full invoicing, prorated invoicing or client-defined on this account as part of this call.  
Values Description
1 Perform full invoicing
2 Perform prorated invoicing
3 use client default
4 None
  alt_start_date string 10 This is an alternative start date, in yyyy-mm-dd format, for the master plan instance being updated/assigned. This date can be used to delay providing services to the account holder (for example: until they have been email validated). This date must be within one billing interval of the plan being updated/assigned.
  alt_bill_day long 2 Number specifying a day of the month to use as an alternate bill day. You can enter a bill date other than the anniversary date in this field. The invoice_mode must be set to 0 or must be blank to enter a date in this field, it cannot be set to 1.
  retroactive_start_date string 10 Date, in yyyy-mm-dd format, to set for retroactive start.
Start of functional_acct_groups_update array
  functional_acct_groups_update array   Array of functional group values to update.
  Field Name Field Type Max Length Description
  brd_arrow.giffunctional_acct_group_no long 22 Functional account group number to update or assign.
  OR      
  brd_arrow.gifclient_functional_acct_group_id string 100 Functional account group id to update or assign to this account.
  brd_arrow.giffunctional_acct_grp_directive long 1 Specifies the action to take for this functional account group. 
Values Description
1 Assign the account to the group.
2 Remove the account from the group.
End of functional_acct-groups_update array
 
Start of collection_acct_groups_update array
  collection_acct_groups_update array   Array of collection account group values to update.
  Field Name Field Type Max Length Description
  brd_arrow.gifcollection_acct_group_no long 22 The collection account group number to update or assign to the account.
  brd_arrow.gifclient_collection_acct_group_id string 100 The collection account group id to update or assign to the account
  brd_arrow.gifcollection_acct_grp_directive long 1 Whether to add or remove the account to or from the specified groups  
Values Description
1 Assign the account to the group.
2 Remove the account from the group.
End of collection_acct_groups_update array
 
Start of acct_supp_fields_update array
  acct_supp_fields_update array   Array of objects to be updated. Each object contains a list of values for one of the following fields: acct_supp_field_name, acct_supp_field_value, or acct_supp_field_directive. 
  Field Name Field Type Max Length Description
  brd_arrow.gifacct_supp_field_name string 100 Supplemental field name. This value is required if you want to assign a supplemental field. 
  brd_arrow.gifacct_supp_field_value string 300 Supplemental field value.
  brd_arrow.gifacct_supp_field_directive long 1 Supplemental field directive. Specifies what action to take.  
Values Description
1 Add the supplemental field and value to the account (default).
2 Replace all instances of the supplemental field with the given value.
3 Remove the supplemental field and value. If the supplemental field exists with values other than the one given, those will remain untouched.
4 Remove all instances of the supplemental field. Any given value is ignored.
End of acct_supp_fields_update array
 
Start of account_surcharges array
  account_surcharges array    
  Field Name Field Type Max Length Description
  brd_arrow.gifsurcharge_no long 22 The Surcharge number to be attached to the account
  brd_arrow.gifsurcharge_directive long 1 The surcharge directive to assign/remove the surcharge from the account  
Values Description
1 Apply surcharge to account
2 Remove surcharge from account
  brd_arrow.gifrate_schedule_no long 22 The Schedule number for this surcharge
End of account_surcharges array
 
  client_master_plan_instance_id string 100 Client-defined unique identifier for Master plan instance
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  new_client_master_plan_instance_id string 100 New Client-defined master plan instance ID for updating existing Client-defined master plan instance ID.
  client_master_plan_id string 100 Client-defined unique identifier for Master plan
  master_plan_no long 22 Master plan number
  master_plan_instance_desc string 1000 Master plan instance description
  dunning_group_no long 22 Dunning group to assign to master plan instance
  client_dunning_group_id string 100 Client-defined unique identifier of dunning group to assign to master plan instance
  mp_billing_group_no long 22 Billing group to assign to master plan instance (Note: This is mandatory when converting an MPI from parent-pay to self pay.)
  client_mp_billing_group_id string 100 Client-defined unique identifier of billing group to assign to master plan (Note: This is mandatory when converting an MPI from parent-pay to self pay.)
  master_plan_instance_status long 8 Master plan instance status  
Values Description
-3 Terminated
-2 Cancelled
-1 Suspended
0 Inactive
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
  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.
  resp_level_cd long 1 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  
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'
  parent_master_plan_inst_no (DEPRECATED) long 22 The system-defined master plan instance number of the parent account. This field is required if the resp_level_cd is not equal to 1
  alt_rate_schedule_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  client_alt_rate_schedule_id string 100 The client-defined unique alternate rate schedule identifier for the master plan
  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. For promo code removal, use the alpha erase indicator value '~' (tilde).
  mp_coupon_cd string array 30 The coupon codes to assign to this master plan instance, if any
  master_plan_assign_directive long 2 The scope rule to be applied to this assignment/de-assignment request, governing both the date upon which the assignment should take place (immediately or on the account's anniversary date) and the proration rule that should be applied (per client's default rules for proration on plan assignment v. forcing proration on or off for this request only). Default behavior is to assign plan to account on the account's anniversary date, resulting in no proration effect. Usage-arrears charges, recurring-in-arrears charges, and any plan cancellation fees (if applicable) will be invoiced during plan cancellation, as these charges are independent of assignment directive. 
Values Description
1 (Default) Perform the requested plan update on the account's next scheduled billing anniversary date. The account will not receive service under this plan (for master plan number updates) until that date. Initial billing for a full period of the given plan update will be performed on the account's next scheduled anniversary date. No charge or credit proration effect.
2 Perform the requested plan update immediately, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan update.
3 Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION
4 Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
5 Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY.
6 Perform the requested plan update immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY.
7 Perform the requested plan assignment/de-assignment on the specified effective_date, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment.
8 Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION.
9 Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
10 Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when calling the cancel_supp_plan API.
11 Perform the requested plan assignment/de-assignment on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when calling the assign_supp_plan API.
  offset_months long 4 Number of months to add to the prorated period.
  offset_interval long 4 If assigning a change on an anniversary day, the number of billing periods by which to delay that change. If the new plan is different from the old plan, and this value is greater than 0, then the billing date continues to be the annniversary date.
  invoice_unbilled_usage string 5 Specifies whether to invoice the unbilled usage if a plan is terminated in the middle of a billing period.  
Values Description
false Do not allow invoicing the unbilled usage during mid-term plan termination.
true Allow invoicing the unbilled usage during mid-term plan termination.
  invoice_approval_required string 5 Boolean indicator to override client's default configured behaviour for creating Pending/Real invoice.  
Values Description
true Attempts to create a pending invoice. Note: if client is configured for real invoices, passing "True" here overrides the client setting.
false Attempts to create a real invoice. Note: if client is configured for pending invoices, passing "False" here overrides the client setting.
null If NULL, defaults to the client configuration setting
  status_degrade_date string 10 Specifies the date, in yyyy-mm-dd format, to degrade the account status. DEPRECATED.
  usage_accumulation_reset_months long 4 The number of reset months for each plan.
  usage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.  
Values Description
true Usage pooling is enabled for this plan instance.
false Usage pooling is not enabled for this plan instance. (default)
  usage_threshold_applicability string 2 Usage tracking options on the plans in the account  
Values Description
UT Usage Type
UP Usage Pool
Start of master_plan_plan_inst_fields array
  master_plan_plan_inst_fields array    
  Field Name Field Type Max Length Description
  brd_arrow.gifplan_instance_field_name string 300 Required based on the definition of each plan instance field associated with the new plan.
  brd_arrow.gifplan_instance_field_value string 1000 The value of the product field. Values for product fields that do not match what is expected based on product field configuration will be ignored.
  brd_arrow.gifplan_instance_field_directive long 1 Required for each plan instance field provided.  
Values Description
1 Add name and value for a new plan instance field.'
2 Replace value of an existing plan instance field.
3 Remove the value of an existing plan instance field, note that if the plan instance field is required based on the field definition, the Replace directive should be used.
4 Remove the name and value of an existing plan instance field from the plan instance.
End of master_plan_plan_inst_fields array
 
Start of mp_surcharges array
  mp_surcharges array   Surcharge for master plan
  Field Name Field Type Max Length Description
  brd_arrow.gifmp_surcharge_no long 22 The surcharge number to assign to or remove from the master plan.
  brd_arrow.gifmp_surcharge_directive long 1 The surcharge directive to assign/remove the surcharge from the master plan instance  
Values Description
1 Apply surcharge to account
2 Remove surcharge from account
  brd_arrow.gifmp_rate_schedule_no long 22 The rate schedule number for pricing the surcharge.
End of mp_surcharges array
 
Start of update_acct_custom_rates array
  update_acct_custom_rates array    
  Field Names Field Type Max Length Description
  brd_arrow.gifcustom_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.
  brd_arrow.gifcustom_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.
  brd_arrow.gifcustom_rate_from_unit long 22 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.
  brd_arrow.gifcustom_rate_to_unit long 22 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.
  brd_arrow.gifcustom_rate_per_unit double 22 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.
  brd_arrow.gifcustom_rate_client_service_id string 100 The unique identifier by client the service ID to determine which custom rate is to be applied for this account.
  OR      
  brd_arrow.gifcustom_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.
End of update_acct_custom_rates array
 
Start of billing_groups_array array
  billing_groups_array array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbilling_group_name string 100 Billing Group name
  brd_arrow.gifbilling_group_description string 1000 Billing group description
  brd_arrow.gifbilling_group_no long 22 Billing group number
  brd_arrow.gifclient_billing_group_id string 100 Client-defined billing group ID. This value must be unique across all client accounts. This field can also be used as a reference to assign this billing group to one or more master plan instances within this API request.
  brd_arrow.gifbg_notify_method long 22 How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).  
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
  brd_arrow.gifnotification_template_group_no long 22 Notify template number. 

Aria-assigned unique identifier for the notification template group to be associated with the account.
  brd_arrow.gifclient_notification_template_group_id string 50

Client-defined unique identifier for the notification template group to be associated with the account.
  brd_arrow.gifstatement_template long 22 Statement template number.
  brd_arrow.gifcredit_note_template long 22 Credit note template No.
  brd_arrow.gifpayment_option string 7 This allows you to select either payment methods (such as a card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'  
Values Description
Methods Methods
Terms Terms
  brd_arrow.gifprimary_payment_method_no long 22 Primary payment method ID (Note: The same pay method sequence number cannot be used for the primary and secondary payment method).
  brd_arrow.gifclient_primary_payment_method_id string 100 Client-defined unique identifier of the primary payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method).
  brd_arrow.gifbackup_payment_method_no long 22 Backup payment method ID (Note: The same pay method sequence number cannot be used for the primary and secondary payment method).
  brd_arrow.gifclient_backup_payment_method_id string 100 Client-defined unique identifier of the backup payment method. The payment method specified must be the same as the primary payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method).
  brd_arrow.gifstmt_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.
  brd_arrow.gifstmt_contact_no long 22 The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
  brd_arrow.gifstmt_first_name string 32 Statement contact first name
  brd_arrow.gifstmt_mi string 2 The Middle Initial of the statement contact.
  brd_arrow.gifstmt_last_name string 32 Statement contact Last name
  brd_arrow.gifstmt_company_name string 100 Company name of the statement contact
  brd_arrow.gifstmt_address1 string 300 First address line of the statement contact
  brd_arrow.gifstmt_address2 string 300 Second address line of the statement contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  brd_arrow.gifstmt_address3 string 300 Thirs address line of the statement contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  brd_arrow.gifstmt_city string 300 City of the statement contact
  brd_arrow.gifstmt_locality string 300

Locality of the statement contact. Use this field instead of the <stmt_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.
  brd_arrow.gifstmt_state_prov string 10 State or province of the statement 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 <stmt_locality> field for addresses in those countries.
  brd_arrow.gifstmt_country string 2 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifstmt_postal_cd string 15 Postal/Zip code for the statement contact address.
  brd_arrow.gifstmt_phone string 25 The phone number of the statement contact
  brd_arrow.gifstmt_phone_ext string 10 The extension for the statement contact phone
  brd_arrow.gifstmt_cell_phone string 20 The contact cell phone of the statement contact.
  brd_arrow.gifstmt_work_phone string 25 Work phone number of the statement contact.
  brd_arrow.gifstmt_work_phone_ext string 10 The extension for the statement contact work phone
  brd_arrow.gifstmt_fax string 25 The fax number for the statement contact.
  brd_arrow.gifstmt_email string 320 Email of the statement contact
  brd_arrow.gifstmt_birthdate string 10 The birthdate, in yyyy-mm-dd format, of the statement contact.
  brd_arrow.gifbg_list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.  
Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
  brd_arrow.gifpayment_terms_no long 22 Payment terms number assigned to the account.
  brd_arrow.gifpayment_terms_name string 50 Payment terms name assigned to the account.
  brd_arrow.gifclient_payment_term_id string 100 Client-defined identifier for the billing group's payment term
  brd_arrow.gifean_gln_num string 50 The European Article Number or Global Location Number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria's client's customers and is unique to each customer (account).
  brd_arrow.gifean_gln_requisition_num string 50 The European Article Number requisition number or Global Location Number requisition number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria's client's customers and is used to track their individual projects similarly to a purchase order. This number is generated by the individual customer (account) and is not provided by any other party.
  brd_arrow.gifcredit_memo_template long 22 Credit template No.
  brd_arrow.gifrebill_template long 22 Rebill template No.
  brd_arrow.gifcollection_group_bg_row array  

Array of collection groups that should be added to or removed from the specified billing groups.

For cost savings or for other reasons, you may choose to have payments made with a particular payment method (associated with a billing group) processed by a specific payment gateway. To do so, you can assign a collection group to a billing group by passing values into the collection_group_bg_row array.

Notes:

  • Aria will use this order of precedence when selecting the payment gateway to use for processing a payment:
  1. Collection group assigned to the billing group associated with the master plan instance being invoiced;
  2. Collection group to which the customer is assigned at the account level.
  • Aria now will allow accounts to have multiple billing groups with different collection groups when using tokenized credit cards that were tokenized outside of Aria. To facilitate multiple payment methods, the billing agreement ID (token) is validated against the specific collection group. When there is no collection group specified, then the agreement ID will be validated against the account level collection group. When no collection group at account level or billing group level is specified, then the agreement ID will be validated against the last processor mapped to that client.
    brd_arrow.gifbrd_arrow.gifcollections_group_bg_no long 22 Aria-assigned identifier of the collection group to assign to the specified billing group.
 
    brd_arrow.gifbrd_arrow.gifclient_collections_group_bg_id string 100 Client-defined identifier of the collection group to assign to the specified billing group.
    brd_arrow.gifbrd_arrow.gifcollections_grp_directive long 1 Indicates whether the identified collection group should be assigned to or removed from the specified billing group.
Values Description
1 Assign the collection group to the billing group.
2 Remove the collection group from the billing group.
End of billing_groups_array array
 
Start of payment_methods_array array
  payment_methods_array array    
  Field Name Field Type Max Length Description
  brd_arrow.gifpayment_method_no long 22 Aria-assigned sequence number for this payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method).
  brd_arrow.gifbill_contact_idx long 32 For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.
  brd_arrow.gifbill_contact_no long 22 The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
  brd_arrow.gifbill_first_name string 300 First name of the billing contact.
  brd_arrow.gifbill_middle_initial string 2 Middle initial of the billing contact.
  brd_arrow.gifbill_last_name string 300 Last name of the billing contact.
  brd_arrow.gifbill_company_name string 100 Company name of the billing contact.
  brd_arrow.gifbill_address1 string 300 First address line of the billing contact.
  brd_arrow.gifbill_address2 string 300 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.
  brd_arrow.gifbill_address3 string 300 The third line of the billing address.
  brd_arrow.gifbill_city string 300 City of the billing contact.
  brd_arrow.gifbill_locality string 300

Locality of the billing contact. Use this field instead of the <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.
  brd_arrow.gifbill_state_prov string 10 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 <bill_locality> field for addresses in those countries.
  brd_arrow.gifbill_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifbill_postal_cd string 15 Postal code for the billing contact.
  brd_arrow.gifbill_phone string 25 Phone number of the billing contact.
  brd_arrow.gifbill_phone_ext string 10 Phone extension of the billing contact.
  brd_arrow.gifbill_cell_phone string 20 Cell phone number of the billing contact.
  brd_arrow.gifbill_work_phone string 25 Work phone number of the billing contact.
  brd_arrow.gifbill_work_phone_ext string 10 This is the work phone extension for the billing contact work phone.
  brd_arrow.gifbill_fax string 25 Fax number of the billing contact.
  brd_arrow.gifbill_email string 320 Email of the billing contact.
  brd_arrow.gifbill_birthdate string 10 Birthdate of the billing contact.
  brd_arrow.gifpay_method_name string 100 Human-readable name of the payment method
  brd_arrow.gifclient_pay_method_id string 100 Client-defined unique identifier for the payment method.
  brd_arrow.gifpay_method_description string 1000 Payment method description
  brd_arrow.gifpay_method_type long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, etc.  
Values Description
-1 External Payment
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
8 Click&Buy
10 PayByCash
11 PayPal Express Checkout
13 Tokenized Credit Card
14 Purchase Power
20 NETS
21 FIK
26 Direct Debit
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
48 Tokenized ACH
  brd_arrow.gifcc_num string 20 Card number.
  brd_arrow.gifcc_expire_mm long 2 Expiration month for the card payment instrument.
  brd_arrow.gifcc_expire_yyyy long 4 Expiration year for the card payment instrument.
  brd_arrow.gifbank_acct_num string 19 The bank account number. The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.
  brd_arrow.gifbank_routing_num string 9 The American Banking Association (ABA) routing number for the financial institution. The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.
  brd_arrow.gifcvv string 6 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the card.
  brd_arrow.giftrack_data1 string 300 Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request
  brd_arrow.giftrack_data2 string 300 Raw "track 2" data from a swiped card used in a card-present transaction to initiate this request
  brd_arrow.gifbill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token). The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.
  brd_arrow.gifiban 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.
  brd_arrow.gifbank_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.
  brd_arrow.gifbank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). It is 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.
  brd_arrow.gifbank_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.
  brd_arrow.gifmandate_id string 35 Used for the Direct Debit payment method. 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.
  brd_arrow.gifbank_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.
  brd_arrow.gifbank_branch_cd string 10 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.
  brd_arrow.gifbank_name string 100 Bank name for the account payment method.
  brd_arrow.gifbank_city string 100 Bank city for the account payment method.
  brd_arrow.gifdo_collect string 5 If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances.  
Values Description
true true
false false
  brd_arrow.gifchange_status_after_coll string 5 If 'true' the account status is is changed after a collection is completed.  
Values Description
0 Do not reset the MPI status to active
1 Reset the MPI status to active when its current status is any non-active status.
2 Reset the MPI status to active only when its current status "Suspended" (default).
3 Reset the MPI status to active only when its current is either "Suspended" or "Terminated"
  brd_arrow.gifcc_id long 2 A numeric code indicating the type of card.  
Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club/Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankoort
End of  payment_methods_array array
 
  revrec_profile_no long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  client_revrec_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_no.
  mp_proration_invoice_timing long 1 Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date. Note that this will override the Proration Invoice Timing configuration saved with the plan in the product catalog.  
Values Description
Null(default) Honor Proration Invoice Timing configuration saved with the plan in the product catalog.
0 Generate the invoice immediately for the pro-rated charges.
1 Generate the invoice on the next anniversary date for the pro-rated charges.
  po_num string 100 Purchase order number assigned to the account.
  mp_po_num string 100 : Purchase order number assigned to a master plan instance.
  list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.  
Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 50 Name of the locale.
Start of contacts_list array
  contacts_list array   Contact information for a contact object to be created on the account. Note that contacts not used as an account contact, billing contact, or statement contact will be saved on the account.
  Field Name Field Type Max Length Description
  brd_arrow.gifaddr_contact_idx long 32 The Aria-assigned address sequence number.
  brd_arrow.gifaddr_first_name string 32 The first name of the contact.
  brd_arrow.gifaddr_middle_initial string 2 The middle initial of the contact.
  brd_arrow.gifaddr_last_name string 32 The last name of the contact.
  brd_arrow.gifaddr_company_name string 100 The company name of the contact.
  brd_arrow.gifaddr_address1 string 100 The first address line of the contact.
  brd_arrow.gifaddr_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
  brd_arrow.gifaddr_address3 string 100 The third line of the address
  brd_arrow.gifaddr_city string 32 The city of the contact.
  brd_arrow.gifaddr_locality string 32 The locality of the contact. 

Use this field instead of the <addr_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.
  brd_arrow.gifaddr_state_prov string 10 The 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 <addr_locality> field for addresses in those countries.
  brd_arrow.gifaddr_country string 2 The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifaddr_postal_cd string 14 The postal/zip code of the contact.
  brd_arrow.gifaddr_phone string 25 The phone number of the contact.
  brd_arrow.gifaddr_phone_ext string 10 The phone number extension of the contact.
  brd_arrow.gifaddr_cell_phone string 20 The cell phone number of the contact.
  brd_arrow.gifaddr_work_phone string 25 The work phone number of the contact.
  brd_arrow.gifaddr_work_phone_ext string 10 The work phone number extension of the contact.
  brd_arrow.gifaddr_fax string 25 The fax number of the contact.
  brd_arrow.gifaddr_email string 320 The email address of the contact.
  brd_arrow.gifaddr_birthdate string 10 The birthdate of the contact.
End of contacts_list array
 
  legal_entity_no long 22 Aria-assigned legal entity identification number. You can only update this field if the account has not yet been assigned to a legal entity, and if legal entities are enabled for this client.
  OR      
  client_legal_entity_id string 50 Client-assigned unique identifier for the legal entity.
  plan_instance_supp_field_update_only long 1 This field controls the ability to update plan instance fields on a plan that is in non-provisioned status.  
Values Description
  This input will not allow plan instance fields to be update for plans that are in a non-provisioned status
0 This input will not allow plan instance fields to be update for plans that are in a non-provisioned status
1 This input will allow plan instance fields to be update for plans that are in a non-provisioned status
  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.
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Transaction qualifier values you can associate with this API call.
  Field Name Field Type Max length Description
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
End of optional_transaction_qualifiers array
 
  remove_pi_custom_rates string 5

Determines whether to keep or remove any custom rates assigned to a plan instance when you change the rate schedule of that plan instance.

Values Description
true Remove the custom rates and use the default rates of the new rate schedule that you assigned.
false (default) Keep the custom rates currently assigned to the plan instance.
  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.
  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.
     
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.
Start of fraud_control_fields array
  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.
  Field Name Field Type Max Length Description
  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.
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.
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 master plan instance.
  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.
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 master plan instance.
  brd_arrow.gif
change_mp_status_on_fraud_filtering_cc_prefix_failure		 string 100 Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post)
Values Description
0 false
1 true
  brd_arrow.gif
mp_status_on_fraud_filtering_cc_prefix_failure		 string 100 If change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
    brd_arrow.gifchange_mp_status_on_fraud_filtering_cc_number_failure string 100 Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the 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)
Values Description
0 false
1 true
    brd_arrow.gifmp_status_on_fraud_filtering_cc_number_failure string 100 If change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gif
change_mp_status_on_fraud_filtering_cc_issuing_country_failure		 string 100 Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post)
Values Description
0 false
1 true
  brd_arrow.gif
mp_status_on_fraud_filtering_cc_issuing_country_failure		 string 100 If change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gif
change_mp_status_on_fraud_filtering_cc_issuing_country_suspect		 string 100 Indicates whether to change the status of the master plan instance(s) if the fraud filtering check for the credit card issuing country returned a "suspect" value. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post)
Values Description
0 false
1 true
  brd_arrow.gif
mp_status_on_fraud_filtering_cc_issuing_country_suspect		 string 100 If change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
End of fraud_control_fields array
 
  stmt_email_list_cc string 3000

Comma-delimited list of email addresses to which the account holder's statements should be cc'd (carbon copied).

If you want to delete existing email addresses in this field, you must enter a '~'.


Note: The list passed in will replace, not be added to, the existing list of email addresses.
  stmt_email_list_bcc string 3000

Comma-delimited list of email addresses to which the account holder's statements should be bcc'd (blind carbon copied).

If you want to delete existing email addresses in this field, you must enter a '~'.


Note: The list passed in will replace, not be added to, the existing list of email addresses.  
  force_currency_change string 5 Force currency change during update. Necessary to accommodate for an account holder moving from one area to another where the local currency is different.
Values Description
true When the plan being updated has a rate schedule with a different currency or the supplied alternate rate schedule has rates defined in different currency, a 'true' value will allow the currency change provided that there are no transactions (or only $0 transaction present) for that account and the new plan/alt rate schedule has the rates defined in the target currency.
false When the plan being updated has a rate schedule with a different currency the supplied alternate rate schedule has rates defined in different currency, a 'false' value will not allow the currency change.
  recurring_processing_model_ind long 1 Defines a recurring payment type for Credit Card and Tokenized Credit Cards. 
Values Description
0 Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1 Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2 Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3 Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.
  usage_accumulation_reset_months_renewal_option lomg 1 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.  
Values Description
NULL or 1 Recurring / Auto Renew.(Default)
2 Single Use.
  include_plan_instance_queue string 5

Use this field to obtain the list of plan changes that you scheduled using this API.

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

Bill lag days are the number of days prior to (negative) or after (positive) an account billing date at which an invoice should be generated for your specified master plan instance. 

Negative bill lag days are typically used for subscription-based services (often subscription-based services paid using net terms), for which you would like to send out invoices to your customers well in advance of the real invoice date. This gives your customers time to receive a paper or email invoice (statement) and send a payment before the actual invoice date.

Positive bill lag days typically apply to usage-based services. 

Examples:

  • If you want an invoice to be generated 14 days before the billing date, pass -14 into this field.
  • If you want an invoice to be generated 10 days after the billing date, pass 10 into this field.

By default, bill lag days are restricted to +/- the (minimum number of days in a recurring billing period – 1 day). However, if your  Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle parameter is set to True (in the Aria application under Configuration > Billing> Invoice Settings), then the negative value can go beyond a single billing period.

Bill lag days can be removed via APIs update_acct_plan_m, replace_acct_plan_m, update_acct_plan_multi_m and update_acct_complete_m). To remove the MPI bill lag days, pass the standard "numeric erase" indicator of a tilde (~) for <bill_lag_days> input.

Note:

  • Although ‘-999’ happens to be a valid bill_lag_days value when the your parameter “_Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle_” is “True”, it is obviously not practical as a real value on the APIs as there are not many plausible scenarios where a customer would be invoiced that far in advance.

Aria will set the bill lag days for plans using this order of precedence:

  1. Master plan instance (for a given account)
  2. Collection group setting
  3. Payment terms/payment method setting
  4. Client setting (Configuration > Billing > Bill Lag Days)

Notes:

  • You cannot pass a value into the <bill_lag_days> field by itself. You must also pass in a value to update the plan units, plan status, and/or alternate rate schedule.
  • <bill_lag_days> cannot be passed in as part of an API call used to schedule changes that will take place on a customer's anniversary date. You must set the <bill_lag_days> to go into effect on a date other than the anniversary date.

    Example: If you have an MPI replacement scheduled for a customer's anniversary date, you should not set <bill_lag_days> in the API used for the MPI replacement. If you do, Aria will ignore the <bill_lag_days>.
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/Vantiv > Gateway Options; and
    • Configuration > Payments > Collection Groups > Chase Paymentech/Vantiv > Collection Group Options.
  • Currently, only Chase Paymentech and Vantiv support this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.
 

Aria will use this order of precedence to determine the transaction type:

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

resp_master_plan_instance_no

 

 

 

OR

 

resp_client_master_plan_instance_id

long

 

 

 

 

 

string

22

 

 

 

 

 

100

The Aria-assigned identifier of the master plan instance that will have payment responsibility for the assigned plan.     

Required if the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options.
 

 

The client-defined identifier of the master plan instance that will have payment responsibility for the assigned plan.    


Required if the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options.

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.
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string The error message associated with collection_error_code.
parent_child_sync_error_code long The result of the synchronization of the parent/child billing dates (if attempted).
parent_child_sync_error_msg string The corresponding text error message for the parent_child_sync_error_code value.
master_plan_error_code long Error code returned upon failure when attempting to update the master plan
master_plan_error_msg string Human-readable error message corresponding to master_plan_error_code
master_plan_coll_error_code long Error code for master plan collection errors.
master_plan_coll_error_msg string Human-readable error text corresponding to the master_plan_coll_error_code
master_plan_stmt_error_code long Error code returned upon failure to update the master plan statement
master_plan_stmt_error_msg string Human-readable error message corresponding to master_plan_stmt_error_code.
proc_cvv_response string The processor return code from CVV validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string The processors return code for security validation.
proc_status_code string The processor status code
proc_status_text string The processors status description
proc_payment_id string The processor payment ID
proc_auth_code string Authorization code provided by the issuing bank
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.
proc_fraud_filtering_info array The fraud filtering information provided by the payment processor as described below.
brd_arrow.gifproc_fraud_country_status string Fraud country status provided by the payment processor.
brd_arrow.gifproc_fraud_country_code string Fraud country code provided by the payment processor.
third_party_errors hash Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.
brd_arrow.gif error_class string The type of error code being represented, such as taxation
brd_arrow.gif error_code string The error code returned by the third party system
brd_arrow.gif error_msg string The error message returned by the third party system
master_plan_instance_id long Master plan instance number
out_client_mp_instance_id string Client-defined unique identifier for Master plan instance
out_master_plan_no long Master plan number
out_client_master_plan_id string Client-defined unique identifier for Master plan
out_master_plan_instance_description string Master plan instance description
master_plan_proration_result_total_amount double Master plan proration total amount
master_plan_proration_amount double Master plan proration amount
master_plan_proration_tax_amount double Master plan proration tax amount
master_plan_proration_surcharge_amount double Master plan proration surcharge amount
master_plan_proration_credit_amount double Master plan prorration credit amount
supp_plan_instance_id long Supplemental plan instance number
out_client_supp_plan_instance_id string Client-defined unique identifier for supplemental plan instance
supp_plan_proration_amount double Supplemental plan proration amount
supp_plan_proration_tax_amount double Supplemental plan proration tax amount
supp_plan_proration_surcharge_amount double Supplemental plan proration surcharge amount
supp_plan_proration_credit_amount double Supplemental plan proration credit amount
out_invoice_no long The unique identifier of a given invoice.
out_billing_group_no long Billing group number
out_client_billing_group_id string Client-defined unique identifier for billing group
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED
acct_locale_no_2 long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
acct_contact_no long The Aria-assigned unique identifier for the account contact saved on the account. DEPRECATED
acct_contact_no_2 long The Aria-assigned unique identifier for the account contact saved on the account.
billing_contact_details hash List of billing contacts saved on the account.
brd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method).
brd_arrow.gif bill_contact_no long The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
statement_contact_details hash List of statement contacts saved on the account.
brd_arrow.gif billing_group_no long The Aria-assigned unique identifier for the billing group on the account.
brd_arrow.gif stmt_contact_no long The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
other_contact_details hash List of contacts saved on the account that are not used as an account, billing, or statement contact.
brd_arrow.gif other_contact_no long The Aria-assigned unique identifier for the contact saved on the account.
brd_arrow.gif other_contact_idx long Value provided for the idx parameter in the API request.
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.
chief_acct_info hash

Array of information about the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy. Example: if you have a child account with a parent and "grandparent", this array will identify the "grandparent" account as the “chief” account.

This array will return values even if the queried account is not part of an account hierarchy. If the account is not part of account hierarchy, this array will return the queried account details in this output parameter.
   brd_arrow.gif chief_acct_no long Account number of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy.
   brd_arrow.gif chief_acct_user_id string User ID of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy.
   brd_arrow.gif chief_client_acct_id string Client-defined identifier of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®