Home > Aria6 User Documentation > Aria6 core api > update_acct_complete

update_acct_complete

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 and functional account group assignment: Specify the collection or functional account groups to which this account is assigned.
  • Payment method and taxation status: Specify if the account payment method is a card, direct debit, or net terms, 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.

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.
  first_name string 32 First name of the contact
  last_name string 32 Last name of the contact
  middle_initial string 1 The Middle initial of the contact.
  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. ISO-compliant 2-character country code abbreviation in uppercase.
  postal_cd string 14 Postal/Zip code for the contact address.
  phone string 25 Phone number of the contact
  phone_ext string 10 Extension for the contact phone
  cell_phone string 20 Contact cell phone.
  work_phone string 25 Work phone number of the contact.
  work_phone_ext string 10 Extension for the contact work phone
  email string 320 Email of the contact
  birthdate string 14 Date of birth of the contact
  bill_first_name string 32 First name of the billing contact
  bill_last_name string 32 Last name of the billing contact
  bill_middle_initial string 1 Middle Initial 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 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.
  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. ISO-compliant 2-character country code abbreviation in uppercase.
  bill_postal_cd string 14 Postal code for the billing contact address.
  bill_phone string 25 Phone of the billing contact
  bill_phone_ext string 10 Extension of the billing contact phone.
  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 Extension of the billing contact work phone
  bill_email string 320 Email of the billing contact
  pay_method long 8 Method_id corresponding to a payment method such as card, Electronic Check, Pre-Paid, Net Terms, etc.  
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
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
  cc_number string 24 Card number.
  cc_expire_mm long 2 Expiration month for the card.
  cc_expire_yyyy long 4 Expiration year for the card.
  bank_routing_num string 9 ABA routing number for the bank holding 'bank_acct_num'
  bank_acct_num string 19 Bank account number.
  master_plan_no long 22 Master subscription plan number.
  OR      
  client_master_plan_id string 100 Client-defined unique identifier for Master plan
  master_plan_alt_rate_sched_no long 22 Alternate rate schedule number for the master subscription plan being considered.
  OR      
  client_mp_alt_rate_sched_id string 100 Client-defined unique alternate rate schedule identifier for the master plan
  master_plan_units long 8 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.
  master_plan_assign_directive long 8 Rule to apply to this assignment/de-assignment request, specifying the following: Date the assignment should take place (immediately or on the account's anniversary date). Proration rule to apply (per client's default rules for proration, that is, prorate on plan assignment or force proration on or off for each request).  
Values Description
1 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.
  update_acct_supp_field array   Array of supplemental field values to be updated. This array contains three sub-arrays: supp_field_names, supp_field_values, and supp_field_directives. The first value in each sub-array is automatically associated with the first values in the other sub-arrays, as are the second values, third values and so on. Each sub-array must contain the same number of values, or the API fails.
   brd_arrow.gif supp_field_names string 100 Pipe-delimited array of supplemental field names.
   brd_arrow.gif supp_field_values string 300 Pipe-delimited array of supplemental field values.
   brd_arrow.gif supp_field_directives long 1000 Pipe-delimited array of supplemental field directives. Specifies what actions to take (update, delete, etc.)  
Values Description
1 Add the supplemental field and value to the account.
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.
  update_acct_func_group array   Array of functional groups to update.
   brd_arrow.gif functional_acct_groups long 38 Array of functional account groups.
  OR      
  brd_arrow.gif client_func_acct_group_ids string 38 Client-defined functional account group ID
  brd_arrow.gif functional_group_directives long 1 For each functional group, this specifies what action to take  
Values Description
1 Assign the account to the group.
2 Remove the account from the group.
  update_acct_coll_group array   Array of account collection groups to update
  brd_arrow.gif collections_acct_groups long 38 Unique ID of the collection account group in which to put the account
  OR      
  brd_arrow.gif client_coll_acct_group_ids string 100 Alternative input to collections_acct_groups above, this array is the client-defined group IDs
  brd_arrow.gif collections_group_directives long 1 Indicates 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.
  status_cd long 8 Status of the object in question for the current API call.  
Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
  notify_method long 8 If notification method is not provided, value will default to 1 (HTML email).
  password string 32 Password for the given user
  secret_question string 100 "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 Personal Identification Number
  test_acct_ind long 1 Indicates the account is a test account and is treated as such in the system.  
Values Description
1 test
0 live
  resp_level_cd long 2 Responsibility level code.  
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 Unique account number for the parent account. Used to establish parent-child billing relationships.
  senior_acct_user_id string 32 Senior account user ID of the account.
  client_senior_acct_id string 50 Client senior account ID of the account.
  client_acct_id string 50 Client-assigned identifier for the account.
  do_collect string 1000 If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances.  
Values Description
true true
false false
  change_status_after_coll string 1000 Indicates if the account status is to change after collection is completed.  
Values Description
true true
false false
  reset_dates_after_status string 1000 If 'true', resets the billing dates after an account status change.  
Values Description
true true
false false
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  alt_do_dunning string 1000 If you are changing the account's status, AND the new status is part of the account's dunning plan, the account can go through the full dunning process which includes dunning fees, dunning notifications, and queuing the account for the next dunning step. If this value is NULL, the client's default setting is honored. If true or false, this input is honored instead of the client's default setting. If the status change is being queued for a future date, this value is ignored and ONLY the clients default setting is honored.
  force_currency_change string 5 Force a currency change on update. This is generally necessary when an account moves from one country to another and the new country has a different monetary currency.  
Values Description
true true
false false
  cvv string 6 Card Verification Value. Printed on the card and used to help verify a transaction is being requested by the card holder.
  taxpayer_id string 32 Taxpayer Identification number.
  bill_agreement_id string 22 Unique ID of the bill agreement (also referred to as a token).
  auto_cancel_supp_plans string 1000 When changing an account's master plan number, this value determines whether to automatically cancel all supplemental plans that are not mapped to the new master plan. A null value defaults to 'false'.
  offset_months long 8 Number of months to add to the prorated period.
  alt_proration_start_date string 14 The date, in yyyy-mm-dd format, from which the proration calculations begin. If this field is NULL, then the proration calculations begin from the current date. This date cannot be before the beginning of the current billing period.
  alt_msg_template_no long 22 Email template number assigned to this account.
  OR      
  client_alt_msg_template_id string 100 Client-defined unique email template identifier
  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.
  bank_acct_type string 32 The type of bank account being used.  
Values Description
savings savings
checking checking
business business
  address3 string 300 Third line of the address
  bill_address3 string 300 Third line of the billing address
  usage_accumulation_config array    
  brd_arrow.gif usage_accumulation_plan_no long   Plan number on which to activate usage accumulation for more than one billing period
  OR      
  brd_arrow.gif client_usage_accumulation_plan_id string 100 Client-defined plan ID on which to activate usage accumulation for more than one billing period
  brd_arrow.gif usage_accumulation_reset_months long 2 For each plan specified, the number of months to accumulate before being reset.
   brd_arrow.gif usage_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.  
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 update_usage_pooling_data array.
  brd_arrow.gif enable_usage_pooling_plan_no long   DEPRECATED. You should use the update_usage_pooling_data array. Plans on which to enable usage pooling
  OR      
  brd_arrow.gif client_enable_usage_pool_plan_id string 100 DEPRECATED. You should use the update_usage_pooling_data array. Client-defined enable usage pool plan ID
  brd_arrow.gif usage_threshold_applicability string 100 DEPRECATED. You should use the update_usage_pooling_data array.Usage tracking options on the plans in the account  
Values Description
UT Usage Type
UP Usage Pool
  disable_usage_pooling_plan_no array   This array is DEPRECATED in favor of the update_usage_pooling_data array.
  brd_arrow.gif disable_usage_pooling_plan_no long   DEPRECATED. You should use the update_usage_pooling_data array. Plans on which to disable usage pooling
  OR      
  brd_arrow.gif client_disable_usage_pool_plan_id string 100 DEPRECATED. You should use the update_usage_pooling_data array. Client-defined plan identifier for disable usage pooling
  update_usage_pooling_data array    
  brd_arrow.gif usage_pooling_plan_no long   Plans on which to update usage pooling data
  OR      
  brd_arrow.gif client_usage_pool_plan_id string   Client-defined plan identifier on which to update usage pooling data
  brd_arrow.gif usage_pooling_action_directive long   Usage tracking options on the plans in the account
Values Description
0 Disable
1 Enable (default)
  brd_arrow.gif usage_threshold_applicability_cd string   Usage tracking options on the plans in the account
Values Description
UT Usage Type (default)
UP Usage Pool
  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.
  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
  offset_interval long 1000 If assigning a change on an anniversary day, the number of billing periods by which to delay that change
  tax_exemption_level long 1 Tax exemption level of this account
  cn_alt_msg_template_no long   Alternate email template number to use for this account
  OR      
  client_cn_alt_msg_template_id string 100 Client-defined cn unique alternate email template
  promo_cd string 30 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.
  invoice_unbilled_usage string 5 Specifies if the unbilled usage to be invoiced.  
Values Description
false Do not allow invoicing of unbilled usage during mid-term plan termination.
true Allow invoicing of unbilled usage during mid-term plan termination.
  coupon_code string 30 Coupon code to apply to this account
  userid string 32 Users unique identifier.
  invoice_approval_required string 5 Boolean indicator to override client's default configured behavior 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 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
  update_surcharge array    
  brd_arrow.gif surcharge_no long   Surcharge number to apply to this account
  brd_arrow.gif surcharge_directive long 1000 Surcharge directive to assign/remove the surcharge from the account  
Values Description
1 Apply surcharge to account
2 Remove surcharge from account
  brd_arrow.gif rate_schedule_no long   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. It is required for BBAN.
  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 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.
  bkup_bill_state_prov string 2 State or province of the secondary billing contact.

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

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <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 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 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 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 Method_id corresponding to a secondary payment method such as card, Electronic Check, Pre-Paid, Net Terms, etc.  
Values Description
1 Credit card
2 Electronic Check (ACH)
13 Tokenized Credit Card
  bkup_cc_number string 24 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 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   ABA (American Banking Association) unique identifier for the financial institution.
  bkup_bank_acct_type string 32 The type of bank account being used.  
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.
  revrec_client_defined_id string 100 Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it takes precedence over revrec_profile_id.
  stmnt_email_list string 3000 Deprecated(Deprecated) Array containing the list of additional email addresses
  stmnt_email_list_cc string 3000 Array containing the list of additional cc email addresses
  stmnt_email_list_bcc string 3000 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.  
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 the existing value remains as it is.
  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.  
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.  
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.  
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.
   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.
  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.
Values Description
0 false (disable)

Note: If you set this field to 0, then Aria will ignore all other fraud filtering fields.

1 true (enable)

Note: If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will ignore that field.

2 Use settings specified at the collection group or payment gateway level.

Note: If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.

  fraud_control_fields array  

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

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

The allowable fields and values for the key-value pairs are highlighted in blue below.

  fraud_control_field_name Field Type Max Length fraud_control_field_value:
  • Field Type: string
  • Max Length: 100
  brd_arrow.gif fraud_filtering_enabled string 100 Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (disable), then Aria will ignore all other fraud filtering fields.
Values Description
0 disable
1 enable
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gif change_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 account.
  brd_arrow.gif change_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 account.
  brd_arrow.gif change_status_on_fraud_filtering_cc_prefix_failure string 100 Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post)
Values Description
0 false
1 true
  brd_arrow.gif status_on_fraud_filtering_cc_prefix_failure string 100 If change_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post)
  brd_arrow.gif change_status_on_fraud_filtering_cc_number_failure string 100 Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card number. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post)
Values Description
0 false
1 true
  brd_arrow.gif status_on_fraud_filtering_cc_number_failure string 100 If change_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post)
  brd_arrow.gif change_status_on_fraud_filtering_cc_issuing_country_failure string 100 Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post)
Values Description
0 false
1 true
  brd_arrow.gif status_on_fraud_filtering_cc_issuing_country_failure string 100 If change_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post)
  brd_arrow.gif change_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)
Values Description
0 false
1 true
  brd_arrow.gif status_on_fraud_filtering_cc_issuing_country_suspect string 100 If change_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post)
End of fraud_control_fields array
Req Field Name Field Type Max Length Description
  recurring_processing_model_ind long 1

Defines a recurring payment type for Credit Card and Tokenized Credit Cards. 

This feature is available to you if your payment gateway supports Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT).

Note: Currently, for only the Vantiv payment gateway, the value in this field will automatically be set to 2 if your payment gateway or collection group configuration has the Send orderSource as recurring for all transactions option enabled.

Refer to your payment gateway documentation to see if this applies.

Please contact your payment gateway representative for more information.

 

Values Description
0 Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1 Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2 Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3 Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.
Start of proc_field_override array
  brd_arrow.gif proc_field_override array  

Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs.

The allowable field(s) and values for the key-value pairs are listed below.

  Field Name Field Type Max Length Description
    brd_arrow.gifbrd_arrow.gif transaction_type string 2

If you use Chase Paymentech or Vantiv, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's  payment information.

This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings).

 

Notes:

  • The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
    • Configuration > Payments > Payment Gateways > Chase Paymentech > Gateway Options; and
    • Configuration > Payments > Collection Groups > Chase Paymentech > Collection Group Options.
  • Currently, only Chase Paymentech supports this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.
 

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

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

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
proration_result_amount double Currency amount of any proration action resulting from the requested plan change. For plan assignments with an assignment directive of '1' (perform on anniversary date), or '2' (honor client default proration action) when the default is no proration, or '3' (force no proration), this field always returns '0'. If proration is performed, the value returned is either a positive currency value (for a charge) or a negative currency value (for a credit). If do_write is false, then any positive or negative value returned in this field is notational only, showing the proration effect if the requested plan assignment/de-assignment was actually performed.
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string Error message associated with collection_error_code.
parent_child_sync_error_code long Error code returned if a synchronization of parent/child billing dates is attempted.
parent_child_sync_error_msg string Error message associated with the parent_child_sync_error_code value.
master_plan_error_code long Error code returned if a master plan update fails.
master_plan_error_msg string Error message associated with the master_plan_error_code value.
master_plan_coll_error_code long Error code for master plan collection errors.
master_plan_coll_error_msg string Error message associated with the master_plan_coll_error_code value.
master_plan_stmt_error_code long Error code returned if a master plan statement update fails.
master_plan_stmt_error_msg string Error message associated with the master_plan_stmt_error_code value.
proc_cvv_response string Processor return code from CVV validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string Processor return code for security validation.
proc_status_code string Processor status code
proc_status_text string Processor status description
proc_payment_id string Processor payment ID
proc_auth_code string Authorization code provided by the issuing bank
proc_merch_comments string Additional information passed to the 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.gif proc_fraud_country_status string Fraud country status provided by the payment processor.
brd_arrow.gif proc_fraud_country_code string Fraud country code provided by the payment processor.
invoice_no long Unique identifier of a given invoice.
cancelled_supp_plans hash  
 brd_arrow.gif supp_plan_no long Unique ID of the supplemental plan
 brd_arrow.gif supp_plan_name string Name of the supplemental plan
 brd_arrow.gif supp_proration_result_amount double Result of the pro-ration calculation for the unused portion of the billing period
 brd_arrow.gif  client_supp_plan_id string Client-defined supplemental plan ID.
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 Type of error code being represented, such as taxation
 brd_arrow.gif error_code string Aria-assigned error identifier. 0 indicates no error.
 brd_arrow.gif error_msg string Description of any error that occurred. "OK" if there was no error.
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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.