update_payment_plan_m
Summary
| API Name | update_payment_plan_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 69 |
Description
Updates an existing payment plan on a specified account, either by modifying the current schedule or by replacing the existing payment plan with a new one. Any fields not provided remain unchanged.
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 | No |
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. 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 |
||||||||
| primary_payment_method_no | long | 22 | No |
Primary payment method ID Alternative field: client_primary_payment_method_id |
||||||||
| client_primary_payment_method_id | string | 100 | No |
Client-defined unique identifier of the primary payment method Alternative field: primary_payment_method_no |
||||||||
| backup_payment_method_no | long | 22 | No |
Backup payment method ID Alternative field: client_backup_payment_method_id |
||||||||
| client_backup_payment_method_id | string | 100 | No |
Client-defined unique identifier of the backup payment method Alternative field: backup_payment_method_no |
||||||||
| update_specific_sequence_list | object | No |
A list of payment plan sequences to be updated. Some fields are applicable only for independent payment plans. |
|||||||||
| aligned_payment_plan_client_master_plan_instance_id | string | 100 | No |
Client-defined unique ID of the master plan instance whose anniversary statement includes the upcoming payment plan due. Alternative field: aligned_payment_plan_master_plan_instance_no |
||||||||
| aligned_payment_plan_master_plan_instance_no | long | No |
Unique ID of the master plan instance whose anniversary statement includes the upcoming payment plan due. Alternative field: aligned_payment_plan_client_master_plan_instance_id |
|||||||||
| update_scope | long | No |
Specifies how the system should apply those changes. Allowable values: 0 - apply changes to specified sequences only. 1 - Apply changes to the remaining sequences, start with specified sequence. Applicable only if one sequence is specified on update_specific_sequence_list. 2 - Create a New Schedule for the remaining unpaid balance, including those dues that have been notified. Allowed values:
|
|||||||||
| do_write | string | 5 | No |
Boolean indicator that specifies whether to perform the requested operation or not. If 'false' is passed in the field, Aria calculates any potential effects from the call such as payment plan schedule, start date and end date etc. and return all relevant data without actually performing the requested operation or making any changes to the account. Do_write defaults to 'true'. Allowed values:
|
||||||||
| new_payment_plan_type | long | No |
Defines the type of payment plan for the remaining unpaid balance. Allowable values: 0 - Independent (own schedule and due dates) 1 - Aligned (with an existing master plan instance anniversary statement). Allowed values:
|
|||||||||
| new_payment_plan_length | long | No |
Specifies the total length of the payment plan. For new_payment_plan_type = 0, this value is used together with new_payment_plan_period_type to determine the overall length. For new_payment_plan_type = 1, it represents the number of Master Plan Instance (MPI) statements included in the payment plan. |
|||||||||
| new_payment_plan_period_type | string | 1 | No |
Specifies the payment plan period type. Valid values are M (Months), W (Weeks), or D (Days). Allowed values:
|
||||||||
| new_payment_plan_interval | long | No |
Specifies the interval of the payment plan, applicable when new_payment_plan_type = 0. Works jointly with new_payment_plan_period_type. If defined, must be less than new_payment_plan_length. |
|||||||||
| new_independent_payment_plan_date | string | No |
Defines the start date of the independent payment plan. Needs to be the same or greater than the current date. |
|||||||||
| new_independent_payment_plan_days_until_due | long | No |
Specifies the number of days until due for the independent payment plan. If null but new_independent_payment_plan_date is populated, then the system will use days until due configured for a payment term or specific payment method. |
|||||||||
| new_client_payment_plan_id | string | 100 | No |
Specifies a new unique client payment plan. Applicable only when update_scope = 2. |
||||||||
| new_payment_plan_lump_sum_type | string | No |
Specifies a new lump sum type for the new payment plan. Allowable values are: P - for proportionately split charge/tax; T - for purchase tax only. Applicable only when update_scope = 2. |
|||||||||
| new_payment_plan_lump_sum_amount | double | No |
Specifies the lump sum amount, mandatory when lump sump type is proportionately split (lump_sum_type = P). Applicable only when update_scope = 2. |
|||||||||
| new_payment_plan_lump_sum_amount_type | string | 1 | No |
Specifies the lump sum amount type. Allowable values are: P - Percentage of balance to be paid; F - Flat amount. Applicable only when update_scope = 2. |
||||||||
| new_payment_plan_lump_sum_date | string | No |
Specifies the date of when payment lump sum will be notified. If it's null, then it will look at bill lag days configuration on payment terms and payment method. If it's 0, lump sum will be notified right away. Applicable only when update_scope = 2. |
|||||||||
| new_payment_plan_lump_sum_days_until_due | long | No |
Specifies how many days after notified that a lump sum is due. If it's NULL, then the system will look at days until due configured for a payment term or a specific payment method. Applicable only when update_scope = 2. |
|||||||||
| do_collect | string | 5 | No |
Indicates whether the new lump sum amount should be collected immediately. Allowable values: true - collect immediately, false - do not collect immediately. If null, the default is false. Applicable only when update_scope = 2. If passed with any other update_scope, no collection is attempted and all collection output fields will be null. Allowed values:
|
||||||||
| comments | string | 500 | No |
Optional explanatory text to add context or explain the reason for discontinuing or replacing the current payment plan. |
||||||||
| recalculate_date | string | 1 | No |
Recalculate future notify dates and days until dues for independent payment plan. Allowable values: Y (Yes) or N (No). Null or any other value is treated as N. Allowed values:
|
update_specific_sequence_list fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| seq_no | long | No |
Aria-assigned sequence number for a payment plan |
|
| notify_date | string | No |
Date when the customer is notified that a payment plan sequence is due. Applicable only for unnotified sequences of an independent payment plan. |
|
| due_date | string | No |
Date when the payment plan sequence becomes due. Applicable only for unnotified sequences of an independent payment plan. |
|
| due_amount | double | No |
Amount due for a payment plan sequence (unnotified only). If a sequence amount is modified, Aria automatically redistributes the remaining balance evenly across remaining sequences. |
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_plan_no | long | No |
Aria-assigned payment plan no |
|
| client_payment_plan_id | string | No |
Client unique payment plan id |
|
| recurring_amount | double | No |
Note: This field is deprecated. Aria no longer supports recurring_amount. |
|
| payment_plan_period_type | string | No |
Specifies the payment plan period type. Allowable values are: M (Months), W (weeks), D (Days). Applicable if payment_plan_type = 1. |
|
| payment_plan_interval | long | No |
Specifies the payment plan interval, applicable when payment_plan_type = 1, it works jointly with payment_plan_period_type. If defined, must be less than payment_plan_length. If null, the system defaults to 1. |
|
| payment_plan_length | long | No |
Specifies the length of payment plan. For payment_plan_type = 1, the input will be used jointly with payment_plan_interval. For payment_plan_type = 0, it is the number of MPI statements that the payment plan will be part of. |
|
| updated_payment_plan_schedule | object | No |
Updated payment plan schedule |
|
| payment_transaction_id | long | No |
The unique identifier for a payment transaction |
|
| collected_amount | double | No |
The amount successfully collected when the payment plan is replaced and an immediate collection is requested. |
|
| 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. |
updated_payment_plan_schedule fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| seq_no | long | No |
Aria assigned sequence number of a payment plan |
|
| notify_date | string | No |
Dates when customer will be notified of a payment plan due. |
|
| due_date | string | No |
Due dates of when a payment plan sequence is due |
|
| due_amount | double | No |
Amount due of a payment plan sequence |