This interface retrieves Arrangements / Scheduled events on a contract like Dollar Cost Average ( DCA), Electronic Fund Transfer ( EFT), Scheduled Withdrawal and Asset Rebalancing. The exact response depends on the type of Arrangement. Following information is returned back in the response.
• Arrangement Type
• Arrangement Mode ( Monthly/Quarterly/ Semi Annual/ Annual)
• Start Date
• End Date
• Investment details
• Subaccounts details
• Mode of transfer ( Percentage or Amount)
• Rate Renewal Allocations
• Withholding details
The below list of products are in scope for this operation.
• Deferred Annuity
• Immediate Annuity
• Term Life Insurance
• Universal Life
• Whole Life Insurance
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate. |
| TR2 | ACORD Tx 215 “Arrangement Inquiry Transaction tc=215” should be used for getting the contract summary |
| TR3 | Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code. |
| TR4 | Q-switch needs to be run while processing any event. |
| TR5 | A success response includes the Arrangement details, where the details of the Arrangement may change based on the product selected within the contract and type of Arrangement. |
| BR ID# | Business Requirements |
| BR1 | Only the following Arrangements on a policy, are returned by this transaction.Dollar Cost Average( DCA)Electronic Fund Transfer (EFT)Asset RebalanceSystematic Withdrawal |
| BR2 | The contract needs to be present in ALIP for the data to be returned. |
| BR3 | Expired events will not be available in the response even if it is processed. |
| BR4 | Future events can be retrieved along with current events based on configurable property in ALIP.By default, the property is set to retrieve only current events as of current system date in response.IX.GET_ARRANGEMENTS.Eventstatus=ALL (set to retrieve all events) |
| BR5 | The Contract should be in Active or Death Claim Pendingstatus to get the summary details. |
| BR6 | The API also retrieves Withholding information for Owner/Primary Annuitant based on a configurable ALIP property. By default, withholding information is not available.IX.GET_ARRANGEMENTS.withholdingIND=Yes |
| BR7 | Rate Renewal Arrangement is also supported. If a contract has Multiple rate renewal on a contract, data for all rate renewals will be displayed in response.Rate Renewal Arrangement block data elements will be displayed in all the Holding blocks having Event start date less than or equal to ‘AsOfDate’ of the Holding block. |
| BR8 | Only Amount, Percentage and Combo option is supported for Get Arrangements |
• The external system would fire the REST URL with the JSON message containing the arrangements information to be retrieved/updated/deleted on the request queue.
• ALIP webadapters 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 arrangement information, existence of the contract id in ALIP etc.
• Post the necessary validations, it would invoke the necessary ALIP APIs/workflows to create/update/delete or retrieve the necessary arrangements information from the database.
• The arrangement information in case of a “GET” request, or the status information incase of a create/update/delete (POST/DELETE), would be generated in XML format, converted to ACORD format, and sent back to the REST layer.
• Here, it would be further converted back into the final JSON output format and returned back to the external system.
Withholding information is available for Owner and Primary roles as part of response based on enabling configurable property in ALIP.
None
. Q switch needs to be run on any date before triggering API.
. Events Type and Options not part of mapping will not be mapped in response.
N/A
| Request Parameters | Description | Mandatory | Allowed values |
| Contract Number | A number which uniquely identifies a contract number within ALIP. | Y |
Response Details:
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The “Get Available Arrangements” 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 |
| #2 | The “Get Available Arrangements” interface could not find any matching record in ALIP. | 5 | Internal Error | Informational |