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

 

Home > Aria6 core api > void_transaction

void_transaction

Voids a particular transaction associated with a specified account.

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.
account_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
transaction_id long 22 The unique identifier for a given transaction
comments string 500 Additional explanatory text relating to this API call. NOTE: For this API method, comments are required (normally comments are not required).
reason_code long 8 The reason a given credit was/is to be applied to the account.   Allowable Values
  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.   Allowable Values
  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
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.

You must to post a comment.
Last modified
14:44, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.