Skip to main content
Aria Knowledge Central

get_acct_payment_history_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_payment_history_m
Class transaction_services_m
Update Version 71

Description

Returns a list of payments associated with an account.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
master_plan_instance_no long 22 No

Aria generated unique identifier for the master plan instance.

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined unique identifier for the master plan instance.

Alternative field: master_plan_instance_no
start_date string 14 No

Specifies start date. The date is in the format yyyy-mm-dd
end_date string 14 No

Specifies end date. The date is in the format yyyy-mm-dd
limit_records long 4 No

Specifies the number of payment transactions to be returned. There will be no limits if not specified.
details_flag long 1 No

If 1, also returns the details for the payments.

Allowed values:

Value Description
0 Do not return details for payments. (default)
1 Return details for payments.
include_unapplied_payments long 1 No

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

Allowed values:

Value Description
0 False (default)
1 True
include_all_voidable_pmt long 1 No

If the value is 1, the output parameter 'voidable_flag' will return 1 for both electronic and external payments.'

Allowed values:

Value Description
0 The 'voidable_flag' output parameter will return 1 (default) only for external payments.
1 The 'voidable_flag' output parameter will return one for both electronic and external payments.
payment_method_filter long 3 No

Payment Method Filter.

Allowed values:

Value Description
-3 Cash Credit
-2 Internal Write-off
-1 External Payment
0 Other/None
1 Credit Card
2 Electronic Check (ACH)
3 Pre-Paid
8 Click&Buy
11 PayPal Express Checkout
13 Tokenized Credit Card
14 Purchase Power
20 NETS
21 FIK
26 Direct Debit
27 Direct Debit - IBAN
28 Direct Debit - BBAN
29 Reserve Account
30 Boleto Bancario
32 iDEAL
33 WebMoney
34 Yandex
35 PaySafeCard
36 SOFORT
37 Tokenized Direct Debit
38 ApplePay - Indirect
39 PayPal Express Checkout - Indirect
40 Merchant Specific Gift Card
41 Giropay
42 Klarna
43 Tokenized Klarna
44 Qiwi
45 Tokenized Qiwi
46 Swish
47 Tokenized ApplePay
48 Tokenized ACH Payment
filter_retry_payments long 3 No

This param is used to filter payments that were reattempted. If filter_retry_payments value is 1, reattempted payment will be retrieved. If 0 or null (default), all payments will be retrieved.

Allowed values:

Value Description
0 retrieve all payments (default)
1 Retrieve only retry payments

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
Start of acct_payment_history object
acct_payment_history object   No

An Array of payment details.
Name Type Length Required Description
▶transaction_id long   No

Aria-assigned identifier for this transaction.
▶payment_source string   No

Specifies the source of the payment.
▶payment_status string   No

Specifies the status of the payment.
▶payment_date string   No

Specifies the date the payment was done in yyyy-mm-dd format.
▶payment_trans_type long   No

Specifies the payment transaction type number.

Allowed values:

Value Description
2 Check
3 Electronic Payment
4 Balance Transfer To Account
6 Write Off
10 Cash Credit
11 Credit From Overpayment
17 reinstated Payment transaction
19 3rd party payment
22 Invoice credit line item
▶payment_currency string   No

Specifies the ISO Currency code for this payment.
▶payment_amount double   No

Specifies the payment amount.
▶payment_amount_left_to_apply double   No

Specifies the amount left to apply of this payment.
▶voiding_event_no long   No

Specifies the voided payment event_no if the payment was voided.
▶voidable_flag long   No

Specifies if this payment transaction can be voided or not.

Allowed values:

Value Description
0 Payment transaction can not be voided.
1 Payment transaction can be voided.
▶cc_suffix string   No

Last four numbers of CC or bank account number for ACH. Null for external payment.
▶cc_string string   No

Either number or string that represents the credit card type - visa, amex, discover, etc.
▶pay_method_type long   No

Number of payment description type, as already stored in DB. (ex. 1= credit card, etc)

Allowed values:

Value Description
-3 Cash Credit
-2 Internal Write-off
-1 External Payment
0 Other/None
1 Credit Card
2 Electronic Check (ACH)
3 Pre-Paid
4 Deprecated Net Terms 30 - use Payment Terms
5 Deprecated Net Terms 10 - use Payment Terms
6 Deprecated Net Terms 15 - use Payment Terms
7 Deprecated Net Terms 60 - use Payment Terms
8 Click&Buy
9 Deprecated Net Terms 0 - use Payment Terms
10 PayByCash
11 PayPal Express Checkout
12 Deprecated Net Terms 45 - use Payment Terms
13 Tokenized Credit Card
14 Purchase Power
15 Deprecated Net Terms 35 - use Payment Terms
16 Deprecated Net Terms 75 - use Payment Terms
17 Deprecated Net Terms 90 - use Payment Terms
18 Deprecated Net Terms 120 - use Payment Terms
19 Deprecated Net Terms 25 - use Payment Terms
20 NETS
21 FIK
22 Deprecated Net Terms 14 - use Payment Terms
23 Deprecated Net Terms 180 - use Payment Terms
26 Direct Debit
27 Direct Debit - IBAN
28 Direct Debit - BBAN
29 Reserve Account
30 Boleto Bancario
31 Deprecated Net Terms 27 - use Payment Terms
32 iDEAL
33 WebMoney
34 Yandex
35 PaySafeCard
36 SOFORT
37 Tokenized Direct Debit
38 ApplePay - Indirect
39 PayPal Express Checkout - Indirect
40 Merchant Specific Gift Card
41 Giropay
42 Klarna
43 Tokenized Klarna
44 Qiwi
45 Tokenized Qiwi
46 Swish
47 Tokenized ApplePay
48 Tokenized ACH Payment
▶proc_status_code string   No

Response code from payment processor.
▶proc_payment_id string   No

The processor payment ID
▶proc_auth_code string   No

Authorization code if payment is approved, null if not approved or not applicable
▶payment_timestamp string   No

Date and time of payment instead of just date as is currently returned.
▶proc_status_text string   No

Payment processor status text is returned.
▶payment_method_no long 22 No

Aria-assigned sequence number for this payment method.
▶client_payment_method_id string   No

The client-defined identifier of the payment method used for payment.
▶payment_received_date string   No

The date the payment was received.
▶bill_email string 320 No

Email of the billing contact.
Start of payment_application_details object
▶payment_application_details object   No

An Array of account payment application details.
Name Type Length Required Description
▶▶invoice_no long   No

The Aria-assigned unique identifier of a given invoice.
▶▶invoice_date string 14 No

Specifies Invoice Date. The date is in the format yyyy-mm-dd.
▶▶invoice_from_date string 14 No

Specifies Invoice From Date. The date is in the format yyyy-mm-dd.
▶▶invoice_to_date string 14 No

Specifies Invoice To Date. The date is in the format yyyy-mm-dd.
▶▶invoice_pay_applied_amount double   No

Specifies the payment amount applied on the invoice by this transaction.
▶▶invoice_overall_paid_amount double   No

Specifies the total payment amount applied on the invoice by all transactions
▶▶invoice_charge double   No

Specifies the Invoice Charge Amount.
▶▶invoice_credit double   No

Specifies the Invoice Credit Amount.
▶▶invoice_bal_due double   No

Specifies the Invoice Balance Amount.
Start of applied_transactions object
▶▶applied_transactions object   No

Array of specific invoice transactions that the payment was applied to.
Name Type Length Required Description
▶▶▶transaction_id long   No

Id of the specific invoice transaction to allocate the payment
▶▶▶original_amount double   No

Charge amount of the original transaction
▶▶▶amount_applied double   No

Amount of the payment to be allocated to the transaction
▶▶▶date_applied string   No

Payment application date.
End of applied_transactions object
▶▶invoice_due_date string   No

Specifies the Invoice due date
End of payment_application_details object
▶cc_prefix string 6 No

The first 6 digit of the credit card number.
▶proc_name string   No

Payment Processor Name.
▶payment_retry_status long   No

Returns the payment's retry status
▶payment_source_description string   No

Returns the description of the payment source associated with the payment, if previously provided.
End of acct_payment_history object
unapplied_payment_summary double   No

Total sum of unapplied payments for a given account.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.