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


Home > Aria Crescendo core api > get_acct_payment_history_m


Returns a list of payments associated with an account.

For information on error messages generated by this API, see get_acct_payment_history_m error messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  client_acct_id string 50 Client-defined account identifier.
  master_plan_instance_no long 22 Aria generated unique identifier for the master plan instance.
  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.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

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.
transaction_id long Aria-assigned identifier for this transaction.
payment_source string Specifies the source of the payment.
payment_status string Specifies the status of the payment.
payment_date string Specifies the date the payment was done in yyyy-mm-dd format.
payment_trans_type long Specifies the payment transaction type number.   Allowable Values
payment_currency string Specifies the ISO Currency code for this payment.
payment_amount double Specifies the payment amount.
payment_amount_left_to_apply double Specifies the amount left to apply of this payment.
voiding_event_no long Specifies the voided payment event_no if the payment was voided.
voidable_flag long Specifies if this payment transaction can be voided or not.   Allowable Values
cc_suffix string Last four numbers of CC or bank account number for ACH. Null for external payment.
cc_string string Either number or string that represents the credit card type - visa, amex, discover, etc.
pay_method_type long Number of payment description type, as already stored in DB. (ex. 1= credit card, 5=net terms 10, etc)   Allowable Values
proc_status_code long Response code from payment processor.
proc_payment_id string The processor payment ID
proc_auth_code string Authorization code if payment is approved, null if not approved or not applicable
payment_timestamp string Date and time of payment instead of just date as is currently returned.
proc_status_text string Payment processor status text is returned.
payment_method_no long Aria-assigned sequence number for this payment method.
client_payment_method_id string The client-defined identifier of the payment method used for payment.
payment_received_date string The date the payment was received.
bill_email string Email of the billing contact.
payment_application_details hash An Array of account payment application details.
invoice_no long The Aria-assigned unique identifier of a given invoice.
invoice_date string Specifies Invoice Date. The date is in the format yyyy-mm-dd.
invoice_from_date string Specifies Invoice From Date. The date is in the format yyyy-mm-dd.
invoice_to_date string Specifies Invoice To Date. The date is in the format yyyy-mm-dd.
invoice_pay_applied_amount double Specifies the payment amount applied on the invoice by this transaction.
invoice_overall_paid_amount double Specifies the total payment amount applied on the invoice by all transactions
invoice_charge double Specifies the Invoice Charge Amount.
invoice_credit double Specifies the Invoice Credit Amount.
invoice_bal_due double Specifies the Invoice Balance Amount.
applied_transactions hash Array of specific invoice transactions that the payment was applied to.
transaction_id long Id of the specific invoice transaction to allocate the payment
original_amount double Charge amount of the original transaction
amount_applied double Amount of the payment to be allocated to the transaction
date_applied string Payment application date.
unapplied_payment_summary double Sum total of unapplied payments for a given account.
Last modified


This page has no custom tags.


This page has no classifications.