Home > Aria6 User Documentation > Aria6 core api > get_payment_applications


Returns a list of charge transactions against which a particular credit transaction has been applied for a specified account.

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.
required-icon.png src_transaction_id long 22 Aria transaction ID for the credit transaction (e.g., Payment)
  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.
payment_applications hash An Array of payment applications.
brd_arrow.gif transaction_id long Aria-assigned identiier for this transaction
brd_arrow.gif transaction_type long Type of transaction  Allowable Values
brd_arrow.gif description string Text description of the transaction
brd_arrow.gif amount double Total monetary value of this transaction
brd_arrow.gif applied_amount double For transaction types that decrease an accounts balance (e.g. Payments) the amount of this transaction applied to date to charge transactions on the account.
brd_arrow.gif currency_code string ISO Currency code for this transaction
brd_arrow.gif transaction_date string Date the transaction was executed.
brd_arrow.gif is_voided string A return value of "true" here indicates the transaction has been voided.  Allowable Values
brd_arrow.gif statement_no long If the given transaction has been included within a statement (an Aria-generated internal grouping of all financial transactions on this account within a given period), the Aria-assigned identifier of that statement.
brd_arrow.gif client_receipt_id string Client-defined unique identifier used to track related system actions
brd_arrow.gif seq_statement_id string The unique sequential statement number.
Last modified


This page has no custom tags.


This page has no classifications.