Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!


Home > Aria6 core api > issue_refund_to_acct


Issues refunds of payment amounts and any invoice line items to be reversed for a specified account.

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".

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
payment_transaction_id long 22 The Aria-generated transaction ID of the payment made.
reason_code long 38 The refund reason code.   Allowable Values
  total_refund_amount double 38 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 The check number associated to the refund.
  comments string 4000 The user comment on the refund.
  do_write string 5 If is is set to 'FALSE', this API will function as in preview mode. No refund and/or reversal will be written to database. The function will merely return the reversal line items including calculated taxes. If it is set to 'true', the refund and reversal, if any, will be commited.   Allowable Values
  auto_calc_refund string 5 This indicates if the refund amount is to be calculated based on reversal line itmes. 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.   Allowable Values
  invoices_to_reverse array    
  invoice_no long 22 The unique identifier of a given invoice.
  invoice_line_no long 22 The line number that is written off.
  invoice_line_reversing_amount double 38 The amount to be refunded from this specific line item.
  invoice_line_reversing_date string 12 The date when this line item is reversed. The date is in the format yyyy-mm-dd.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions.
  is_unlinked_refund string   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.   Allowable Values
  alt_pay_method long 1 If you wish to use the account's original payment method for refund, leave this value empty. If you wish to use an alternate method for refund, enter '1' for this value.
  cc_number string 24 Credit card number.
  cc_expire_mm long 2 Expiration month for the credit card refund instrument.
  cc_expire_yyyy long 4 Expiration year for the credit card refund instrument.
  cvv string 6 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 First name of the billing contact
  bill_last_name string 32 Last name of the billing contact
  bill_company_name string 100 Company name of the billing contact
  bill_address1 string 100 First address line of the billing contact
  bill_address2 string 100 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 Third address line of the billing contact
  bill_city string 32 City of the billing contact
  bill_locality string 32 Locality of the billing contact
  bill_country string 3 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bill_state_prov string 2 State or Province of the billing contact. The official postal service codes for all the 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 Zip Code of the billing contact
  bill_phone string 25 Phone of the billing contact
  bill_cell_phone string 25 Cell phone of the billing contact
  bill_work_phone string 25 Work phone of the billing contact
  bill_email string 320 Email of the billing contact
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
applied_total_refund_amount double 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 The total amount that has been reversed on this invoice line. This amount is calculated for relevant tax lines.
transaction_id long Event number that was recorded in the account transaction table for this refund.
reversed_invoice_lines hash  
invoice_no long The invoice number reversed
invoice_line_no long The line of this item
invoice_line_service_no long The service number on this invoice
invoice_line_reversed_amount double The reversed amount for this particular line
invoice_line_reversing_date string Specifies the reversing date on this invoice line.
invoice_line_comments string Comments, if any, for the original invoice line
client_invoice_line_service_id string The client-defined service ID on this invoice

You must to post a comment.
Last modified
17:11, 28 Mar 2017


This page has no custom tags.


This page has no classifications.