get_cash_credits_details_m Guide
- Last updated
-
-
Save as PDF
This API is used to return details of the cash credits on an account, or just for a given cash credit "transaction_id". This API also returns the charge details on which the cash credit is applied.
Error Codes:
Error Code/Description |
Associated Inputs |
|
|
1004: authentication error
|
<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)
|
<acct_no>, <client_acct_id> |
2001: transaction does not exist
|
<invoice_no> |
Additional Guidance
Output Fields
Field Name |
Notes |
<transaction_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 Disbursementt |
-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 |
|