One-Time Withdrawal

Request/Response & Json Schema

Overview

The purpose of this interface is to inquire, submit or cancel operation for One Time Withdrawal transaction.

Through this interface user can Inquiry about withdrawal and know their eligibility towards withdrawal.

After getting projected potential resulting scenario user can decide whether to continue with Withdrawal transaction through provide Cancel and Submit option.

ALIP will receive the details for inquiry, cancel and submit operations to withdrawal transaction.

Inquire: User passes the details for inquiry request for one-time withdrawal. Request has information regarding amount, transaction effective date, policy number, target fund account. Interface processes information and sends back the Potential Resulting Values present in respective contract to the user. And, there is Withdrawal transaction request saved with incomplete status in ALIP.

Submit/Cancel: Based on the response on inquire, user can select desired option/step i.e. should processed or not for one-time withdrawal transaction. User canhave sent another request to the interface for submitting/cancelling the transaction.

Withdrawal transition which is saved as part of Inquire process can be saved with pending status or delete for submit and cancel options respectively.

All products are in scope under this interface functionalities.

Through this interface user can Inquiry about withdrawal and know their eligibility towards withdrawal.

After getting projected promised scenario user can decide whether to continue with Withdrawal transaction through provide Cancel and Submit option.

Requirements

TR ID# Technical Requirements Interface Design Traceability Test Case Traceability
TR1 ACORDv2.36 shall be used to communicate.  IEX-IDD-INT- 005-7.1  IEX-IDD-INT- 005-11.1
TR2 ACORD Tx 105 “One-Time Withdrawal” tc=”105” is being used for One Time Withdrawal IEX-IDD-INT- 005-7.2 IEX-IDD-INT- 005-11.1
TR3 Interface must always return an error code and description in the event of a processing failure in addition to HTTP response code.  IEX-IDD-INT- 005-7.3 IEX-IDD-INT- 005-11.1#1
TR4 For a success, the response will provide the as “Success” IEX-IDD-INT- 005-7.4  IEX-IDD-INT- 005-11.1#2
TR4 tag in request should define whether its Inquire /Submit/Cancel>. i.e. I=Inquire, S=Submit, C=Cancel based on mentioned indicator interface will perform Enquiry, Submission or cancellation on withdrawal transaction respectively. IEX-IDD-INT- 005-7.4  IEX-IDD-INT- 005-11.1#3

Business Requirements

BR ID# Business Requirements
BR1 The contract number within the input request needs to be present in ALIP.
BR2 Input amount should be greater than zero and less than contract maximum withdrawal amount.
BR3 The contract should be in below status to support this transaction.1.Active2.Payout3.Free look

Process Flow

The external system would fire the message containing the one-time withdrawal Information request.

ALIP web adapters would pick up, process the message, convert it into XML format, and posts it onto the ALIP request queue.

ALIP process server will pick up the message, convert from ACORD to the canonical format, perform the necessary XSD validations, and other basic validations on the completeness of the Requirement information, existence of the contract in ALIP etc.

Post the necessary validations, it would invoke the required ALIP APIs for getting the necessary data.

For inquiry request, workflow will return with transaction details along with all the account quote and fund Information and the transaction will get saved in ALIP.

For submit request, workflow will again validate the request and incase of no errors, transaction will be created in pending section in ALIP.

For cancel request, workflow will delete the transaction created during inquiry.

In all above scenarios, a success response will be returned to the external system.

In case of a Processing failures, the same will be logged with proper error code, description and the exception information to the log files and an Integration Failure should be created.

Impact on ALIP system

This interface provides the ability for creation withdrawal transaction with Incomplete status on ALIP when user opted inquire process.

This interface provides the ability for creation withdrawal transaction in pending status on ALIP when user opted submit process.

This interface provides the ability to deletion transaction from Alip in case user opted cancel process.

Assumptions

Withdrawal process request support Amount no other transfer option like percentage.

Inquire process followed by Submit or Cancel process.

After Inquireprocess withdrawal transaction willbe present with Incomplete status and Submit/Cancel process can be applied on that incomplete transaction.

ALIP support Withdrawal transaction on policy with specific status only i.e. - 1. Active, 2.Payout3.Free look.

Dependencies

NA

Request Data Elements

Response Data Elements

Success/Error Handling

# Condition Message Code Message Description Message Type Expected Results
1 The One Time Withdrawal(Inquire) call was successful. N/A Success Informational Response with informational tag elements and transaction code
2 The One Time Withdrawal(Submit) call was successful. N/A Success Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1
3 The One Time Withdrawal(Cancel) call was successful. N/A Success Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1
4 The One Time Withdrawal(Inquire/Submit/Cancel) interface fails with any input missing field validation failures XSD validation Error Message Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
5 The One Time Withdrawal(Inquire/Submit/Cancel) interface fails with invalid ActionIndicator field from input Invalid Action indicator Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
6 The One Time Withdrawal(Inquire/Submit/Cancel) interface fails with blank ActionIndicator field from input Action indicator cannot be empty Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
7 The One Time Withdrawal(Inquire/Submit/Cancel) interface fails with missing ActionIndicator field from input Action Indicator is required Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
8 The One Time Withdrawal(Inquire) interface fails with Financial Net Amount not tallying with Total Transfer Amount from multiple funds Total Transfer Amount Should be equal to FinActivityNet Amount Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
9 The One Time Withdrawal(Inquire) interface fails with Financial Net Amount not tallying with Total Transfer Amount from single fund Transfer Amount Should be equal to FinActivityNet Amount Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
10 The One Time Withdrawal(Inquire) interface fails with Financial Net Amount not tallying with Arrangement Modal Amount FinActivityNet Amount must be equal to the Modal Amount Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
11 The One Time Withdrawal(Inquire) interface fails with Total transfer amount of multiple funds not tallying with Arrangement Modal Amount Total Transfer Amount Should be equal to modal Amount Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
12 The One Time Withdrawal(Inquire) interface fails with Total transfer amount of single fund not tallying with Arrangement Modal Amount Transfer Amount Should be equal to modal Amount Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
13 The One Time Withdrawal(Inquire) interface fails with transfer amount equal to 0 Transfer Amount should not be blank or zero Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
14 The One Time Withdrawal(Inquire) interface fails with Modal amount equal to 0 Modal Amount should not be blank or zero Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
15 The One Time Withdrawal(Inquire) interface fails with FinActivityNet amount equal to 0 FinActivityNet Amount should not be blank or zero Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
16 The One Time Withdrawal(Inquire) interface fails with transfer amount less than 0 Transfer Amount should not be less than zero Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
17 The One Time Withdrawal(Inquire) interface fails with Modal amount equal to 0 Modal Amount should not be less than zero Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
18 The One Time Withdrawal(Inquire) interface fails with FinActivityNet amount equal to 0 FinActivityNetAmount should not be less than zero Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
19 The One Time Withdrawal(Inquire/Submit) interface fails due to invalid contract status Transaction not allowed. Contract not in valid status Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
20 The One Time Withdrawal(Submit/Cancel) interface fails due to invalid non existing transaction number Transaction down not exist in ALIP Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
21 The One Time Withdrawal(Submit/Cancel) interface fails due to txn eff date prior to contract date Transaction Effective Date is before contract date Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
22 The One Time Withdrawal(Submit/Cancel) interface fails due to invalid fund in input %Fund_Name% does not exist on contract Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
23 The One Time Withdrawal(Submit/Cancel/Inquire) interface fails due to error from workflow processing Workflow specific error/s displayed Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5
24 System Error N/A Failure Fatal TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5