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.. |
transaction_type | long | 8 | Transaciton type to search account history for. Allowable Values | |
start_date | string | 14 | Specifies start date. The date is in the format yyyy-mm-dd | |
end_date | string | 14 | Specifies end date. The date is in the format yyyy-mm-dd | |
record_limit | long | 12 | This is the maximum number of records to retrieve from the query. | |
filter_statement_no | long | 22 | Statement number filter to use when querying for account transaction history. | |
include_void_transactions | string | 5 | Allows whether or not to include void transactions. 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. | ||
![]() |
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 |
---|---|---|
history | hash | |
![]() |
long | The globally-unique ID for this transaction across all transactions |
![]() |
long | The numeric code for the type of transaction being returned. Allowable Values |
![]() |
string | The long description of this transaction |
![]() |
double | The amount of this transaction |
![]() |
double | The amount of this transaction actually applied to the account balance, if different than above |
![]() |
string | The currency this transaction was recorded in |
![]() |
string | The creation datetime of this transaction |
![]() |
string | If this transaction was voided, the void datetime |
![]() |
long | The ID of the statement on which this transaction appears, if any |
![]() |
string | A human-readable reason for this transaction to be voided, if any |
![]() |
string | Client-defined unique identifier used to track related system actions |
![]() |
string | Client-defined comments on this transaction |
![]() |
long | A code defining the originating source of the transaction, such as a write-off number, payment ID, etc |
![]() |
string | External reference code for this transaction, such as a check number or external reference code |
![]() |
string | The reason for the credit this transaction represents |
![]() |
string | CSR-generated comments for this transaction line, if any |
![]() |
string | The unique sequential statement number. |
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. |