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. |
![]() |
src_transaction_id | long | 22 | Either the Aria transaction ID or the Aria invoice number for the invoice |
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. |
invoice_payments | hash | Array of invoice payments returned upon succesful completion of the API call. |
![]() |
long | The unique identifier for a given transaction |
![]() |
long | Aria-assigned identifier for this type of transaction Allowable Values |
![]() |
string | Text description of the transaction |
![]() |
double | Total monetary value of this transaction |
![]() |
double | For transaction types that decrease an accounts balance (e.g. Payments) the amount of this transaction applied to date to charge transactions on the account. |
![]() |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
![]() |
string | Date the transaction was executed. |
![]() |
string | A return value of "true" here indicates the transaction has been voided. Allowable Values |
![]() |
long | If the given transaction has been included within a statement (an Aria-generated internal grouping of all financial transactions on this account within a given period), the Aria-assigned identifier of that statement. |
![]() |
string | For payment transactions only, the type of payment (e.g. Credit Card). Allowable Values |
![]() |
string | For electronic payment transactions only, the granular type of the source of the payment (e.g. American Express) |
![]() |
string | For electronic payment transactions only, the last 4 digits of the account (e.g. the last 4 digits if the credit card used). |
![]() |
string | Client-defined unique identifier used to track related system actions |
![]() |
string | The unique sequential statement number. |
![]() |
string | Email of the billing contact. |