Home > Tech Writers Hub > Knowledge Services Sandbox > Aria6 APIs Bucket > A6-API DEV-10591 BT Tokenized ACH API r47 wk > create_acct_complete

create_acct_complete

Creates an account with an extensive set of data elements including the customer's contact information, billing information, master and supplemental plans, account groups, supplemental fields, and several other data elements. This call also allows you to specify alternate billing dates for a new account.

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.
Asterisk_0807a.jpg master_plan_no long 22 The Master Subscription plan number.
  OR      
  client_master_plan_id string 100 Client-defined Master plan Subscription plan ID.
  alt_start_date string 14 This is an alternative start date, in yyyy-mm-dd format, for the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated).
  client_acct_id string 50 The client-assigned identifier for the account.
  userid string 32 The unique user identifier. This field is required unless the Auto Gen Userid Rule is set to automatically generate a user ID when one is not provided upon account creation. This rule is located in Aria6, under Client Settings, Miscellaneous Settings.
  status_cd long 8 This is the status of the object in question for the current API call.  

Allowable values for 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 2
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
  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.jpgsupp_plans long array 38 An array of supplemental plan numbers to assign to this account
  OR      
  Subarray_0807a.jpgclient_supp_plan_ids string array 100 The array of client-defined supplemental plan IDs.
  Subarray_0807a.jpgsupp_plan_units long array 38 The units of each plan in the above supp_plans array to assign to this account
  notify_method long 38 If notification method is not provided, value will default to 1 (HTML emal).  

Allowable values for 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
  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.
  password string 100 Password for the given user. This field is required unless the New Acct Auto Gen Pw Rule is set to True, to automatically generate a password when one is not provided upon account creation. This rule is located in Aria6, under Client Settings, Miscellaneous Settings.
  secret_question string 300 The users secret question recorded to recover a password.
  secret_question_answer string 300 The response to a users 'secret_question
  first_name string 32 Contact first name
  mi string 1 The Middle Initial of the contact.
  last_name string 32 Contact last name
  company_name string 100 Company name of the contact
  address1 string 100 First address line of the contact
  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.
  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 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 <locality> field for addresses in those countries.
  country string 2 Country of the contact. 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 14 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
  email string 320 Email of the contact
  birthdate string 14 Contact date of birth
  bill_first_name string 32 First name of the billing contact
  bill_mi string 1 Middle Initial of the billing contact
  bill_last_name string 32 Last name of the billing contact
  bill_company_name string 100 Company name of the billing contact
  bill_address1 string 100 First address line of the billing contact
  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.
  bill_city string 32 City of the billing contact
  bill_locality string 32

Locality of the billing contact. Use this field instead of the <bill_state_prov> field to designate 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.
  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 <bill_locality> field for addresses in those countries.
  bill_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bill_postal_cd string 14 This is the postal code for the billing contact address.
  bill_phone string 25 Phone of the billing contact
  bill_phone_ext string 10 This is the billing contacts extension for the bill_phone given.
  bill_cell_phone string 25 Cell phone of the billing contact
  bill_work_phone string 25 Work phone of the billing contact
  bill_work_phone_ext string 100 This is the work phone extension for the billing contact work phone.
  bill_email string 320 Email of the billing contact
  pay_method long 8 This is the method_id corresponding to a payment method such as card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for 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
  cc_number string 24 Card number.
  cc_expire_mm long 2 Expiration month for the card payment instrument.
  cc_expire_yyyy long 4 Expiration year for the card payment instrument.
  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 along with the <bank_routing_no> or <bill_agreement_id> and <bank_acct_type> are needed for the Tokenized ACH payment method - 48.
  bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution. This along with the <bank_acct_no> or <bill_agreement_id> and <bank_acct_type> are needed for the Tokenized ACH payment method - 48.
  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 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
  senior_acct_no long 22 The senior_acct_no is the unique account number for the parent account and is used in establishing parent-child billing relationships.
  senior_acct_user_id string 32 The senior account user ID of the account.
  client_senior_acct_id string 50 The client senior account ID of the account.
  Subarray_0807a.jpgfunctional_acct_groups long array 38 Array of functional account groups.
  OR      
  Subarray_0807a.jpgclient_func_acct_group_ids string array 38 The functional account group ID to which this account should be assigned
  Subarray_0807a.jpgcollections_acct_groups long array 38 The group ID(s) for the collections account groups to assign to this account. An account cannot be assigned to two or more collections account groups for the same pay_method (regardless of whether they use different payment processors). However, accounts can be assigned to two or more collections account groups provided that each is for a different pay_method (for example, ACH vs. card).
  OR      
  Subarray_0807a.jpgclient_coll_acct_group_ids string array 100 The collections account group ID to which this account should be assigned
  Subarray_0807a.jpgsupp_field_names string array 100 The names of the supplemental fields for which values are to be stored for this account
  Subarray_0807a.jpgsupp_field_values string array 300 The values for the supplemental field names given in supp_field_names
  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 test_acct_ind

Values Description
1 test
0 live
  status_until_alt_start long 8 The status of the account prior to alt_start_date or alt_bill_day. If the alt_start_date or alt_bill_day field is used, this field is required and defaults to 0 (inactive) if no value is provided. Other acceptable values for status_until_alt_start are any valid account statuses. If an alternate starting date or alternate bill day is passed in, the account remains in this status until its start date arrives. This only applies if a prorated invoice is not created. If a prorated invoice is created, this field is ignored.
  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.
  alt_bill_day long 2 The day of the month that will act in perpetuity as the account's billing anniversary day.
  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 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
  do_prorated_invoicing string 5 Prorate the invoice to the end of the billing cycle  

Allowable values for 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
  master_plan_alt_rate_sched_no long 22 The alternate rate schedule number for the master subscription plan being considered.
  OR      
  client_mp_alt_rate_sched_id string 100 The client alternate rate schedule ID for the master subscription plan being considered.
  Subarray_0807a.jpgsupp_plan_alt_rate_sched_no long array   The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  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 card.
  taxpayer_id string 32 Taxpayer Identification number.
  bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token). This along with the <bank_acct_no> or <bank_routing_no> and <bank_acct_type> are needed for the Tokenized ACH payment method - 48.
  retroactive_start_date string 14 Date, in yyyy-mm-dd format, to set for retroactive start.
  Subarray_0807a.jpgcoupon_codes string array 30 The coupon codes to assign to this account, if any
  new_acct_custom_rates array    
  Subarray_0807a.jpgcustom_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.jpgclient_custom_rate_plan_id string 32 The unique identifier defined by client for the plan to which this custom rate is to be applied for this account.
  Subarray_0807a.jpgcustom_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.jpgclient_custom_rate_service_id string 32 The unique identifier by client the service ID to determine which custom rate is to be applied for this account.
  Subarray_0807a.jpgcustom_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.jpgcustom_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. Defaults to 1.
  Subarray_0807a.jpgcustom_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. Defaults to infinity.
  Subarray_0807a.jpgcustom_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.
  alt_msg_template_no long 22 Email template number assigned to this account.
  OR      
  client_alt_msg_template_id string 100 Client-defined email template ID assigned to this account.
  seq_func_group_no long 22 Functional account group number specifically designated for statement sequence number assignment.
  OR      
  seq_func_group_id string 32 Unique Functional account group ID specifically designated for statement sequence number assignment.
  new_acct_plan_contracts array    
  Subarray_0807a.jpgcontract_plan_no long   The unique identifier of this contract
  OR      
  Subarray_0807a.jpgclient_contract_plan_id string 100 The client-defined unique ID for the plan to which this contract applies
  Subarray_0807a.jpgcontract_type_no long   The type ID of this contract
  Subarray_0807a.jpgcontract_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.jpgcontract_length_months long 4 The number of months this contract should remain on the account
  Subarray_0807a.jpgcontract_cancel_fee double 38 The fee charged to the account for prematurely ending this contract
  Subarray_0807a.jpgcontract_comments string 300 Any client-defined comments stored on this contract at the account level
  Subarray_0807a.jpgcontract_start_date string   The date, in yyyy-mm-dd format, on which this contract takes effect
  Subarray_0807a.jpgcontract_end_date string   Allows the caller to set a specific end date when creating or modifying plan contracts.
  bank_acct_type string 32 The type of bank account being used.  

Allowable values for bank_acct_type

Values Description
savings savings
checking checking
business business
  address3 string 300 The third line of the address
  bill_address3 string 300 The third line of the billing address
  usage_accumulation_config array   The array of plans for which to enable usage accumulation
  Subarray_0807a.jpgusage_accumulation_plan_no long   The plan ID for which to enable usage accumulation
  OR      
  Subarray_0807a.jpgclient_usage_accumulation_plan_id string 32 The client-defined plan ID on which to activate usage accumulation for more than one billing period
  Subarray_0807a.jpgusage_accumulation_reset_months long 2 The number of reset months for each plan.
 

  Subarray_0807a.jpgusage_accumulation_reset_months_

renewal_option

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

Allowable values for usage_accumulation_reset_months_ renewal_option

Values Description
1 Recurring / Auto Renew.
NULL or 2 Single Use. (Default)
  enable_usage_pooling_plan_no array   This array is DEPRECATED in favor of the create_usage_pooling_data array.
  Subarray_0807a.jpgenable_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.jpgclient_enable_usage_pool_plan_id string 32 DEPRECATED. You should use the create_usage_pooling_data array. The client-defined plan ID on which to enable usage pooling
  Subarray_0807a.jpgusage_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 usage_threshold_applicability

Values Description
UT Usage Type
UP Usage Pool
  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
  track_data1 string 1000 Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request
  track_data2 string 1000 Raw "track 2" data from a swiped card used in a card-present transaction to initiate this request
  do_write string 1 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
  tax_exemption_level long 1 To provide Tax Exemption Level for the account  

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

Allowable values for 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
  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 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.jpgclient_sp_alt_rate_sched_ids string array 100 The client alternate rate schedule ID for the supplementary subscription plan being considered.
  surcharge_no array    
  Subarray_0807a.jpgsurcharge_no long   The Surcharge number to be attached to the account
  Subarray_0807a.jpgrate_schedule_no long   The Schedule number for this surcharge
  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.
  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.
  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.
  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.
  mandate_id string 35

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

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.
  bank_id_cd string 10 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.
  bank_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.
  bank_name string 100 Bank name for the account payment method
  bank_city string 100 Bank city for the account payment method
  bkup_bill_first_name string 32 First name of the secondary billing contact
  bkup_bill_mi string 1 Middle Initial of the secondary billing contact
  bkup_bill_last_name string 32 Last name of the secondary billing contact
  bkup_bill_company_name string 100 Company name of the secondary billing contact
  bkup_bill_address1 string 100 First address line of the secondary billing contact
  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.
  bkup_bill_address3 string 100 second address line of the secondary billing contact
  bkup_bill_city string 32 City of the secondary billing contact
  bkup_bill_locality string 32

Locality of the secondary billing contact. Use this field instead of the <bkup_bill_state_prov> field to designate 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.
  bkup_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 <bkup_bill_locality> field for addresses in those countries.
  bkup_bill_country string 2 Country of the secondary billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bkup_bill_postal_cd string 14 This is the postal code for the secondary billing contact address.
  bkup_bill_phone string 25 Phone of the secondary billing contact
  bkup_bill_phone_ext string 10 This is the secondary billing contacts extension for the bill_phone given.
  bkup_bill_cell_phone string 25 Cell phone of the secondary billing contact
  bkup_bill_work_phone string 25 Work phone of the secondary billing contact
  bkup_bill_work_phone_ext string 100 This is the work phone extension for the secondary billing contact work phone.
  bkup_bill_email string 320 Email of the secondary billing contact
  bkup_pay_method long 8 This is the method_id corresponding to a secondary payment method such as card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for bkup_pay_method

Values Description
1 Credit card
2 Electronic Check (ACH)
13 Tokenized Credit Card
  bkup_cc_number string 24 Credit card number.
  bkup_cc_expire_mm long 2 Expiration month for the card payment instrument.
  bkup_cc_expire_yyyy long 4 Expiration year for the card payment instrument.
  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.
  bkup_bank_routing_no string   This is the ABA (American Banking Association) unique identifier for the financial institution.
  bkup_bank_acct_type string 32 The type of bank account being used.  

Allowable values for bkup_bank_acct_type

Values Description
savings savings
checking checking
business business
  bkup_bill_agreement_id string 32 Unique ID of the secondary bill agreement (also referred to as a token).
  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 card.
  revrec_profile_id long 8 Profile ID of an existing Revenue Recognition Profile.
  OR      
  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.
  stmnt_email_list string 3000 Deprecated(Deprecated) An array containing the list of additional email addresses
  stmnt_email_list_cc string 3000 An array containing the list of additional cc email addresses
  stmnt_email_list_bcc string 3000 An array containing the list of additional bcc email addresses
  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 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.
  acct_start_date string 14 This is the date, in yyyy-mm-dd format, that this account was originally started.
  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.
  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.
  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 defer_full_statements_only

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

Allowable values for 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 Dankoort
  bkup_cc_id long 2 A numeric code indicating the type of card.  

Allowable values for 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 Dankoort
  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.jpgqualifier_name string 100 Name of the field you want to associate with this API call.
   Subarray_0807a.jpgqualifier_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
  Subarray_0807a.jpgfraud_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.
  Subarray_0807a.jpgchange_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.
  Subarray_0807a.jpgstatus_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.
  Subarray_0807a.jpgchange_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.
  Subarray_0807a.jpgstatus_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.
  Subarray_0807a.jpgchange_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
  Subarray_0807a.jpgstatus_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)
  Subarray_0807a.jpgchange_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
  Subarray_0807a.jpgstatus_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)
  Subarray_0807a.jpgchange_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
  Subarray_0807a.jpgstatus_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)
  Subarray_0807a.jpgchange_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
  Subarray_0807a.jpgstatus_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.
 

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.
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
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.
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.
invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
invoice_no long The unique identifier of the invoice, if any, created automatically by Aria in conjunction with this call.
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.
out_new_acct_plan_contracts hash  
 Subarray_0807a.jpgout_contract_no long The unique ID of the contract assigned to this account
 Subarray_0807a.jpgout_contract_plan_no long The unique ID of the plan to which this contract applies
 Subarray_0807a.jpgout_client_contract_plan_id string The client-defined unique ID for the plan to which this contract applies
invoice_charges_before_tax double Charges before tax on the initial invoice for this account
invoice_tax_charges double Tax charges on the initial invoice for this account
invoice_charges_after_tax double The sum of invoice_charges_before_tax and invoice_tax_charges
invoice_credit_amount double The amount of credit on the initial invoice for this account
invoice_total_amount double The total owed on the initial invoice for this account
new_acct_invoice_line_items hash  
 Subarray_0807a.jpginvoice_line_no long The line number on the initial invoice
 Subarray_0807a.jpginvoice_plan_no long The unique ID plan this line represents
 Subarray_0807a.jpginvoice_plan_name string The name of the plan this line represents
 Subarray_0807a.jpginvoice_service_no long The unique ID for the service this line represents
 Subarray_0807a.jpginvoice_service_name string The name of the service this line represents
 Subarray_0807a.jpginvoice_service_coa_id long The Chart of Accounts ID for the service this line represents
 Subarray_0807a.jpginvoice_units double The number of units of the item or plan on this line
 Subarray_0807a.jpginvoice_rate_per_unit double The charge per unit of the item or plan on this line
 Subarray_0807a.jpginvoice_line_amount double The subtotal amount of this line
 Subarray_0807a.jpginvoice_line_description string The long description of this line, used when printing or otherwise displaying invoices
 Subarray_0807a.jpginvoice_start_date_range string The starting date range for the item or plan on this line
 Subarray_0807a.jpginvoice_end_date_range string If any, the ending date range for the item or plan on this line.
 Subarray_0807a.jpgclient_invoice_plan_id string The client-defined unique ID for plan this line represents
 Subarray_0807a.jpgclient_invoice_service_id string The client-defined unique ID for the service this line represents
 Subarray_0807a.jpgclient_invoice_service_coa_code string The client-defined Chart of Accounts code for the service this line represents
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.jpgerror_class string The type of error code being represented, such as taxation
 Subarray_0807a.jpgerror_code string The error code returned by the third party system
 Subarray_0807a.jpgerror_msg string The error message returned by the third party system
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 ®