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_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||
client_acct_id | string | 50 | Client-defined account identifier. | |||||||||||||||||||||||||||||||||||||||
![]() |
notify_method | long | 2 | How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).
|
||||||||||||||||||||||||||||||||||||||
list_start_master_file | long | 1 | Indicates whether the account is listed at the start of a master file.
|
|||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||
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. |
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. |