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

 

Home > Aria Crescendo core api > update_payment_method_m

update_payment_method_m

This API is used to update the payment method of an 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.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  payment_method_no long   Aria-assigned sequence number for this pay method.
  client_payment_method_id string   The client-defined billing primary payment method ID.
  disabled_ind long   Determines whether or not the existing payment method on the account (specified by payment_method_no / client_payment_method_id) should be disabled. When set to 1, the payment method will be disabled. Note that once a payment method has been disabled, it cannot be re-enabled. When set to 0 (default), the payment method will remain enabled. This input takes precedence over all other parameters available for updating a payment (i.e., the existing payment method specified will not be disabled and no new payment methods will be created on the account).   Allowable Values
  bill_contact_no long   The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters will be ignored.
  bill_first_name string   First name of the billing contact.
  bill_middle_initial string   Middle initial of the billing contact.
  bill_last_name string   Last name of the billing contact.
  bill_company_name string 100 Company name of the billing contact.
  bill_address1 string   First address line of the billing contact.
  bill_address2 string   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_address3 string   The third line of the billing address.
  bill_city string   City of the billing contact.
  bill_locality string   Locality of the billing contact.
  bill_state_prov string   State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  bill_country string   Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bill_postal_cd string 15 Postal code for the billing contact.
  bill_phone string 25 Phone number of the billing contact.
  bill_phone_ext string 10 Phone extension of the billing contact.
  bill_cell_phone string 20 Cell phone number of the billing contact.
  bill_work_phone string 25 Work phone number of the billing contact.
  bill_work_phone_ext string   This is the work phone extension for the billing contact work phone.
  bill_fax string 25 Fax number of the billing contact.
  bill_email string 320 Email of the billing contact.
  bill_birthdate string 14 Birthdate of the billing contact.
  pay_method_name string   The human-readable name of the payment method.
  pay_method_description string   Description for the primary payment method.'
  pay_method_type long   This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.   Allowable Values
  cc_num string   Credit card number.
  cc_expire_mm long   Expiration month for the credit card payment instrument.
  cc_expire_yyyy long   Expiration year for the credit card payment instrument.
  cvv string 6 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  bank_acct_num string   The bank account number.
  bank_routing_num string   The American Banking Association (ABA) routing number for the financial institution.
  bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token).
  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). It is used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  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 35 character alphanumeric. 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.
  do_collect string   If 'true', a collection will be attempted after updating electronic billing information on accounts with outstanding balances.   Allowable Values
  change_status_after_coll string   This argument indicates if the account status is to change after collection is completed.   Allowable Values
  reset_dates_after_status string   This allows you to reset 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
  cc_id long 2 A numeric code indicating the type of credit card.   Allowable Values
  cc_auth_amount double   For non-tokenized credit cards, if an amount is provided for cc_auth_amount, a full authorization for the amount specified will be performed regardless of how the 'Perform Authorization Request on Credit Card Update' client parameter is configured. When cc_auth_amount is not provided, the 'Perform Authorization Request on Credit Card Update' client parameter will determine whether or not a $1 authorization will be attempted when saving a new credit card on an account. In the event authorization fails, the authorization will be reversed (for non-$0 authorizations) provided Aria's integration with the payment processor supports authorization reversals.
  disable_existing_on_update string   When updating an existing payment method on an account determines whether or not the original payment method (specified by payment_method_no / client_payment_method_id) should be disabled. When set to 'true' (default), the payment method will be disabled. Note that once a payment method has been disabled, it cannot be re-enabled. When set to 'false', the original payment method will remain enabled on the account.   Allowable Values
  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.

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.
seq_no long The sequence number of this payment, as it appears on the account
collection_info hash A multidimensional array of collection information of master plan instance.
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string The error message associated with collection_error_code.
bill_group_no long Aria assigned bill group number
client_bill_group_id string Specifies client defined id for bill group
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
bill_contact_no long The Aria-assigned unique identifier for the billing contact associated with a payment method on this account.

You must to post a comment.
Last modified
17:08, 28 Mar 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.