get_reversible_authorizations_m
Summary
| API Name | get_reversible_authorizations_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 47 |
Description
Use this API to retrieve a list of pending authorizations for an account. Authorizations check that a credit card is valid and that funds are available to be captured. The authorization reversal time period varies by payment provider. 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 |
| 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. |
|
| reversible_authorizations | object | No |
reversible_authorizations fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| auth_no | long | No |
Aria-assigned authorization identifier. |
|
| proc_auth_id | string | No |
The authorization transaction identifier provided by the payment processor. |
|
| authorization_date | string | No |
The date of the authorization. |
|
| authorization_reversible_amount | double | No |
The amount of the authorization that can be reversed. |