Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria6 core api > update_payment_method

update_payment_method

This API is used to update the payment method on an account. Newly added payment methods are automatically made the default payment method on the account.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
account_number long   Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  first_name string 300 Billing address first name
  last_name string 300 Billing address last name
  middle_initial string 2 Billing address middle initial
  company_name string 100 Billing address company name
  address1 string 300 Billing street address line one
  address2 string 300 Billing street address line two. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  city string 300 Billing address city
  locality string 300 Billing address locality
  state string 10 Billing address state
  country string 15 Billing address ISO-compatible 2-letter country code
  zip string 15 Billing address zip or postal code
  intl_phone string 25 Billing address international phone number
  phone_npa string 3 Numbering Plan Area value (area code) of the phone of the billing contact.
  phone_nxx string 3 Exchange (first 3 numbers following the area code/NPA) of the phone of the billing contact.
  phone_suffix string 10 Exchange (NXX) target number of the phone of the billing contact.
  phone_extension string 10 Billing address telephone extension
  email string 320 Billing address contact email
  pay_method string 38 Billing address payment method code   Allowable Values
  cc_number string   Credit card number, if payment method is CC
  cc_expire_mm long   Credit card expiration month, 2-digit
  cc_expire_yyyy long   Credit card expiration year, 4-digit
  bank_routing_num string   Bank account routing number
  bank_acct_num string   Bank account number
  do_collect string 1000 If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances.   Allowable Values
  change_status_after_coll string 1000 Indicates if the account status is to change after collection is completed.   Allowable Values
  reset_dates_after_status string 1000 If 'true', resets the billing dates after an account status change.   Allowable Values
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  bank_acct_type string   The type of bank account being used.   Allowable Values
  bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token).
  cc_id long 2 A numeric code indicating the type of credit card.   Allowable Values
  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. 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. Used in Europe. 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. Used in Europe. Only hyphen and space are allowed to format the bank branch code.
  primary_or_bkup_pay_method_ind long 1 Indicates whether to update primary or secondary payment method.   Allowable Values
  ref_bkup_seq_no long 8 The unique bill sequence number of the existing payment method on account to be set as backup payment method.
  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.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  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 be 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
  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
 
fraud_filtering_enabled
string 100 Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (disable), then Aria will ignore all other fraud filtering fields. Allowable Values
  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. Allowable Values
 
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.
  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. Allowable Values
 
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.
 
change_status_on_fraud_filtering_cc_prefix_failure
string 100 Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
 
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)
 
change_status_on_fraud_filtering_cc_number_failure
string 100 Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card number. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
 
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)
 
change_status_on_fraud_filtering_cc_issuing_country_failure
string 100 Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
 
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)
  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) Allowable Values
 
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
  end_user_session_id string 32 The client-generated session ID that is often used with captcha fraud prevention measures as part of an online order.
  end_user_ip_address string 15 IP address that was used to place an online order.
  end_user_browser_accept_header string 32 Browser accept header that was used to place an online order. Example: “text/html,application/xhtml+xml,application/xml ;q=0.9,*/*;q=0.8".
  end_user_browser_agent string 32 Browser that was used to place an online order. Example: "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0".
 

Output Arguments

Field Name Field Type Description
seq_no long Sequence number of this payment, as it appears on the account
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 Error code for the collection portion of this call, if a collection was attempted
collection_error_msg string Error message for the collection portion of this call, if a collection was attempted
proc_cvv_response string Processor return code from CVV validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string Processors 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
proc_payer_auth_request string The unique number for an authorization.
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.
proc_fraud_country_status string Fraud country status provided by the payment processor.
proc_fraud_country_code string Fraud country code provided by the payment processor.
proc_redirect_issuer_url string The URL to which you must post the 3DS (3D Secure) data. This will redirect the customer.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.