void_transaction_m
Summary
| API Name | void_transaction_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.35 |
Description
Voids a particular transaction associated with a specified account.
Inputs
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||||||||||||||||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||||||||||||||||||
| account_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||||||||||||||||||||||
| transaction_id | long | 22 | Yes |
The unique identifier for a given transaction |
||||||||||||||||||||||||||
| comments | string | 300 | Yes |
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 | Yes |
The reason a given credit was/is to be applied to the account. Allowed values:
|
||||||||||||||||||||||||||
| client_receipt_id | string | 50 | No |
Client-defined unique identifier used to track related system actions |
||||||||||||||||||||||||||
| discard_invoice_usage | string | 5 | No |
Determine whether the loaded usages should be discarded or not. Allowed values:
|
||||||||||||||||||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: account_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| new_transaction_id | long | No |
This is the resulting transaction ID from the void action. |
|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |