cancel_acct_installment_m Sample Call and Response
This example shows a call that cancels a scheduled installment plan after the customer pays off the remaining balance early, based on the cancel_acct_installment_m method defined in the plsql_m_r73.yml release file.
This example covers a specific future cancellation date with explanatory comments and a successful collection of the remaining balance. It does not cover an immediate cancellation, which results from leaving cancellation_date blank, or identifying the account by client_acct_id.
Sample call
{
"rest_call": "cancel_acct_installment_m",
"output_format": "json",
"client_no": 4001,
"auth_key": "a1b2c3d4e5f6g7h8i9j0",
"acct_no": 305567,
"installment_no": 88213,
"cancellation_date": "2026-08-01",
"cancellation_comments": "Customer paid off remaining balance early; installment plan cancelled per request."
}
The acct_no field is used instead of its alternative, client_acct_id. The cancellation_date field schedules the cancellation for a specific future date; the method description notes that leaving this field blank instead treats the cancellation as immediate.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"payment_transaction_id": 7734021,
"collected_amount": 214.50,
"proc_status_code": "00",
"proc_status_text": "Approved",
"proc_auth_code": "Z9Y8X7",
"collection_error_code": null,
"collection_error_msg": null,
"collection_payment_method_no": 552013
}
An error_code of 0 together with an error_msg of "OK" indicates that the installment cancellation itself completed without error. Because cancelling the installment also triggers an attempt to collect the remaining outstanding balance, this response also shows the outcome of that collection attempt: payment_transaction_id and collected_amount confirm that the remaining balance was collected, and collection_payment_method_no identifies the payment method used to collect it. A collection_error_code and collection_error_msg of null indicate that no error occurred during that collection attempt; a failed collection would instead return a non-null error code and message here, independent of the overall error_code. This example leaves out error_details, since that field is marked nonpublic in the shared field definitions, and it leaves out proc_cvv_response, proc_avs_response, proc_cavv_response, proc_payment_id, and proc_merch_comments from the response, keeping only a representative subset of the processor detail fields.