Home > Aria Crescendo Documentation > Aria Crescendo core api > get_refundable_payments_m


Returns an array of payment transactions for a a given acct_no or master plan instance that are considered refundable.

For error messages generated by this API, see get_refundable_payments_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 The Master Subscription plan instance number.
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  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.
  include_unapplied_payments long 1

Determines whether or not unapplied payment summary is included in the return. Default is 0. 

Allowable values for include_unapplied_payments:

Values Description
0 False; do not return unapplied payments total. (default)
1 True; return details unapplied payments total.
  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.
refundable_payments hash  
brd_arrow.gif payment_transaction_id long The transaction this payment applies to
brd_arrow.gif payment_date string The date of the payment
brd_arrow.gif payment_description string The description of the payment
brd_arrow.gif payment_amount double The amount of the payment
brd_arrow.gif payment_refunded_amount double If any refunds have been booked against this payment, the sum of all refunds
brd_arrow.gif payment_refundable_amount double The amount of this payment remaining to be refunded
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.