PackageInquiryService

ESD Interface Control Document

 

Service Version 2.1

Document Version 1.11

Updated 02/01/2016

U.S. Bank Internal

This document may not be shared with third parties without approval from the Enterprise Service Development (ESD) department. Please contact the ESD Documentation Shared Mailbox for further information.

 
 



Document Revision History

See the Service Change Log for more details about service version changes.

Date

Version

Overview of Update

Author

08/06/2012

1.0

Initial creation

Krishna Gurram

09/06/2012

1.1

Updated the Element names

Krishna Gurram

09/18/2012

1.2

Updated the State field mapping

Krishna Gurram

09/28/2012

1.3

Updated AccountIdentifier to AccountPrimaryIdentifier_2

Lingaraju P N

10/15/2012

1.4

Element “AlertCode” Data type is changed from Boolean to String of length 1

Lingaraju P N

04/29/2013

1.5

Converted to new ICD template

Lisa De Luney

04/29/2013

1.6

Updated message version for GetPackageHistoryDetail and added HeartBeat operation

David Altieri

05/17/2013

1.7

Replaced Previous Versions Cross Reference table with an updated table.

Lisa De Luney and David Altieri

09/27/2013

1.8

Updated Cross Reference Table to include GetPackageAccountList

David Altieri

12/11/2015

1.9

Added New Operation GetExpandedSavingsOptionDetail

Jhansi Priya

12/21/2015

1.10

Updated Status codes for GetExpandedSavingsOptionDetail

Jhansi Priya

02/01/2016

1.11

Updated Schema and Contivo map for GetExpandedSavingsOptionDetail Operation

Jhansi Priya

 


Table of Contents

Service Description................................................................................................................ 5

Limitations................................................................................................................................. 5

Special Considerations.............................................................................................................. 5

Assumptions.............................................................................................................................. 5

References................................................................................................................................ 5

High-Level Web Service Interface Specifications.............................................................. 6

System Interface Diagram.......................................................................................................... 6

System Interaction Diagrams...................................................................................................... 7

Security Specifications............................................................................................................... 7

Tier 2 Consumer Authorization.............................................................................................. 7

Tier 3 Consumer Authorization.............................................................................................. 7

Processing Specifications.......................................................................................................... 8

Exception Processing................................................................................................................ 8

Service Time-Out Specifications................................................................................................. 9

Detailed Interface/Message Specifications by Service Operation................................... 9

GetPackageAccountList............................................................................................................ 9

Operation Description............................................................................................................ 9

Processing Specifications.................................................................................................... 10

Functional Scenarios........................................................................................................... 10

Pagination or Scrolling for Results Using the GetList Aggregate.......................................... 10

Operation to Data Source Reference Table......................................................................... 10

Field/Element Specifications................................................................................................ 10

Exception Processing.......................................................................................................... 28

GetPackageHistoryDetail......................................................................................................... 30

Operation Description.......................................................................................................... 30

Processing Specifications.................................................................................................... 30

Functional Scenarios........................................................................................................... 31

Pagination or Scrolling for Results Using the GetList Aggregate.......................................... 31

Operation to Data Source Reference Table......................................................................... 31

Field/Element Specifications................................................................................................ 31

Exception Processing.......................................................................................................... 42

HeartBeat................................................................................................................................ 44

Operation Description.......................................................................................................... 44

Processing Specifications.................................................................................................... 44

Functional Scenarios........................................................................................................... 44

Pagination or Scrolling for Results Using the GetList Aggregate.......................................... 44

Operation to Data Source Reference Table......................................................................... 44

Field/Element Specifications................................................................................................ 44

Exception Processing.......................................................................................................... 46

Connection Information..................................................................................................... 48

Tier 2 Environment Configuration............................................................................................. 48

Tier 3 Environment Configuration............................................................................................. 48

Disaster Recovery (DR) Testing................................................................................................ 48

Service Change Log............................................................................................................ 49

PackageInquiryService 2.0 – PRJ0000####............................................................................ 49

Operation Name.................................................................................................................. 49

Refactored Service and Operation Cross-Reference Table........................................... 50

GetPackageHistoryDetail......................................................................................................... 50

GetPackageAccountsRequest................................................................................................. 50

Appendix A     Custom Components.................................................................................. 60

AccountPrimaryIdentifier_2.................................................................................................. 60

AddressResponse............................................................................................................... 60

CustomerKeyIdentifier......................................................................................................... 64

GetList................................................................................................................................ 64

Status................................................................................................................................. 64

USTaxPayerIdentifier.......................................................................................................... 65

Appendix B     Definitions, Acronyms and Abbreviations............................................... 65


Service Description

Packages are a combination of U.S. Bank qualifying accounts that offer consumer and business customers’ benefits and/or features which may include product discounts and rewards. The PackageInquiryService 2.0 is used to retrieve the Savings Today and Rewards Tomorrow (S.T.A.R.T.) program features of a Building Deeper Relationships (BDR) package. This service returns both enrolled and eligible accounts based on the filter flag and package detail and history information as requested.

Limitations

Consider the following limitations before consuming this service:

·       The service will support XML SOAP 1.2 messages over HTTP 1.1.

·       Refer to the WSDL and XSD files for the technical details.

·       This service is accessed from Tier 2/Tier 3.

Special Considerations

Consider the following special considerations when consuming this service:

Assumptions

The audience has knowledge of and understands the following technologies:

·       XML

·       XSD

·       SOAP

Note: ESD designed PackageInquiryService 2.0 as an enterprise Web service with the assumption that any application could be a consumer of this service.

References

ESD referenced the following documents or artifacts while creating or updating this ICD:

·       PackageInquiryService_V_2_0.wsdl

·       Message PackageInquiryService_V_2_0.xsd

·       USBSOATypeLibrary_V_3_0.xsd

·       USBSOACoreComponentsLibrary_V_3_0.xsd

·       GetPackageAccountListRequest_to_EPKSTIP2RequestCCB.xbm

·       EPKSTIP2ReplyCCB_to_GetPackageAccountListReply.xbm

·       GetPackageHistoryDetailRequest_to_EPHDTIP5RequestCCB.xbm

·       EPHDTIP5ReplyCCB_to_GetPackageHistoryDetailReply.xbm

·       GetExpandedSavingOptionDetailRequest_to_EPKESIP0RequestCCB.xbm

·       EPKESIP0ReplyCCB_to_GetExpandedSavingsOptionDetailReply.xbm

 


High-Level Web Service Interface Specifications

This topic illustrates both the system interface and interactions and covers specifications related to service security, processing, exception processing and time-outs.

System Interface Diagram

The following diagram (Figure 1) gives a high-level view of the pieces involved in the PackageInquiryService 2.0 service, which is an enterprise Web service that could be used by any application. The diagram shows the process of how consumers connect to enterprise services through the Oracle Service Bus (OSB), which hosts virtualized services, instead of connecting directly to them.

Figure 1   PackageInquiryService_V_2_0


System Interaction Diagrams

PackageInquiryService 2.0 presents multiple scenarios for processing requests. The following interaction and sequence diagrams illustrate each scenario and provide better insight about how the components interact.

The following diagram (Figure 2) shows how the system routes all requests between consumers and services through OSB. This is true for both internal and external Web services. The following diagram illustrates the role OSB plays in the sequence following a consumer call to a service operation.

Note: This diagram is a brief overview of this interaction and not a complete picture of how OSB and other involved software components work together in the service environment.

Figure 2   Sequence Diagram

Error! Objects cannot be created from editing field codes.

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

Security Specifications

The following topics describe the U.S. Bank security specifications this service interface must implement.

Tier 2 Consumer Authorization

Mutual authentication, or two-way authentication (which is sometimes written as 2WAY authentication), refers to two parties authenticating each other suitably. In technology terms, this refers to clients or users authenticating themselves to servers and those servers authenticating themselves to the clients or users in such a way that both parties are assured of the others' identities. Trusted third parties that use shared secrets, as in Kerberos v5, or cryptographic means, as with a public key infrastructure, can also validate identities.

Tier 3 Consumer Authorization

ESD uses WS-Security 1.0 to handle service authentication. ESD expects all clients to provide a WS-Security Username Token in the WS-Security header in all service calls. SSL-mutual authentication provides the payload authentication between OSB and the TIBCO service layer. See the Oracle Service Bus (OSB) WS-Security Mechanism document on the ESD SharePoint site for more information.


Processing Specifications

This topic describes the most common processing pattern used by the service operations. If this pattern does not apply to an operation, that operation will contain a description of its unique processing pattern.

·       Processing starts with the client application sending the SOAP request message to the service URL over HTTPS.

·       The BW Process Engine (engine) monitors the specified JMS-based request queue for messages. When the engine detects a message on the HTTPS port, it initiates the BW Process associated with that service operation.

·       The system logs the request, then validates and transforms it into the host-specific format. In this case, the XML message is converted into a COBOL Copy Book (CCB) format, which is also called a Flat File Definition (FFD) format.

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

·       Hogan/PAS sends a reply to the MQ CICS adapter. The MQ adapter places this reply message in the MQ reply queue.

·       The BW process Engine (engine) waits for a reply from MQ adapter. When the engine detects the message, it converts the message from the FFD format into XML. The BW process uses Contivo as a mapping engine during the transformation.

·       The system sends a reply to another JMS-based response queue, which OSB monitors. When OSB detects a reply, it pulls the response and passes it to the client.

·       There is a time-out limit related to messaging on both the client and host sides. When a time-out occurs, the system sends the USBSOAPFault in the response.

Exception Processing

Consumers access all services through the OSB gateway layer. Consumers must handle the following two types of faults, generated by either the gateway or implementation layers, when calling any of the ESD-hosted services:

·       W3 Standard Fault (gateway-generated fault)

·       USBSOAPFault (implementation-generated fault)

Refer to the technical implementation service guide for directions on implementing enterprise error codes for replies and fault messages. (This topic was called Error Codes in earlier ICD versions.)

Note: Each operation includes documentation on the specific error messages impacting that operation.


Service Time-Out Specifications

When time-outs occur, consumers should receive an USBSOAPFault in the following places:

·       OSB Gateway, or

·       TIBCO Service layer.

Important:

·       Consumers need to set the time-out value higher than the OSB Gateway time-out value.

·       Individual operations can have different time-out values, which are documented in the specific operation topics.

·       The highest operation time-out values are set during the overall TIBCO service implementation. For example, a service has three operations. If the first and second operations need 10 seconds to process, but the third operation needs 20 seconds, then the TIBCO service time-out value is set at 20 seconds.)

At the TIBCO Service implementation for PackageInquiryService 2.0, ESD determined that a 10-second time-out value is appropriate.

The following diagram shows the end-to-end time-out intervals for the various system components involved in the PackageInquiryService 2.0 service.

Figure 3   End-To-End Timeout Intervals


Detailed Interface/Message Specifications by Service Operation

This topic provides detailed processing specifications that are common to all the operations for this service.

GetPackageAccountList

The following topics describe this operation.

Operation Description

The GetPackageAccountList operation is used to retrieve the START features of a Building Deeper Relationships (BDR) package. This operation returns either enrolled or eligible accounts, or both, based on the filter flag. PAS returns the following four response segments based on product:

·       PKG

·       DDA

·       CCD

·       CHX


Processing Specifications

This topic describes the most common processing pattern used by the service operations. If this pattern does not apply to an operation, that operation will contain a description of its unique processing pattern.

·       See Processing Specifications for service-level processing specifications.

Functional Scenarios

The following scenarios demonstrate how to set up the operation for functional testing and usage.

NA

Pagination or Scrolling for Results Using the GetList Aggregate

ESD enterprise services use the GetList aggregate type in both requests and replies for services that require scrolling. The usage is slightly different for both requests and replies between service implementation and consumption.

Request

·       GetList is optional for the first call and use only the MaximumNumberOfItems element to limit the number of rows in the reply. If it is not passed, the SOR uses the default value that is documented in the ICD.

·       When the system first calls the operation, it either skips or leaves empty the NextDataFetchKey element in the GetList.

·       When the system calls the operation for additional results, it sends the GetList the results from the previous reply. Do not alter any value in NextDataFetchKey.

Reply

·       Check the status aggregate first for the successful execution of the call.

·       Use the MoreIndicator element to find out if more data exists in the SOR.

Operation to Data Source Reference Table

This table shows the operation and the provider system of record (SOR).

Source System Name

Source System Transaction/Message Name

HOGAN PAS

EPKSTIP2

Field/Element Specifications

This section explains all of the field-level elements for the request and response aggregates.

 


GetPackageAccountListRequest

Name

Type

Width

Req?

Description

Host Field Name

GetPackageAccountListRequest

 

Y

 

 

 PackagePrimaryIdentifier

 

 

Y

 

 

   OperatingCompany

   Identifier

Number

0 to 5

Y

Operating Company Identifier
Bank Number is a three-digit number which delineates a particular market region

Default: 00654

X77806-PKG-COID-N

   ProductCode

String

0 to 3

Y

Product Code
Three character alpha-numeric product code used to identify the general type of an account

Value: PKG

X77806-PKG-PROD

   PrimaryIdentifier

String

0 to 23

Y

The account number

X77806-PKG-NBR      

EnrollmentCode

String

0 to 1

Y

Valid Values:

Y: returns accounts which are already enrolled in START feature.(Y)

N: returns only eligible accounts.(N)

Space: returns both enrolled and eligible accounts.

X77806-ENROLLED-FLAG

GetList                                                                                                   N

NextDataFetchKey

String

0 to 2048

N

The composite key that the service consumers will use when requesting additional pages of data.

X77806-NXT-ACCT-COID-N+

X77806-NXT-ACCT-PROD+

X77806-NXT-ACCT-NBR+

X77806-PKST-NEXT-SEQ

MaximumNumberOfItems

Number

0 to 5

N

Number of accounts returned in each transaction.

Max Value: 15

V200-MAX-RELATIONSHIPS

SortOrder

Number

0 to 5

N

 

NA

MoreIndicator

Boolean

--------

N

 

NA

GetPackageAccountListReply

Name

Type

Width

Req?

Description

Host Field Name

GetPackageAccountListReply

    Status

 

 

Y

 

 

      StatusCode

Integer

 

Y

Service Status Code (used from IFX)

N/A

      Severity

String

 

Y

Service Severity

N/A

      StatusDescription

String

1 to 255

Y

Service Status Description (used from IFX)

N/A

      ServerStatusCode

String

0 to 20

N

Host System Status Code

BTCB-USER-CC

      ServerStatusDescription

String

0 to 255

N

Host System Status Description

BTCB-USER-DESCRIPTION

   GetList

 

 

N

 

 

      NextDataFetchKey

String

 0 to 2048

N

The composite key that the service consumers will use when requesting additional pages of data.

X77806-NXT-ACCT-COID-N+

X77806-NXT-ACCT-PROD+

X77806-NXT-ACCT-NBR+

X77806-PKST-NXT-SEQ

      MaximumNumberOfItems

Integer

 0 to 5

N

NA

NA

      SortOrder

Integer

 0 to 5

N

NA

NA

      MoreIndicator

boolean

 

N

NA

NA

PackageData                                                                                    N

    AccountIdentifier                                                                         N

      OperatingCompany

      Identifier

Integer

0 to 5

Y

Operating Company – internal US Bank identifier used for segmenting accounts into regions or other operating units.

PKG Company ID.

X77806-PACKAGE-COID-N

      ProductCode

String

0 to 3

Y

PKG Product Code (PKG).

Three character alpha-numeric product codes used to identify the general type of an account.

X77806-PACKAGE-PRD

      PrimaryIdentifier

String

0 to 23

Y

PKG Number

Package Identifier

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.

Package Types:

Consumer Silver Package

Consumer Gold Package

Consumer Platinum Package

Silver Elite Consumer Package

Elite Consumer Package

Silver Business Package

Gold Business Package

Platinum Business Package

Business Edge Package

Business Edge with Interest Package

X77806-PACKAGE-ID

   CoreAccountIdentifier                                                                   N

      OperatingCompany

      Identifier

Integer

0 to 5

Y

Core DDA Company ID

This is the number assigned to identify which operating company to search for this account. If not specified this will default to US Bank

X77806-CORE-DDA-COID-N

      ProductCode

String

0 to 3

Y

Core DDA Product Code

Three character alpha-numeric product code used to identify the general type of an account.

X77806-CORE-DDA-PRD

      PrimaryIdentifier

String

0 to 23

Y

Core DDA Account Number

X77806-CORE-DDA-NBR

   StatusCode

String

0 to 2

N

If X77806-STRT-PGM-STATUS=1 ->

 WORKING_TOWARD_GOAL_ONE

If X77806-STRT-PGM-STATUS=2 ->

MET_GOAL_ONE_WORKING_

TOWARD-GOAL_TWO

If X77806-STRT-PGM-STATUS=3 ->

MET_GOAL_ONE_FAILED_TO_

MEET_GOAL_TWO

If X77806-STRT-PGM-STATUS=4 ->

MET_GOAL_TWO OTHERWISE  ->

UNKNOWN_HOGAN_STATUSCODE

X77806-STRT-PGM-STATUS

   SubProductCode

String

0 to 2

N

Package Sub Product Code

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

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

X77806-PKG-SUB-PRD

EnrollmentDetail                                                                               N

   ProgramEnrollmentStatus

   Code

String

0 to 2

N

Program Enrollment Status Code

X77806-STRT-ENROLL-STATUS

   ProgramEnrollmentDate

Date

0 to 8

N

ENROLL DATE

Date indicates when the account was enrolled in S.T.A.R.T. program. Populated on both the DDA and the Sav account.

X016-DATE-01

   LastEnrollmentStatus

   ChangedDate

Date

0 to 8

N

DATE ENROLLMENT STATUS CHANGE

X016-DATE-04

   LastProgramStatus

   ChangedDate

Date

0 to 8

N

DATE PROGRAM STATUS CHANGE

X016-DATE-05

NotificationDetail                                                                              N

   NotificationTypeCode

String

0 to 3

N

LETTER NOTIFICATION TYPE

This field contains the Hogan Letter Number that will be suppressed (Y or N) for mailing if  Form Media Code on DDMU11 = 02.   

X77806-LETTER-NOTIF-TYPE

   LastNotificationSentDate

Date

0 to 8

N

DATE LAST LETTER NOTIFICATION SENT

Date the most recent letter was sent to  customer indicating that their account does not qualify for the five star package.

X016-DATE-02

   NotificationExpirationDate

Date

0 to 8

N

PACKAGE DATE LETTER NOTICE EXPIRED.

Expiration date of the 30 day grace period after notification is sent when product or benefit changes will be triggered.  

X016-DATE-03

DDAAccountList                                                                               N

  DDAAccountSummary                                                                   N

   AccountIdentifier

 

 

N

 

 

      OperatingCompany

      Identifier

Integer

0 to 5

Y

Money Market Company Identifier

X77806-DDA-COID-N

      ProductCode

String

0 to 3

Y

MM Product Code.

Three character alpha-numeric product code used to identify the general type of an account.

X77806-DDA-PRD

      PrimaryIdentifier

String

0 to 23

Y

MM Account Number

X77806-DDA-NBR

  StatusCode

String

0 to 2

N

Account Status

X77806-DDA-ACT-STATUS

  SubProductCode

String

0 to 2

N

Sub Product Code

X77806-DDA-ACT-SUB-PRD

STARTProgramDetail                                                                       N

GoalOneDetail

 

 

N

 

 

  PercentToGoalOne

Decimal

0 to 5

N

Percent achieved for Goal 1

X77806-PERCNT-TO-GOAL1

  AchievedDate

Date

0 to 8

N

GOAL 1 Achieved date

X016-DATE-01

  RewardReceipientName

String

0 to 40

N

GOAL 1 Reward recipient

X77806-GOAL1-REWARD-RECIP

GoalTwoDetail

 

 

N

 

 

  TargetDate

Date

0 to 8

N

GOAL 2 Target Date

X016-DATE-02

  AchievedDate

Date

0 to 8

N

Date 2nd Save Goal Met

X016-DATE-07

  RewardRecipientName

String

0 to 40

N

Goal2 Reward Recipient

X77806-GOAL2-REWARD-RECIP

  CounterToGoalTwoNumber

Integer

0 to 3

N

 

X77806-COUNTER-TO-GOAL2

  FailedDate

Date

0 to 8

N

START Fail Goal 2 Date

X016-DATE-10

ThinkTwiceDetail

 

 

N

 

 

  EnrollmentDate

Date

0 to 8

N

Think Twice enrollment date

X016-DATE-03

  DeEnrollmentDate

Date

0 to 8

N

Think Twice de-enrollment date

X016-DATE-04

TransferDetail

    AutomatedTransferAmount

Decimal

0 to 15

N

Automated Transfer Program-to-date

X77806-STRT-ATA-AMOUNT-PTD

    DebitTransferAmount

Decimal

0 to 15

N

Debit Transaction transfer amount Program-to-date

X77806-STRT-DTS-AMOUNT-PTD

    CreditTransferAmount

Decimal

0 to 15

N

Credit Transaction transfer amount Program-to-date

X77806-STRT-CTS-AMOUNT-PTD

    DebitRewardsAmount

Decimal

0 to 15

N

Debit rewards Program-to-date

X77806-STRT-DRS-AMOUNT-PTD

    CreditRewardsAmount

Decimal

0 to 15

N

Credit rewards Program-to-date

X77806-STRT-CRS-AMOUNT-PTD

    ProgramLastTransferDate

Date

0 to 8

N

Last START Transfer Date

X016-DATE-06

  AlertCode

String

0 to 1

N

R =  for on-line activity

Y = Customer eligible for START rewards

N = Customer not set up for START rewards

X71504D-START-ALERT-FLAG

  AutomaticTransferCode

Switch

 

N

Enrolled in START Automated Transfer Flag

X77806-DDA-ATA-ENROLLED

  EnrollmentCode

Switch

 

N

Enrolled in START Target Flag

X77806-DDA-TGT-ENROLLED

  LedgerBalanceAmount

Decimal

0 to 15

N

Ledger Balance

X77806-DDA-LEDGER-BAL

  BeginningBalanceAmount

Decimal

0 to 15

N

START Program beginning balance

X77806-BEGIN-STRT-BAL

  TargetBalanceAmount

Decimal

0 to 15

N

START Program target balance

X77806-TARGET-STRT-BAL

  TotalSkipNumber

Integer

0 to 3

N

Number of skips of eligible schedule transfer into START Program account.

X71504D-START-TOT-NUM-SKIPS

  NextStatementDate

Date

0 to 8

N

Next Statement Date

X016-DATE-09

  ResetDate

Date

0 to 8

N

START Reset Date

X016-DATE-08

  DeEnrollmentDate

Date

0 to 8

N

START de-enrollment date

X016-DATE-05

CreditCardList

CreditCardSummary                                                                        N

   AccountIdentifier                                                                           N

      OperatingCompany

      Identifier

Integer

0 to 5

Y

CCD Company Identifier

X77806-CCD-COID-N

      ProductCode

String

0 to 3

Y

CCD Product Code. Three character alpha-numeric product code used to identify the general type of an account.

X77806-CCD-PRD

      PrimaryIdentifier

String

0 to 23

Y

Credit Card Account Number

X77806-CCD-NBR

   StatusCode

String

0 to 2

N

Account Status

X77806-CCD-ACT-STATUS

   SubProductCode

String

0 to 2

N

Sub Product Code

X77806-CCD-ACT-SUB-PRD

RewardSweepDetail

 

 

N

 

 

   EligibilityCode

Switch

 

N

Credit Rewards sweep eligible

X77806-CCD-CRS-ELIGIBLE

   EnrollmentCode

Switch

0 to 1

N

Credit Rewards sweep enrolled (Y/N)

X77806-CCD-CRS-ENROLLED

   TransactionSweep

   EnrollmentCode

Switch

0 to 1

N

Credit Transaction sweep enrolled (Y/N)

X77806-CCD-CTS-ENROLLED

   BeginningDate

Date

0 to 8

N

Credit Rewards sweep feature

beginning date

X016-DATE-02

  PerTransactionAmount

Integer

0 to 15

N

Transaction Amount

X77806-CCD-PER-TRAN-AMOUNT

  BeginningDate

Date

0 to 8

N

CCD features beginning Date

X016-DATE-01

  PrimaryOwnerName

String

0 to 40

N

Credit Card Primary Owner

X77806-CCD-PRIMARY-OWNER

CheckCardList

CheckCardSummary                                                                        N

   AccountIdentifier                                                                           N

      OperatingCompany

      Identifier

Integer

0 to 5

Y

CHX Company Identifier

X77806-CHX-COID-N

      ProductCode

String

0 to 3

Y

CHX Product Code. Three character alpha-numeric product code used to identify the general type of an account.

X77806-CHX-PRD

      PrimaryIdentifier

String

0 to 23

Y

Checking Account Number

X77806-CHX-NBR

   StatusCode

String

0 to 2

N

Account Status

X77806-CHX-ACT-STATUS

   SubProductCode

String

0 to 2

N

Sub Product Code

X77806-CHX-ACT-SUB-PRD

 RewardSweepDetail

   EligibilityCode

Switch

 

N

Debit Rewards Sweep Eligible

X77806-CHX-DRS-ELIGIBLE

   EnrollmentCode

Switch

0 to 1

N

Debit Rewards Sweep Enrollment (Y/N)

X77806-CHX-DRS-ENROLLED

   TransactionSweep

   EnrollmentCode

Switch

0 to 1

N

Debit Transaction Sweep Enrollment (Y/N)

X77806-CHX-DTS-ENROLLED

   BeginningDate

Date

0 to 8

N

Debit Rewards Sweep feature beginning Date

X016-DATE-02

  PerTransactionAmount

Integer

0 to 15

N

Transaction Amount

X77806-CHX-PER-TRAN-AMOUNT

  BeginningDate

Date

0 to 8

N

CHX features beginning Date

X016-DATE-01

  PrimaryOwnerName

String

0 to 40

N

CHX Primary Owner

X77806-CHX-PRIMARY-OWNER

Input Data Mapping Specifications

OLD Schema (GetPackageAccountListRequest)

NEW Schema (GetPackageAccountListRequest)

Comments

Aggregate

Element

Aggregate

Element

 

 

EnrolledInProgram

 

 

Not mapped to the Host

 

EnrolledFlag

 

EnrollmentCode

 

PackageIdentifier

 

 

 

Not mapped to the HOST

NextAccountPrimaryIdentifier

OperatingCompanyIdentifier

AccountIdentifier

OperatingCompanyIdentifier

 

 

ProductCode

 

ProductCode

 

 

PrimaryIdentifier

 

PrimaryIdentifier

 

 

Company_ID

 

 

Not Mapped to the Host

CustomerIdentityChoice

CustomerKey

GetList

 

Added to the refactored operation

 

CustomerLPID

 

 

 

CustomerKey

CustomerName

 

 

Not Mapped to the Host

 

TieBreaker

 

 

 

Output Data Mapping Specifications

Note: This operation is moved from CustomerService_V9.GetPackageAccounts and using the below X-Reference table would help understand the mapping between the old and the new service implementations.

OLD Schema (GetPackageAccountListReply)

NEW Schema (GetPackageAccountListReply)

Comments

Aggregate

Element

Aggregate

Element

 

 

 

Status

 

Added to the refactored operation

 

 

GetList

 

Added to the refactored operation

PackageData

 

PackageData

 

 

PackagePrimaryIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

AccountIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

 

CoreAccountPrimaryIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

CoreAccountIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

 

 

AccountSubProd

PackageData

SubProductCode

 

 

ProgramEnrollDate

EnrollmentDetail

ProgramEnrollmentDate

 

 

ProgramStatus

PackageData

StatusCode

 

 

ProgramStatusDescription

 

 

Not Mapped to the Host

 

ProgramEnrollmentStatus

EnrollmentDetail

ProgramEnrollmentStatusCode

 

 

ProgramEnrollmentStatusDescription

 

 

Not Mapped to the Host

 

LastNotifySent

NotificationDetail

LastNotificationSentDate

 

 

NotificationExpiryDate

NotificationDetail

NotificationExpirationDate

 

 

NotificationType

NotificationDetail

NotificationTypeCode

 

 

DateLastEnrollmentStatusChanged

EnrollmentDetail

LastEnrollmentStatusChangedDate

 

 

DateLastProgramStatusChanged

EnrollmentDetail

LastProgramStatusChangedDate

 

 

MessageToGoal1

 

 

Not Mapped to the Host

 

StatusToGoal1

 

 

Not Mapped to the Host

 

MessageToGoal2

 

 

Not Mapped to the Host

 

StatusToGoal2

 

 

Not Mapped to the Host

 

ProductID

 

 

Not Mapped to the Host

 

ProductName

 

 

Not Mapped to the Host

 

AccoutStatusCode

 

 

Not Mapped to the Host

 

AccountStatusDescription

 

 

Not Mapped to the Host

 

AccountRelationshipCode

 

 

Not Mapped to the Host

 

AccountRelationshipDescription

 

 

Not Mapped to the Host

 

BranchID

 

 

Not Mapped to the Host

 

BranchName

 

 

Not Mapped to the Host

 

DateAccountOpened

 

 

Not Mapped to the Host

 

DateAccountClosed

 

 

Not Mapped to the Host

 

AccountBalance

 

 

Not Mapped to the Host

 

AccountAvailableBalance

 

 

Not Mapped to the Host

 

NickName

 

 

Not Mapped to the Host

 

StatementStreetAddress

 

 

Not Mapped to the Host

DDALevelData

 

DDAAccountList/DDAAccountSummary

 

 

MMSavingsPrimaryIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

AccountIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

 

 

AccountStatus

DDAAccountSummary

StatusCode

 

 

AccountSubProd

DDAAccountSummary

SubProductCode

 

ProgramSettings

AutomaticTransferAccount

STARTProgramDetail

AutomaticTransferCode

 

 

DebitTransactionSweep

 

 

Not Mapped to the Host

 

CreditTransactionSweep

 

 

Not Mapped to the Host

 

DebitRewardSweep

 

 

Not Mapped to the Host

 

CreditRewardSweep

 

 

Not Mapped to the Host

 

TargetAccountPrimarySTARTenrollmentflag

STARTProgramDetail

EnrollmentCode

 

DDALevelData

LedgerBalance

STARTProgramDetail

LedgerBalanceAmount

 

 

BeginStartBalance

STARTProgramDetail

BeginningBalanceAmount

 

 

TargetStartBalance

STARTProgramDetail

TargetBalanceAmount

 

 

Goal1AchievedDate

GoalOneDetail

AchievedDate

 

 

Goal1RewardReceipt

GoalOneDetail

RewardRecipientName

 

 

ThinkTwiceEnrollDate

ThinkTwiceDetail

EnrollmentDate

 

 

ThinkTwiceDeEnrollDate

ThinkTwiceDetail

DeEnrollmentDate

 

 

ProgramDeEnrollDate

STARTProgramDetail

DeEnrollmentDate

 

 

ProgramATAAmountPTD

TransferAmountList

AutomatedTransferAmount

 

 

ProgramDTSAmountPTD

TransferAmountList

DebitTransferAmount

 

 

ProgramCTSAmountPTD

TransferAmountList

CreditTransferAmount

 

 

ProgramDRSAmountPTD

TransferAmountList

DebitRewardsAmount

 

 

ProgramCRSAmountPTD

TransferAmountList

CreditRewardsAmount

 

 

LastProgramTransferDate

STARTProgramDates

ProgramLastTransferDate

 

 

PercentToGoal1

GoalOneDetail

PercentToGoalOne

 

 

CounterToGoal2

GoalTwoDetail

CounterToGoalTwo

 

 

STARTAlertsFlag

STARTProgramDetail

AlertCode

 

 

Goal2TargetDate

GoalTwoDetail

TargetDate

 

 

STARTTotalSkips

STARTProgramDetail

TotalSkipNumber

 

 

Goal2AchievedDate

GoalTwoDetail

AchievedDate

 

 

Goal2RewardRecipient

GoalTwoDetail

RewardRecipientName

 

 

STARTResetDate

STARTProgramDetail

ResetDate

 

 

NextStatementDate

STARTProgramDetail

NextStatementDate

 

 

DateFailedToMetGoal2

GoalTwoDetail

FailedDate

 

 

ProductID

 

 

Not Mapped to the Host

 

ProductName

 

 

Not Mapped to the Host

 

AccoutStatusCode

 

 

Not Mapped to the Host

 

AccountStatusDescription

 

 

Not Mapped to the Host

 

AccountRelationshipCode

 

 

Not Mapped to the Host

 

AccountRelationshipDescription

 

 

Not Mapped to the Host

 

BranchID

 

 

Not Mapped to the Host

 

BranchName

 

 

Not Mapped to the Host

 

DateAccountOpened

 

 

Not Mapped to the Host

 

DateAccountClosed

 

 

Not Mapped to the Host

 

AccountBalance

 

 

Not Mapped to the Host

 

AccountAvailableBalance

 

 

Not Mapped to the Host

 

NickName

 

 

Not Mapped to the Host

 

StatementStreetAddress

 

 

Not Mapped to the Host

 

ProductID

 

 

Not Mapped to the Host

 

ProductName

 

 

Not Mapped to the Host

 

AccoutStatusCode

 

 

Not Mapped to the Host

 

AccountStatusDescription

 

 

Not Mapped to the Host

 

AccountRelationshipCode

 

 

Not Mapped to the Host

 

AccountRelationshipDescription

 

 

Not Mapped to the Host

 

BranchID

 

 

Not Mapped to the Host

 

BranchName

 

 

Not Mapped to the Host

 

DateAccountOpened

 

 

Not Mapped to the Host

 

DateAccountClosed

 

 

Not Mapped to the Host

 

AccountBalance

 

 

Not Mapped to the Host

 

AccountAvailableBalance

 

 

Not Mapped to the Host

 

NickName

 

 

Not Mapped to the Host

 

StatementStreetAddress

 

 

Not Mapped to the Host

CCDLevelData

 

CreditCardList/CreditCardSummary

 

 

CCDPrimaryIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

AccountIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

 

 

AccountStatus

CardSummary

StatusCode

 

 

AccountSubProd

CardSummary

SubProductCode

 

 

CRSEligible

CardDetail/RewardSweepDetail

EligibilityCode

 

ProgramSettings

AutomaticTransferAccount

 

 

Not Mapped to the Host

 

DebitTransactionSweep

 

 

Not Mapped to the Host

 

CreditTransactionSweep

RewardSweepDetail

TransactionSweepEnrollmentCode

 

 

DebitRewardSweep

 

 

Not Mapped to the Host

 

CreditRewardSweep

RewardSweepDetail

EnrollmentCode

 

 

TargetAccountPrimarySTARTenrollmentflag

 

 

Not Mapped to the Host

 

PerTransactionAmount

CardDetail

PerTransactionAmount

 

 

CCDBeginDate

CardDetail

BeginningDate

 

 

CRSBeginDate

RewardSweepDetail

BeginningDate

 

 

CCDPrimaryOwner

CardDetail

PrimaryOwnerName

 

 

ProductID

 

 

Not Mapped to the Host

 

ProductName

 

 

Not Mapped to the Host

 

AccoutStatusCode

 

 

Not Mapped to the Host

 

AccountStatusDescription

 

 

Not Mapped to the Host

 

AccountRelationshipCode

 

 

Not Mapped to the Host

 

AccountRelationshipDescription

 

 

Not Mapped to the Host

 

BranchID

 

 

Not Mapped to the Host

 

BranchName

 

 

Not Mapped to the Host

 

DateAccountOpened

 

 

Not Mapped to the Host

 

DateAccountClosed

 

 

Not Mapped to the Host

 

AccountBalance

 

 

Not Mapped to the Host

 

AccountAvailableBalance

 

 

Not Mapped to the Host

 

NickName

 

 

Not Mapped to the Host

 

StatementStreetAddress

 

 

Not Mapped to the Host

 

ProductID

 

 

Not Mapped to the Host

 

ProductName

 

 

Not Mapped to the Host

 

AccoutStatusCode

 

 

Not Mapped to the Host

 

AccountStatusDescription

 

 

Not Mapped to the Host

 

AccountRelationshipCode

 

 

Not Mapped to the Host

 

AccountRelationshipDescription

 

 

Not Mapped to the Host

 

BranchID

 

 

Not Mapped to the Host

 

BranchName

 

 

Not Mapped to the Host

 

DateAccountOpened

 

 

Not Mapped to the Host

 

DateAccountClosed

 

 

Not Mapped to the Host

 

AccountBalance

 

 

Not Mapped to the Host

 

AccountAvailableBalance

 

 

Not Mapped to the Host

 

NickName

 

 

Not Mapped to the Host

 

StatementStreetAddress

 

 

Not Mapped to the Host

CHXLevelData

 

CheckCardList/CheckCardSummary

 

 

CHXPrimaryIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

AccountIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

 

 

AccountStatus

CheckCardSummary

StatusCode

 

 

AccountSubProd

CheckCardSummary

SubProductCode

 

 

DRSEligibility

CardDetail/RewardSweepDetail

EligibilityCode

 

ProgramSettings

AutomaticTransferAccount

 

 

Not Mapped to the Host

 

DebitTransactionSweep

RewardSweepDetail

TransactionSweepEnrollmentCode

 

 

CreditTransactionSweep

 

 

Not Mapped to the Host

 

DebitRewardSweep

RewardSweepDetail

EnrollmentCode

 

 

CreditRewardSweep

 

 

Not Mapped to the Host

 

TargetAccountPrimarySTARTenrollmentflag

 

 

Not Mapped to the Host

 

PerTransactionAmount

CardDetail

PerTransactionAmount

 

 

CHXBeginDate

CardDetail

  BeginningDate

 

 

DRSBeginDate

RewardSweepDetail

BeginningDate

 

 

CHXPrimaryOwner

CardDetail

PrimaryOwnerName

 

 

ProductID

 

 

Not Mapped to the Host

 

ProductName

 

 

Not Mapped to the Host

 

AccoutStatusCode

 

 

Not Mapped to the Host

 

AccountStatusDescription

 

 

Not Mapped to the Host

 

AccountRelationshipCode

 

 

Not Mapped to the Host

 

AccountRelationshipDescription

 

 

Not Mapped to the Host

 

BranchID

 

 

Not Mapped to the Host

 

BranchName

 

 

Not Mapped to the Host

 

DateAccountOpened

 

 

Not Mapped to the Host

 

DateAccountClosed

 

 

Not Mapped to the Host

 

AccountBalance

 

 

Not Mapped to the Host

 

AccountAvailableBalance

 

 

Not Mapped to the Host

 

NickName

 

 

Not Mapped to the Host

 

StatementStreetAddress

 

 

Not Mapped to the Host

 


Exception Processing

This topic describes the service specifications for SOAP faults and status aggregate error codes. See Exception Processing for additional details about the USBSOAPFault and W3 standards.

·       Consumer will either receive the SOAP fault or the ESD standard status aggregate in the response, which tracks the execution status of the service operation.

·       When a service does not execute successfully, the consumer receives the SOAP fault, which the USBSOAPFaultoperation produces.

·       When a service executes successfully, the consumer receives the ESD standard status aggregate.

Service layer returns a SuccessCode of 0 in the status aggregate, but if the host returns any conditional error codes, consumers use the StatusCode table to determine the cause of the issue.

·       ESD maps all undocumented error code/condition to StatusCode 100, which is General Error.

Additional Statuses

Please refer the ESD Status Aggregate Usage Standards Document in the Customer Portal of the ESD USBnet site for more information about additional statuses.

 


StatusCode

Status Code

Severity

Status Description

Server Status Code

Server Status Description

Additional details

0

Info

Success

 

ACTION SUCCESSFUL

Success

100

Error

General Error

<Unknown Server code>

<Host message>

All Default and Unknown errors

 

 


GetPackageHistoryDetail

The following topics describe this operation.

Operation Description

The GetPackageHistoryDetail operation is a scrollable function used to return a list of Package Detail and Package Detail History data. The input field’s history date and history required flag indicate there is more package history data.

Processing Specifications

This topic describes the most common processing pattern used by the service operations. If this pattern does not apply to an operation, that operation will contain a description of its unique processing pattern.

·       See Processing Specifications for service-level processing specifications.

For the very first time, consumer may or may not send the HistoryDate in the request. If they do send HistoryDate then Hogan would pull the package detail history based on the supplied History Date. Consumer can also request for more history data through 'ProvideHistoryKeyCode' in the request. In that case Hogan would return the key 'next history date'  through EPHDTNS0.X78075-NEXT-PHLO-DATE and TIBCO would map the key value to GetList.NextDataFetchKey (as scrolling). If consumer doesn't request for more history through 'ProvideHistoryKeyCode' then Hogan will not return the key even in the case of more history data exist in the host system.

With the above logic, Service layer would first check the GetList.NextDataFetchKey from request before mapping the HistoryDate to host. If GetList,NextDataFetchKey supplied in the request then that value would be mapped to host and if it doesn't then HistoryDate will be supplied to host. By doing this logic both the first service call and the subsequent service calls can be handled properly.

In the reply, the scrolling key field EPHDTNS0.X78075-NEXT-PHLO-DATE is 9(7), so values could be returned as '9999999' or '1111111' or '0000000' or a 'validdate'.  So service would map only the valid EPHDTNS0.X78075-NEXT-PHLO-DATE date to Reply.GetList.NextDataFetchKey to avoid any unnecessary confusion.  Also in the case of no more history, Service would set the 'GetList.MoreIndicator' to false so that consumer will know whether more history data exist or not.

Inputs

·       HistoryDate – Package history data will be returned based on the supplied History Date.

·       ProvideElementCode – setting the flag to true would request Hogan to return package elements in the reply.

·       ProvideAddressCode – setting the flag to true would request Hogan to return address (returned in EnterpriseDetail reply aggregate)

·       ProvideHistoryKeyCode – setting the flag to true would request Hogan to return the history key (which is the history date) so that the consumer can scroll through to other package history data by using this key in the subsequent service call  (this is handled in GetList reply aggregate)

Note: Setting the ‘ProvideHistoryKeyCode’ to true is required if the consumer interested in scrolling through the package history data.

Outputs

·       The complete package history data is segregated into meaningful individual aggregates. Please refer the GetPackageHistoryDetailReply mapping section for more details.

Input Data Mapping

·       For Package History Detail data ‘ProvideHistoryKeyCode’ needs to be set.

·       For Package Current Detail (not history) elements data ‘ProvideElementsCode’ needs to be set.

·       For Package Current Detail (not history) address data ‘ProvideAddressCode’ needs to be set.

Output Data Mapping

·       This operation is moved from PackageInquiryServiceV1.

Functional Scenarios

The following scenarios demonstrate how to set up the operation for functional testing and usage.

NA

Pagination or Scrolling for Results Using the GetList Aggregate

ESD enterprise services use the GetList aggregate type in both requests and replies for services that require scrolling. The usage is slightly different for both requests and replies between service implementation and consumption.

Request

·       GetList is optional for the first call and use only the MaximumNumberOfItems element to limit the number of rows in the reply. If it is not passed, the SOR uses the default value that is documented in the ICD.

·       When the system first calls the operation, it either skips or leaves empty the NextDataFetchKey element in the GetList.

·       When the system calls the operation for additional results, it sends the GetList the results from the previous reply. Do not alter any value in NextDataFetchKey.

Reply

·       Check the status aggregate first for the successful execution of the call.

·       Use the MoreIndicator element to find out if more data exists in the SOR.

Operation to Data Source Reference Table

This table shows the operation and the provider system of record (SOR).

Source System Name

Source System Transaction/Message Name

HOGAN PAS

EPHDTIP5

Field/Element Specifications

This section explains all of the field-level elements for the request and response aggregates.

 


CustomerIdentity

Name

Type

Width

Req?

Description

Host Field Name

USTaxIdentifier

usbsoaccl:USTaxPayerIdentifier

 

N

US Tax Identifier

Note: SSN/TAXID-IND will be returned as UNKNOWN if the actual identifier/value not been recognized by the service.

See USTaxPayerIdentifier

X78075-CIS-SSN-TAXID-IND +

X78075-CIS-SSN-TAXID

TaxIDSuffix

usbsoatl:String0001

1

N

Tax Identification Suffix

X78075-CIS-TAXID-SUFFIX

EmployeeTypeCode

usbsoatl:String0001

1

N

Employee Indicator

X78075-CIS-EMPLOYEE-IND        

LegalEntityCode

usbsoatl:NumberNonNegative05

5

N

Legal Entity Identifier

X78075-LEGAL-ENTITY-N          

CoreAccountPrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

 

N

Account Primary Identifier

See AccountPrimaryIdentifier_2

X78075-CORE-COID-N +

X78075-CORE-PRDCD +

X78075-CORE-ACCT-NO                           

LastCustomerRelationshipAddedDate

usbsoatl:Date

 

N

Last CustomerRelationship Added Date

X78075-DATE-LST-CUST-REL-ADD   

LastCustomerRelationshipDeletedDate

usbsoatl:Date

 

N

Last Customer Relationship Deleted Date

X78075-DATE-LST-CUST-REL-DEL   

LastAccountRelationshipAddedDate

usbsoatl:Date

 

N

Last Account Relationship Added Date

X78075-DATE-LST-ACCT-REL-ADD   

LastAccountRelationshipDeletedDate

usbsoatl:Date

 

N

Last Account Relationship Deleted Date

X78075-DATE-LST-ACCT-REL-DEL   

BranchDetail

Name

Type

Width

Req?

Description

Host Field Name

BranchNumber

usbsoatl:NumberNonNegative05

5

N

Branch Number

X78075-BRANCH                  

CostCenter

usbsoatl:NumberNonNegative07

7

N

Cost Center

X78075-COST-CENTER             

Officer (occurs zero to 2 times)

Code

usbsoatl:String0005

5

N

Officer Code

Position 1: X78075-OFF-1 &

Position 2:

X78075-OFF-2                                      

Name

usbsoatl:String0040

40

N

Officer Name

Position 1:

X064-OFF1-NAME            

Position 2:

X064-OFF2-NAME                 

StatementDetail

Name

Type

Width

Req?

Description

Host Field Name

DataCollectionCycleCode

usbsoatl:String0002

2

N

Data Collection Cycle Code

X78075-DC-CYCLE-CODE           

DataCollectionFutureCycleCode

usbsoatl:String0002

2

N

Data Collection Future Cycle Code

X78075-DC-FUTURE-CYCLE-CODE    

LastDataCollectionTriggerReleasedDate

usbsoatl:Date

 

N

Last Data Collection Trigger Released Date

X78075-DATE-LAST-DC-TRIG-REL   

LastDataCollectionCycleDate

usbsoatl:Date

 

N

Last Data Collection Collection Cycle Date

X78075-DC-LAST-CYCLE-DATE      

CycleCode

usbsoatl:String0002

2

N

Statement Cycle Code

X78075-STMT-CYCLE-CODE         

FutureCycleCode

usbsoatl:String0002

2

N

Statement Future Cycle Code

X78075-STMT-FUTURE-CYCLE-CODE  

LastStatementTriggerReleasedDate

usbsoatl:Date

 

N

Last Statement Trigger Release Date

X78075-DATE-LAST-ST-TRIG-REL   

MailCode

usbsoatl:String0002

2

N

Statement Mail Code

X78075-STMT-MAIL-CODE          

BulkCode

usbsoatl:String0002

2

N

Statement Bulk Code

X78075-STMT-BULK-CODE          

CopyCountNumber

usbsoatl:NumberNonNegative02

2

N

Statement Number of Copies

X78075-STMT-NUMBER-COPIES      

LastCycleDate

usbsoatl:Date

 

N

Statement Last Cycle Date

X78075-STMT-LAST-CYCLE-DATE    

PrintCompanyIdentifier

usbsoatl:OperatingCompanyIdentifier

 

N

Statement Print Company Identifier

X78075-STM-PRINT-COID          

CSFDelayCode

usbsoatl:String0001

1

N

Statement CSF Delay Indicator

X78075-STM-CSF-DELAY-IND       

OptionCode

usbsoatl:String0001

1

N

Statement Option Code

X78075-STM-OPT                 

FutureCSFDelayCode

usbsoatl:String0001

1

N

Statement Future CSF Delay Indicator

X78075-STM-FUT-CSF-DELAY-IND

FutureBulkCode

usbsoatl:String0002

2

N

Statement Future Bulk Code

X78075-STM-FUT-BULK-CODE       

NotificationDetail

Name

Type

Width

Req?

Description

Host Field Name

PreviousWaiveCode

usbsoatl:String0002

2

N

Previous Waive Code

X78075-PREV-WAIVE-CODE         

PreviousWaiveExpirationDate

usbsoatl:Date

 

N

Previous Waive Expiration Date

X78075-PREV-WAIVE-EXP-DT       

LastLetterSentDate

usbsoatl:Date

 

N

Last Letter Sent Date

X78075-DATE-LAST-LETTER-SENT   

LastAutoCombineDate

usbsoatl:Date

 

N

Last Auto Combine Date

X78075-DATE-LAST-AUTO-COMBINE  

LastMaintenanceOnlineDate

usbsoatl:Date

 

N

Last Maintenance Online Date

 X78075-DATE-LAST-MAINT-ONLINE  

LastNoticeMadeDate

usbsoatl:Date

 

N

Last Notice Made Date

X78075-DATE-LAST-NOTICE-MODE   

LastNotificationSentDate

usbsoatl:Date

 

N

Last Notification Sent Date

X78075-DATE-LAST-NOTIF-SENT    

ExpirationDate

usbsoatl:Date

 

N

Modification Expire Date

X78075-DATE-NOTIFICATION-EXP   

LetterCode

usbsoatl:String0003

3

N

Notification Letter Type Code

X78075-LETTER-NOTIF-TYPE       

PreviousNotificationLetterSentDate

usbsoatl:Date

 

N

Previous Notification Letter Sent Date

X78075-PREV-DATE-NOTIF-SENT    

PreviousNotificationExpireDate

usbsoatl:Date

 

N

Previous Notification Expire Date

X78075-PREV-DATE-NOTIF-EXP     

PreviousNotificationLetterCode

usbsoatl:String0003

3

N

Previous Notification letter Type

X78075-PREV-LETTER-NOTIF-TYPE  

AnalysisDetail

Name

Type

Width

Req?

Description

Host Field Name

CycleCode

usbsoatl:String0002

2

N

Analysis Cycle Code

X78075-ANLY-CYCLE-CODE         

FutureCycleCode

usbsoatl:String0002

2

N

Analysis Future Cycle Code

X78075-ANLY-FUTURE-CYCLE-CODE  

DispositionCode

usbsoatl:String0002

2

N

Analysis Disposition Code

X78075-ANLY-DISP-CODE          

WaiveCode

usbsoatl:String0002

2

N

Analysis Waive Code

X78075-ANLY-DISP-CODE          

WaiveExpirationDate

usbsoatl:Date

 

N

Analysis Waive Expiration Date

X78075-ANLY-WAIVE-EXP-DATE     

LastCycleDate

usbsoatl:Date

 

N

Analysis Last Cycle Date

X78075-ANLY-LAST-CYCLE-DATE    

USBDestinationAccountPrimaryIdentifier

usbsoaccl:AccountPrimaryIdentifier

 

N

Analysis USB Destination Account Identifier

See AccountPrimaryIdentifier_2

X78075-FBS-DEST-COID-N +

X78075-FBS-PRDCD +

X78075-FBS-ACCT-NO                          

ACHDestinationAccountRoutingNumber

usbsoatl:NumberNonNegative09

9

N

Analysis ACH Destination Account Routing Number

X78075-ACH-RT                  

ACHDestinationAccountNumber

usbsoatl:String0017

17

N

Analysis ACH Destination Account Number

X78075-ACH-ACCT-NO             

ACHDestinationCustomerCode

usbsoatl:String0015

15

N

Analysis ACH Destination Customer Code

X78075-ACH-CUST-ID             

ACHDestinationTranCode

usbsoatl:String0002

2

N

Analysis ACH Destination Transaction Code

X78075-ACH-TRAN-CODE           

LastTriggerReleasedDate

usbsoatl:Date

 

N

Last Analysis Trigger Release Date

X78075-DATE-LAST-AN-TRIG-REL   

PackageDetail

Name

Type

Width

Req?

Description

Host Field Name

OpenedDate

usbsoatl:Date

 

N

Opened Date

X78075-DATE-OPENED             

ClosedDate

usbsoatl:Date

 

N

Closed Dated

X78075-DATE-CLOSED             

LastMaintenanceDate

usbsoatl:Date

 

N

Last Maintenance Date

X78075-DATE-LAST-MAINT         

SubProductCode

usbsoatl:String0002

2

N

Sub Product Code

X78075-SUB-PROD-CODE           

SubProductTransferredCode

usbsoatl:String0002

2

N

Sub Product Transferred Code

X78075-SUBPRD-TRANSFERED       

SubProductTransferredDate

usbsoatl:Date

 

N

Sub Product Transferred Date

X78075-DATE-SUBPRD-TRANSFERED  

PreviousTransferredSubProductCode

usbsoatl:String0002

2

N

Previous Transferred Sub Product Code

X78075-PREV-TRANSFERED-SUBPRD  

Title

TitleOne

usbsoatl:String0040

40

N

Package Title 1

X050-PKG-TITLE1               

TitleTwo

usbsoatl:String0040

40

N

Package Title 2

X050-PKG-TITLE2             

TitleThree

usbsoatl:String0040

40

N

Package Title Comment 1

X050-PKG-TITLE-COMMENT1

TitleFour

usbsoatl:String0040

40

N

Package Title Comment 2

X050-PKG-TITLE-COMMENT2

 

StatusCode

usbsoatl:String0002

2

N

Status Code

X78075-STATUS-CODE             

StatusDescription

usbsoatl:String0020

20

N

Status Description

X51675D-STATUS-DESCRIPTION

OpenChannelCode

usbsoatl:String0003

3

N

Open Channel Code

X112-OPEN-CHANNEL

ChannelDescription

usbsoatl:String0025

25

N

Channel Description

X50208D-CHANNEL-DESCRIPTION   

PlanTypeCode

usbsoatl:String0002

2

N

Plan Type Code

X78075-RRSPLTYP

QualifyingStatusCode

usbsoatl:String0002

2

N

Qualifying Status Code

X78075-QUALIFYING-STATUS-CODE  

LastAutoUpdateDate

usbsoatl:Date

 

N

Last Auto Update Date

X78075-DATE-LAST-AUTO-UPDATE   

LastAutoSetupDate

usbsoatl:Date

 

N

Last Auto Setup Date

X78075-DATE-LAST-AUTO-SETUP    

LastAutoAccountAddedDate

usbsoatl:Date

 

N

Last Auto Account Added Date

X78075-DATE-LAST-AUTO-ACCT-ADD 

LastAutoAccountUpdatedDate

usbsoatl:Date

 

N

Last Auto Account Updated Date

X78075-DATE-LAST-AUTO-ACCT-UPD 

GracePeriodExpirationDate

usbsoatl:Date

 

N

Grace Period Expiration Date

X78075-DATE-GRACE-PERIOD-EXP   

SensitivityCode

usbsoatl:NumberNonNegative01

1

N

Sensitivity Code

X78075-CIS-SENSITIVITY-CODE    

EnterpriseDetail

Name

Type

Width

Req?

Description

Host Field Name

CoSignerFirstName

usbsoatl:String0040

40

N

Co Signer First Name

X78075-PCCOFINM              

CoSignerLastName

usbsoatl:String0040

40

N

Co Signer Last Name

X78075-PCCOLANM

PrimarySecurityName

usbsoatl:String0040

40

N

Primary Security Name

X78075-PCPSECNM         

SecondarySecurityName

usbsoatl:String0040

40

N

Secondary Security Name

X78075-PCSSECNM

SoftwareProductName

usbsoatl:String0040

40

N

Software Product Name

X78075-PCSOFTNM

ServicePackageCode

usbsoatl:String0001

1

N

Service Package Code

X78075-PCPCSERV

PinResetCode

usbsoatl:String0001

1

N

PIN Reset Code

X78075-PCPINRES

UseCode

usbsoatl:String0002

2

No

Use Code

X050-NA-USE-CODE

Address

usbsoaccl:AddressResponse

 

N

Address

AddressResponse

USAddressSwitch

Usbsoatl:Switch

 

Y

If the Country Code from the Host is Blank (Spaces) or US, the switch should be true, else false.

 

SupplementalAddressLine

usbsoatl:String0040

40

N

 

X78075-ADDR-0

AddressLine1

usbsoatl:String0040

40

Y

 

X78075-ADDR-1

AddressLine2

usbsoatl:String0040

40

N

 

X78075-ADDR-2

City

usbsoatl:String0025

25

N

 

X78075-CITY 

StateCode

usbsoatl:String0002

2

N

 

X78075-STATE

State

usbsoatl:String0015

15

N

Populated only if the Address is a Foreign Address.

i.e. when Country Code is not US or Spaces

X78075-STATE

ZipCode

usbsoatl:String0009

9

Y

 

X78075-ZIP-CODE

ZipPlus4

usbsoatl:NumberNonNegative04

4

N

 

X78075-ZIP-CODE

DeliveryPointIdentifier

usbsoatl:String0002

2

N

 

N/A

CarrierRouteIdentifier

usbsoatl:String0005

5

N

 

N/A

CountryCode

usbsoatl:String0002

2

N

 

X78075-COUNTRY-CODE

CheckDigit

usbsoatl:NumberNonNegative01

1

N

 

N/A

CountryShortName

usbsoatl:String0005

5

N

Country Short Name

X78075-COUNTRY-CODE-5

PackageHistory

Name

Type

Width

Req?

Description

Host Field Name

CustomerIdentity

mpis:CustomerIdentify

 

N

Customer Identity related package history data

See CustomerIdentity

BranchDetail

mpis:BranchDetail

 

N

Branch related package history data

See BranchDetail

StatementDetail

mpis:StatementDetail

 

N

Statement related package history data

See StatementDetail

NotificationDetail

mpis:NotificationDetail

 

N

Notification related package history data

See NotificationDetail

AnalysisDetail

mpis:AnalysisDetail

 

N

Analysis related package history data

See AnalysisDetail

PackageDetail

mpis:PackageDetail

 

N

Package detail related history data

See PackageDetail

EnterpriseDetail

mpis:EnterpriseDetail

 

N

Package detail selective out data

See EnterpriseDetail

GetPackageHistoryDetailRequest

Name

Type

Width

Req?

Description

Host Field Name

GetList

usbsoaccl:GetList

 

N

Used for Scrolling / Pagination

See GetList

X78075-INP-HIST-DATE +

N/A+

N/A +

N/A

PackageKeyIdentifier

usbsoaccl:AccountPrimaryIdentifier

 

Y

Package Primary Key Identifier

See AccountPrimaryIdentifier_2

X78075-INP-PKG-COID +

X78075-INP-PKG-PROD +

X78075-INP-PKG-NO-X

HistoryDate

usbsoatl:Date

 

N

History Date

X78075-INP-HIST-DATE

ProvideElementCode

usbsoatl:Switch

 

N

Flag to tell Hogan to return package related element attributes

Default : false

X77105-INP-PCB-ELE-REQD

ProvideAddressCode

usbsoatl:Switch

 

N

Flag to tell Hogan to return address

Default : false

X77105-INP-ADDRESS-REQD

ProvideHistoryKeyCode

usbsoatl:Switch

 

N

Flag to tell Hogan to  return the history key so that it can be used to scroll in the subsequent calls

Default : false

X77105-INP-HISTORY-REQD

GetPackageHistoryDetailReply

Name

Type

Width

Req?

Description

Host Field Name

Status

usbsoaccl:Status

 

Y

Status Aggregate

See Status

N/A +

BTCB-USER-CC +

N/A +

BTCB-USER-DESCRIPTION +

N/A

GetList

usbsoaccl:GetList

 

N

Scrolling/Pagination Aggregate

See GetList

X78075-NEXT-PHLO-DATE +

N/A +

N/A +

N/A             

PackageHistory

mpis:PackageHistory

 

N

Aggregate of Package history details

See PackageHistory

 


Exception Processing

This topic describes the service specifications for SOAP faults and status aggregate error codes. See Exception Processing for additional details about the USBSOAPFault and W3 standards.

·       Consumer will either receive the SOAP fault or the ESD standard status aggregate in the response, which tracks the execution status of the service operation.

·       When a service does not execute successfully, the consumer receives the SOAP fault, which the USBSOAPFaultoperation produces.

·       When a service executes successfully, the consumer receives the ESD standard status aggregate.

Service layer returns a SuccessCode of 0 in the status aggregate, but if the host returns any conditional error codes, consumers use the StatusCode table to determine the cause of the issue.

·       ESD maps all undocumented error code/condition to StatusCode 100, which is General Error.

Additional Statuses

Please refer the ESD Status Aggregate Usage Standards Document in the Customer Portal of the ESD USBnet site for more information about additional statuses.

 


StatusCode

Status Code

Severity

Status Description

Server Status Code

Server Status Description

Additional details

0

Info

Success

0

ACTION SUCCESSFUL

Success

100

Error

General Error

<Unknown Server code>

<Host message>

All Default and Unknown errors

 

 


GetExpandedSavingsOptionDetail

The following topics describe this operation.

Operation Description

The GetExpandedSavingsOptionDetail operation is used to inquire on an expanded savings option relationship. There will be two levels of inquiry:

PKESINQ – returns details for a specific CHX/CCD card

Note: Only card Identifier fields are needed as input

PKESALL – returns details of all ESO’s for a customer

Note: Customer Identifier along with (optionally) funding account identifier and/or target account identifier are input

ESO’s are stored on the PKG system in ES packages (ES is the PKG sub-product code).

Processing Specifications

This topic describes the most common processing pattern used by the service operations. If this pattern does not apply to an operation, that operation will contain a description of its unique processing pattern.

·       See Processing Specifications for service-level processing specifications.

Functional Scenarios

The following scenarios demonstrate how to set up the operation for functional testing and usage.

NA

Pagination or Scrolling for Results Using the GetList Aggregate

ESD enterprise services use the GetList aggregate type in both requests and replies for services that require scrolling. The usage is slightly different for both requests and replies between service implementation and consumption.

Request

·       GetList is optional for the first call and use only the MaximumNumberOfItems element to limit the number of rows in the reply. If it is not passed, the SOR uses the default value that is documented in the ICD.

·       When the system first calls the operation, it either skips or leaves empty the NextDataFetchKey element in the GetList.

·       When the system calls the operation for additional results, it sends the GetList the results from the previous reply. Do not alter any value in NextDataFetchKey.

Reply

·       Check the status aggregate first for the successful execution of the call.

·       Use the MoreIndicator element to find out if more data exists in the SOR.

Operation to Data Source Reference Table

This table shows the operation and the provider system of record (SOR).

Source System Name

Source System Transaction/Message Name

HOGAN PAS

EPKESIP0

Field/Element Specifications

This section explains all of the field-level elements for the request and response aggregates.

 


GetExpandedSavingsOptionDetailRequest

Name

Type

Width

Req?

Description

Host Field Name

 

GetExpandedSavingsOptionDetailRequest

 

Y

 

 

 

CustomerIdentifier

 

Y

Choice between either CustomerIdentifier or CardAccountIdentifier.

 

 

  CustomerNameIdentifier

 

        Y                

 

Choice in between CustomerNameIdentifier and LPID

 

 

      OperatingCompany

      Identifier

nonNegativeInteger

0..*

N

Customer Company Number 

Three-digit number which determines a particular market region (usually the State to which an account or customer has been assigned). If none is assigned then it will default to bank number 654

V560-WRK-COID-N

 

      CustomerWholeName

string

0..40

Y

Customer Name - whole name of customer - string of your whole name (IE.  Jane D. Doe)Customer whole name - Includes first, middle and last

V560-WRK-NAME-1

 

      NameTieBreaker          

      Number

nonNegativeInteger

0..*

Y

Customer Tie Breaker

An integer with a maximum length of 5 digits used to break a tie on a name lookup.

V560-WRK-TIE-N

 

  LegalParticipantIdentifier

string

1..18

Y

Customer’s legal participant Identification

LPID is used as the Primary Key for Customers. Retain the leading 3 digit prefix, and then allocate a unique 15 digit number to make up the full 18 digit LPID.

X060-ENRB-WRK-LPID

 

CardAccountIdentifier                                                   

 

 

Y

 

 

 

      OperatingCompany

      Identifier

Integer

0 to 5

Y

Operating Company Identifier

Bank Number, an Internal US Bank three-digit number used for segmenting accounts into regions or other operating units. (usually the State to which an account or customer has been assigned).

Default = 654

X176-CARD-ACCT-COID-N              

 

      ProductCode

String

0 to 3

Y

Product Code

Three character alpha-numeric product code used to identify the general type of an account.  . 

X176-CARD-ACCT-PROD                

 

      PrimaryIdentifier

String

0 to 23

Y

Primary Identifier
The account number that is used to uniquely identify the specific account associated with the Product code and Operating Company Identifier.

If a value is sent by the consumer then this field should be right-justified, zero filled. If no value is sent by consumer then this field should be spaces.

X176-CARD-ACCT-ID                  

 

 FundingAccountPrimaryIdentifier                                            N

 

 

 

 

 

      OperatingCompany

      Identifier

Integer

0 to 5

N

Operating Company Identifier

Bank Number, an Internal US Bank three-digit number used for segmenting accounts into regions or other operating units. (usually the State to which an account or customer has been assigned).

Default = 654

X176-FUNDING-ACCT-COID-N    

 

 

      ProductCode

String

0 to 3

N

Product Code

Three character alpha-numeric product code used to identify the general type of an account.  . 

X176-FUNDING-ACCT-PROD                

 

      PrimaryIdentifier

String

0 to 23

Y

Primary Identifier
The account number that is used to uniquely identify the specific account associated with the Product code and Operating Company Identifier.

If a value is sent by the consumer then this field should be right-justified, zero filled. If no value is sent by consumer then this field should be spaces.

 

X176-FUNDING-ACCT-ID                  

 

TargetAccountPrimaryIdentifier                                                 N

 

      OperatingCompany

      Identifier

Integer

0 to 5

N

Operating Company Identifier

Bank Number, an Internal US Bank three-digit number used for segmenting accounts into regions or other operating units. (usually the State to which an account or customer has been assigned).

Default = 654

X176-TARGET-ACCT-COID-N              

 

      ProductCode

String

0 to 3

N

Product Code

Three character alpha-numeric product code used to identify the general type of an account.  . 

X176-TARGET-ACCT-PROD                

 

      PrimaryIdentifier

String

0 to 23

Y

Primary Identifier
The account number that is used to uniquely identify the specific account associated with the Product code and Operating Company Identifier.

If a value is sent by the consumer then this field should be right-justified, zero filled. If no value is sent by consumer then this field should be spaces.

X176-TARGET-ACCT-ID                  

 

  GetList

 

 

N

 

 

 

   NextDataFetchKey

String

0 to 2048

N

The composite key that the service consumers will use when requesting additional pages of data

 

For X176-NXT-ACCT-ID field, If a value is sent by the consumer then this field should be right-justified, zero filled. If no value is sent by consumer then this field should be spaces.

X176-NXT-ACCT-COID-N

X176-NXT-ACCT-PROD

X176-NXT-ACCT-ID

 

   MaximumNumberOfItems

Integer

0 to 5

Y

Five digits in length positive integer. Number of items to return for this get. In this operation, the field is for requesting Maximum no. of accounts that the user wants returned in the response. If no value sent in, PAS will set to the maximum allowed.

 

Default value:100

V200-MAX-RELATIONSHIPS

 

GetExpandedSavingsOptionDetailReply

Name

Type

Width

Req?

Description

Host Field Name

GetExpandedSavingsOptionsAccountListReply

 

 

Y

 

 

    Status                                                                                                        Y

        StatusCode

integer

 

Y

This list provides the complete set of valid Response    Status codes defined for the response Status Aggregate Status Code    along with conditions that may cause the Response Status to be sent.

BTCB-USER-CC

        Severity

string

0..80

Y

The severity is assigned once a Status Code is selected    for the specific source systems code. values: Warning, Info, Error

PAS-RESULT-CODE

        StatusDescription

string

0..255

Y

Status text is provided in the Status Desc field

BTCB-USER-CC

        ServerStatusCode

string

0..20

N

This status code will be the source system's status code

PAS-RESULT-CODE

        ServerStatusDescription

string

0..255

N

This status description will be the source system's    status description

BTCB-USER-DESCRIPTION

GetList

 

 

N

 

 

  NextDataFetchKey

String

0 to 2048

N

The composite key that the service consumers will use when requesting additional pages of data

X176-RS-NXT-FUN-ACCT-COID-N

X176-RS-NXT-FUN-ACCT-PROD

X176-RS-NXT-FUN-ACCT-NBR

  MoreIndicator

Boolean

0 to *

N

Switch to indicate if more data is available to fetch or not.

X176-MORE-NOMORE-FLAG

ESOEnrolledAccountList

 

 

 N

 

 

  ESOEnrolledAccountDetails (0 to * )

 

 

N

 

 

      FundingAccountPrimaryIdentifier

 

 

N

 

 

               OperatingCompany

               Identifier

Integer

0 to *

N

Operating Company Identifier

Bank Number, an Internal US Bank three-digit number used for segmenting accounts into regions or other operating units. (usually the State to which an account or customer has been assigned).

Default = 654

X176-RS-FUND-ACCT-COID-N              

               ProductCode

String

0 to 3

N

Product Code

Three character alpha-numeric product code used to identify the general type of an account. 

X176-RS-FUND -ACCT-PROD                

               PrimaryIdentifier

String

0 to 23

Y

Primary Identifier
The account number that is used to uniquely identify the specific account associated with the Product code and Operating Company Identifier

X176-RS-FUND-ACCT-ID                  

      TargetAccountPrimaryIdentifier

 

 

N

 

 

               OperatingCompany

               Identifier

Integer

0 to *

N

Operating Company Identifier

Bank Number, an Internal US Bank three-digit number used for segmenting accounts into regions or other operating units. (usually the State to which an account or customer has been assigned).

Default = 654

X176-RS-TRGT-ACCT-COID-N              

               ProductCode

String

0 to 3

N

Product Code

Three character alpha-numeric product code used to identify the general type of an account. 

X176-RS-TRGT-ACCT-PROD                

               PrimaryIdentifier

String

0 to 23

Y

Primary Identifier
The account number that is used to uniquely identify the specific account associated with the Product code and Operating Company Identifier

X176-RS-TRGT-ACCT-ID                  

      CardAccountPrimaryIdentifier

 

 

N

 

 

               OperatingCompany

               Identifier

Integer

0 to *

N

Operating Company Identifier

Bank Number, an Internal US Bank three-digit number used for segmenting accounts into regions or other operating units. (usually the State to which an account or customer has been assigned).

Default = 654

X176-RS-CRD-ACCT-COID-N              

               ProductCode

String

0 to 3

N

Product Code

Three character alpha-numeric product code used to identify the general type of an account. 

X176-RS-CRD-ACCT-PROD                

               PrimaryIdentifier

String

0 to 23

Y

Primary Identifier
The account number that is used to uniquely identify the specific account associated with the Product code and Operating Company Identifier

X176-RS-CRD-ACCT-ID                  

       RewardDetails

 

 

N

 

 

             EnrollmentDate

Date

0 to *

N

RewardEnrollmentDate

X176-RWD-ENR-DATE                    

             DeEnrollmentDate

Date

0 to *

N

RewardDeEnrollmentDate

X176-RWD-DENR-DATE                   

         PurchaseXfrDetail

 

 

N

 

 

             EnrollmentDate

Date

0 to *

N

PurchaseXfr Enrolled Date

X176-PXFR-ENR-DATE                              

             DeEnrollmentDate

Date

0 to *

N

PurchaseXfr DeEnrolled Date

X176-PXFR-DENR-DATE                   

              Amount

Decimal

(5.2)

N

AdvancesAmount.

X176-PXFR-AMOUNT                     


Exception Processing

This topic describes the service specifications for SOAP faults and status aggregate error codes. See Exception Processing for additional details about the USBSOAPFault and W3 standards.

·       Consumer will either receive the SOAP fault or the ESD standard status aggregate in the response, which tracks the execution status of the service operation.

·       When a service does not execute successfully, the consumer receives the SOAP fault, which the USBSOAPFaultoperation produces.

·       When a service executes successfully, the consumer receives the ESD standard status aggregate.

Service layer returns a SuccessCode of 0 in the status aggregate, but if the host returns any conditional error codes, consumers use the StatusCode table to determine the cause of the issue.

·       ESD maps all undocumented error code/condition to StatusCode 100, which is General Error.

Additional Statuses

Please refer the ESD Status Aggregate Usage Standards Document in the Customer Portal of the ESD USBnet site for more information about additional statuses.

 


StatusCode

Status Code

Severity

Status Description

Server Status Code

Server Status Description

Additional details

0

Info

Success

60598

SUCCESSFUL - NO MORE

Success

100

Error

General Error

<Unknown Server code>

<Host message>

All Default and Unknown errors

1120

Info

No Records Match Selection Criteria

01379

ACCOUNT NOT ENROLLED IN ESO

LPID Not enrolled

1120

Info

No Records Match Selection Criteria

64148

ENTER CUSTOMER NAME

Without CustomerWholeName

1220

Error

InvalidIdentifier

01328

INVALID TARGET ACCOUNT

Without Target Account Primary Identifier

1220

Error

InvalidIdentifier

01389

INVALID CHX ACCOUNT

Without Card Account Primary Identifier

1220

Error

InvalidIdentifier

01391

INVALID FUNDING ACCOUNT

Without Funding Account Primary Identifier

1120

Info

No Records Match Selection Criteria

64005

CUSTOMER NOT FOUND

Customer not enrolled

 


HeartBeat

The following topics describe this operation.

Operation Description

The HeartBeat operation provides the capability for an external monitoring system or for the consuming application to check that the service is active and responding.

Processing Specifications

The processing specifications for the HeartBeat operation do not follow this service’s most common processing pattern.

This processing pattern for this operation is:

·       The service consumer, or consuming application, sends a request.

·       The service consumer, or consuming application, receives a reply.

o   The HeartBeat operation sends a reply with a status aggregate, indicating success.

o   If the service consumer, or consuming application, receives a reply, the assumption is that all other operations contained within the service are operational.

Note: It is not recommended to check the HeartBeat operation too frequently (more than once or twice a minute), because this could increase traffic and cause other issues.

Functional Scenarios

NA

Pagination or Scrolling for Results Using the GetList Aggregate

NA

Operation to Data Source Reference Table

This table shows the operation and the provider system of record (SOR).

Source System Name

Source System Transaction/Message Name

NA

NA

Field/Element Specifications

This section explains all of the field-level elements for the request and response aggregates.

 


HeartBeatRequest

Name

Type

Width

Req?

Description

Host Field Name

HeartBeatRequest

 

 

 

Empty aggregate.

 

HeartBeatReply

Name

Type

Width

Req?

Description

Host Field Name

HeartBeatReply

 

 

 

 

 

Status

 

 

Y

 

 

      StatusCode

Integer                 

0 to 10

Y

Status Code
This list provides the complete set of valid Response Status codes defined for the response Status Aggregate Status Code along with conditions that may cause the Response Status to be sent 

 

      Severity

String

0 to 80

Y

Severity
The severity is assigned once a Status Code is selected for the specific source systems code

 

      StatusDescription

String

0 to 255

N

Status Description
Status text is provided in the Status Desc field

 

      ServerStatusCode

String

0 to 20

N

Server Status Code
This status code will be the source systems status code

 

      ServerStatusDescription

String

0 to 255

N

Server Status Description
This status description will be the source systems status description

 


Exception Processing

This topic describes the service specifications for SOAP faults and status aggregate error codes. See Exception Processing for additional details about the USBSOAPFault and W3 standards.

·       Consumer will either receive the SOAP fault or the ESD standard status aggregate in the response, which tracks the execution status of the service operation.

·       When a service does not execute successfully, the consumer receives the SOAP fault, which the USBSOAPFaultoperation produces.

·       When a service executes successfully, the consumer receives the ESD standard status aggregate.

Service layer returns a SuccessCode of 0 in the status aggregate, but if the host returns any conditional error codes, consumers use the StatusCode table to determine the cause of the issue.

·       ESD maps all undocumented error code/condition to StatusCode 100, which is General Error.

 


StatusCode

Status Code

Severity

Status Description

Server Status Code

Server Status Description

Additional details

0

Info

Success

 

 

Service is active.


Connection Information

The end points for ESD enterprise Web services are documented in the following table(s):

Note: The data centers are Olathe Business Center (OBC) and Energy Park Operations Center (EPOC).

Tier 2 Environment Configuration

NA

Tier 3 Environment Configuration

Use the URLs associated with the data center in which your consuming application is deployed.

Environment

Service URL

DEV: OBC

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

IT: OBC

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

UAT: EPOC

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

UAT: OBC

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

PROD: EPOC

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

PROD: OBC

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

Disaster Recovery (DR) Testing

ESD designed its enterprise Web service infrastructure (the Oracle Service Bus or OSB) to use both data centers actively all the time for UAT and PROD environments. This configuration, called Active/Active, is different from the Active/Passive architecture, which is also referred to as Disaster Recovery (DR).

Because ESD does not have or provide a DR environment, ESD instead supports DR testing during quarterly Enterprise Readiness Services Group weekends under the following conditions:

·       ESD will provide a DR URL for OSB consumers to use during their DR testing.

·       Consumers are responsible for configuring their own applications for DR testing.

Please visit the Customer Portal on the ESD USBnet site for more information about how ESD supports DR testing.

Note: External vendor DR testing is not part of the Active/Active Enterprise Service Bus (ESB) testing. Please be aware that this type of testing is rarely possible in most cases.


Service Change Log

This topic covers the functionality that ESD has removed or added in relation to PackageInquiryService.

PackageInquiryService 2.0 – PRJ15988

GetExpandedSavingsOptionDetail

Request Message

Date

Change Type

Description or Fields Added/Removed/Modified

12/11/2015AddedAdded new Operation as per PRJ15988 Apr 16 Release.

 

 

 

 

 

 

 

 

 

Reply Message

Date

Change Type

Description or Fields Added/Removed/Modified

12/11/2015AddedAdded new Operation as per PRJ15988 Apr 16 Release.

 

 

 

 

 

 

 

 

 


Refactored Service and Operation Cross-Reference Table

This table documents the previous service operations, aggregates and fields for the corresponding PackageInquiryService 2.0 operations as follows:

·        

GetPackageHistoryDetail

This table documents the previous aggregates and fields for PackageInquiryService and how they map to the new version.

OLD Schema (EPHDTIP4)

 MessagePackageInquiryService_V_1_0

NEW Schema (EPHDTIP5 )

 MessagePackageInquiryService_V_2_0

Comments

Aggregate Name

Element Name

Aggregate Name

Element Name

 

GetPackageHistoryDetailRequest

GetPackageHistoryDetailRequest

 

 

 

 

 

 

GetPackageHistoryDetailReply

GetPackageHistoryDetailReply

 

PackageDetail

LastQualifyingAccountDeletedDate

NA

NA

 Element removed

PackageDetail

LastQualifyingAccountAddedDate

NA

NA

 Element removed

GetPackageAccountsRequest

OLD Schema (EPKSTIP2)

 MessageCustomerService_V_8_0

NEW Schema (EPKSTIP2 )

 MessagePackageInquiryService_V_2_0

Comments

Aggregate Name

Element Name

Aggregate Name

Element Name

 

GetPackageAccountsRequest

GetPackageAccountListRequest

 

NA

EnrolledInProgram

NA

NA

Element removed

NA

EnrolledFlag

NA

EnrollmentCode

Element name changed

AccountKey

NA

NA

NA

Aggregate removed

CustomerIdentityChoice

NA

NA

NA

Aggregate removed

NA

Company_ID

NA

NA

Element removed

NextAccountPrimaryIdentifier

OperatingCompanyIdentifier

ProductCode

PrimaryIdentifier

GetList

NextDataFetchKey

Elements consolidated

NA

NA

GetList

MaximumNumberOfItems

Element added

NA

Company_ID

CustomerIdentityChoice

NA

NA

Elements removed

GetPackageAccountsReply

GetPackageAccountListReply

 

NA

NA

Status

NA

Aggregate added 

PackageData

PackagePrimaryIdentifier

PackageData

AccountIdentifier

Name changed

PackageData

CoreAccountPrimaryIdentifier

PackageData

CoreAccountIdentifier

Name changed

PackageData

ProgramStatus

PakageData

StatuCode

Name changed

PackageData

AccountSubProduct

PackageData

AccountSubProduct

Name changed

PackageData

ProgramStatusDescription

ProgramEnrollmentStatus

ProgramEnrollmentStatusDescription

PackageData/EnrollmentDetail

ProgramEnrollmentStatusCode

Elements consolidated

PackageData

ProgramEnrollDate

PackageData/EnrollmentDetail

ProgramEnrollmentDate

Hogan mapping changed

PackageData

DateLastEnrollmentStatusChanged

PackageData/EnrollmentDetail

LastEnrollmentStatusChangedDate

 

Hogan mapping changed

PackageData

DateLastProgramStatusChanged

PackageData/EnrollmentDetail

LastProgramStatusChangedDate

Hogan mapping changed

PackageDetail

NotificationType

PackageData/NotificationDetail

NotificationTypeCode

Name changed

PackageDetail

LastNotifySent

PackageData/NotificationDetail

LastNotificationSentDate

Hogan mapping changed

PackageDetail

NotificationExpiryDate

PackageData/NotificationDetail

NotificationExpirationDate

Hogan mapping changed

PackageData

MessageToGoal1

StatusToGoal1

MessageToGoal2

StatusToGoal2

ProductID

ProductName

AccoutStatusCode

AccountStatusDescription

AccountRelationshipCode

AccountRelationshipDescription

BranchID

BranchName

DateAccountOpened

DateAccountClosed

AccountBalance

AccountAvailableBalance

NickName

StatementStreetAddress

OperatingCompanyIdentifier

NA

NA

Elements removed

DDALevelData

MMSavingsPrimaryIdentifier

DDAAccountSummary

AcountIdentifier

Aggregate name change

DDALevelData

AccountStatus

DDAAccountSummary

StatusCode

Name change

DDALevelData

AccountSubProd

DDAAccountSummary

SubProductCode

Name change

DDALevelData/ProgramSettings/ STARTProgramSettings

AutomaticTransferAccount

STARTProgramDetail

AutomaticTransferCode

Name change

DDALevelData/ProgramSettings/ STARTProgramSettings

DebitTransactionSweep

CreditTransactionSweep

DebitRewardSweep

CreditRewardSweep

NA

NA

Elements removed

DDALevelData/ProgramSettings/ STARTProgramSettings

TargetAccountPrimarySTARTenrollmentFlag

STARTProgramDetail

AlertCode

Name change

DDALevelData

PercentToGoal1

STARTProgramDetail/ GoalOneDetail

PercentToGoalOne

Name change

DDALevelData

Goal1AchievementDate

STARTProgramDetail/ GoalOneDetail

AchievedDate

Name change

DDALevelData

Goal1RewardReceipt

STARTProgramDetail/ GoalOneDetail

RewardRecipientName

Name change

DDALevelData

Goal2TargetDate

STARTProgramDetail/ GoalTwoDetail

TargetDate

Name change

DDALevelData

Goal2AchievedDate

STARTProgramDetail/ GoalTwoDetail

AchievedDate

Name change

DDALevelData

Goal2RewardReceipient

STARTProgramDetail/ GoalTwoDetail

RewardRecipientName

Name change

DDALevelData

CounterToGoal2

STARTProgramDetail/ GoalTwoDetail

CounterToGoalTwoNumber

Name change

DDALevelData

DateFailedToMetGoal2

STARTProgramDetail/ GoalTwoDetail

FailedDate

Name change

DDALevelData

ThinkTwiceEnrollDate

STARTProgramDetail/ThinkTwiceDetail

EnrollmentDate

Name change

DDALevelData

ThinkTwiceDeEnrollDate

STARTProgramDetail/ThinkTwiceDetail

DeEnrollmentDate

Name change

DDALevelData

ProgramATAAmountPTD

STARTProgramDetail/TransferDetail

AutomatedTransferAmount

Name change

DDALevelData

ProgramDTSAmountPTD

STARTProgramDetail/TransferDetail

DebitTransferAmount

Name change

DDALevelData

ProgramCTSAmountPTD

STARTProgramDetail/TransferDetail

CreditTansferAmount

Name change

DDALevelData

ProgramDRSAmountPTD

STARTProgramDetail/TransferDetail

DebitRewardsAmount

Name change

DDALevelData

ProgramCRSAmountPTD

STARTProgramDetail/TransferDetail

CreditRewardsAmount

Name change

DDALevelData

LastProgramTransferDate

STARTProgramDetail/TransferDetail

ProgramLastTransferDate

Name change

DDALevelData

STARTAlertsFlag

STARTProgramDetail

AlertCode

Name change

DDALevelData

AutomaticTransferAccount

STARTProgramDetail

AutomaticTransferCode

Name change

DDALevelData

TargetAccountPrimarySTARTenrollmentFlag

STARTProgramDetail

EnrollmentCode

Name change

DDALevelData

LedgerBalance

STARTProgramDetail

LedgerBalanceAmount

Name change

DDALevelData

BeginStartBalance

STARTProgramDetail

BeginningBalanceAmount

Name change

DDALevelData

TargetStartBalance

STARTProgramDetail

TargetBalanceAmount

Name change

DDALevelData

STARTTotalSkips

STARTProgramDetail

TotalSkipNumber

Name change

DDALevelData

NextStatementDate

STARTProgramDetail

NextStatementDate

Name change

DDALevelData

STARTResetDate

STARTProgramDetail

ResetDate

Name change

DDALevelData

ProgramDeEnrollDate

STARTProgramDetail

DeEnrollmentDate

Name change

DDALevelData

ProductID

ProductName

AccountStatusCode

AccountStatusDescription

AccountRelationshipCode

AccountRelationshipDescription

BranchID

BranchName

DateAccountOpened

DateAccountClosed

AccountBalance

AccountAvailableBalance

NickName

StatementStreetAddress

NA

NA

Elements removed

CCDLevelData

CCDPrimaryIdentifier

CreditCardSummary

AccountIdentifier

Aggregate name change

CCDLevelData

AccountStatus

CreditCardSummary

StatusCode

Name change

CCDLevelData

AccountSubProduct

CreditCardSummary

SubProductCode

Name change

CCDLevelData

CRSEligible

CardDetail/RewardSweepDetail

EligibilityCode

Name change

CCDLevelData /ProgramSettings/ STARTProgramSettings

CreditRewardSweep

CardDetail/RewardSweepDetail

EnrollmentCode

Name change

CCDLevelData /ProgramSettings/ STARTProgramSettings

CreditTransactionSweep

CardDetail/RewardSweepDetail

TransactionSweepEnrollmentCode

Name change

CCDLevelData

CRSBeginDate

CardDetail/RewardSweepDetail

BeginningDate

Name change

CCDLevelData /ProgramSettings/ STARTProgramSettings

AutomaticTransferAccount

DebitTransactionSweep

DebitRewardSweep

TargetAccountPrimarySTARTenrollmentFlag

NA

NA

Elements removed

CCDLevelData

PerTransactionAmount

CardDetail

PerTransactionAmount

Name change

CCDLevelData

CCDBeginDate

CardDetail

BeginningDate

Name change

CCDLevelData

CCDPrimaryOwner

CardDetail

PrimaryOwner

Name change

CCDLevelData

ProductID

ProductName

AccountStatusCode

AccountStatusDescription

AccountRelationshipCode

AccountRelationshipDescription

BranchID

BranchName

DateAccountOpened

DateAccountClosed

AccountBalance

AccountAvailableBalance

NickName

StatementStreetAddress

NA

NA

Elements removed

CHXLevelData

CCDPrimaryIdentifier

CheckCardSummary

AccountIdentifier

Aggregate name change

CHXLevelData

AccountStatus

CheckCardSummary

StatusCode

Name change

CHXLevelData

AccountSubProduct

CheckCardSummary

SubProductCode

Name change

CHXLevelData

DRSEligible

CardDetail/RewardSweepDetail

EligibilityCode

Name change

CHXLevelData /ProgramSettings/ STARTProgramSettings

DebitRewardSweep

CardDetail/RewardSweepDetail

EnrollmentCode

Name change

CHXLevelData /ProgramSettings/ STARTProgramSettings

DebitTransactionSweep

CardDetail/RewardSweepDetail

TransactionSweepEnrollmentCode

Name change

CHXLevelData

DRSBeginDate

CardDetail/RewardSweepDetail

BeginningDate

Name change

CHXLevelData /ProgramSettings/ STARTProgramSettings

AutomaticTransferAccount

CreditTransactionSweep

CreditRewardSweep

TargetAccountPrimarySTARTenrollmentFlag

NA

NA

Elements removed

CHXLevelData

PerTransactionAmount

CardDetail

PerTransactionAmount

Name change

CHXLevelData

CHXBeginDate

CardDetail

BeginningDate

Name change

CHXLevelData

CHXPrimaryOwner

CardDetail

PrimaryOwner

Name change

CHXLevelData

ProductID