Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo object query api > get_refund_information_m

get_refund_information_m

This object includes information about a refund disbursement. Recommended query parameters include acct_no and aria_event_no for optimal performance.

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.

Querystring Keys

Key Name Description
aria_event_no The Aria assigned ID for the event.
acct_no The Aria assigned ID of the account.
user_id The client defined user_id for the account.
refund_amount Amount of the refund disbursement.
create_date
create_user
aria_statement_no
ref_payment_event_no The payment event is being refunded.
refund_transaction_type The transaction type code of the refund.
refund_is_voided_ind Value is 1 if this refund has been subsequently voided, otherwise 0

Output Arguments

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.
refund_information hash
aria_event_no long The Aria assigned ID for the event.
acct_no long The Aria assigned ID of the account.
user_id string The client defined user_id for the account.
refund_amount double Amount of the refund disbursement.
create_date string
create_user string
refund_reason_code long
refund_reason_label string
refund_reason_description string
currency_cd string
aria_statement_no long
ref_payment_event_no long The payment event is being refunded.
ref_payment_transaction_type long The transaction type code of the payment event that is being refunded.
ref_payment_transaction_desc string The transaction type of the payment event that is being refunded.
ref_payment_amount double The amount of the original payment.
refund_transaction_type long The transaction type code of the refund.
refund_transaction_desc string The transaction type of the refund.
refund_check_num string The check that was recorded as being sent to the end user, for external check refunds.
refund_bill_seq_no long The billing information sequence number used, for electronic refunds.
refund_pay_method_id long The electronic method ID used (e.g. 1), for electronic refunds.
refund_pay_method_name string The pay method name (e.g. Credit Card), for electronic refunds.
refund_cc_id long The credit card type ID used, for electronic refunds.
refund_cc_type string The credit card type name (e.g. MasterCard), for electronic refunds.
refund_payment_src_suffix string The payment suffix from the original electronic billing record.
refund_is_voided_ind long Value is 1 if this refund has been subsequently voided, otherwise 0
bill_email string Email of the billing contact. Note that this value is currently populated only if the payment method is PayPal Express Checkout and configured to update the billing email address with the PayPal Express Checkout email address.

You must to post a comment.
Last modified
12:59, 12 Oct 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.