transfer_account_balance_m
Summary
| API Name | transfer_account_balance_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 34 |
Description
Transfers the balance from one account to another account.
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. |
| source_account_no | long | 22 | Yes |
The Source account is the account who's entire balance will be credited and a the amount applied to the specified Target account. Alternative required field: source_client_acct_id |
| target_account_no | long | 22 | Yes |
The Target account is the account that will received a debit for the entire balance of the Source account. Alternative required field: target_client_acct_id |
| client_receipt_id | string | 50 | No |
Client-defined unique identifier used to track related system actions. |
| target_master_plan_instance_no | long | 22 | Yes |
The MPI associated with the target account that will receive a debit for the entire balance of the Source account. Alternative required field: target_client_master_plan_instance_id |
| target_client_master_plan_instance_id | string | 100 | Yes |
Client-defined unique identifier for the master plan instance Alternative required field: target_master_plan_instance_no |
| source_client_acct_id | string | 50 | Yes |
Alternative required field: source_account_no |
| target_client_acct_id | string | 50 | Yes |
Alternative required field: target_account_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| account_balance_transfer_details | object | No |
Array of balance transfer details. |
|
| 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. |
account_balance_transfer_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| source_master_plan_instance_no | long | No |
Source master plan instance no which has balance |
|
| destination_master_plan_instance_no | long | No |
Destination master plan instance which has received the balance |
|
| transaction_id | long | No |
The unique identifier for a given transaction |
|
| balance_transfer_amount | double | No |
The amount of money transferred from the Source to the Target account for this transaction. |