Skip to main content

Class AddAccountsRequest


Properties

NAMETYPELENGTHREQUIREDDESCRIPTIONEXAMPLES
PartnerIdInteger9YesThe Partner ID is a unique ID assigned by Ensenta specific to each setup within Ensenta’s platform and will be different for each environment (UAT and Production).<PartnerId>8257</PartnerId>
LanguageIdInteger1YesSend integer 9<LanguageId>9</LanguageId>
DepositorIpAddressString45YesIP address of End-User (NOT calling web service). IPv4 or IPv6 are accepted.<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
DeviceIdentifierStringN/AYesThe unique UUID generated for the phone.<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
SessionStateIdStringN/AYesThis is the unique GUID returned in the StartSession response.<SessionStateId>a15adeac-ae2c47dc-86ca973a7bc79dfb</SessionStateId>
SessionTokenThis is the value returned in the StartSession response.<SessionToken>7bdb9860-dcd5-4f75-8629-61c8d18cbfed</SessionToken>
AccountsAccount[]YesAn array containing the account(s) the End-User can make a deposit into.

Contains the account details for a single account.
<Accounts>
<Account>
<AccountNumber>20202</AccountNumber>
<Description>RenSaving-20202</Description>
<AccountTypeCode>0</AccountTypeCode>
<JointAccountHolderNames>
<string>Tim</string>
</JointAccountHolderNames>
</Account>
<Account>
<AccountNumber>20203</AccountNumber>
<Description>RenChecking-20203</Description>
<AccountTypeCode>1</AccountTypeCode>
<JointAccountHolderNames>
<string>Tim</string>
</JointAccountHolderNames>
</Account>
</Accounts>

Account

ParameterTYPEREQUIREDDescriptionEXAMPLESComments
AccountNumberStringYesAccount Number.<AccountNumber>123456</AccountNumber>
DescriptionStringYesThe description of the account as displayed to the EndUser.<Description>Checking</Description>
AccountTypeCodeStringYesA code that identifies the type of account.

Supported values:
  • 0 = Savings / Regular Share
  • 1 = Checking / Share Draft
  • 32 = Line of Credit
  • 64 = Credit Card
  • 128 = Installment Loan
  • 256 = Mortgage Loan
<AccountTypeCode>1</AccountTypeCode>
JointAccountHolderNamesString[]NoFull name of joint account holders that are also authorized to make deposits to this specific account. If no joint account holder names are available, send empty.

Name of joint account holder as described in JointAccountHolderNames.
<JointAccountHolderNames>
<string>John Doe</string>
</JointAccountHolderNames>
TagStringYesAs described in the Accounts parameter above, Ensenta will provide a list of accounts in the StartSession response that are allowed per any additional account eligibility controls being enforced on the Ensenta side (see StartSession Response).

The accounts provided back in the AccountKey parameter from the StartSession response will include the Tag value that you have defined for each account you defined in the request, so you can match up accounts in the request with accounts in the response and display the full account descriptions you originally sent. Alternatively, Ensenta will pass back account descriptions in the StartSession response, but they will be slightly altered (we remove "account" and if duplicate descriptions exist, we will append the masked account number at the end).
<Tag>0</Tag>

Examples

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ecp="http://ensenta.com/ECPartnerDepositRequest">
<soapenv:Header/>
<soapenv:Body>
<ecp:AddAccounts>
<ecp:request>
<ecp:PartnerId>7163</ecp:PartnerId>
<ecp:LanguageId>9</ecp:LanguageId>
<ecp:DepositorIpAddress>::1</ecp:DepositorIpAddress>
<ecp:DeviceIdentifier>::1</ecp:DeviceIdentifier>
<ecp:SessionStateId>a15adeac-ae2c-47dc-86ca973a7bc79dfb</ecp:SessionStateId>
<ecp:Accounts>
<ecp:Account>
<ecp:AccountNumber>20202</ecp:AccountNumber>
<ecp:Description>RenSaving-20202</ecp:Description>
<ecp:AccountTypeCode>0</ecp:AccountTypeCode>
<ecp:JointAccountHolderNames>
<ecp:string>Tim</ecp:string>
</ecp:JointAccountHolderNames>
</ecp:Account>
<ecp:Account>
<ecp:AccountNumber>20203</ecp:AccountNumber>
<ecp:Description>RenChecking-20203</ecp:Description>
<ecp:AccountTypeCode>1</ecp:AccountTypeCode>
<ecp:JointAccountHolderNames>
<ecp:string>Tim</ecp:string>
</ecp:JointAccountHolderNames>
</ecp:Account>
<ecp:Account>
<ecp:AccountNumber>20204</ecp:AccountNumber>
<ecp:Description>Money Market Checking-202024</ecp:Description>
<ecp:AccountTypeCode>2</ecp:AccountTypeCode>
<ecp:JointAccountHolderNames>
<ecp:string>Tim</ecp:string>
</ecp:JointAccountHolderNames>
</ecp:Account>
</ecp:Accounts>
</ecp:request>
</ecp:AddAccounts>
</soapenv:Body>
</soapenv:Envelope>