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".
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 for reason_code
|
||||||||||||||||||
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 this 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 committed.
Allowable values for do_write
|
|||||||||||||||||||
auto_calc_refund | string | 5 | 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.
Allowable values for auto_calc_refund
|
|||||||||||||||||||
invoices_to_reverse | array | Note: If sending multiple line items, you must send the line items in ascending order using the invoice_line_no field in the invoices_to_reverse array for the tax line items to be calculated correctly. | ||||||||||||||||||||
![]() |
long | 22 | The unique identifier of a given invoice. | |||||||||||||||||||
![]() |
long | 22 | The line number that is written off. | |||||||||||||||||||
![]() |
double | 38 | The amount to be refunded from this specific line item. | |||||||||||||||||||
![]() |
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 a standalone refund. If is_unlinked_refund is set to 'true', then the refund amount is considered as a standalone 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. Allowable values for is_unlinked_refund
|
||||||||||||||||||||
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. Use this field instead of the <bill_state_prov> field to identify 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 addresses in the United States, Australia, and Canada. | |||||||||||||||||||
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 code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries. This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <bill_locality> field for addresses in those 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 | |||||||||||||||||||
soft_descriptor | string | 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 | 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. | ||||||||||||||||||||
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. | ||||||||||||||||||||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |||||||||||||||||||
![]() |
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. |
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 | |
![]() |
long | The invoice number reversed |
![]() |
long | The line of this item |
![]() |
long | The service number on this invoice |
![]() |
double | The reversed amount for this particular line |
![]() |
string | Specifies the reversing date on this invoice line. |
![]() |
string | Comments, if any, for the original invoice line |
![]() |
string | The client-defined service ID on this invoice |