Get Bank Account Details

Request/Response & Json Schema

Overview

The Get Bank Account Details API accepts an clientid and returns all the bank account available on that clientid. The API will also return the credit card registered within the ALIP system associated with the clientId.

The following information for the available Bank Account is returned in the response:

Holding

HoldingTypeCode

Banking

BankingSysKey

BankAcctType

AccountNumber

RoutingNum

AcctHolderName

BankName

RoleCount

PolicyId

billId

billingType

PolicyNumber

CreditCardType

CreditCardExpDate

CreditDebitType

CardVerificationNum

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 shall be used to communicate.
TR2 ACORD Tx 2035“Get Bank Account tc=2035” is being used for getting the Bank Account and Credit Card 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 Bank Account and its details.

Business Requirements

BR ID# Business Requirements
BR1 The Get Bank Account details for Client Id should provide the list and details of all the Bank Account for the Client id. Here the client id should be within the ALIP system, having any role.
BR2 Interface returns a list of Bank Account and Credit Card details based on the client id where respective of the role of the client id should be within the ALIP system.
BR3 The Client Id needs to be present in ALIP for the data to be returned.

Impact on ALIP system

N/A

Assumptions

The Client id passed within the request should be of a user within the ALIP system.

The client id passed must belong to an individual type client present within the ALIP system. There is no support for company or trust type clients.

The field specified in the 3.1.1 overview section are not mandatory but will depend on the type of data associated with the client id.

The System will also able to get Card details at the PaymentSource Level.

Dependencies

The Client id and the related data be available within the ALIP system.

Request Data Elements

Request Parameters Description Mandatory Allowed values
PartySysKey A number which uniquely identifies a contract number within ALIP. Y
PartyTypeCode Type of party existing in the system N

Response Data Elements

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The get Bank Account Detils on for client id 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 Bank Account Details for client id call was NOT successful due to a technical error or client id not found. 5 Internal Error Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5