Home > Aria6 User Documentation > Aria6 core api > get_acct_payment_methods
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 |
|---|---|---|---|---|
 |
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. |
| 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. | ||
 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. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| acct_pay_methods | hash | |
| first_name |
string | Contact first name for the account payment method |
| middle_initial |
string | Contact middle initial for the account payment method |
| last_name |
string | Contact last name for the account payment method |
| address1 |
string | Contact street address for the account payment method |
| address2 |
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. |
| city |
string | Contact city for the account payment method |
| state |
string | Contact state for the account payment method. The official postal-service codes for all United States and Canada states, provinces, and territories. |
| zipcode |
string | Contact postal code for the account payment method |
| country |
string | Contact country for the account payment method. The ISO-compliant 2-character country code abbreviation in uppercase. |
| locality |
string | Contact locality for the account payment method |
| phone |
string | Contact phone for the account payment method |
| cell_phone |
string | Contact cell phone for the account payment method |
| work_phone |
string | Contact work phone for the account payment method |
| email |
string | Contact email address for the account payment method |
| company_name |
string | Contact company name for the account payment method |
| seq_no |
long | Aria-assigned sequence number for this pay method. |
| pay_method_id |
long | The identifier for this payment method Allowable Values |
| pay_method_name |
string | The human-readable name of this payment method |
| persistent_ind |
long | If true, this payment method persists on the account. Otherwise it was used for a one-time payment Allowable Values |
| from_date |
string | The beginning effective date for this payment method on this account |
| to_date |
string | The ending effective date for this payment method on this account. If none, this is the current form of payment |
| cc_exp_mm |
long | Credit card expiration month |
| cc_exp_yy |
long | Credit card expiration year |
| cc_id |
long | A numeric code indicating the type of credit card. Allowable Values |
| cc_type |
string | The type of credit card used for the original payment. |
| bank_routing |
long | Bank routing number for the account payment method |
| bank_name |
string | Bank name for the account payment method |
| bank_acct_type |
string | Type of bank account for the account payment method |
| bank_branch_cd |
string | Up to 10-digit numeric bank branch code. Used for the Direct Debit payment method. |
| bank_id_cd |
string | Up to 10-digit numeric bank identifier code. Used for the Direct Debit payment method. |
| bank_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. |
| bank_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. |
| bank_city |
string | Bank city for the account payment method |
| suffix |
string | The last 4 digits of the account number |
| current_pay_method |
long | The payment method currently used by the account holder. Allowable Values |
| bill_info_api_receipt_id |
string | The receipt ID used in the initial API call which created this billing info record |
| address3 |
string | The third line of the address |
| from_date_time |
string | The beginning effective date with time for this payment method on this account |
| to_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 |
| bkup_pay_method_ind |
long | Determines what sort of payment method. |
| bill_agreement_id |
string | Unique ID of the bill agreement (also referred to as a token). |
| mandate_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. |
- © Copyright 2022 Aria Developer Central