reverse_authorized_electronic_payment_m
Summary
| API Name | reverse_authorized_electronic_payment_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 47 |
Description
Use this API to reverse an authorization on a customer's credit card or gift card. The authorization reversal time period varies by payment provider. Note: If the currency on an account is changed and there are pending authorizations, we will automatically reverse all pending authorizations that are in the prior currency. Authorizations reversal applies to the following payment methods: credit card, tokenized credit card, Paypal express checkout and gift cards.
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 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||||||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||||||||||||||
| auth_no | long | 22 | Yes |
Aria-assigned authorization identifier. |
||||||||||||||||||
| reason_code | long | 8 | Yes |
The authorization reversal reason code. Allowed values:
|
||||||||||||||||||
| comments | string | 1000 | No |
The user comment on the authorization reversal |
||||||||||||||||||
| client_receipt_id | string | 50 | No |
Client-defined unique identifier used to track related system actions |
||||||||||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| 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. |
|
| applied_total_reversal_amount | double | No |
Note: This field is deprecated. Aria no longer supports applied_total_reversal_amount. |
|
| proc_status_code | string | No |
The processor status code |
|
| proc_status_text | string | No |
The processors status description |
|
| proc_auth_id | string | No |
The processor authorization ID |
|
| proc_auth_code | string | No |
Authorization code provided by the issuing bank |
|
| proc_merch_comments | string | No |
Additional information passed to payment processor |
|
| applied_total_reversal_amt_2 | double | No |
The total amount that has been reversed. |