Skip to main content
Aria Knowledge Central

issue_refund_to_acct_m

  1. Last updated
  2. Save as PDF

Summary

API Name issue_refund_to_acct_m
Class transaction_services_m
Update Version 58

Description

Issues refunds of payment amounts, and any invoice line items to be reversed for a specified account. The refund of a payment will increase the account/master plan instance balance to its pre-payment state (or near, if a partial refund). A refund related reversal would almost retain the balance "as is", as you are reversing the invoice line item charges, along with the refund. Reversing an invoice charge line item proportionately reverses the corresponding tax (tax to reverse = original tax - tax for revised charge). In the case of tax-inclusive charges, the specified line item reversal amount will be considered as a tax-inclusive reversal amount. In the case of external tax engines, there will be a tax-posting that will occur to update the new taxes to the external tax engine against the customer's account. As an aside, tax-posting to external tax engines occurs for all generated invoices, voided invoices, write-offs, refund-related reversals, proration reversal/credit (and credit-memo/rebills).

Note: If you use the NETS payment processor, "Enable Refund for NETS Payment" must be set to "True" in the UI before you use this API, or you receive the error message "The payment processor does not support refunds".

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
payment_transaction_id long 22 Yes

The Aria-generated transaction ID of the payment made.
total_refund_amount double 12 No

The total amount intended to refund. If it is null and auto is set to 'true', the refund amount is calculated based on line items reversed.
refund_check_number string 38 No

The check number associated to the refund.
reason_code long 38 Yes

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
comments string 300 No

The user comment on the refund.
do_write string 5 No

Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true'

Allowed values:

Value Description
True  
False  
auto_calc_refund string 5 No

This indicates if the refund amount is to be calculated based on reversal line items. If auto_calc_refund is set to 'true' and if do_write is 'true', if the total_refund_amount is not null, process will use the input total_refund_amount, but if the total_refund_amount is null, then the total_refund_amount will be equal to the calculated total reversal amount. However, do_write = 'true' and auto_calc_refund = 'false' is not a valid combination and will error out.

Allowed values:

Value Description
True  
False  
Null equate to 'false'
invoice_trans_to_reverse object   No

See fields below
client_receipt_id string 50 No

Client-defined unique identifier used to track related system actions.
is_unlinked_refund string 5 No This indicates that the refund amount is to be passed against a payment transaction or it is passed as stand alone refund. If is_unlinked_refund is set to 'true', then the refund amount is considered as stand alone refund for the account. but if is_unlinked_refund is set to 'false' then the refund amount is processed for payment transaction.

Refunds passed against a payment transaction (value='false') are only supported for Payjunction and Cybersource payment processors.

Refunds that are unlinked (value='true') are only supported for the Vantiv payment processor.

Allowed values:

Value Description
True  
False  
Null equate to 'false'
alt_pay_method long 2 No

If you want to use the current form of payment, leave this field empty. To use an alternate payment method, enter the appropriate value.
cc_number string 24 No

Credit card number.
cc_expire_mm long 2 No

Expiration month for the credit card refund instrument.
cc_expire_yyyy long 4 No

Expiration year for the credit card refund instrument.
cvv string 6 No

Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
bill_first_name string 32 No

First name of the billing contact.
bill_last_name string 32 No

Last name of the billing contact.
bill_company_name string 100 No

Company name of the billing contact.
bill_address1 string 100 No

First address line of the billing contact.
bill_address2 string 100 No

Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
bill_address3 string 100 No

The third line of the billing address.
bill_city string 32 No

City of the billing contact.
bill_locality string 32 No

Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
bill_country string 3 No

Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bill_state_prov string 10 No

State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
bill_zip string 16 No

Zip Code of the billing contact
bill_phone string 25 No

Phone number of the billing contact.
bill_cell_phone string 20 No

Cell phone number of the billing contact.
bill_work_phone string 25 No

Work phone number of the billing contact.
bill_email string 320 No

Email of the billing contact.
soft_descriptor string   No

Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field will be ignored if not supported/certified by the payment processor.
soft_descriptor_customer_service string   No

Transaction description shown on the buyer's statement that displays a City for Card Present transactions or a Phone Number for Card Not Present transactions. This field will be ignored if not supported/certified by the payment processor.
open_paid_line_items object   No

See fields below
refund_payment_ind long 1 No

Refund payment method.

Allowed values:

Value Description
Null Honor what is set on alt_payment_method (backward compatibility)
2 Original or External Payment --- if original payment method fails then external payment is issued. Check number is required.
3 External Payment
open_line_item_action long 1 No

Handle open invoice line item aging.

Allowed values:

Value Description
Null Continue to age (meaning, the aging counter continue - default)
1 Re-age as of today (meaning, aging is reset as of today)
apply_refunded_payment_on_refund_trans long 1 No

This parameter is added to control the existing behaviour of payment application to the refund transaction such that the refund amount should be applied to the specific payment against which the refund is created instead of FIFO application. This parameter is not honoured when refund with opening of paid lines is performed.

Allowed values:

Value Description
0 Continue to work as per existing way of applying payment based on FIFO (default, except for open paid lines).
1 Apply refund amount to the specific payment against which the refund is created.

invoice_trans_to_reverse fields

Name Type Length Required Description
invoice_no long   No

Invoice number of the invoice being reversed. Required if Invoice_line_no is used.
invoice_line_no long 22 No

Sequence number of the invoice transaction. Valid only if invoice_no is provided.
invoice_transaction_id long 22 No

Id of the specific invoice transaction to reverse.
invoice_line_reversing_amount double 12 No

The amount to be refunded from this specific line item.
invoice_line_reversing_date string 10 No

The date when this line item is reversed. The date is in the format yyyy-mm-dd.

open_paid_line_items fields

Name Type Length Required Description
open_invoice_no long   No

Invoice number of the invoice clients want to open. Required if invoice_line_no is used.
open_invoice_line_no long 22 No

Sequence number of the invoice transaction. Valid only if invoice_no is provided.
open_transaction_id long 22 No

Id of the specific transaction to open. This is a required field for balance transfer.
open_amount double 12 No

The amount to be refunded from this specific item. Includes balance transfer.

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.
applied_total_refund_amount double   No

The total amount that has been refunded. If inAuto is TRUE, this amount will equal to the total reversal amount.
applied_total_reversal_amount double   No

The total amount that has been reversed on this invoice line. This amount is calculated for relevant tax lines.
out_transaction_id long   No

Note: This field is deprecated. Aria no longer supports out_transaction_id.
reversed_invoice_transactions object   No

See fields below
out_transaction_id_2 long   No

Event number that was recorded in the account transaction table for this refund.
open_paid_line_item_list object   No

See fields below

reversed_invoice_transactions fields

Name Type Length Required Description
invoice_no long   No

The invoice number reversed
invoice_line_no long   No

The line of this item
reversed_transaction_id long   No

The Transaction Id of this item
service_no long   No

The service number on this invoice
reversed_amount double   No

The reversed amount for this particular line
reversing_date string   No

Specifies the reversing date on this invoice line.
transaction_comments string   No

Comments, if any, for the original invoice line
client_service_id string 100 No

The client-defined service ID on this invoice
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.

open_paid_line_item_list fields

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.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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