Package Service

IDM Interface Control Document

 

Service Version 2.0

Document Version 1.5

 

 

 

 


Revision History

Date

Revision

Description

Author

August 5, 2011

1.0

Initial Draft

Richard Daniel

August 15, 2011

August 16, 2011

1.1

Updated Field Definitions and formatting

Kathleen M Stone

August 16, 2011

1.1

GetListPackageStatementEligibility request mapping fix

Richard Daniel

August 22, 2011

1.2

GetListPackageStatementEligibility mapping description update

Richard Daniel

August 23,2011

1.2

Status Block added to all reply schemea definitions

Richard Daniel

September 6, 2011

1.3

Status Block Fix in all operations

Richard Daniel

September 27, 2011

1.4

SubProductCode of GetListPackageStatementEligibilityRequest changed to optional.

Richard Daniel

October 6, 2011

1.5

Added new element CoreAccountSwitch to GetListPackageStatementEligibilityReply

Richard Daniel

February 27, 2012

1.6

Added additional status related process descriptions to MaintainPackageRelationships operation

Richard Daniel

 


Table of Contents

1.     Introduction                                                                                                                                   3

1.1     Purpose                                                                                                                               3

1.2     Scope                                                                                                                                  3

1.3     Assumptions                                                                                                                        3

1.4     References                                                                                                                            3

1.5     Definitions, Acronyms, and Abbreviations                                                                                 3

2.     High-Level Interface Specification                                                                                                      3

2.1     System Interface Diagram                                                                                                       3

2.2     System Interaction Diagrams                                                                                                   3

2.2.1   GetListPackageEligibleAccounts                                                                                       3

2.3     Security Specification                                                                                                            3

2.4     Processing Specifications                                                                                                        3

2.5     Exception Processing                                                                                                             3

3.     Data Types                                                                                                                                    3

3.1     Simple Types                                                                                                                       3

3.2     Complex Types                                                                                                                    3

3.2.1   Core Components                                                                                                          3

3.2.2   Custom Components                                                                                                      3

3.2.3   Status                                                                                                                          3

3.2.4   GetList                                                                                                                        3

3.2.5   Detailed Message Specification                                                                                         3

3.3     GetListPackageEligibleAccounts                                                                                              3

3.3.1   Processing Specifications                                                                                                3

3.3.2   Special Notes                                                                                                                3

3.3.3   Message or File Format Specifications                                                                               3

3.3.4   Message to Data Source High level Specifications                                                                3

3.3.5   Field/Element Specifications                                                                                            3

3.3.6   Exception Processing                                                                                                      3

3.4     GetListPackageRelatedAccounts                                                                                               3

3.4.1   Processing Specifications                                                                                                3

3.4.2   Special Notes                                                                                                                3

3.4.3   Message or File Format Specifications                                                                               3

3.4.4   Message to Data Source High level Specifications                                                                3

3.4.5   Field/Element Specifications                                                                                            3

3.4.6   Exception Processing                                                                                                      3

3.5     SetupPackageAccount                                                                                                            3

3.5.1   Processing Specifications                                                                                                3

3.5.2   Special Notes                                                                                                                3

3.5.3   Message or File Format Specifications                                                                               3

3.5.4   Message to Data Source High level Specifications                                                                3

3.5.5   Field/Element Specifications                                                                                            3

3.5.6   Exception Processing                                                                                                      3

3.6     MaintainPackageRelationships                                                                                                 3

3.6.1   Processing Specifications                                                                                                3

3.6.2   Special Notes                                                                                                                3

3.6.3   Message or File Format Specifications                                                                               3

3.6.4   Message to Data Source High level Specifications                                                                3

3.6.5   Field/Element Specifications                                                                                            3

3.6.6   Exception Processing                                                                                                      3

3.7     GetListPackageStatementEligibility                                                                                          3

3.7.1   Processing Specifications                                                                                                3

3.7.2   Special Notes                                                                                                                3

3.7.3   Message or File Format Specifications                                                                               3

3.7.4   Message or File Format Specifications                                                                               3

3.7.5   Message to Data Source High level Specifications                                                                3

3.7.6   Field/Element Specifications                                                                                            3

3.7.7   Exception Processing                                                                                                      3

3.8     MaintainPackageAnalysis                                                                                                       3

3.8.1   Processing Specifications                                                                                                3

3.8.2   Special Notes                                                                                                                3

3.8.3   Message or File Format Specifications                                                                               3

3.8.4   Message to Data Source High level Specifications                                                                3

3.8.5   Field/Element Specifications                                                                                            3

3.8.6   Exception Processing                                                                                                      3

3.9     UpdatePackageStatementCycle                                                                                                 3

3.9.1   Processing Specifications                                                                                                3

3.9.2   Special Notes                                                                                                                3

3.9.3   Message or File Format Specifications                                                                               3

3.9.4   Message to Data Source High level Specifications                                                                3

3.9.5   Field/Element Specifications                                                                                            3

3.9.6   Exception Processing                                                                                                      3

3.10       GetListPackageStatementCycle                                                                                             3

3.10.1 Processing Specifications                                                                                                3

3.10.2 Special Notes                                                                                                                3

3.10.3 Message or File Format Specifications                                                                               3

3.10.4 Message to Data Source High level Specifications                                                                3

3.10.5 Field/Element Specifications                                                                                            3

3.10.6 Exception Processing                                                                                                      3

4.     Connection Information                                                                                                                   3


Interface Control Document

 

1.    Introduction

1.1    Purpose

The purpose of this document is to describe the interfaces for the Package Service Version 2 that will be used to populate the Online Banking Dash Board with customer information. 

1.2    Scope

This document addresses the Package Service Version 2 interface for the purposes retrieving customer information.  The Package Service Version 2 is being designed as an Enterprise Services with the intention that any application could be a consumer of this service.

1.3    Assumptions

The following assumptions were made in the creation of this specification:

·       The audience of this document has a basic common understanding of the Common Information Model (CIM) and of the simple and complex types defined within the model.

 

1.4    References

The following documents were used in the creation of this specification:

·       PackageService_V_2_0.wsdl

·       MessagePackageService_V_2_0.xsd

·       USBSOACoreComponentsLibrary_V_2_0.xsd

·       USBSOATypeLibrary_V_2_0.xsd

 

1.5    Definitions, Acronyms, and Abbreviations

Abbreviation/Acronym/Term

Definition

Common Information Model (CIM)

Is the common repository for the Enterprise Business Objects/Canonicals’ (EBO/EBC), Enterprise Business Message's (EBM), Enterprise Business Message Components (EBMC) and Enterprise Business Message Types (EBMT).

OSB (Oracle Service Bus)

Is the run-time component that is responsible for the enforcement/execution of the policies defined for web services.

SOAP

Simple Object Access Protocol (SOAP) version 1.2 is the W3C specification for a simplified messaging framework based on XML.

SOA Software

Third party vendor that provides our web service gateway tools.

WSDL

Web Service Definition Language (WSDL) version 1.1 is the W3C specification for web services definition

 


2.    High-Level Interface Specification

2.1    System Interface Diagram

The following diagram (figure 1.1) shows a high-level view of the parties involved in the Package Service Version 1 process.  As mentioned in the scope section of this document, the Package Service Version 1 is being designed to be an Enterprise service that could be used by any application.

The diagram also shows the OSB components of SOA Software because it is still fairly new to the enterprise and its role is not widely understood.  The intention is to represent the fact that the consumers are not connecting directly to the service, but are going through virtualized service that is hosted by OSB.  There will also be a detailed sequence diagram to provide a little better insight to how the components will interact with each other.  

 

Figure 2.1

 


 

2.2    System Interaction Diagrams

There are a couple of different scenarios for the main flows through the Package Service Version 2 processes.  Each of those scenarios will be depicted in the following interaction/sequence diagrams.  One of the sequences will also include the OSB component to depict how the virtualized services sit in front of the real services.

 

2.2.1        GetListPackageEligibleAccounts

2.2.1.1    The following diagram (figure 2.2) illustrates the series of interactions for getting a list of customer accessible accounts.

 

In this flow, the consuming client will submit their request and the system will

 

Figure 2.2

 


2.2.1.2    Oracle Service Bus (OSB)

The following diagram (figure 2.3) illustrates the details of how OSB plays a role in the sequence where the PackageService_V_2_0 operation is being invoked.  You can see that every request between consumer and service is routed through OSB.  This is true for both internal (ID Confirmation) and external (Acxiom) services. 

 

This is not intended to be a complete/full picture of how the OSB (and all the SOA Software components) works in the environment, but is here to provide a brief overview of the role it will play.

Figure 2.3

 

A proxy pattern is used and the proxy gateway is used as a policy enforcement point for authentication.

 

 

2.3    Security Specification

The US Bank security specifications are explained below..

Mutual authentication or two-way authentication (sometimes written as 2WAY authentication) refers to two parties authenticating each other suitably.  In technology terms, it refers to a client or user authenticating themselves to a server and that server authenticating itself to the user in such a way that both parties are assured of the others' identity.  Identity can be proved through a trusted third party and use shared secrets, as in Kerberos v5, or through cryptographic means, as with a public key infrastructure.

 

WS-Security 1.0 will be used to handle service authentication.  We expect a WS-Security UsernameToken to be provided in the WS-Security header from client in all service calls.  In addition, SSL mutual authentication would be the payload authentication between OSB and the TIBCO service layer.

 

Document name : OSB WS-Sec ICD x.y.doc (x - Major version, y Minor version)

Click here for the document folder in Share point.

 

2.4           Processing Specifications

 

This section describes the most common processing pattern used by the operations of the service.  If this pattern does not apply to a specific operation then that operation will document the processing pattern specifically for that operation.

 

·     Process starts with client application putting the SOAP on HTTPS request message to the service URL

·     The BW Process Engine listens for messages on the specified HTTPS port.  As soon as the message is received on the HTTPS port, it kicks off the BW Process associated with that service operation.

·     The request is logged, validated and transformed into HOST specific format.  In this case, XML message is converted into COBOL Copy Book (CCB) or some times referred to as a Flat File Definition (FFD) format.

·     After transformation, this message is sent to MQ queue.  The MQ CICS adapter running on the mainframe processes this message and starts the CICS transaction associated with the application name provided in the message.

·     The Hogan/PAS sends reply to the MQ CICS Adapter. MQ Adapter in turn puts this reply message onto the MQ reply queue.

·     The BW process Engine, which is waiting for reply from MQ Adapter, now receives this message, and converts the FFD format into XML format.  For all the transformation purpose BW process uses Contivo as a mapping engine.

·     Reply will sent to client application at the HTTPS port on which the client application put the request.

·     There will be time-out limit on Client and Host side messaging and appropriate message will be sent in the event of time-out.

 

2.5           Exception Processing

Please refer to the technical implementation service guide for directions on implementing enterprise error codes for replies and fault messages.  This section was referred as Error Codes in earlier versions.

 

Document name : USBank_SOAP-Error-Warning-Info_InterfaceControlDocument_V_x_y.doc

(x - Major version, y Minor version)

Click here for the document folder in Share point.

 

Note:  Specific error messages for each operation will be documented along with that operation.


3.    Data Types

3.1    Simple Types

All of the simple types that will be used are defined within the SOA type library specification. 

Please refer to the USBSOATypeLibrary_V_2_0.xsd for details the types.

 

3.2    Complex Types

Where possible, the complex types that are defined in the SOA core components library will be used and additional complex types will be created that are specific to the Package Service Version 2 as necessary.  Please refer to the USBSOACoreComponentsLibrary_V_2_0.xsd for details on the core components.

 

3.2.1    Core Components

·       There are no core components currently documented.

 

3.2.2    Custom Components

3.2.2.1    CustomerNameIdentifier

 

Name

Type

Required

Description

Data Source Target

OperatingCompanyIdentifier

usbsoatl:OperatingCompanyIdentifier

No

Operating Company Identifier

Internal US Bank identifier used for segmenting accounts into regions or other operating units.

 

 

AccountWholeName

usbsoatl:String0040

Yes

Customer name 1. Whole name of customer that includes first, middle, and last.

 

 

CustomerTieBreaker

usbsoatl:NumberNonNegative05

Yes

Customer Tie Breaker

Used along with Customer Company Number and Customer Name to create a unique identifier for a customer.

 

 

 

 

3.2.2.2    AccountPrimaryIdentifier

Name

Type

Required

Description

Data Source Target

OperatingCompanyIdentifer

usbsoatl:OperatingCompanyIdentifier

Yes

Operating Company Identifier

Company Identifier a/k/a Bank Number is a three-digit number which delineates a particular market region (usually the State to which an account or customer has been assigned).  

Default = 654

 

 

ProductCode

usbsoatl:String0003

Yes

Account Product Code

This field is used in conjunction with X77806-NXT-ACCT-COID-N and X77806-NXT-ACCT-NBR for scrolling purpose. Values of the product code are DDA, CCD.

 

 

 

PrimaryIdentifier

usbsoatl:AlphaNumeric23

Yes

Primary Account Identifier

The account number.

This is the account number to search for.  This is a key used for account lookup in HOGAN.

 

 

 

3.2.3      Status

Name

Type

Required

Description

Data Source Target

StatusCode

usbsoatl:IdentifierNumber

Yes

Process Status Code (0 or 1)

 

 

 

See Status

ServerStatusCode

usbsoatl:String0020

No

Return Code from Host Systems

 

Severity

usbsoatl:Severity_2

Yes

Enumeration

(Info, Error & Warning)

 

StatusDesc

usbsoatl:String0255

No

Return Status Description from Host Systems

 

AdditionalStatus

AdditionalStatus

No

Additional Info  (of type Status)

 

 

3.2.4    GetList

Name

Type

Required

Description

Target Source

NextDataFetchKey

usbsoatl:String2048

No

NextDataFetchKey

Check to see if this is implemented fully. 

Composite key of the next desired Account or Customer.  Consumers will use this key to obtain the next page of data.

 

 

MaximumNumberOfItems

usbsoatl:NumberNonNegative05

No

Maximum Number of Items

Check to see if this is implemented fully

 

 

SortOrderCode

usbsoaccl:SortOrderCodeEnumerationsList

No

Sort Order Code

Check to see if this is implemented fully. 

A code that indicates the sorting performed on this list. 

 

 

MoreIndicator

Xsd:Boolean

No

More Indicator

Indicate if more data is available to fetch or not

 

 

 

 

3.2.5    Detailed Message Specification

 

 


 

3.3    GetListPackageEligibleAccounts

Gets only package eligible accounts from Hogan.

 

3.3.1    Processing Specifications

Input

·       Package Account Identifier

·       Customer Identifier (Name or LPID)

·       Sub Product Code, Only Eligible accounts flag

·       Core Account Identifier

·       Scrolling Parameters

 

      Output

·       Scrolling parameters

·       Package Eligible Accounts List

 

3.3.2    Special Notes

Please refer to the following documents regarding message structure, USB SOAP Header and USB SOAP Fault and error codes.

·       USBSOAPHeader_V_2 Interface Control Document v0.1.doc

·       USBSOAPFault_V_2 Interface Control Document v0.1.doc

 

 

3.3.3    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

3.3.4    Message to Data Source High level Specifications

 

Service Operation Name

Source System Name

Source System Transaction/ Message Name

GetListPackageEligibleAccounts

HOGAN PAS

EPKLGIP0

 

3.3.5    Field/Element Specifications

3.3.5.1    GetListPackageEligibleAccountsRequest

Name

Type

Required

Description

Data Source Target

GetList

mps:GetListPackageEligibleAccountsFilter

Yes

Items used for message request control

See GetListPackageEligibleAccountsFilter

GetListPackageEligibleAccountsList

usbsoaccl:Noun_2

No

Package eligible account list

n/a

 
3.3.5.1.1    GetListPackageEligibleAccountsFilter

Name

Type

Required

Description

Data Source Target

FetchLimit

usbsoatl:NumberNonNegativeInteger

No

Maximum number of Accounts to return. If not supplied, a default number determined by the host (77 in this case) will be returned.

 

V200-MAX-RELATIONSHIPS

NextSequenceKey

usbsoaccl:AccountPrimaryIdentifier

No

The account primary identifier

See  AccountPrimaryIdentifier

X77806-NXT-ACCT-COID-N+

X77806-NXT-ACCT-PROD+

X77806-NXT-ACCT-NBR

ChannelTypeCode

usbsoatl:ChannelTypeCode

No

Channel Type Code

The type code assigned to this channel.

This field tracks the method used to open the account.  Examples are

Internet (WEB),

walk-in to Branch (BPL), Acquisition (ACQ) or Solicitor (SOL and SQL).

 

n/a

PackageEligibleAccountsSpecificFilterCriteria

mps:PackageEligibleAccountsSpecificFilterCriteria

Yes

Package Eligible Accounts Specific Filter Criteria

Composite key of the specific account criteria filter.

 

See  PackageEligibleAccountsSpecificFilterCriteria

 

 

3.3.5.1.2    PackageEligibleAccountsSpecificFilterCriteria

Name

Type

Required

Description

Data Source Target

SwitchEmptyListForNoRecords

usbsoatl:Switch

No

Logic condition to send if there is no record for a valid combination of PKG/Cust/SPC, otherwise USBSOAPFault_2 will be sent. Possible values are 'true' and 'false'.

n/a

PackagePrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

The account primary identifier

See AccountPrimaryIdentifier

X77806-CORE-ACCT-COID-N+

X77806-CORE-ACCT-PROD+

X77806-CORE-ACCT-NBR

PackageSubProductCode

usbsoatl:String0003

Yes

Generic Code representation type. Will typically be further restricted to the field length needed by a specific code field.

X77806-PKG-SUB-PRD

CoreAccountPrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

The account primary identifier

See AccountPrimaryIdentifier

X77806-CORE-ACCT-COID-N +

X77806-CORE-ACCT-PROD +

X77806-CORE-ACCT-NBR

CustomerIdentifiers

mps:CustomerIdentifiers

No

Customer account identifier complex type

See CustomerIdentifier

OnlyEligibleAccounts

usbsoatl:Switch

No

This is an eligibility flag and its value can be ‘Y’, ‘N’, or ‘’.  If "Y", the results table would only contain those accounts that could be in the package type, and not any accounts that are in the package type.  If "N", the results table would only contain those accounts that are in the package type, and not any accounts that could be in the package type.  If spaces, the results table would contain both those accounts that could be in the package type as well as any accounts that are in the package type.  

X77806-PKLG-ELIG-ONLY

3.3.5.2    CustomerIdentifier

 

Name

Type

Required

Description

Data Source Target

CustomerNameIdentifier

usboaccl:CustomerNameIdentifier

 

 

 

Choice

Group

Customer Name Identifier

This field contains the activity to be issued by programs accessing this data.

 

See  CustomerNameIdentifier

X77806-PRIM-CUST-COID-N+

X77806-PRIM-CUST-NAME          +

X77806-PRIM-CUST-TIE-N        

CustomerLegalParticipantIdentifier

usbsoatl:ParticipantSystemIdentifier

Customer Legal Participant Identifier

A unique 18-digit identifier for each U.S. Bank customer.  Leading 3 digit prefix, then a unique 15 digit number. 

LPID is an unique identifier used for Foreign customers which is located on Hogan.  Retain the leading 3 digit prefix, and then allocate a unique 15 digit number to make up the full 18 digit LPID.  The rule for generating these digits must be secured. The applications should view the resulting values as though it were a randomly generated (although unique) number.  They cannot expect any intelligence in digits 4 through 18.  LPID is used as the Primary Key for Customers.

 

X060-ENRB-WRK-LPID

 


 

3.3.5.3    GetListPackageEligibleAccountsReply           

Name

Type

Required

Description

Data Source Target

Status

usbsoaccl:Status

Yes

Status

See Status

GetList

mps:GetListPackageEligibleAccountsVerbResults

No

Items used for message request control

See GetListPackageEligibleAccountsVerbResults

GetListPackagesEligibleAccountsList

mps:PackageEligibleAccounts

No

Package eligible account list

See PackageEligibleAccounts

 

3.3.5.3.1    GetListPackageEligibleAccountsVerbResults

Name

Type

Required

Description

Data Source Target

FetchLimit

usbsoatl:NumberNonNegativeInteger

No

Maximum number of Accounts to return. If not supplied, a default number determined by the host (77 in this case) will be returned.

 

V200-MAX-RELATIONSHIPS

NextSequenceKey

usbsoaccl:AccountPrimaryIdentifier

No

The account primary identifier

See AccountPrimaryIdentifier

X77806-NXT-ACCT-COID-N+

X77806-NXT-ACCT-PROD+

X77806-NXT-ACCT-NBR

ChannelTypeCode

usbsoatl:ChannelTypeCode

No

The type code assigned to this channel.  This field tracks the method used to open the account.  Examples are Internet (WEB),

walk-in to Branch (BPL), Acquisition (ACQ) or Solicitor (SOL and SQL).

 

n/a

PackageEligibleAccountsSpecificFilterCriteria

mps:PackageEligibleAccountsSpecificFilterCriteria

Yes

Composite key of the specific account criteria filter.

n/a

 

 

3.3.5.3.2    PackageEligibleAccounts

Name

Type

Required

Description

Data Source Target

AccountPrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

Yes

Account primary identifier information

 

See Error! Reference source not found.

AccountSubProductCode

usbsoatl:String0003

Yes

Account Sub product Code

Identifies a specific sub unit of a product and is based on a set of features associated with an account.

 

X77806-ALL-ACCT-SPC

AccountEligible

usbsoatl:String0003

Yes

Account eligibility flag, the value can be ‘Y’ or ‘N’.

 

X77806-ALL-ACCT-ELIG

AccountInPackage

usbsoatl:String0003

Yes

Account in package information, the value can be ‘Y’ or ‘N’.

 

X77806-ALL-ACCT-IN-PKG

AccountOwner

usbsoatl:String0003

Yes

Account owner information. If customer key is entered, this field designates whether customer is primary or secondary owner.

 

X77806-ALL-ACCT-OWNER

AccountStatus

usbsoatl:String0003

Yes

Account Status

The status of the account.  Valid values are:

 07 – Closed

 99 – Active

 01 – New

 03 – Inactive

 05 – Dormant

 06 – In the Escheat process

 08 – Purgeable

 09 – Active

 11 – Matured CDs

 12 – In process of Close

 01- Paydown LOC

 20 – Shell

 91 – Lost, stolen, forgery

 92 – Bankrupt

 93 – Closed with balance

 96 – Charge off

 30 – Close to post

 31 – Paydown

 97 – Partial Charge-off.

 

X77806-ALL-ACCT-STATUS

AccountStatusDescription

usbsoatl:String0003

Yes

Account status description of X77806-ALL-ACCT-STATUS field.  Descriptions listed above for 3-digit code.

 

X77806-STATUS-DESR

 

 

3.3.6    Exception Processing

The service specification for error codes is described in the High-Level Web Service Interface Specification section titled Error Codes.

 

For details on Status object Refer section 2.5

 

3.3.6.1    StatusCode

 

Status Code

Severity

Status Description

Server Status Code

Additional details

0

Info

Success –

  ACTION SUCCESSFUL

000

Action Successful

100

Error

General Error

<Unknown Server code>

All Default and Unknown errors

 


 

3.4    GetListPackageRelatedAccounts

This function is a stand alone feature that provides the ability to scroll through accounts which are in a specific package.

 

3.4.1    Processing Specifications

Input :  

·       Account Key Identifier and Relationship Code for Scrolling (Next Sequence Key)

·       Package Primary key account identifier

·       Customer name identifier or customer legal participant identifier

 

Output :

·       Account Key Identifier and Relationship Code for Scrolling (Next Sequence Key)

·       Packages related accounts list

 

3.4.2    Special Notes

Please refer to the following documents regarding message structure, USB SOAP Header and USB SOAP Fault and error codes.

·       USBSOAPHeader_V_2 Interface Control Document v0.1.doc

·       USBSOAPFault_V_2 Interface Control Document v0.1.doc

 

3.4.3    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

3.4.4    Message to Data Source High level Specifications

 

Service Operation Name

Source System Name

Source System Transaction/

Message Name

GetListPackageRelatedAccounts

HOGAN PAS

EPKACIP2

 

3.4.5    Field/Element Specifications

 

3.4.5.1    GetListPackageRelatedAccountsRequest

Name

Type

Required

Description

Data Source Target

GetList

mps:GetListPackageEligibleAccountsFilter

Yes

Items used for message request control

See GetListPackageEligibleAccountsFilter

 

GetListPackageEligibleAccountsList

usbsoaccl:Noun_2

No

Package eligible account list

n/a


 

3.4.5.1.1    GetListPackageEligibleAccountsFilter

Name

Type

Required

Description

Data Source Target

FetchLimit

usbsoatl:NumberNonNegativeInteger

No

Maximum number of Accounts to return. If not supplied, a default number determined by the host (77 in this case) will be returned.

V200-MAX-RELATIONSHIPS

NextSequenceKey

mps:PackageRelatedAccountsNextSequenceKey

No

Next Sequence Key for scrolling

See PackageRelatedAccountsNextSequenceKey

ChannelTypeCode

usbsoatl:ChannelTypeCode

No

The type code assigned to this channel.

This field tracks the method used to open the account.  Examples are

Internet (WEB),

Walk-in to Branch (BPL), Acquisition (ACQ) or Solicitor (SOL and SQL).

n/a

PackageRelatedAccountsSpecificFilterCriteria

mps:PackageRelated

AccountsSpecificFilterCriteria

Yes

Composite key of the specific account criteria filter.

See PackageEligibleAccountsSpecificFilterCriteria

 

3.4.5.1.2    PackageRelatedAccountsNextSequenceKey

Name

Type

Required

Description

Data Source Target

AccountKey

usbsoatl:OperatingCompanyIdentifier

Yes

Operating company identifier

Company Identifier a/k/a Bank Number is a three-digit number which delineates a particular market region (usually the State to which an account or customer has been assigned).  Default = 654

 

See AccountPrimaryIdentifier

X78075-MESSAGE-PTR-COID +

V562-AIF-ACT-TO-ACT-PRDCT

 +

V562-AIF-ACT-TO-ACT-ACT-ID

RelationshipCode

usbsoatl:String0003

Yes

Account Relationship Code

Valid Primary Customer to Account/ Account-to-Customer codes:

 

  IND = Individual (personal)    

   JOF = Joint-First Name (personal)

   NIN = Non-Individual (business)

   ALY = Analysis   

   PFT = Profitability

   PNS = Primary Non-Signer (personal)

 

V562-AIF-ACT-TO-ACT-REL-CODE

 

3.4.5.1.3    PackageEligibleAccountsSpecificFilterCriteria

Name

Type

Required

Description

Data Source Target

PackageKey

usbsoaccl:AccountPrimaryIdentifier

No

The account primary identifier

See AccountPrimaryIdentifier

V562-WRK-COID-N+

V562-WRK-ALPHA-PRDCT-CODE+

V562-WRK-ACT-ID

CustomerIdentifiers

mps:CustomerIdentifiers

No

Customer account identifier complex type

 

See  CustomerIdentifier

 

3.4.5.1.4    CustomerIdentifier

Name

Type

Required

Description

Data Source Target

AccountKey

usbsoatl:OperatingCompanyIdentifier

 

 

 

Choice

Group

Operating Company Identifier

a/k/a Bank Number is a three-digit number which delineates a particular market region (usually the State to which an account or customer has been assigned).

Default = 654

 

See AccountPrimaryIdentifier

V560-WRK-COID-N+

V560-WRK-NAME-1+

V560-WRK-TIE-BREAKER-N

CustomerLegalParticipantIdentifier

usbsoatl:ParticipantSystemIdentifier

Account Relationship Code

This field describes the reason for relating the customer to the primary customer.  Defined on PCD 24180.  This field is displayed on CIS screens.  The first eight characters should be descriptive enough for display on screens that do not have sufficient room for a 16-character description.

 

V560-CIF-CUST-LPID-X

 


 

3.4.5.2    GetListPackageEligibleAccountsReply           

Name

Type

Required

Description

Data Source Target

Status

usbsoaccl:Status

Yes

Status

See Status

GetList

mps:GetListPackageRelatedAccountsVerbResults

No

Items used for message request control (scrolling)

See  GetListPackageRelatedAccountsVerbResults

GetListPackagesRelatedAccountsList

mps:GetListPackageRelatedAccountsList

No

(o to many)

Package related accounts list

See  PackageRelatedAccounts

 

3.4.5.2.1    GetListPackageRelatedAccountsVerbResults

 

Name

Type

Required

Description

Data Source Target

FetchLimit

usbsoatl:NumberNonNegativeInteger

No

Maximum number of Accounts to return. If not supplied, a default number determined by the host (77 in this case) will be returned.

 

N/A

NextSequenceKey

mps:PackageRelatedAccountsNextSequenceKey

No

Next Sequence Key for scrolling

See  PackageRelatedAccountsNextSequenceKey

 

ChannelTypeCode

usbsoatl:ChannelTypeCode

No

The type code assigned to this channel.

Internet (WEB),

walk-in to Branch (BPL), Acquisition (ACQ) or Solicitor (SOL and SQL).

 

N/A

PackageRelatedAccountsSpecificFilterCriteria

mps:PackageRelated

AccountsSpecificFilterCriteria

Yes

Composite key of the specific account criteria filter.

N/A

 

 

3.4.5.2.2    PackageRelatedAccounts

Name

Type

Required

Description

Data Source Target

AccountPrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

Yes

Account primary identifier information

See Error! Reference source not found.

X78051-X78078-LINE-COID-N+

X78051-X78078-LINE-PRDCT-CD+

X78051-X78078-LINE-ACT-NO

RelationshipCode

usbsoatl:String0003

No

Account Relationship Code

This field describes the reason for relating the customer to the primary customer.  Defined on PCD 24180.  This field is displayed on CIS screens.  The first eight characters should be descriptive enough for display on screens that do not have sufficient room for a 16-character description.

X78051-X78078-LINE-REL-CODE

CoreIndicator

usbsoatl:String0001

No

Core Indicator

 

X78051-X78078-LINE-COR-IND

StatementIndicator

usbsoatl:String0001

No

Statement Indicator

This field indicates if this customer is to be included in a combined statement.

X78051-X78078-LINE-STM-IND

QualifyingAccountIndicator

usbsoatl:String0001

No

Qualifying Account Indicator

X78051-X78078-LINE-QUA-IND

BenefitsIndicator

usbsoatl:String0001

No

Benefits Indicator

X78051-X78078-LINE-BEN-IND

OwnerIndicator

usbsoatl:String0001

No

Owner Indicator

X78075-LINE-PRI-IND

ExternalSubProductCode

usbsoatl:String0002

No

External Sub Product Code

Identifies a specific sub unit of  a product and is based on a set of features associated with an account

X78051-X78078-LINE-ACT-EXT-SP

AccountStatusCode

usbsoatl:String0003

No

Account Status Code

The status of the account.  Valid values are:

 07 – Closed

 99 – Active

 01 – New

 03 – Inactive

 05 – Dormant

 06 – In the Escheat process

 08 – Purgeable

 09 – Active

 11 – Matured CDs

 12 – In process of Close

 01- Paydown LOC

 20 – Shell

 91 – Lost, stolen, forgery

 92 – Bankrupt

 93 – Closed with balance

 96 – Charge off

 30 – Close to post

 31 – Paydown

 97 – Partial Charge-off.

 

ACCOUNT-STATUS-CODE

AccountStatusDescription

usbsoatl:String0040

No

Account Status Description

Description of the Account Status code.

 

X51675D-STATUS-DESCRIPTION

PayOnlineIndicator

usbsoatl:String0001

No

Pay Online Indicator

 

X78075-PCPAYENB

StatementDownload

usbsoatl:String0001

No

Statement Download Indicator

 

X78075-PCDLSTAT

TransferCode

usbsoatl:String0001

No

Transfer Code Indicator

 

X78075-PCXFERCD

WaiveIndicator

usbsoatl:String0001

No

Package Waive Indicator

Indicates account is eligible for Package Waiver.

 

X78051-X78078-LINE-WAV-IND

InfluencePackageIndicator

usbsoatl:String0001

No

INF determines if an account is brought into analysis and contributes to the overall PKG fee considerations.  Our doco says "Does this account "Influence package analysis". Valid values are Y and N

 

X78051-X78078-LINE-INF-IND

InternalSubProductCode

usbsoatl:String0001

No

Internal Sub Product Code

Identifies a specific sub unit of a product and is based on a set of features associated with an account.

 

X78051-X78078-LINE-ACT-INT-SP 

 


 

3.4.6    Exception Processing

The service specification for error codes is described in the High-Level Web Service Interface Specification section titled Error Codes.

 

For details on Status object Refer section 2.5

 

3.4.6.1    StatusCode

 

Status Code

Severity

Status Description

Server Status Code

Additional details

0

Info

Success –

  ACTION SUCCESSFUL

000

Action Successful

100

Error

General Error

<Unknown Server code>

All Default and Unknown errors

 

 

3.5    SetupPackageAccount

This function can be used to setup a new package of any type for a given customer and accounts.  The channel will send a customer key along with other account key data which can be used in the setup.

 

3.5.1    Processing Specifications

Input :  

·       Customer name identifier or customer legal participant identifier

·       Account key identifier

·       Relationship code and sub product code

·       Open channel code

·       Application Type Code, package code, primary security name, product code, sub type code

 

Output :

·       Status block

·       New package account identifier

 

3.5.2    Special Notes

Please refer to the following documents regarding message structure, USB SOAP Header and USB SOAP Fault and error codes.

·       USBSOAPHeader_V_2 Interface Control Document v0.1.doc

·       USBSOAPFault_V_2 Interface Control Document v0.1.doc

 

 

3.5.3    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

3.5.4    Message to Data Source High level Specifications

 

Service Operation Name

Source System Name

Source System Transaction/

Message Name

SetupPackageAccount

HOGAN PAS

EPKSUAP3

 

 

3.5.5    Field/Element Specifications

3.5.5.1    SetupPackageAccountRequest

Name

Type

Required

Description

Data Source Target

SetupPackageAccountRequest

mps:SetupPackageAccountRequest

Yes

Setup Package Accounts

See SetupPackageAccountsRequest

3.5.5.1.1    SetupPackageAccountRequest

Name

Type

Required

Description

Data Source Target

CustomerKeyIdentifier

mps:CustomerIdentifiers

Yes

Customer Key Identifier (Name or LPID)

 

See

CustomerIdentifiers

AccountPrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

Account Primary key Identifier

See AccountPrimaryIdentifier

X77806-CORE-ACCT-COID-N+

X77806-CORE-ACCT-PROD+

X77806-CORE-ACCT-NBR

RelationshipCode

usbsoatl:String0003

Yes

Relationship Code

This field describes the reason for relating the customer to the primary customer.   The code describing the reason for relating the two records. 

 

X77806-PRIM-CUST-REL-CD

SubProductCode

usbsoatl:String0002

Yes

Sub Product Code

Identifies a specific sub unit of a product and is based on a set of features associated with an account

X77806-PKG-SUB-PROD

OpenChannelCode

usbsoatl:String0008

Yes

Possible channel codes are

BRN-Wizard

24H – Orion

FSN - Fusion

X112-OPEN-CHANNEL

UserIdentifier

usbsoatl:String0008

Yes

User Identifier

This field is used for the operator identifier.

X77007-USER-ID  

ApplicationTypeCode

usbsoatl:String0002

No

Application Type Code

 

X77806-PCAPTPCD

ServicePackageCode

usbsoatl:String0001

No

PC Service Package Code

Packages are a combination of qualifying accounts which offer consumer and business customer’s benefits and/or features which may include product discounts and rewards.

X77806-PCPCSERV

PrimarySecurityName

usbsoatl:String0040

No

Primary Security Name

 

X77806-PCPSECNM

SoftwareProductCode

usbsoatl:String0010

No

Software Product Code

 

X77806-PCSOFTNM

CustomerSubTypeCode

usbsoatl:String0002

No

Customer Sub Type code

 

X77806-PCSUBTYP

 


 

3.5.5.1.2    CustomerIdentifiers

Name

Type

Required

Description

Data Source Target

CustomerNameIdentifier

usboaccl:CustomerNameIdentifier

 

 

 

Choice

Group

Customer Name Identifier

See  CustomerNameIdentifier

X77806-PRIM-CUST-COID-N+

X77806-PRIM-CUST-NAME          +

X77806-PRIM-CUST-TIE-N        

CustomerLegalParticipantIdentifier

usbsoatl:ParticipantSystemIdentifier

Customer Legal Participant Identifier

A unique 18-digit identifier for each U.S. Bank customer.  Leading 3 digit prefix, then a unique 15 digit number.  LPID is an unique identifier used for Foreign customers which is located on Hogan.  Retain the leading 3 digit prefix, and then allocate a unique 15 digit number to make up the full 18 digit LPID.  The rule for generating these digits must be secured. The applications should view the resulting values as though it were a randomly generated (although unique) number.  They cannot expect any intelligence in digits 4 through 18.  LPID is used as the Primary Key for Customers.

 

X060-ENRB-WRK-LPID 

 

3.5.5.2    SetupPackageAccountReply

Name

Type

Required

Description

Data Source Target

SetupPackageAccountReply

mps:SetupPackageAccountReply

Yes

Setup Package Accounts Reply

See SetupPackageAccountsReply

 

 

3.5.5.3    SetupPackageAccountReply 

Name

Type

Required

Description

Data Source Target

Status

 

Yes

Status Block

 

See Status

AccountPrimaryIdentifier

Usbsoaccl:AccountPrimaryIdentifier

No

New Package Account Identifier

 

See AccountPrimaryIdentifier

X78075-PKG-COID-N+

X78075-PKG-PROD+

X78075-PKG-ACCT-NO

 

 

 

3.5.6    Exception Processing

The service specification for error codes is described in the High-Level Web Service Interface Specification section titled Error Codes.

 

For details on Status object Refer section 2.5

 

3.5.6.1    StatusCode

 

Status Code

Severity

Status Description

Server Status Code

Additional details

0

Info

Success –

  ACTION SUCCESSFUL

000

Action Successful

200

Error

General Data Error  -- Account Already on

422

Account Already On STM W/Details

100

Error

General Error

<Unknown Server code>

All Default and Unknown errors

 

 


3.6    MaintainPackageRelationships

This Customer Service function will be used to perform the following maintenance:

·       Add an account to a package

·       Delete an account from a package

·       Add a customer to a package

·       Delete a customer from a package

·       Close a package

·       Update the STM flag on an account in a PKG

 

The call types that will be used between PAS and PKG are listed below, together with the data required by PKG to process the call:

                  1) PKREADD:

-        to add an account to a package

-        PKG key; secondary account key (coid, prod, acct #)

-        to add a customer to a package

-        PKG key; customer key (coid, name, tie); cust rel code

 

                        2) PSTMCHG:

-        to change an account in a package

-        PKG key; secondary account key (coid, prod, acct #); PKGACSTM element value

                        3) PKREDEL:

-        to delete an account from a package

-        PKG key; secondary account key (coid, prod, acct #)

-        to delete a customer from a package

-        PKG key; customer key (coid, name, tie)

                        4) PKRECLS:

-        to close a package

-        PKG key

 

3.6.1    Processing Specifications

                         Input               

·       Package Primary Account Identifier

·       Related Account Primary Identifier

·       Customer Name Identifier (Name or LPID)

·       Package Call type, Relationship code and Account STM type code

 

                  Output

·       In the case of more than one Package Relationship Maintenance requests, service would use the AdditionalStatus aggregate to reflect the results for each action.

For Example #1:

  Input: received three different maintenance request, PKREADD, PKREADD & PKREDEL

             Assume first and the third one succeed and the second one failed

  Output:  StatusCode=100 & StatusDescription=Error & Severity=Error

                   AdditionalStatus[1] :

   StatusCode=0

   ServerStatusCode={HostConditionCode}

   Severity=Info

   StatusDescription={HostStatusDescription}

 

                  AdditionalStatus[2] :

   StatusCode=100

   ServerStatusCode={HostConditionCode}

   Severity=Error

   StatusDescription={HostStatusDescription}

AdditionalStatus[3] :

   StatusCode=0

   ServerStatusCode={HostConditionCode}

   Severity=Info

   StatusDescription={HostStatusDescription}

 

Example #2:

  Input: received two different maintenance request, PKREADD & PKREDEL

             Assume both succeed

  Output:  StatusCode=0 & StatusDescription=Success & Severity=Info

                   AdditionalStatus[1] :

   StatusCode=0

   ServerStatusCode={HostConditionCode}

   Severity=Info

   StatusDescription=Success or {HostStatusDescription}

                  AdditionalStatus[2] :

   StatusCode=0

   ServerStatusCode={HostConditionCode}

   Severity=Info

   StatusDescription=Success or {HostStatusDescription}

 

To ADD an account to a PKG:

INPUT fields to be populated:

OPERATOR ID                                                 

X78075-PKG-COID-N                             -           ‘654’                

X78075-PKG-PROD                                -           ‘PKG’              

X78075-PKG-ACCT-NO                                      -A valid PKG account number

X77806-CALL-TYPE                              -           ‘PKREADD‘

X78075-ACCT-LINE-COID-N                   -           A valid company id 

X78075-ACCT-LINE-PRDCT-CD             -           A valid product code

X78075-ACCT-LINE-ACT-NO                  -           A valid account number

X78806-PKGACSTM                              -           ‘N’, ‘S’, ‘D’ or space (for SB and SC packages only)

 

To DELETE an account from a PKG:

INPUT fields to be populated:

OPERATOR ID                                                 

X78075-PKG-COID-N                             -           ‘654’                

X78075-PKG-PROD                                -           ‘PKG’              

X78075-PKG-ACCT-NO                                      -A valid PKG account number                  

X77806-CALL-TYPE                              -           ‘PKREDEL‘

X78075-ACCT-LINE-COID-N                   -           A valid company id 

X78075-ACCT-LINE-PRDCT-CD             -           A valid product code

X78075-ACCT-LINE-ACT-NO                  -           A valid account number

 

To CHANGE the STM value for an account in a PKG:

INPUT fields to be populated:

OPERATOR ID                                                 

X78075-PKG-COID-N                             -           ‘654’                

X78075-PKG-PROD                                -           ‘PKG’              

X78075-PKG-ACCT-NO                          -           A valid PKG account number                   

X77806-CALL-TYPE                              -           ‘PSTMCHG‘

X78075-ACCT-LINE-COID-N                   -           A valid company id 

X78075-ACCT-LINE-PRDCT-CD             -           A valid product code

X78075-ACCT-LINE-ACT-NO                  -           A valid account number

X78806-PKGACSTM                              -           ‘N’, ‘S’, ‘D’ or space (for SB and SC packages only)

 

To ADD a customer to a PKG:

INPUT fields to be populated:

OPERATOR ID                                                 

X78075-PKG-COID-N                             -           ‘654’

X78075-PKG-PROD                                -           ‘PKG’

X78075-PKG-ACCT-NO                          -           A valid PKG account number

X77806-CALL-TYPE                              -           ‘PKREADD‘

X78075-CUST-LINE-COID-N                   -           ‘654’

X78075-CUST-LINE-CUST-NAME           -           Customer Name (that exists on Hogan CIS)

X78075-CUST-LINE-CUST-TIE                -           Customer Tie (of customer that exists on Hogan CIS)

 

To DELETE a customer from a PKG:

INPUT fields to be populated:

OPERATOR ID                                                 

X78075-PKG-COID-N                             -           ‘654’

X78075-PKG-PROD                                -           ‘PKG’

X78075-PKG-ACCT-NO                                      -A valid PKG account number

X77806-CALL-TYPE                              -           ‘PKREDEL‘

X78075-CUST-LINE-COID-N                   -           ‘654’

X78075-CUST-LINE-CUST-NAME           -           Customer Name (that exists on Hogan CIS)

X78075-CUST-LINE-CUST-TIE                -           Customer Tie (of customer that exists on Hogan CIS)

 

To CLOSE a Package:

INPUT fields to be populated:

OPERATOR ID                                                 

X78075-PKG-COID-N                             -           ‘654’                

X78075-PKG-PROD                                -           ‘PKG’              

X78075-PKG-ACCT-NO                                      -A valid PKG account number                  

X77806-CALL-TYPE                              -           ‘PKRECLS‘

 

 

3.6.2    Special Notes

Please refer to the following documents regarding message structure, USB SOAP Header and USB SOAP Fault and error codes.

·       USBSOAPHeader_V_2 Interface Control Document v0.1.doc

·       USBSOAPFault_V_2 Interface Control Document v0.1.doc

 

3.6.3    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

3.6.4    Message to Data Source High level Specifications

 

Service Operation Name

Source System Name

Source System Transaction/

Message Name

MaintainPackageRelationships

HOGAN PAS

EPKRECP3

 

3.6.5    Field/Element Specifications

3.6.5.1    MaintainPackageRelationshipsRequest

Name

Type

Required

Description

Data Source Target

MaintainPackaageRelationshipsRequest

mps:MaintainPackageRelationshipsRequest

Yes

Setup Package Accounts

See MaintainPackageRelationshipsRequest

 

3.6.5.1.1    MaintainPackageRelationshipsRequest

Name

Type

Required

Description

Data Source Target

Maintain

mps:PackageMaintenance

Yes

Maintain Package Account

See PackageMaintenance

Package Relationships

mps:PackageRelationships

Yes

(1 to many)

Account Relationships

This field describes the reason for relating the customer to the primary customer.  Defined on PCD 24180.  This field is displayed on CIS screens.  The first eight characters should be descriptive enough for display on screens that do not have sufficient room for a 16-character description.

See PackageRelationships

 

3.6.5.1.2    PackageMaintenance

Name

Type

Required

Description

Data Source Target

OperatorID

usbsoatl:String0008

No

User/Operator Identifier

This field is used for the operator identifier.

X77007-USER-ID

PackagePrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

Package Account Primary Key Identifier

See AccountPrimaryIdentifier

V562-WRK-COID-N                        +

V562-WRK-ALPHA-PRDCT-CODE              +

V562-WRK-ACT-ID                        

 

3.6.5.1.3    PackageRelationships

Name

Type

Required

Description

Data Source Target

PackageCallType

usbsoatl:String0007

Yes

Package Call Type

 

X77806-CALL-TYPE

RelatedAccountPrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

Related Account Primary key Identifier

See AccountPrimaryIdentifier

V562-AIF-COID-N

  +

V562-AIF-ALPHA-PRDCT-CODE 

   +

V562-AIF-ACT-ID 

RelatedCustomerIdentifier

mps:CustomerIdentifiers

No

Customer Key Identifier (Name or LPID)

See

CustomerIdentifiers

 

RelatedCustomerRelationshipCode

usbsoatl:String0007

No

Related Customer Relationship Code

 

X77805-CUST-REL-CODE

StatementTypeCode

sbsoatl:String0001

No

Values can be

‘N’, ‘S’, ‘D’ or space (for SB and SC packages only)

X77805-PKGACSTM                       

 

3.6.5.1.4    CustomerIdentifiers

Name

Type

Required

Description

Data Source Target

CustomerNameIdentifier

usboaccl:CustomerNameIdentifier

 

 

 

Choice

Group

Customer Name Identifier

See  CustomerNameIdentifier

X77805-CUST-COID-N                     +

 X77805-CUST-NAME                       +

X77805-CUST-TIE-N                     

CustomerLegalParticipantIdentifier

usbsoatl:ParticipantSystemIdentifier

Customer Legal Participant Identifier

A unique 18-digit identifier for each U.S. Bank customer.  Leading 3 digit prefix, then a unique 15 digit number.  LPID is an unique identifier used for Foreign customers which is located on Hogan.  Retain the leading 3 digit prefix, and then allocate a unique 15 digit number to make up the full 18 digit LPID.  The rule for generating these digits must be secured. The applications should view the resulting values as though it were a randomly generated (although unique) number.  They cannot expect any intelligence in digits 4 through 18.  LPID is used as the Primary Key for Customers.

 

N/A

 

3.6.5.1.5    MaintainPackageRelationshipsReply

Name

Type

Required

Description

Data Source Target

MaintainPackageRelationshipsReply

mps:MaintainPackageRelationshipsReply

Yes

Maintain package Relationships Reply

See MaintainPackageRelationshipsReply

 


 

3.6.5.2    MaintainPackageRelationshipsReply

 

Name

Type

Required

Description

Target Source

Status

mas:Status

Yes

The Status

A message that contains only a transaction header, a message header and one occurrence of message-segment data.

  MESSAGE-RESULT

StatusCode

xsd:string

No

The Status Code

BTCB-USER-CC-APP

StatusDescription

xsd:string

No

The Status Description

Description of the status code.

 

BTCB-USER-DESCRIPTION

AdditonalInfo

AdditionalStatus

No

(o to many)

Status Aggregate

Refer Processing Specifications

For additional details

 

3.6.6    Exception Processing

The service specification for error codes is described in the High-Level Web Service Interface Specification section titled Error Codes.

 

For details on Status object Refer section 2.5

 

3.6.6.1    StatusCode

 

Status Code

Severity

Status Description

Server Status Code

Additional details

0

Info

Success –

  ACTION SUCCESSFUL

64000

0 to many Additional Details

0

Info

Success –

   SUCCESSFUL PKG RESPONSE  

60141

0 to many Additional Details

0

Info

Success –

   SUCCESSFUL DDA RESPONSE  

60142

0 to many Additional Details

0

Info

Success –

   SUCCESSFUL CCD RESPONSE  

60143

0 to many Additional Details

0

Info

Success –

   SUCCESSFUL CHX RESPONSE  

60144

0 to many Additional Details

0

Info

Success- MAX REACHED, MORE AVAILABLE

60040

0 to many Additional Details

200

Error

Failure -  ACCOUNT NOT IN PACKAGE   

60236

0 to many Additional Details

0

Info

Success -  DE-ENR SUCCESSFUL

60134

0 to many Additional Details

0

Info

Success -  PKG AND DDA OUT OF SYNC

60047

0 to many Additional Details

0

Info

Success -  END OF RECORDS           

60023

0 to many Additional Details

100

Error

General Error

<Unknown Server code>

All Default and Unknown errors

 

Please refer the section Processing Specifications for Status Aggregate around Additional Status aggregates.

 

3.7    GetListPackageStatementEligibility

This new call will return a list of accounts back to the channel.  This list will include either those accounts that can be the Core/Primary account in a new Statement package, or those accounts that can be in the same Statement package as the Core/Primary account on the input.  

 

ELCUACT returns a list of eligible accounts that could be linked to a PKG, with a flag indicating if the account is eligible to be the core account in the package. Primary input is customer key.

 

ELPKACT returns a list of eligible accounts for a particular PKG. Primary input is Package key.

 

3.7.1    Processing Specifications

Input                

§  Scrolling Parameters

§  ELCUACT related parameters or ELPKACT related parameters

§  Sub product code

§  Statement Indicator

 

                  Output

§  Status Block

§  Scrolling parameters

§  Statement Account Eligibility List

3.7.2    Special Notes

Please refer to the following documents regarding message structure, USB SOAP Header and USB SOAP Fault and error codes.

·       USBSOAPHeader_V_2 Interface Control Document v0.1.doc

·       USBSOAPFault_V_2 Interface Control Document v0.1.doc

 

3.7.3    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

3.7.4    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

 

3.7.5    Message to Data Source High level Specifications

 

Service Operation Name

Source System Name

Source System Transaction/

Message Name

GetListPackageStatementEligibility

HOGAN PAS

EPSELIP1

 

3.7.6    Field/Element Specifications

3.7.6.1    GetListPackageStatementEligibilityRequest

Name

Type

Required

Description

Data Source Target

GetListPackageStatementEligibilityRequest

mps:GetListPackageStatementEligibilityRequest

Yes

Get Package Statement Eligibility Accounts

See  GetListPackageStatementEligibilityRequest

3.7.6.2    PackageStatementEligibilityRequest

 

Name

Type

Required

Description

Data Source Target

GetList

Usbsoaccl:GetList_3

No

Used for Scrolling

See GetList

V560-NEXT-ENTRY+

V200-MAX-RELATIONSHIPS+

N/A+

N/A

GetListPackageAccounts

mps:GetListPackageAccounts

 

Choice

Group

To return a list of eligible accounts that are linked to a package

 

See GetListPackageAccounts

GetListEligibilePackageAccounts

mps:GetListEligiblePackageAccounts

To return a list of eligible accounts that could be linked to a PKG

 

See GetListEligiblePackageAccounts

N/A

N/A

Yes

Type of Process

‘ELCUACT’ or ‘ELPKACT’

 

X115-IS-CALL-TYPE             

SubProductCode

usbsoatl:String0003

No

Sub Product Code

Identifies a specific sub unit of a product and is based on a set of features associated with an account

 

X115-IS-SUB-PROD-CODE         

StatementIndicatorCode

usbsoatl:String0001

No

Statement Indicator

Blank = Return all

'N' = Return only those accounts with STM flag = 'N'

'S' = Return only those accounts with STM flag = 'S'

'D' = Return only those accounts with STM flag = 'D'

'B' = Return only those accounts with STM flag = either 'S' or 'D'

 

X115-STM-FLAG-FILTER

 

3.7.6.3    GetListPackageAccounts

 

Name

Type

Required

Description

Data Source Target

PackageKeyIdentifier

Usbsoaccl:AccountPrimaryIdentifier

Yes

Package Key Identifier

See AccountPrimaryIdentifier

X115-IS-ACCT-COID-N +

X115-IS-ACCT-PROD +

X115-IS-ACCT-ID

 

3.7.6.4    GetListEligiblePackageAccounts

 

Name

Type

Required

Description

Data Source Target

CustomerKeyIdentifier

ms:CustomerIdentifiers

Yes

Customer Key Identifier

See CustomerIdentifiers

 

3.7.6.5    GetListPackageStatementEligibilityReply

Name

Type

Required

Description

Data Source Target

Status

usbsoaccl:Status

Yes

Status Block

 

See Status

GetList

usbsoaccl:GetList_3

No

Scrolling

See GetList

V560-NEXT-ENTRY+

+

+X115-NS-MORE-FLAG    +

N/A+

N/A 

StatementAccountEligibilityList

mps: StatementAccountEligibility

No

(0 to many)

Statement Account Eligibility List

See StatementAccountEligiblity

 

3.7.6.6    StatementAccountDetail

Name

Type

Required

Description

Data Source Target

PackageKeyIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

Package Key

See AccountPrimaryIdentifier

X115-RS-PKG-COID-N             +

X115-RS-PKG-PROD+

X115-RS-PKG-ID

PackageSubProductCode

usbsoatl:String0002

No

Package Sub Product Code

The alpha-numeric subproduct code used to default the majority of the account control information and for general ledger reporting.

 

PKG SPC:

CO = Chextra Online MYM

FP = Focal Point

IR = Portfolio IRA

OB = Online Business Banking

OI = Online Individual Banking

TB = Telephone Bill Pay

W = Web Bill Pay

11 = US Bank Elite CKG

12 = US Bank Interest Plus CKG

14 = US Bank Balance CKG

16 = US Bank Mesa CKG

40 = US Bank Edge CKG

X115-RS-PKG-SUB-PROD-CD

InternalSubProductCode

usbsoatl:String0002

No

Internal Sub Product Code

The alpha-numeric subproduct code used to default the majority of the account control information and for general ledger reporting.

 

X115-RS-INT-SUB-PROD-CD       

ExternalSubProductCode

usbsoatl:String0002

No

External Sub Product Code

Same as above

X115-RS-EXT-SUB-PROD-CD       

AccountStatusCode

usbsoatl:String0003

No

Account Status

Account Status

The status of the account.  Valid values are:

 07 – Closed

 99 – Active

 01 – New

 03 – Inactive

 05 – Dormant

 06 – In the Escheat process

 08 – Purgeable

 09 – Active

 11 – Matured CDs

 12 – In process of Close

 01- Paydown LOC

 20 – Shell

 91 – Lost, stolen, forgery

 92 – Bankrupt

 93 – Closed with balance

 96 – Charge off

 30 – Close to post

 31 – Paydown

 97 – Partial Charge-off.

 

X115-RS-ACCT-STATUS

CurrentStatementCycleCode

usbsoatl:String0002

No

Current Statement Cycle

Indicates when the statement is scheduled to generate for the account.

X115-RS-CUR-STM-CYCL

FutureStatementCycleCode

usbsoatl:String0002

No

Future Statement Cycle

This code indicates the future statement cycle code.

X115-RS-FUT-STM-CYCL

CurrentSafekeepingTypeCode

usbsoatl: String0001

No

Current Safekeeping Flag

Possible Values

Space/B = statement with all items  returned, charge

C = ARP - Return Checks only  Credits, Deposits and Internal Debits-truncate 

F = statement with all items returned, waive charge

T = statement with no items returned, charge

N = statement with no items returned, waive charge   

S = ARP truncate

D = statement with only checks returned, charge  

W = statement with only checks returned, waive charge

V = Bay View Image check return

I = statement with images, charge

J = statement with check images only, waive charge

 

X115-RS-CUR-SAFEKEEPING

FutureSafekeepingTypeCode

usbsoatl: String0001

No

Future Safekeeping Flag

Possible Values

Space/B = statement with all items  returned, charge  

 C = ARP - Return Checks only  Credits, Deposits and Internal Debits-truncate 

F = statement with all items returned, waive charge   

T = statement with no items returned, charge         

N = statement with no items returned, waive charge   

S = ARP truncate 

D = statement with only checks returned, charge  

W = statement with only checks returned, waive charge

V = Bay View Image check return

I = statement with images, charge

J = statement with check images only, waive charge

 

X115-RS-FUT-SAFEKEEPING

CoreAccountSwitch

usbsoatl:Switch

No

Core Account

True – (Y)Core Account

False-(N)Not Core Account

X115-RS-CORE-FLAG

 

CoreEligibilitySwitch

usbsoatl:Switch

No

Core Eligibility

True – (Y)Core Eligible

False-(N)Not Core Eligible

X115-RS-CORE-ELIG-FLAG

PackageInSwitch

usbsoatl:Switch

No

Package In

True – (I) In Package

False – (N) Eligible

X115-RS-IN-PKG-FLAG  

PrimaryCustomerSwitch

usbsoatl:Switch

No

Primary or Non Primary

True – (Y)PrimaryCustomer

False – (N)Non-primary customer relationship

X115-RS-PRIM-CUST-FLAG

PackageAccountStatementTypeCode

usbsoatl: String0001

No

Package Account Statement Flag

Possible Values:

N or I or E or S or D

X115-RS-PKGACSTM

 

3.7.6.7    StatementAccountEligiblity

Name

Type

Required

Description

Data Source Target

AccountKeyIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

Account Key

See AccountPrimaryIdentifier

X115-RS-ACCT-COID-N            +

X115-RS-ACCT-PROD              +

X115-RS-ACCT-ID

StartTargetBalanceSwitch

usbsoatl:Switch

No

START Program Target Balance Switch

True – Y (Yes)

False – N (No)

 

X115-RS-START-TGT-FLAG

CommercialOrRetailSwitch

usbsoatl:Switch

No

Commercial or Retail

True – (C)Commercial

False – (R)Retail

 

X115-RS-COMML-RETL

StatementAccountDetail

mps:StatementAccountDetail

No

Statement Account Detail

 

See StatementAccountDetail

 

 

3.7.7    Exception Processing

The service specification for error codes is described in the High-Level Web Service Interface Specification section titled Error Codes.

 

For details on Status object Refer section 2.5

 

3.7.7.1    StatusCode

 

Status Code

Severity

Status Description

Server Status Code

Additional details

0

Info

Success –

 ACTION SUCCESSFUL

000

Action Successful

200

Error

General Data Error  --  Package Not Found

006

Package Not Found

100

Error

General Error

<Unknown Server code>

All Default and Unknown errors

 


 

3.8    MaintainPackageAnalysis

This function will be used to change the WAIVE CODE on a Hogan PKG account.  The waive code expiration date can be sent in or left blank.  If left blank PKG will default in the correct expiration date for the waive code used.

 

3.8.1    Processing Specifications

Input                            

§  Package Primary Account Identifier

§  Operation Identifier

§  Package analysis waive code

§  Package analysis waive code expiration date

 

                  Output

§  Status Block

3.8.2    Special Notes

Please refer to the following documents regarding message structure, USB SOAP Header and USB SOAP Fault and error codes.

·       USBSOAPHeader_V_2 Interface Control Document v0.1.doc

·       USBSOAPFault_V_2 Interface Control Document v0.1.doc

 

3.8.3    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

3.8.4    Message to Data Source High level Specifications

 

Service Operation Name

Source System Name

Source System Transaction/

Message Name

MaintainPackageAnalysis

HOGAN PAS

EPKAMCP1

 

3.8.5    Field/Element Specifications

 


 

3.8.5.1    MaintainPackageAnalysisRequest

Name

Type

Required

Description

Data Source Target

MaintainPackaageAnalysisRequest

mps:MaintainPackageAnalysisRequest

Yes

Maintain package Analysis

See MaintainPackageAnalysisRequest

3.8.5.1.1    MaintainPackageAnalysisRequest

Name

Type

Required

Description

Data Source Target

Maintain

mps:PackageMaintenance

Yes

Maintain Package Account

 

See PackageMaintenance

PackageAnalysis

mps:PackageAnalysis

Yes

(1 to many)

Account Relationships

 

See PackageAnalysis

 

3.8.5.1.2    PackageMaintenance

Name

Type

Required

Description

Data Source Target

OperatorID

usbsoatl:String0008

No

User/Operator Identifier

This field is used for the operator identifier.

 

X77007-USER-ID

PackagePrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

Package Account Primary Key Identifier

 

See AccountPrimaryIdentifier

X78075-PKG-COID-N              +

X78075-PKG-PROD                +

X78075-PKG-ACCT-NO            

 

3.8.5.1.3    PackageAnalysis

Name

Type

Required

Description

Data Source Target

PackageAnalysisWaiveCode

usbsoatl:String0002

No

Package Analysis Waive Code

Valid Codes:

  Blank = Charge

  IR = Intg IRA 6 months waived

  NI = New IRA 12 months waived

  P1 = Perm waive 999 months waived

  P2 = Perm waive 999 months waived

  P3 = Perm waive 999 months waived

  P4 = Perm waive - Banker discretion 999 months waived

  P5 = Perm waive officer requested 999 months waived

  P6 = Perm waive - Senior Citizen 999 months waived

 P7 = Perm waive - Non-profit  ( 999 months waived)

  P8 = Perm waive - Grandfathered

  999 months waived

  P9 = Perm waive – Grandfathered 999 months waived  

  R1 = Waive Service Charge 3 months waived

  R2 = Waive Service Charge 6 months waived

  R3 = Waive Service Charge 12 months waived

  R4 = Waive Service Charge 18 months waived

  R5 = Waive Service Charge 24 months waived

  R6 = Waive Service Charge 6 months waived

  R7 = Perm waive - FSTU 999  months waived

  R8 = Perm waive - Brokerage FSTU 999 months waived      

  R9 = Perm waive 999 months waived

  T1 = Temp waive - 1 or expiration date can be changed to any value     

  T7 = Perm waive - Preferred Cust  999 months waived

  WE = Standard waive 1 month waived

  WM = Relationship 6 months waived

  WN = Waive with offer 6 months waived

  WP = Perm waive with offer 999 months waived

  WQ = One year with offer 12 months waived

  WR = Six months with offer 6 months waived

  WS = Two months with offer 2 months waived

  WT = Two months with offer 2 months waived 

  WU = Two months with offer 2 months waived

  WV = Two months with offer 2 months waived

  WW = Perm waive with offer 999 months waived

  WX = Perm waive relationship 999 months waived

  WY = One year with offer 12 months waived

 WZ = One year relationship 12 months waived

  01 = Default - first cycle waive Temp waive 1 month waived 

X77805-PKG-ANA-WAIVE-CODE     

PackageAnalysisWaiveCodeExpDate

usbsoatl:Date

No

Package Analysis Waive Code Expiration Date

Indicates the waive code assigned to the package. 

Valid code for All Packages:

Blank = Charges will be assessed 

Valid codes for Compensating Balance Packages:

  01 = Charges waived first cycle

  Default

  P1 = Permanent Waive - Waive One

  P2 = Permanent Waive - Waive Two

  P3 = Permanent Waive - Waive Three

  P4 = Permanent Waive - Banker  Discretion

P5 = Permanent Waive - Officer requested - Not on ARGO 

P6 = Permanent Waive - Senior Citizen - Not on ARGO

P7 = Permanent Waive - Non-Profit

P8 = Grandfathered Waive - Not on ARGO

R1 = Waive Service Charge 3 cycles

R2 = Waive Service Charge 6 cycles

R3 = Waive Service Charge 12 cycles

R4 = Waive Service Charge 18 cycles

R5 = Waive Service Charge 24 cycles

 R7 = Permanent Waive (FSTU) - Not on ARGO

 R8 = Permanent Brokerage Waive (FSTU) - Not on ARGO

 T1 = Waive Service Charge - Specify Exp Date on ARGO System

 T7 = Permanent Waive - Preferred Customers Compensating Balance

 WE = Waive One Month Standard   

 WM = Waive Six Months - Relationship

 WN = Waive Six Months - with Offer

 WP = Permanent Waive - with offer

 WQ = Waive One Year - with offer

 WR = Waive Six Months - with offer

 WS = Wiave Two Months Standard  

 WT = Waive Two Months - with offer

 WU = Wiave Two Months - with offer

WV = Waive Two Months - with offer

 WW = Permanent Waive - with offer

 WX = Permanent Waive - Relationship

 WY = Waive One Year - with offer

 WZ = Waive One Year -  Relationship Packages:

  IR = Integrated IRA Package Waive Code (6 Months)

 NI = Waive One Year - Standard 

  P1 = Permanent Waive - Waive One

  P2 = Permanent Waive - Waive Two

  P3 = Permanent Waive - Waive Three

 

 X77805-PKG-ANA-WAIVE-EXP      

 

3.8.5.1.4    MaintainPackageAnalysisReply

Name

Type

Required

Description

Data Source Target

MaintainPackageAnalysisReply

mps:MaintainPackageAnalysisReply

Yes

Maintain package Analysis Reply

See

MaintainPackageAnalysisReply

 

3.8.5.2    MaintainPackageAnalysisReply

Name

Type

Required

Description

Target Source

Status

usbsoaccl:Status

Yes

Status

See Status

 

 

3.8.6    Exception Processing

The service specification for error codes is described in the High-Level Web Service Interface Specification section titled Error Codes.

 

For details on Status object Refer section 2.5

 

3.8.6.1    StatusCode

 

Status Code

Severity

Status Description

Server Status Code

Additional details

0

Info

Success –

  ACTION SUCCESSFUL

000

Action Successful

100

Error

General Error

<Unknown Server code>

All Default and Unknown errors


 

3.9    UpdatePackageStatementCycle

This call will provide the channel with the ability to change the statement cycle code for a statement.  If the input account is a DDA product (meaning a stand-alone statement), PAS will call DDA to update the future cycle code on the DDA.  If the input account is a PKG product, PAS will call PKG via a new call to the PKG Box (call type yet to be determined).

 

3.9.1    Processing Specifications

Input :  

·       User Identifier

·       Account key identifier

·       Future Statement Cycle Code

 

Output :

·       Status block

           

3.9.2    Special Notes

Please refer to the following documents regarding message structure, USB SOAP Header and USB SOAP Fault and error codes.

·       USBSOAPHeader_V_2 Interface Control Document v0.1.doc

·       USBSOAPFault_V_2 Interface Control Document v0.1.doc

 

3.9.3    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

3.9.4    Message to Data Source High level Specifications

 

Service Operation Name

Source System Name

Source System Transaction/

Message Name

UpdatePackageStatementCycle

HOGAN PAS

EPSCYCP0

 

3.9.5    Field/Element Specifications

3.9.5.1    UpdatePackageStatementCycleRequest

Name

Type

Required

Description

Data Source Target

UpdatePackageStatementCycleRequest

mps:UpdatePackageStatementCycleRequest

Yes

Update Future package statement cycle code

See

UpdatePackageStatementCycleRequest

3.9.5.1.1    UpdatePackageStatementCycleRequest

Name

Type

Required

Description

Data Source Target

UserIdentifier

usbsoatl:String0008

Yes

User/Operator Identifier

This field is used for the operator identifier.

X77007-USER-ID

AccountPrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

Yes

Account Primary key Identifier

See AccountPrimaryIdentifier

V562-WRK-COID-N+

V562-WRK-ALPHA-PRDCT-CODE+

V562-WRK-ACT-ID

FutureStatementCycleCode

usbsoatl:String0002

Yes

Future Statement Cycle Code

This code indicates the future  

statement cycle code.

X085-FUTURE-STMT-CYCLE

 

3.9.5.2    UpdatePackageStatementCycleReply

Name

Type

Required

Description

Data Source Target

UpdatePackageStatementCycleReply

mps:UpdatePackageStatementCycleReply

Yes

Update Package Statement future Cycle Reply

See

UpdatePackageStatementCycleReply

 

3.9.5.3    UpdatePackageStatementCycleReply

Name

Type

Required

Description

Data Source Target

Status

 

Yes

Status Block

See Status

 

 

3.9.6    Exception Processing

The service specification for error codes is described in the High-Level Web Service Interface Specification section titled Error Codes.

 

For details on Status object Refer section 2.5

 

 

3.9.6.1    StatusCode

 

Status Code

Severity

Status Description

Server Status Code

Additional details

0

Info

Success –

  ACTION SUCCESSFUL

000

Action Successful

200

Error

General Data Error  --  Account Not Found on DB

51208

Account Not Found on DB

100

Error

General Error

<Unknown Server code>

All Default and Unknown errors


3.10    GetListPackageStatementCycle

 

This call will return a list of accounts to the channel. PAS will retrieve this data from PKG.  DDA accounts in a PKG statement will be returned with the PKG number, and the current cycle code of that PKG. DDA accounts not in a PKG statement will be returned with no PKG number.  If the DDA account is not the core account in the PKG, PKG will change the cycle at the PKG level, and on all accounts within the PKG that are getting details on the statement (not summary info only).

 

3.10.1    Processing Specifications

Input                            

§  Scrolling Parameters

§  Customer Key Identifier (name or LPID)

 

                  Output

§  Status Block

§  Scrolling parameters

§  Package Statement Cycle List (account key identifier and additional statement account detail attributes)

3.10.2    Special Notes

Please refer to the following documents regarding message structure, USB SOAP Header and USB SOAP Fault and error codes.

·       USBSOAPHeader_V_2 Interface Control Document v0.1.doc

·       USBSOAPFault_V_2 Interface Control Document v0.1.doc

 

3.10.3    Message or File Format Specifications

The message will be sent as an XML SOAP 1.2 message over HTTP 1.1.

 

3.10.4    Message to Data Source High level Specifications

 

Service Operation Name

Source System Name

Source System Transaction/

Message Name

GetListPackageStatementCycle

HOGAN PAS

EPSCYIP0

 

3.10.5    Field/Element Specifications

3.10.5.1    GetListPackageStatementCycleRequest

Name

Type

Required

Description

Data Source Target

GetListPackageStatementCycleRequest

mps:GetListPackageStatementCycleRequest

Yes

Get Package Statement Cycle Information

See  GetListPackageStatementCycleRequest

 

 
3.10.5.1.1    GetListPackageStatementCycleRequest

 

Name

Type

Required

Description

Data Source Target

GetList

Usbsoaccl:GetList_3

No

Used for Scrolling

See GetList

V560-NEXT-ENTRY+

V200-MAX-RELATIONSHIPS+

N/A+N/A

CustomerKeyIdentifier

mps:CustomerIdentifiers

Yes

Customer Key

Either Name or LPID

 

See CustomerIdentifiers

 

3.10.5.2    CustomerIdentifiers

Name

Type

Required

Description

Data Source Target

CustomerNameIdentifier

usboaccl:CustomerNameIdentifier

 

 

 

Choice

Group

Customer Name Identifier

See  CustomerNameIdentifier

 V560-WRK-COID-N+

V560-WRK-NAME-1+

V560-WRK-TIE-BREAKER-N

CustomerLegalParticipantIdentifier

usbsoatl:ParticipantSystemIdentifier

Customer Legal Participant Identifier

A unique 18-digit identifier for each U.S. Bank customer.  Leading 3 digit prefix, then a unique 15 digit number.  LPID is an unique identifier used for Foreign customers which is located on Hogan.  Retain the leading 3 digit prefix, and then allocate a unique 15 digit number to make up the full 18 digit LPID.  The rule for generating these digits must be secured. The applications should view the resulting values as though it were a randomly generated (although unique) number.  They cannot expect any intelligence in digits 4 through 18.  LPID is used as the Primary Key for Customers.

 

X060-ENRB-WRK-LPID

 

 

3.10.5.3    GetListPackageStatementCycleReply

Name

Type

Required

Description

Data Source Target

GetListPackageStatementCycleReply

mps:GetListPackageStatementCycleReply

Yes

Get List package Statement Cycle Reply

See

GetListPackageStatementCycleReply

 

3.10.5.4    GetListPackageStatementCycleReply

Name

Type

Required

Description

Data Source Target

Status

usbsoaccl:Status

Yes

Status Block

See Status

GetList

usbsoaccl:GetList_3

No

Scrolling

See GetList

 V560-NEXT-ENTRY+

N/A+

N/A+

N/A

StatementAccountCycleList

mps: PackageStatementCycle

No

(0 to many)

Package Statement Account cycle List

See

PackageStatementCycle

 

3.10.5.5    PackageStatementCycle

Name

Type

Required

Description

Data Source Target

AccountKeyIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

Account Key

See AccountPrimaryIdentifier

 X115-RS-ACCT-COID-N+

X115-RS-ACCT-PROD+

X115-RS-ACCT-ID

StatementAccountDetail

mps:StatementAccountDetail

No

Statement Account Detail

See StatementAccountDetail

 

3.10.5.6    StatementAccountDetail

Name

Type

Required

Description

Data Source Target

PackageKeyIdentifier

usbsoaccl:AccountPrimaryIdentifier

No

Package Key

See AccountPrimaryIdentifier

X115-RS-PKG-COID-N             +

X115-RS-PKG-PROD+

X115-RS-PKG-ID

PackageSubProductCode

usbsoatl:String0002

No

Package Sub Product Code

A finer classification of the product.  “Sub-product code” is the code used to identify the specific type (“sub-product”) of account within a general product group. 

The alpha-numeric subproduct code used to default the majority of the account control information and for general ledger reporting.

 

PKG SPC:

CO = Chextra Online MYM

FP = Focal Point

IR = Portfolio IRA

OB = Online Business Banking

OI = Online Individual Banking

TB = Telephone Bill Pay

W = Web Bill Pay

11 = US Bank Elite CKG

12 = US Bank Interest Plus CKG

14 = US Bank Balance CKG

16 = US Bank Mesa CKG

40 = US Bank Edge CKG

 

X115-RS-PKG-SUB-PROD-CD

InternalSubProductCode

usbsoatl:String0002

No

Internal Sub Product Code

 

X115-RS-INT-SUB-PROD-CD

ExternalSubProductCode

usbsoatl:String0002

No

External Sub Product Code

X115-RS-EXT-SUB-PROD-CD

AccountStatus

usbsoatl:String0003

No

Account Status

The status of the account.  Valid values are:

 07 – Closed

 99 – Active

 01 – New

 03 – Inactive

 05 – Dormant

 06 – In the Escheat process

 08 – Purgeable

 09 – Active

 11 – Matured CDs

 12 – In process of Close

 01- Paydown LOC

 20 – Shell

 91 – Lost, stolen, forgery

 92 – Bankrupt

 93 – Closed with balance

 96 – Charge off

 30 – Close to post

 31 – Paydown

 97 – Partial Charge-off.

 

X115-RS-ACCT-STATUS

CurrentStatementCycleCode

usbsoatl:String0002

No

Current Statement Cycle

The statement cycle code assigned to the account which indicates when

the statement is to cycle.

X115-RS-CUR-STM-CYCL

FutureStatementCycleCode

usbsoatl:String0002

No

Future Statement Cycle

This code indicates the future statement cycle code.

X115-RS-FUT-STM-CYCL

CurrentSafekeepingTypeCode

usbsoatl: String0001

No

Current Safekeeping Flag

Possible Values

Space/B = statement with all items  returned, charge 

C = ARP - Return Checks only  Credits, Deposits and Internal Debits-truncate 

F = statement with all items returned, waive charge   

T = statement with no items returned, charge         

N = statement with no items returned, waive charge   

S = ARP truncate

D = statement with only checks returned, charge  

W = statement with only checks returned, waive charge 

V = Bay View Image check return  

I = statement with images, charge 

J = statement with check images only, waive charge

 

X115-RS-CUR-SAFEKEEPING

FutureSafekeepingTypeCode

usbsoatl: String0001

No

Future Safekeeping Flag

Possible Values

Space/B = statement with all items  returned, charge 

C = ARP - Return Checks only  Credits, Deposits and Internal Debits-truncate 

F = statement with all items returned, waive charge   

T = statement with no items returned, charge

N = statement with no items returned, waive charge   

S = ARP truncate

D = statement with only checks returned, charge  

W = statement with only checks returned, waive charge

V = Bay View Image check return

I = statement with images, charge

J = statement with check images only, waive charge

 

X115-RS-FUT-SAFEKEEPING

CoreEligibilitySwitch

usbsoatl:Switch

No

Core Eligibility

True (Core Eligible)

False (Not Core Eligible)

 

X115-RS-CORE-FLAG

 

PackageInSwitch

usbsoatl:Switch

No

Package In

True (In Package)

False (Eligible)

 

X115-RS-IN-PKG-FLAG  

PrimaryCustomerSwitch

usbsoatl:Switch

No

Primary or Non Primary

customer relationship

True (PrimaryCustomer)

False (Non-primary)

 

X115-RS-PRIM-CUST-FLAG

PackageAccountStatementTypeCode

usbsoatl: String0001

No

Package Account Statement Flag

Possible Values

N or I or E or S or D

 

X115-RS-PKGACSTM

 

 

 

3.10.5.7    GetList

Name

Type

Required

Description

Target Source

NextDataFetchKey

usbsoatl:String2048

No

Check to see if this is implemented fully

NextDataFetchKey

Composite key of the next desired Account or Customer. Consumers will use this key to obtain the next page of data.

 

 

MaximumNumberOfItems

usbsoatl:NumberNonNegative05

No

Check to see if this is implemented fully

Maximum Number of Items

 

 

SortOrderCode

usbsoaccl:SortOrderCodeEnumerationsList

No

Check to see if this is implemented fully

Sort Order Code

A code that indicates the sorting performed on this list. 

 

 

MoreIndicator

Xsd:Boolean

No

Indicate if more data is available to fetch or not

 

 

 

3.10.6    Exception Processing

The service specification for error codes is described in the High-Level Web Service Interface Specification section titled Error Codes.

 

For details on Status object Refer section 2.5

 

3.10.6.1    StatusCode

 

Status Code

Severity

Status Description

Server Status Code

Additional details

0

Info

Success –

 ACTION SUCCESSFUL

000

Action Successful

200

Error

General Data Error  --  Customer not found on file

64159

Customer Not found on file

100

Error

General Error

<Unknown Server code>

All Default and Unknown errors

 

 


 

4.    Connection Information

The connection information for the service is as follows: 

 

Environment

Hyperlink to connection information

DEV/UNIT

https://dev-internalservice.us.bank-dns.com:8002/PackageService_V_2_0

IT/ST1

https://it-internalservice.us.bank-dns.com/PackageService_V_2_0

UAT/ST2

https://uat-internalserviceep.us.bank-dns.com/PackageService_V_2_0

https://uat-internalserviceobc.us.bank-dns.com/PackageService_V_2_0

Prod

https://internalserviceep.us.bank-dns.com/PackageService_V_2_0

https://internalserviceobc.us.bank-dns.com/PackageService_V_2_0