Get Contract Funds accepts a contract ID as an input and returns all the funds which are currently vested in for a particular contract. The funds are tied to the product associated with the contract.
The API also returns segment information in response as of Current Date.
The following products are in scope:
Deferred Annuity
Universal Life
The following information for each of the available fund is returned in the response:
Policy
PolNumber
ProductCode
AsOfDate
Arrangement
ArrangementMode
ArrangementType
StartDate
EndDate
ArrangementSubType
SourceTransferAmountType
DestinationTransferAmountType
Investment
AccountValue
SubAccount
FinancialStatement
InvestmentStatement
SubAccountStatement
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate. |
| TR2 | ACORD Tx 233 “Holding Product Inquiry Transaction tc=233” is being used for getting the available funds and its details |
| TR3 | Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code. |
| TR4 | For a success, the response will provide the available funds and its details. |
| BR ID# | Business Requirements |
| BR1 | Get Contract Funds should provide the list and details of all the vested funds for the provided contract. |
| BR2 | Contract Status should be ‘Active’. |
| BR3 | The contract needs to be present in ALIP for the data to be returned. |
| BR4 | API supports display of active segments data elements (For list of data elements refer section 3.2.9) |
| BR5 | A segment is active if the current date is on or before the segment maturity date. |
| BR6 | Active segments are always displayed in response based on current date. To fetch active Segment/Bucket details on a contract, a quote will be run on current date which will fetch all the active segment/Buckets. |
| BR7 | As Per ATH059 Enhancement the fund name should be appended with deposit date when the date tracking is enabled at fundlevel.For the funds where Date tracking isnot enabled only fund name will be displayed.Eg:1. Fund A: Money Market[Deposit Date: 2022/12/12]2. Standard Fixed Loan |
Below is the screenshot of ALIP segments, which are fetched in response.
Same as section 3.1.4
N/A
Contracts in ‘Pending Issue’ and ‘Pending Awaiting Funds’ status will not fetch Segment related data elements.
Segment information will be supported for valid business cases only, where last processed transaction date is not a future date or cycle is processed till current date.
N/A
| Request Parameters | Description | Mandatory | Allowed values |
| Contract Number | A number which uniquely identifies a contract number within ALIP. | Y |
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Get Contract Funds call was successful with details being returned in the output | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Get Contract Funds call was NOT successful due to a technical error or contract not found. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |