Home > Aria Crescendo Documentation > Aria Crescendo object query api > get_payment_details_m

get_payment_details_m

Table of contents

Input Arguments
Querystring Keys
Output Arguments

Gets payment details for all accounts matching specified query

Input Arguments

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.
	query_string	string	1000	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".
	username	string	30	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	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.
	limit	long	12	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	The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.

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	Specifies the date on which the payment was made in yyyy-mm-dd format
amount	The payment amount
processor_name	The name of the processor used
method	The name of the payment method used
reference_num	The reference number of the payment

Field Name	Field Type	Description
error_code	long	Aria-assigned error identifier. 0 indicates no error
error_msg	string	Textual description of any error that occurred. "OK" if there was no error.
starting_record	long	This indicates the number of objects that were (or would be) skipped before beginning output.
total_records	long	This is the total number of objects that matched the provided criteria.
payment_details	hash	Detailed payment information for any accounts matching the query
payment_id	long	The Aria assigned ID of the payment
processor_payment_id	string	The payment processor assigned ID of the payment
acct_no	long	The Aria assigned ID of the account
user_id	string	The client defined user_id for the account
currency_cd	string	The 3-character ISO-compliant currency code for a payment
payment_date	string	Specifies the date on which the payment was made in yyyy-mm-dd format
amount	double	The payment amount
collection_status_cd	string	Unique identifier for the collection status of a payment
collection_status_text	string	Description of the collection status of a payment
processor_name	string	The name of the processor used
method	string	The name of the payment method used
reference_num	string	The reference number of a payment
last_updated	string	Most recent date on which the payment information was updated
voiding_event_no	long	The identifier for a void payment transaction

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.

© Copyright 2023 Aria Developer Central

Powered by CXone Expert ®