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



 

Home > Aria6 User Documentation > Aria6 core api > get_acct_payment_methods

get_acct_payment_methods

Returns the historical data related to the account's payment methods.

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 acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  filter_seq_no long 22 An Aria-assigned billiing sequence number used to filter results.
  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.jpg qualifier_name string 100 Name of the field you want to associate with this API call.
  Subarray_0807a.jpg qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
 

Output Arguments

Field Name Field Type Description
acct_pay_methods hash  
 Subarray_0807a.jpgfirst_name string Contact first name for the account payment method
 Subarray_0807a.jpgmiddle_initial string Contact middle initial for the account payment method
 Subarray_0807a.jpglast_name string Contact last name for the account payment method
 Subarray_0807a.jpgaddress1 string Contact street address for the account payment method
 Subarray_0807a.jpgaddress2 string Contact building/suite/floor,etc. for the account payment method. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
 Subarray_0807a.jpgcity string Contact city for the account payment method
 Subarray_0807a.jpgstate string Contact state for the account payment method. The official postal-service codes for all United States and Canada states, provinces, and territories.
 Subarray_0807a.jpgzipcode string Contact postal code for the account payment method
 Subarray_0807a.jpgcountry string Contact country for the account payment method. The ISO-compliant 2-character country code abbreviation in uppercase.
 Subarray_0807a.jpglocality string Contact locality for the account payment method
 Subarray_0807a.jpgphone string Contact phone for the account payment method
 Subarray_0807a.jpgcell_phone string Contact cell phone for the account payment method
 Subarray_0807a.jpgwork_phone string Contact work phone for the account payment method
 Subarray_0807a.jpgemail string Contact email address for the account payment method
 Subarray_0807a.jpgcompany_name string Contact company name for the account payment method
 Subarray_0807a.jpgseq_no long Aria-assigned sequence number for this pay method.
 Subarray_0807a.jpgpay_method_id long The identifier for this payment method  Allowable Values
 Subarray_0807a.jpgpay_method_name string The human-readable name of this payment method
 Subarray_0807a.jpgpersistent_ind long If true, this payment method persists on the account. Otherwise it was used for a one-time payment  Allowable Values
 Subarray_0807a.jpgfrom_date string The beginning effective date for this payment method on this account
 Subarray_0807a.jpgto_date string The ending effective date for this payment method on this account. If none, this is the current form of payment
 Subarray_0807a.jpgcc_exp_mm long Credit card expiration month
 Subarray_0807a.jpgcc_exp_yy long Credit card expiration year
 Subarray_0807a.jpgcc_id long A numeric code indicating the type of credit card.  Allowable Values
 Subarray_0807a.jpgcc_type string The type of credit card used for the original payment.
 Subarray_0807a.jpgbank_routing long Bank routing number for the account payment method
 Subarray_0807a.jpgbank_name string Bank name for the account payment method
 Subarray_0807a.jpgbank_acct_type string Type of bank account for the account payment method
 Subarray_0807a.jpgbank_branch_cd string Up to 10-digit numeric bank branch code. Used for the Direct Debit payment method.
 Subarray_0807a.jpgbank_id_cd string Up to 10-digit numeric bank identifier code. Used for the Direct Debit payment method.
 Subarray_0807a.jpgbank_country_cd string 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.
 Subarray_0807a.jpgbank_swift_cd string 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.
 Subarray_0807a.jpgbank_city string Bank city for the account payment method
 Subarray_0807a.jpgsuffix string The last 4 digits of the account number
 Subarray_0807a.jpgcurrent_pay_method long The payment method currently used by the account holder.  Allowable Values
 Subarray_0807a.jpgbill_info_api_receipt_id string The receipt ID used in the initial API call which created this billing info record
 Subarray_0807a.jpgaddress3 string The third line of the address
 Subarray_0807a.jpgfrom_date_time string The beginning effective date with time for this payment method on this account
 Subarray_0807a.jpgto_date_time string The ending effective date with time for this payment method on this account. If none, this is the current form of payment
 Subarray_0807a.jpgbkup_pay_method_ind long Determines what sort of payment method.
 Subarray_0807a.jpgbill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
 Subarray_0807a.jpgmandate_id string 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.
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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.