Skip to main content
Aria Knowledge Central

get_refund_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_refund_details_m
Class transaction_services_m
Update Version 66

Description

Returns refund information, including invoice reversals, for a specified 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
include_voided string 5 No

Include voided invoices in the search results.

Allowed values:

Value Description
True  
False  
aria_event_no long 22 No

Aria Event number of the writeoff event
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no

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 refund_details object
refund_details object   No  
Name Type Length Required Description
▶refund_transaction_id long   No

Note: This field is deprecated. Aria no longer supports refund_transaction_id.
▶refund_amount double   No

The monetary amount of the refund.
▶create_date string   No

The date the refund was created.
▶create_user string   No

The user responsible for creating the refund.
▶reason_code long   No

The refund reason code.

Allowed values:

Value Description
1 Account charged in error
2 Goods/services not delivered
3 Customer dissatisfaction
4 Cancellation of pre-paid service
5 Good Will
6 Overpayment / Duplicate payment
7 Wrong/undesired payment source charged
99999999 Other
▶reason_label string   No

The human-readable refund reason name.
▶reason_description string   No

The human-readable refund reason description.
▶ref_payment_transaction_id long   No

Transaction ID for the refund payment.
▶ref_payment_transaction_type long   No

The type of the refund payment transaction.
▶ref_payment_transaction_desc string   No

Description of the refund payment transaction.
▶ref_payment_amount double   No

The monetary amount of the refund.
▶ref_payment_ref_code string   No

The monetary amount of the refund.
▶bill_seq_no long   No

The Aria-assigned bill sequence number.
▶pay_method_id long   No

The method of payment originally used.

Allowed values:

Value Description
-1 External Payment
0 Other
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
26 Direct Debit
48 Tokenized ACH Payment
▶pay_method_name string   No

The human-readable name of this payment method
▶cc_id long 2 No

A numeric code indicating the type of credit card.

Allowed values:

Value Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club/Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankoort
▶cc_type string   No

The type of credit card used for the original payment.
▶payment_src_suffix string   No

For electronic payment transactions only, the last 4 digits of the account (e.g. the last 4 digits if the credit card used).
▶refund_check_num string   No

Client's check number for the refund.
▶is_voided_ind long   No

Indicates if the refund has been voided (true) or applied (false).

Allowed values:

Value Description
0 false
1 true
▶bill_email string 320 No

Email of the billing contact.
Start of invoice_reversals object
▶invoice_reversals object   No  
Name Type Length Required Description
▶▶invoice_no long   No

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

The date the invoice was originally billed.
▶▶invoice_line_no long   No

The line number containing a reversal for this refund.
▶▶total_line_debit double   No

The total invoice line item value that was originally billed.
▶▶reversed_line_amount double   No

The amount refunded for this specific line item.
▶▶reversed_line_start_date string   No

The effective start date of the original line item that is written off if it was a recurring fee service. The date is in the format yyyy-mm-dd.
▶▶reversed_line_end_date string   No

The effective end date of the original line item that is written off if it was a recurring fee service. The date is in the format yyyy-mm-dd.
▶▶transaction_id string   No

Id of the specific invoice transaction that was reversed
▶▶reversal_date string   No

Date and time of the reversal
▶▶service_no string   No

Service number of the invoice transaction
▶▶client_service_id string   No

Client-defined service ID for the invoice transaction_amount
▶▶transaction_comments string   No

Comments, if any, on the original invoice transaction
▶▶rebill_invoice_no long   No

The Aria generated unique invoice number for the rebill invoice. This field is populated for the refund with rebill.
▶▶rebill_invoice_line_no long   No

The line number on the rebill invoice. This field is populated for the refund with rebill.
▶▶rebill_invoice_line_transaction_id long   No

The Aria generated transaction ID for the rebill invoice line. This field is populated for the refund with rebill.
End of invoice_reversals object
▶refund_transaction_id_2 long   No

The Aria-generated transaction ID for this refund
▶payment_src_cc_prefix string 6 No

The first 6 digit of the credit card number of the payment.
Start of open_paid_line_item_list object
▶open_paid_line_item_list object   No  
Name Type Length Required Description
▶▶open_invoice_no long   No

Invoice number that's open with a refund. Required if invoice_line_no is used. For balance transfer, this will display child invoice number.
▶▶open_invoice_bill_date string   No

Date the invoice originally billed. For balance transfer, this will display date of child invoice or balance transfer.
▶▶open_invoice_line_no long   No

The line number open with this refund. For balance transfer, no line number will be displayed.
▶▶open_total_line_debit double   No

The total invoice line item value that was originally billed. For balance transfer, this is the total amount of balance transfer.
▶▶open_amount double   No

The amount refunded and open for this specific line item or transaction.
▶▶open_date string   No

Date and time when paid transaction becomes open.
▶▶open_transaction_id long   No

Id of the specific transaction to open.
▶▶service_no long   No

Service number of the invoice transaction. For balance transfer, service_no won't be populated.
▶▶client_service_id string   No

Client defined service ID for the invoice transaction_amount. For balance transfer, client_service_id won't be populated.
End of open_paid_line_item_list object
▶proc_refund_id string   No

The payment processor assigned ID of the refund.
End of refund_details object
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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