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. | ||||||
![]() |
pay_method | long | 38 | Determines if this is a credit card or bank account being searched against
Allowable values for pay_method:
|
||||||
![]() |
form_payment_acct_id | string | 1000 | The account ID (credit card number or bank account number) of the payment method being searched for | ||||||
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). | |||||||
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. | ||||||||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |||||||
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
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. | ||||||
accts_with_pay_method | hash | |||||||
![]() |
long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||
![]() |
long | This indicator represents if the credit card number or bank account number of the payment method being searched is currently active and is the primary method. A value of 1 is true, and a value of 0 is false.
Allowable values for active:
|