Home > Aria6 User Documentation > Aria6 core api > update_existing_billing_info

update_existing_billing_info

updates some billing info including contact info and credit card expiration

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.
  seq_no long 22 Unique bill sequence number
  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
  state 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.
  zip string 16 Zip/postal code of the contact.
  country string 2 Country of the contact. ISO-compliant 2-character country code abbreviation in uppercase.
  cc_expire_mm long 2 Expiration month for the credit card.
  cc_expire_yyyy long 4 Expiration year for the credit card.
  phone_npa long 3 Numbering Plan Area value (area code) of the phone of the contact.
  phone_nxx long 3 Exchange (first 3 numbers following the area code/NPA) of the phone of the contact.
  phone_suffix string 10 Phone number (this is the number on the exchange/NXX for the target phone).
  phone_ext string 10 Extension for the contact phone
  phone_country_cd string 3 Country code dialing prefix for the phone number. The ISO-compliant 2-character country code abbreviation in uppercase.
  intl_phone string 25 International phone number of the contact
  email string 320 Email of the contact
  locality string 32

Locality of the contact. Use this field instead of the <state> 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.
  cell_phone_npa long 3 Numbering Plan Area value (area code) of the cell phone of the contact.
  cell_phone_nxx long 3 Exchange (first 3 numbers following the area code/NPA) of the cell phone of the contact.
  cell_phone_suffix string 12 Exchange (NXX) target number of the cell phone of the contact.
  work_phone_npa long 3 Numbering Plan Area value (area code) of the work phone of the contact.
  work_phone_nxx long 3 Exchange (first 3 numbers following the area code/NPA) of the work phone of the contact.
  work_phone_suffix string 10 Exchange (NXX) target number of the work phone of the contact
  work_phone_ext string 10 Extension for the contact work phone
  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
  address3 string 300 Third line of the address
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions.
  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.
 

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string Error message associated with collection_error_code.
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 Processors 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 payment processor
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®