cancel_payment_plan_m
Summary
| API Name | cancel_payment_plan_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 68 |
Description
Cancels a payment plan for an account. The cancellation can be immediate or scheduled for a future date. If cancellation_date is null, the cancellation will be treated as immediate.
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 |
| payment_plan_no | long | Yes |
Aria-assigned payment plan no Alternative required field: client_payment_plan_id |
|
| client_payment_plan_id | string | 100 | Yes |
Specifies unique client payment plan id Alternative required field: payment_plan_no |
| cancellation_date | string | No |
Date on which the payment plan 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. |
|
| queued_id | long | No |
Queued ID for future cancellation |
|
| cancellation_effective_date | string | No |
Cancellation effective date |
|
| cancelled_by | string | No |
User submitted the cancellation |
|
| payment_transaction_id | long | No |
The unique identifier for a given transaction |
|
| collected_amount | double | No |
The amount of remaining balance successfully collected for the cancelled payment plan. |
|
| 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. |