cancel_acct_installment_m
Summary
| API Name | cancel_acct_installment_m |
|---|---|
| Class | account_services_m |
| Update Version | 58 |
Description
When an installment plan is cancelled, any future scheduled installment payments are canceled, and the entire outstanding balance becomes due upon the original invoice's due date. Aria will attempt to collect the remaining amount using the account's configured payment method. Use this API when the installment arrangement is no longer valid or when the account is being closed.
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 |
| installment_no | long | 22 | Yes |
Aria assigned installment schedule no |
| cancellation_date | string | No |
Date on which the installment will be cancelled, in yyyy-mm-dd format. If null, it will be treated as immediate. |
|
| cancellation_comments | string | 500 | No |
Additional explanatory text relating to this API call |
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. |
|
| payment_transaction_id | long | No |
The unique identifier for a given payment transaction |
|
| collected_amount | double | No |
The amount of remaining balance successfully collected for the cancelled installment. |
|
| proc_cvv_response | string | No |
The processor return code from CVV validation. |
|
| proc_avs_response | string | No |
Processor return code from address validation |
|
| proc_cavv_response | string | No |
The processors return code for security validation. |
|
| proc_status_code | string | No |
The processor status code |
|
| proc_status_text | string | No |
The processors status description |
|
| proc_payment_id | string | No |
The processor payment ID |
|
| proc_auth_code | string | No |
Authorization code provided by the issuing bank |
|
| proc_merch_comments | string | No |
Additional information passed to payment processor |
|
| collection_error_code | long | No |
If a collection is attempted, returns the error code associated with the collection. |
|
| collection_error_msg | string | No |
The error message associated with collection_error_code. |
|
| collection_payment_method_no | long | No |
The payment method sequence no for the payment attempted during collection. |