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. |
OR | ||||
client_acct_id | string | 50 | Client-defined account identifier. | |
master_plan_instance_no | long | 22 | Aria generated unique identifier for the master plan instance. | |
OR | ||||
client_master_plan_instance_id | string | 100 | Client-defined unique identifier for the master plan instance. | |
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 | |
limit_records | long | 4 | Specifies the number of payment transactions to be returned. There will be no limits if not specified. | |
details_flag | long | 1 | If 1, also returns the details for the payments. Allowable Values | |
include_unapplied_payments | long | 1 |
Determines whether or not unapplied payment summary is included in the return. Default is 0. 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 |
---|---|---|
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. |
acct_payment_history | hash | An Array of payment details. |
![]() |
long | Aria-assigned identifier for this transaction. |
![]() |
string | Specifies the source of the payment. |
![]() |
string | Specifies the status of the payment. |
![]() |
string | Specifies the date the payment was done in yyyy-mm-dd format. |
![]() |
long | Specifies the payment transaction type number. Allowable Values |
![]() |
string | Specifies the ISO Currency code for this payment. |
![]() |
double | Specifies the payment amount. |
![]() |
double | Specifies the amount left to apply of this payment. |
![]() |
long | Specifies the voided payment event_no if the payment was voided. |
![]() |
long | Specifies if this payment transaction can be voided or not. Allowable Values |
![]() |
string | Last four numbers of CC or bank account number for ACH. Null for external payment. |
![]() |
string | Either number or string that represents the credit card type - visa, amex, discover, etc. |
![]() |
long | Number of payment description type, as already stored in DB. (ex. 1= credit card, 5=net terms 10, etc) Allowable Values |
![]() |
long | Response code from payment processor. |
![]() |
string | The processor payment ID |
![]() |
string | Authorization code if payment is approved, null if not approved or not applicable |
![]() |
string | Date and time of payment instead of just date as is currently returned. |
![]() |
string | Payment processor status text is returned. |
![]() |
long | Aria-assigned sequence number for this payment method. |
![]() |
string | The client-defined identifier of the payment method used for payment. |
![]() |
string | The date the payment was received. |
![]() |
string | Email of the billing contact. |
![]() |
hash | An Array of account payment application details. |
![]() |
long | The Aria-assigned 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 to allocate the payment |
![]() |
double | Charge amount of the original transaction |
![]() |
double | Amount of the payment to be allocated to the transaction |
![]() |
string | Payment application date. |
unapplied_payment_summary | double | Sum total of unapplied payments for a given account. |