Home > Aria6 User Documentation > Aria6 core api > void_transaction


Voids a particular transaction associated with a specified account.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png account_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
required-icon.png transaction_id long 22 The unique identifier for a given transaction
required-icon.png comments string 500 Additional explanatory text relating to this API call. NOTE: For this API method, comments are required (normally comments are not required).
required-icon.png reason_code long 8 The reason a given credit was/is to be applied to the account.  
Values Description
1 Duplicate check posting
2 Transfer in wrong direction
3 Returned payment
4 Account responsibility incorrect
5 Invoice created in error
6 Error in processor integration
7 test data
8 Erroneous entry
9 Collection on order failed
10 Payment voided before settlement
11 Voided by 3rd party
12 Collection Failed
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  discard_invoice_usage string   Determine whether the loaded usages should be discarded or not.  
Values Description
true The loaded usages will be discarded for the invoice.
false The loaded usages will not be discarded for the invoice.
null If NULL, it takes defaults which setting does not discard the usages.
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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
new_transaction_id long This is the resulting transaction ID from the void action.
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.
Last modified


This page has no custom tags.


This page has no classifications.