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. |
![]() |
transaction_id | long | 22 | Payment transaction ID for which the application details are to be retrieved. |
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. |
payment_application_details | hash | An Array of account payment application details. |
![]() |
long | The unique identifier of a given invoice. |
![]() |
string | Specifies Invoice Date. The date is in the format yyyy-mm-dd |
![]() |
string | Specifies Invoice From Date. The date is in the format yyyy-mm-dd |
![]() |
string | Specifies Invoice To Date. The date is in the format yyyy-mm-dd. |
![]() |
double | Specifies the payment amount applied on the invoice by this transaction. |
![]() |
double | Specifies the total payment amount applied on the invoice by all transactions. |
![]() |
double | Specifies the Invoice Charge Amount |
![]() |
double | Specifies the Invoice Credit Amount. |
![]() |
double | Specifies the Invoice Balance Amount. |
![]() |
hash | Array of specific invoice transactions that the payment was applied to. |
![]() |
long | Id of the specific invoice transaction. |
![]() |
double | Original amount of the transaction. |
![]() |
double | Amount of the payment applied to the transaction. |
![]() |
string | Payment application date. |