Skip to main content
Aria Knowledge Central

get_acct_payment_history_m Guide

Returns a list of payments associated with an account.

API Specification:

get_acct_payment_history_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>

Error Codes 

Error Code/Description Associated Inputs

1001: unexpected error


 

1004: authentication error

Associated Inputs: auth_key, client_id, client_no


<auth_key>, <client_no>
 

1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)

Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no


<acct_no>, <client_acct_id>
 

14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".

Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id

Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.


<plan_instance_no>, <master_plan_instance_id>, <client_plan_instance_id>
 

14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".

Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id


<client_master_plan_instance_id>
 

1024: invalid date format

Associated Inputs: bill_birthdate, birthdate, degrade_date, initial_credit_date, invoice_line_reversing_date, service_fulfillment_date, queue_date, start_bill_date, end_bill_date, start_date, end_date, stmt_birthdate, bill_birthdate

Additional Comments: All date inputs must be in yyyy-mm-dd format.


<start_date>, <end_date>

Additional Guidance:

Input Fields
Field Name Notes
<details_flag>
Allowable Values
Values Description
0 Do not return details for payments. (default)
1 Return details for payments.
<include_unapplied_payments>
Allowable Values
Values Description
0 False; do not return unapplied payments total. (default)
1 True; return details unapplied payments total.
<payment_method_filter>

Default value: NULL

Datatype: long

Length: 3

 

Allowable Values
Values 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

 

Output Fields
Field Name Notes
<payment_trans_type>
Allowable Values
Values Description
1 Invoice
-1 Voided Invoice
2 check
-2 Voided Check
3 Electronic Payment
-3 Voided Electronic Payment
4 Balance Transfer To Account
-4 Voided Balance Transfer To Account
5 Balance Transfer From Account
-5 Voided Balance Transfer From Account
6 Write Off
-6 Voided Write Off
7 (Deprecated) Out-of-band Electronic Credit
-7 (Deprecated) Voided Out-of-band Electronic Credit
8 Refund Request
-8 Voided Refund Request
9 Balance Forward
-9 Voided Balance Forward
10 Cash Credit
-10 Voided Cash Credit
11 Credit From Overpayment
-11 Voided Credit From Overpayment
12 Electronic Refund Disbursement
-12 Voided Electronic Refund Disbursement
13 Check Refund Disbursement
-13 Voided Check Refund Disbursement
14 External charge
-14 Voided External Charge
15 Dunning Charge
-15 Voided Dunning Charge
16 reinstated Charge transaction
-16 voided reinstated Charge transaction
17 reinstated Payment transaction
-17 voided reinstated payment transaction
18 Negative Balance Forward
-18 Voided Negative Balance Forward
19 3rd party payment
-19 voided 3rd party payment
20 3rd party payment refund
-20 Voided 3rd party payment refund
21 Invoice charge line item
-21 Voided Invoice charge line item
22 Invoice credit line item
-22 Voided Invoice credit line item
24 Credit memo line
-24 Voided credit memo line
<voidable_flag>
Allowable Values
Values Description
0 Payment transaction can not be voided.
1 Payment transaction can be voided.
<pay_method_type>
Allowable Values
Values 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 Net Terms 30 (deprecated)
5 Net Terms 10 (deprecated)
6 Net Terms 15 (deprecated)
7 Net Terms 60 (deprecated)
8 Click&Buy
9 Net Terms 0 (deprecated)
10 PayByCash (deprecated)
11 PayPal Express Checkout
12 Net Terms 45 (deprecated)
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35 (deprecated)
16 Net Terms 75 (deprecated)
17 Net Terms 90 (deprecated)
18 Net Terms 120 (deprecated)
19 Net Terms 25 (deprecated)
20 NETS
21 FIK
22 Net Terms 14 (deprecated)
23 Net Terms 180 (deprecated)
26 Direct Debit
27 Direct Debit - IBAN
28 Direct Debit - BBAN
29 Reserve Account
30 Boleto Bancario
31 Net Terms 27
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

 

 

  • Was this article helpful?