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



 

Home > Aria Crescendo core api > get_acct_payment_history_m

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

Tags

This page has no custom tags.

Classifications

This page has no classifications.