Description
Gets payment details for all accounts matching specified query
Inputs
| Name |
Type |
Length |
Required |
Description |
| username |
string |
30 |
No |
DeprecatedThe login name of the user making this request. It is the same name that is used to log in to the Aria Administration and Configuration Tool. |
| password |
string |
1000 |
No |
DeprecatedThe password of the user making this request. It is the same password that is used to log in to the Aria Administration and Configuration Tool. |
| client_no |
long |
12 |
Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key |
string |
32 |
Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
| limit |
long |
12 |
No |
The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records. |
| offset |
long |
12 |
No |
The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records. |
| query_string |
string |
1000 |
Yes |
The criteria which all returned objects must match. Different objects have a different set of searchable criteria.
Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC". |
Querystring Keys
| Key Name |
Description |
| payment_id |
The Aria assigned ID of the payment |
| processor_payment_id |
The payment processor assigned ID of the payment |
| acct_no |
The Aria assigned ID of the account |
| payment_date |
|
| amount |
|
| processor_name |
The name of the processor used |
| method |
The name Payment method used |
| reference_num |
|
Outputs
| Name |
Type |
Length |
Required |
Description |
| error_code |
long |
|
No |
Aria-assigned error identifier. 0 indicates no error |
| error_msg |
string |
|
No |
Textual description of any error that occurred. "OK" if there was no error. |
| starting_record |
long |
|
No |
This indicates the number of objects that were (or would be) skipped before beginning output. |
| total_records |
long |
|
No |
This is the total number of objects that matched the provided criteria. |
| Start of payment_details hash |
| payment_details |
hash |
|
No |
List of payment_details associated with this method. |
| Name |
Type |
Length |
Required |
Description |
| ▶payment_id |
long |
|
No |
The Aria assigned ID of the payment |
| ▶processor_payment_id |
string |
|
No |
The payment processor assigned ID of the payment |
| ▶acct_no |
long |
|
No |
The Aria assigned ID of the account |
| ▶user_id |
string |
100 |
No |
The client defined user_id for the account |
| ▶currency_cd |
string |
|
No |
|
| ▶payment_date |
string |
|
No |
|
| ▶amount |
double |
|
No |
|
| ▶collection_status_cd |
string |
|
No |
|
| ▶collection_status_text |
string |
|
No |
|
| ▶processor_name |
string |
|
No |
The name of the processor used |
| ▶method |
string |
|
No |
The name Payment method used |
| ▶reference_num |
string |
|
No |
|
| ▶last_updated |
string |
|
No |
|
| ▶voiding_event_no |
long |
|
No |
|
| End of payment_details hash |
