void_transaction_m Sample Call and Response
This example shows a call to void_transaction_m, based on the plsql_m_r73.yml Core API definition file for release 73. The example voids a specific transaction on an account because the related check payment was returned by the bank.
This example covers a straightforward void of one transaction, identified by its Aria-assigned account number and transaction identifier, along with a reason code and required explanatory comments. It does not cover the optional client_receipt_id or discard_invoice_usage fields, both of which are left out and explained below.
Sample call
{
"rest_call": "void_transaction_m",
"output_format": "json",
"client_no": 34281,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"account_no": 7001452,
"transaction_id": 98234561,
"comments": "Voiding original check payment transaction; the check was returned by the bank as NSF.",
"reason_code": 3
}
account_no and client_acct_id are alternatives (alt_required_field); this example uses account_no, the Aria-assigned numeric identifier, rather than the client-defined client_acct_id. The comments field is required for this particular method, even though comments are optional for most other Core API methods. reason_code is an enumerated field; this example uses value 3, "Returned payment." Other allowable values include 1 (Duplicate check posting), 2 (Transfer in wrong direction), 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 third party), and 12 (Collection failed). The rest_call and output_format fields are added by the REST layer and are not part of the method's own argument list. This example leaves out the optional client_receipt_id field, used only to correlate this call with a client-side tracking identifier, and the optional discard_invoice_usage field, used only to control whether loaded usage data tied to the voided invoice is discarded.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"new_transaction_id": 98234609
}
error_code of 0 combined with an error_msg of "OK" indicates that the void succeeded. new_transaction_id is the identifier of the reversing transaction that Aria created to record the void. This example leaves out the error_details structure entirely, because that field is marked nonpublic in the underlying definition and is not part of the public response.