Use this API to reverse an authorized electronic payment for an account. Criteria for reversing an authorized electronic payment include that the initial payment should have been made within the last 72 hours, and the payment method was a credit card, or tokenized credit card.
For information on error messages generated by this API, see reverse_authorized_electronic_payment_m Error Messages.
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. |
OR | ||||
client_acct_id | string | 50 | Client-defined account identifier. | |
![]() |
auth_no | long | 22 | Aria-assigned authorization identifier. |
![]() |
reason_code | long | The authorization reversal reason code. Allowable Values | |
comments | string | 1000 | The user comment on the authorization reversal | |
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |
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_reversal_amount | double | The total amount that has been reversed. DEPRECATED |
applied_total_reversal_amount_2 | double | The total amount that has been reversed. |
proc_status_code | string | The processor status code |
proc_status_text | string | The processors status description |
proc_auth_id | string | The processor authorization ID |
proc_auth_code | string | Authorization code provided by the issuing bank |
proc_merch_comments | string | Additional information passed to payment processor |