ElectronicPaymentService

ESD Interface Control Document

 

Service Version 3.0

Document Version 1.1

Updated 03/11/2014

 

 

 

 

 

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

11/20/2013

1.0

Initial Creation

Shravan Alugati

3/11/2014

1.1

Updated  ProcessFlow

Ghouse A Mohammed

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


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............................................................................................................... 8

Tier 2 Consumer Authorization.............................................................................................................. 8

Tier 3 Consumer Authorization.............................................................................................................. 8

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

Exception Processing................................................................................................................ 9

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

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

ExecutePayment..................................................................................................................... 10

Operation Description.......................................................................................................................... 10

Processing Specifications.................................................................................................................... 11

Functional Scenarios........................................................................................................................... 15

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

Operation to Data Source Reference Table......................................................................................... 16

Field/Element Specifications................................................................................................................ 16

Exception Processing.......................................................................................................................... 44

HeartBeat................................................................................................................................ 52

Operation Description.......................................................................................................................... 52

Processing Specifications.................................................................................................................... 52

Functional Scenarios........................................................................................................................... 52

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

Operation to Data Source Reference Table......................................................................................... 52

Field/Element Specifications................................................................................................................ 52

Exception Processing.......................................................................................................................... 54

Connection Information..................................................................................................... 56

Tier 2 Environment Configuration............................................................................................. 56

Tier 3 Environment Configuration............................................................................................. 56

Disaster Recovery (DR) Testing................................................................................................ 56

Service Change Log............................................................................................................ 57

ElectronicPaymentService 3.0 PRJ00008968....................................................................... 57

ExecutePayment................................................................................................................................. 57

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

Operation Name...................................................................................................................... 58

Appendix A     Definitions, Acronyms and Abbreviations............................................... 60


Service Description

Online banking customers need the ability to transfer funds from their accounts to other U.S. Bank and non-U.S. Bank accounts. The ElectronicPaymentService 3.0 is used to verify and execute funds transfers between two accounts. After the system completes an allowed funds transfer, the service displays the before and after amounts, which is similar to showing already-posted amounts

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

NA

Assumptions

The audience has knowledge of and understands the following technologies:

       XML

       XSD

       SOAP

Note: ESD designed ElectronicPaymentService 3.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:

       ElectronicPaymentService_V_3_0.wsdl

       MessageElectronicPaymentService_V_3_0.xsd

       USBSOATypeLibrary_V_3_0.xsd

       USBSOACoreComponentsLibrary_V_3_0.xsd

       USBSOAPHeader ICD for use with XSD type Lib V3 .doc

       USBSOAPFault ICD for use with XSD type Lib V3 .doc

       USBank_SOAP-Error-Warning-Info_InterfaceControlDocument for use with XSD Lib V3


        

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 ElectronicPaymentService 3.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   ElectronicPaymentService_V_3_0


System Interaction Diagrams

ElectronicPaymentService 3.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

 

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 EMS-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 EMS-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 ElectronicPaymentService 3.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 ElectronicPaymentService 3.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.

ExecutePayment

The following topics describe this operation.

Operation Description

The ExecutePayment operation is used to verify whether a funds transfer between two accounts is allowed, and then actually transfer the requested funds. This operation displays the before and after transfer amounts, which is similar to showing already-posted amounts, once the system validates the From and To accounts for the funds transfer. Supported From account types include the following:

       DDA

       LOC

       CAA

       CCD

       EXL

       SEL

       UNL

       ACH

       CCL

Supported To account types include the following:

       DDA

       LOC

       CAA

       CCD

       EXL

       BCD

       SEL

       UNL

       SLN

       BLN

       LEA

       CCL

       MAL


 

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.

Figure 4   ExecutePayment Process Flow

 


Payments Internal to Internal

Payments Internal to Internal

KEY - CHANNEL/MSG

FROM PRODUCT

TO PRODUCT

TXN INDICATOR

FTM

DDA

BCD

P

FTM

DDA

BLN

P

FTM

DDA

CCD

P

FTM

DDA

DDA

P

FTM

DDA

EXL

P

FTM

DDA

LEA

P

FTM

DDA

LOC

P

FTM

DDA

SEL

P

FTM

DDA

SLN

P

FTM

DDA

UNL

P

 


 

Payments External to Internal

Payments External to Internal

FROM

PROD

CODE

TO

PROD

CODE

TRF

TYPE

APP

TRN IND

FROM TRAN CODE

TO TRAN CODE

TRANSACTION

DESCRIPTION

ACH

SEL UNL

SLN

BLN

PMT

SEL

P

N/A

33

ALS Credit Line/Loan External Regular Payment

ACH

SEL UNL

SLN

BLN

PMT

SEL

R

N/A

34

ALS Credit Line/Loan External Principal Payment

or Lock Principal Payment

ACH

SLN

SEL

PMT

SEL

E

N/A

35

ALS Loan/Line Escrow Payment

ACH

LEA

PMT

LEA

P

N/A

33

Leasemaster External Payment

Advances External to Internal

Advances External to Internal

KEY - CHANNEL/MSG

FROM PRODUCT

TO PRODUCT

TXN INDICATOR

FTM

EXL

DDA

A

FTM

LOC

DDA

A

FTM

SEL

DDA

A

FTM

UNL

DDA

A


Account Balance Rules

The account balance is based of the product being processed. Account balances are determined as listed below:-

 

Account Type

Balance Description

DDA

Available Balance as listed on the DE00 screen

CAA, LOC

Payoff Balance (including fees)

LEA

All 9s (ODS does not have access to the Leasemaster payoff balance)

All other (credit products)

Current payoff balance including any intra-day (pending) advances

 

 


 

ICS Response Codes

Below table has ICS status codes returned by ODS where applicable (The Value column in the table, when available, is mapped to AdditionalStatus/ServerStatusCode element in the Reply)

Value

Description

1

Being Closed

2

Closed

3

Temporary Restraint

4

Closed

5

Permanent Restraint

6

Lost/Stolen Card

7

Over Credit Limit

8

Fraud

9

Bad Debt

G

Account Not Active

H

Account Expired

P

Account Not Found

Y

CADV Exceeds 375

AD

Account Lost/Stolen

AE

Account Fradulent

AK

Account Permanent Restraint

AL

Account Bad Debt

W1

Statused Account

W2

Delinquent Account

W3

Overlimit Account

W4

Uses and Limits

 

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

HOGAN ODS

ODSXFRP1(DDA to DDA Post)

HOGAN ODS (RIB MAL)

ODSMXFP0 (MAL Post)

HOGAN ODS (Hogan DDA and Lease products )

ODSXFRP0 (Post)

HOGAN ODS

ODSXFRA0 (Post Preview)

ICS

CG400060 (External to Internal)

Field/Element Specifications

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

 


ExecutePaymentRequest

Name

Type

Width

Req?

Description

Host Field Name

  ExecutePaymentRequest

 

 

Y

 

 

      PreviewPaymentSwitch

Boolean

 

Y

If the Switch is set to "true" or "1", the operation produces the before and after values as if an amount was actually posted. But in reality it has not been posted. In other words it is a Preview Payment if the switch is set to "true" or "1" and it Is an Execute Payment if its set to "false" or "0"

     

    CustomerPayment (DDA to DDA Payment)

Y

 

 

         ChannelCode

String

30

Y

Possible Valid Values could be:

OLB_MM,

RETLINETBNK,

RETLMOBILEPHNBNK,

RETL24HRBNK,

RETLBRANCHBNK,

RETLIVRBNK

ODS-CICS-TRAN-CODE

         TransactionTypeCode

String

30

Y

Payment Type.

Valid Values:

DPSTFUNDXFER

REGPMT

PRINPMT

LOANLNPAYOFF

ADVANCE

LOANLNPAYOFFTOZERO

LOANLNPAYOFFTOCLOSE

ESCROWONLYPMT

MORTGAGEPMT

ACTIONABLEALERTXFER

TRANSACTION-INDICATOR

    FromUsbankAccountPrimaryIdentifier

 

N

 

 

                  Operating

                  CompanyIdentifier

Integer

5

Y

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

FROM-ACCT-COMP-ID

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Valid Values:

DDA

FROM-ACCT-PROD-CODE

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

FROM-ACCT-NBR

 

    ToUsbankAccountPrimaryIdentifier

 

N

 

 

                  Operating

                  CompanyIdentifier

Integer

5

Y

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

TO-ACCT-COMP-ID

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Valid Values:

DDA

TO-ACCT-PROD-CODE

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

TO-ACCT-NBR

 

DebitTransactionCode

Integer

4

N

Four digit Deposit debit tran code.

Valid Values:

5518 for OLXX

Host ODS will derive this for SVP, OLB

Note: This list of values may not be comprehensive.

FROM-TRAN-CODE

CreditTransactionCode

Integer

4

N

Four digit deposit credit tran code.

Valid Values:

5517 for OLXX

Host ODS will derive this for SVP, OLB

Note: This list of values may not be comprehensive.

TO-TRAN-CODE

DebitTransactionDescription

String

47

N

If a description is received, Host ODS will use this when updating DDA account transaction history.

SVP - will contain Merchant Name

OLB - will contain INTERNET BANKING TRANSFER TO receiving customer name

FROM-TRAN-CODE-DESC

CreditTransactionDescription

String

47

N

If a description is received, Host ODS will use this when updating DDA account transaction history

OLB  - will contain INTERNET BANKING TRANSFER FROM sending customer name

TO-TRAN-CODE-DESC

RequestSubmittedDateTime

dateTime

 

Y

For SVP this will be the current Business date for payments processed before 3pm CT and next Business date for payments processed after 3pm CT. ODS will reject transactions that dont have current or next business date.

TRANSACTION-DATE, TRANSACTION-TIME

RequestedTransferAmount

Decimal

13.2

Y

 

TRANSACTION-AMT

 

  FulfillerIdentity

 

 

Y

 

 

            IdentityIdentifier

String

8

Y

Possible Valid Values could be:

OLXX, OLB,

SVP for Secured Vault Payments

USER-ID

            IdentityType

String

30

Y

Possible Valid Values could be:

Application

NA

 

    CustomerPayment (Internal Payment)

N

 

 

         ChannelCode

String

30

Y

Possible Valid Values could be:

OLB_MM,

RETLINETBNK,

RETLMOBILEPHNBNK,

RETL24HRBNK,

RETLBRANCHBNK,

RETLIVRBNK

ODS-CICS-TRAN-CODE

         TransactionTypeCode

String

30

Y

Payment Type

Valid Values:

DPSTFUNDXFER

REGPMT

PRINPMT

LOANLNPAYOFF

ADVANCE

LOANLNPAYOFFTOZERO

LOANLNPAYOFFTOCLOSE

ESCROWONLYPMT

MORTGAGEPMT

ACTIONABLEALERTXFER

TRANSACTION-INDICATOR

    FromUsbankAccountPrimaryIdentifier

 

Y

 

 

    OperatingCompany

    Identifier

Integer

5

Y

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

FROM-ACCT-COMP-ID

            ProductCode

String

5

Y

Indicates the type of product/account the customer has.

Possible Valid Values could be

DDA, LOC, CCD, EXL, SEL, UNL, CAA, CCL

FROM-ACCT-PROD-CODE

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

FROM-ACCT-NBR

 

 

 

 

 

 

    ToUsbankAccountPrimaryIdentifier

 

Y

 

 

                  Operating

                  CompanyIdentifier

Integer

5

Y

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

TO-ACCT-COMP-ID

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Possible Valid Values could be:

DDA, LOC, CCD, EXL, BCD, SEL, UNL, SLN, BLN, LEA, CAA, CDA, CCL

TO-ACCT-PROD-CODE

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

TO-ACCT-NBR

 

RequestSubmittedDateTime

DateTime

 

Y

For CDA funding transactions, ORION will send backdated date in this field ensuring it is equal to the Open date of the CDA account

TRANSACTION-DATE, TRANSACTION-TIME

RequestedTransferAmount

Decimal

13.2

Y

For Escrow only payments, both the transaction amount and escrow payment amount must be populated

TRANSACTION-AMT

 

    PaymentOptions

 

Y

 

 

FixedRateOptionCode

String

3

N

 

FIXED-RATE-OPTION-NUMBER

            RegularPayment

            Amount

Decimal

13.2

N

 

REGULAR-PAYMENT

            PrincipalPayment

            Amount

Decimal

13.2

N

 

ALS-MAL-PRINCIPAL-PMT

            InterestPayment

            Amount

Decimal

13.2

N

 

MAL-INTEREST-PAYMENT

            LateChargePayment

            Amount

Decimal

13.2

N

 

MAL-LATE-CHARGE-PMT

            EscrowPayment

            Amount

Decimal

13.2

N

For Escrow only payments, both the Transaction and Escrow amounts must be populated

MAL-ESCROW-PAYMENT

 

  FulfillerIdentity

 

 

Y

 

 

            IdentityIdentifier

String

8

Y

Possible Valid Values could be:

RIB -  Retail Internet Banking users

OLB Online Banking  users

MOBILAPP Mobile Web users

MOBILWAP Mobile Web users

IVR IVR Users

USER-ID

            IdentityType

String

30

Y

Possible Valid Values could be:

Application

NA

 

    CustomerPayment (Mortgage Payment)

N

 

 

         ChannelCode

String

30

Y

Possible Valid Values could be:

OLB_MM,

RETLINETBNK,

RETLMOBILEPHNBNK,

RETL24HRBNK,

RETLBRANCHBNK,

RETLIVRBNK

NA

         TransactionTypeCode

String

 30

Y

Payment Type

Valid Values:

DPSTFUNDXFER

REGPMT

PRINPMT

LOANLNPAYOFF

ADVANCE

LOANLNPAYOFFTOZERO

LOANLNPAYOFFTOCLOSE

ESCROWONLYPMT

MORTGAGEPMT

ACTIONABLEALERTXFER

NA

    FromUsbankAccountPrimaryIdentifier

 

Y

 

 

                  Operating

                  CompanyIdentifier

Integer

5

Y

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

FromAccountCompanyID

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Possible Valid Values could be:

DDA - Transfer from USB checking or savings

FromAccountProductCode

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

FromAccountNumber

 

    ToUsbankAccountPrimaryIdentifier

 

Y

 

 

                  Operating

                  CompanyIdentifier

Integer

5

Y

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

ToAccountCompanyID

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Valid Values:

MAL

ToAccountProductCode

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

ToAccountNumber

 

RequestSubmittedDateTime

DateTime

 

Y

Transaction Date Time

Transaction Date, Transaction Time

RequestedTransferAmount

Decimal

13.2

Y

Total value of all payment buckets i.e. 

Transaction amount = regular + principle + escrow + interest + late charge

TransactionAmount

 

    PaymentOptions

 

N

 

 

            RegularPayment

            Amount

Decimal

13.2

N

Note:

If any of the excluded Plan IDs (PlanIdentifierList/PlanIdentifier) is passed, the premium amount of that plan is subtracted from this field

RegularPaymentAmount

            PrincipalPayment

            Amount

Decimal

13.2

N

 

PrincipalPaymentAmount

            InterestPayment

            Amount

Decimal

13.2

N

 

InterestPayment

            LateChargePayment

            Amount

Decimal

13.2

N

 

LateChargePayment

            EscrowPayment

            Amount

Decimal

13.2

N

 

EscrowPayment

 

  PlanIdentifierList

 

 

N

 

 

            PlanIdentifier (0 to 12)

String

2

N

Excluded insurance.

Note:

The Optional Insurance can only be excluded when a Regular Payment is being requested, i.e. the Plan ID may only be populated when the Regular Payment Amount is non-zeroes.  The premium amount of the insurance Plan must be subtracted out of the Regular payment amount

PlanID

 

  FulfillerIdentity

 

 

Y

 

 

            IdentityIdentifier

String

8

Y

Possible Valid Values could be:

RIB -  Retail Internet Banking users

OLB Online Banking  users

MOBILAPP Mobile Web users

MOBILWAP Mobile Web users

Banker ID Orion

UserID

            IdentityType

String

30

Y

Possible Valid Values could be:

BANKER,

Application

NA

 

    CustomerPayment (Preview Payment)

Y

 

 

         ChannelCode

String

30

Y

Possible Valid Values could be:

OLB_MM,

RETLINETBNK,

RETLMOBILEPHNBNK,

RETL24HRBNK,

RETLBRANCHBNK,

RETLIVRBNK

ODS-CICS-TRAN-CODE

         TransactionTypeCode

String

 30

Y

Payment Type

Valid Values:

DPSTFUNDXFER

REGPMT

PRINPMT

LOANLNPAYOFF

ADVANCE

LOANLNPAYOFFTOZERO

LOANLNPAYOFFTOCLOSE

ESCROWONLYPMT

MORTGAGEPMT

ACTIONABLEALERTXFER

TRANSACTION-INDICATOR

    FromUsbankAccountPrimaryIdentifier (Choice)

(Internal Payments)

N

 

 

                  Operating

                  CompanyIdentifier

Integer

5

Y

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

FROM-ACCOUNT-COMPANY

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Possible Valid values could be:

DDA, LOC, CAA, CCD, EXL, SEL, UNL, ACH, CCL

FROM-ACCOUNT-PRODUCT

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

FROM-ACCOUNT-NUMBER

 

    FromExternalAccountPrimaryIdentifier (Choice)

(External Payments)

N

 

 

                  Operating

                  CompanyIdentifier

Integer

5

Y

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

Value 00300 for all ACH From Account Product.

FROM-ACCOUNT-COMPANY. ODS-CICS-TRAN-CODE

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Possible Valid values could be:

DDA, LOC, CAA, CCD, EXL, SEL, UNL, ACH, CCL

FROM-ACCOUNT-PRODUCT

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

FROM-ACCOUNT-NUMBER

 

    ToUsbankAccountPrimaryIdentifier

 

N

 

 

                  Operating

                  CompanyIdentifier

Integer

5

Y

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

TO-ACCOUNT-COMPANY

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Possible Valid Values could be:

DDA, LOC, CAA, CCD, EXL, BCD, SEL, UNL, SLN, BLN, LEA, CCL, MAL.

TO-ACCOUNT-PRODUCT

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

TO-ACCOUNT-NUMBER

 

RequestSubmittedDateTime

DateTime

 

Y

For CDA funding transactions, Orion will send the backdated date in this field ensuring it is equal to the Open date of the CDA account.

TRANSACTION-DATE, TRANSACTION-TIME

RequestedTransferAmount

Decimal

13.2

Y

 

TRANSACTION-AMOUNT

 

    PaymentOptions

 

N

 

 

FixedRateOptionCode

String

3

N

 

FIXED-RATE-OPTION-NUMBER

 

  FulfillerIdentity

 

 

Y

 

 

            IdentityIdentifier

String

8

Y

Possible Valid Values could be:

OLB_MM,

RETLINETBNK,

RETLMOBILEPHNBNK,

RETL24HRBNK,

RETLBRANCHBNK,

RETLIVRBNK

USER-ID

            IdentityType

String

30

Y

Possible Valid Values could be:

Application

NA

 

    CustomerPayment (External Payment)

Y

 

 

    FromExternalAccountPrimaryIdentifier

 

Y

 

 

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

CGIO0060-REL-ACCT-NBR

            RoutingNumber

String

9

N

Transit/Routing Number

CGIO0060-REL-ACCT-RTG

 

    ToUsbankAccountPrimaryIdentifier

 

Y

 

 

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

CGIO0060-ACCT-NBR

 

RequestSubmittedDateTime

DateTime

 

Y

 

CGIO0060-PYMT-DUE-DTE-X

RequestedTransferAmount

Decimal

13.2

Y

 

CGIO0060-PYMT-AMT-X

 

  FulfillerIdentity

 

 

Y

 

 

            IdentityIdentifier

String

8

Y

Possible Valid Values could be:

OLB_MM,

RETLINETBNK,

RETLMOBILEPHNBNK,

RETL24HRBNK,

RETLBRANCHBNK,

RETLIVRBNK

NA

            IdentityType

String

30

Y

Possible Valid Values could be:

Application

NA

 

    CustomerPayment (External Payment with Select Product Code)

N

 

 

         ChannelCode

String

30

Y

Possible Valid Values could be:

OLB_MM,

RETLINETBNK,

RETLMOBILEPHNBNK,

RETL24HRBNK,

RETLBRANCHBNK,

RETLIVRBNK

ODS-CICS-TRAN-CODE

         TransactionTypeCode

String

 30

Y

Payment Type.

Valid Values:

DPSTFUNDXFER

REGPMT

PRINPMT

LOANLNPAYOFF

ADVANCE

LOANLNPAYOFFTOZERO

LOANLNPAYOFFTOCLOSE

ESCROWONLYPMT

MORTGAGEPMT

ACTIONABLEALERTXFER

TRANSACTION-INDICATOR

    FromExternalAccountPrimaryIdentifier

 

N

 

 

OperatingCompanyIdentifier

Integer

5

Y

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

FROM-ACCT-COMP-ID

            ProductCode

String

3

Y

Indicates the type of product/account the customer has.

Possible Valid values could be:

DDA, LOC, CCD, EXL, SEL, UNL, CAA, ACH, CCL

FROM-ACCT-PROD-CODE

            PrimaryIdentifier

String

23

Y

Account Identifier / Account Number

FROM-ACCT-NBR

           RoutingNmber

String

9

N

Transit/Routing Number

FROM-ACCT-TAR-NUM

 

    ToUsbankAccountPrimaryIdentifier

 

N

 

 

                  Operating

                  CompanyIdentifier

Integer

 

Y

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

TO-ACCT-COMP-ID

            ProductCode

String

 

Y

Indicates the type of product/account the customer has.

Possible Valid Values could be:

DDA, LOC, CCD, EXL, BCD, SEL, UNL, SLN, BLN, LEA, CAA, CDA, CCL

TO-ACCT-PROD-CODE

            PrimaryIdentifier

String

 

Y

Account Identifier Account Number

TO-ACCT-NBR

 

RequestSubmittedDateTime

DateTime

 

Y

For CDA funding transactions, ORION will send backdated date in this field ensuring it is equal to the Open date of the CDA account

TRANSACTION-DATE, TRANSACTION-TIME

RequestedTransferAmount

Decimal

13.2

Y

For Escrow only payments, both the transaction amount and escrow payment amount must be populated

TRANSACTION-AMT

 

    PaymentOptions

 

N

 

 

FixedRateOptionCode

String

3

N

 

FIXED-RATE-OPTION-NUMBER

            RegularPayment

            Amount

Decimal

13.2

N

 

REGULAR-PAYMENT

            PrincipalPayment

            Amount

Decimal

13.2

N

 

ALS-MAL-PRINCIPAL-PMT

            InterestPayment

           Amount

Decimal

13.2

N

 

MAL-INTEREST-PAYMENT

            LateChargePayment

            Amount

Decimal

13.2

N

 

MAL-LATE-CHARGE-PMT

            EscrowPayment

            Amount

Decimal

13.2

N

For Escrow only payments, both the Transaction and Escrow amounts must be populated.

MAL-ESCROW-PAYMENT

 

  FulfillerIdentity

 

 

Y

 

 

            IdentityIdentifier

String

8

Y

Possible Valid Values could be:

RIB -  Retail Internet Banking users

OLB Online Banking  users

MOBILAPP Mobile Web users

MOBILWAP Mobile Web users

IVR IVR Users

USER-ID

            IdentityType

String

30

Y

Possible Valid Values could be:

Application

NA

 


 

ExecutePaymentReply

Name

Type

Width

Req?

Description

Host Field Name

ExecutePaymentReply

 

 

 

 

 

   ExecutePaymentReply (DDA to DDA Payment)

Y

 

 

      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 

Transaction Response Code, Condition Code

      Severity

String

0 to 80

Y

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

Transaction Response Code, Condition Code

      StatusDescription

String

0 to 255

N

Status Description
Status text is provided in the Status Desc field

Transaction Response Code, Condition Code

      ServerStatusCode

String

0 to 20

N

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

Condition Code

      ServerStatusDescription

String

0 to 255

N

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

Condition Code Description

      CustomerPayment

 

 

N

 

 

         AdjustedAmount

Decimal

13.2

N

 

ADJUSTED-AMOUNT

         TransferTypeCode

String

3

N

Valid Values:-

TFR = DDA Transfer

PMT = Payments, Payoffs, Principal Payments

ADV = Advance

FND = ATM Card Funding

TRANSFER-TYPE

         TransactionIndicator

String

 

N

Transaction/Payment Indicator. If the Host ODS returns C then PAYMENTS is assigned and any other returned values are not mapped

TRAN-INDICATOR

         EffectiveDate

Date

 

N

 

EFFECTIVE-DATE

         BalanceDetail

 

 

N

 

 

            FromAccountPriorTo

            PostingBalance

            Amount

Decimal

13.2

N

 

FROM-ACCT-BEFORE-POST-AVAIL-BAL

            FromAccountAfter

            PostingBalance

            Amount

Decimal

13.2

N

 

FROM-ACCT-AFTER-POST-AVAIL-BAL

            ToAccountPriorTo

            PostingBalance

            Amount

Decimal

13.2

N

 

TO-ACCT-BEFORE-POST-AVAIL-BAL

            ToAccountAfter

            PostingBalance

            Amount

Decimal

13.2

N

 

TO-ACCT-AFTER-POST-AVAIL-BAL

            FixedRateOption

            BeforePostCurrent

            Balance

Decimal

13.2

N

 

FIXED-RATE-OPTION-BEFORE-POST

            FixedRateOption

            AfterPostCurrent

            Balance

Decimal

13.2

N

 

FIXED-RATE-OPTION-AFTER-POST

         ChargeList

 

 

N

 

 

            ChargeAmount

Decimal

13.2

Y

 

CAA-FINANCE-CHARGE

         DueDateList

 

 

N

 

 

            Date

Date

 

Y

 

CAA-ADVANCE-DUE

 

   ExecutePaymentReply (Internal Payment & External with Select Product codes Payment)

Y

 

 

      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 

Transaction Response Code, Condition Code

      Severity

String

0 to 80

Y

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

Transaction Response Code, Condition Code

      StatusDescription

String

0 to 255

N

Status Description
Status text is provided in the Status Desc field

Transaction Response Code, Condition Code

      ServerStatusCode

String

0 to 20

N

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

Condition Code

      ServerStatusDescription

String

0 to 255

N

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

Condition Code Description

          AdditionalStatus

 

 

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

Valid Values:

0

100

              Severity

String

0 to 80

Y

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

Valid Values:

Info

Warning

Error

              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.

Valid Values:

ICS Response Code

ICS-CODE

        ServerStatusDescription

String

0 to 255

N

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

Valid Values:

ICS Response Code

      CustomerPayment

 

 

N

 

 

         AdjustedAmount

Decimal

13.2

N

For ALS, ICS, CAA and LOC products:-

This will be the available credit for all advances where the transaction amount exceeds the available credit.

This will be the current payoff balance for all payments where the transaction amount exceeds the payoff balance.

In other words we are preventing more money being advances than is available, or making a payment that exceeds the outstanding balance

ADJUSTED-AMOUNT

         TransferTypeCode

String

 

N

Values:-

TFR = DDA Transfer

PMT = Payments, Payoffs, Principal Payments

ADV = Advance

TRANSFER-TYPE

         TransactionIndicator

String

 

N

NOTE: For Principle only and Escrow payments, to loan and line accounts, the payment will be changed to a regular payment when the account is past due.

The indicator will be switched to a C in the reply message to indicate the change in payment type.

TRANSACTION-INDICATOR

         EffectiveDate

Date

 

N

Effective Date of the transaction as determined by ODS

EFFECTIVE-DATE

 

         BalanceDetail

 

 

N

 

 

            FromAccountPriorTo

            PostingBalance

            Amount

Decimal

13.2

N

See Account Balance Rules

FROM-PRE-POST-AVAIL-BAL

            FromAccountAfter

            PostingBalance

            Amount

Decimal

13.2

N

See Account Balance Rules

FROM-AFT-POST-AVAIL-BAL

            ToAccountPriorTo

            PostingBalance

            Amount

Decimal

13.2

N

See Account Balance Rules

TO-PRE-POST-AVAIL-BAL

            ToAccountAfter

            PostingBalance

            Amount

Decimal

13.2

N

See Account Balance Rules

TO-AFT-POST-AVAIL-BAL

            FixedRateOption

            BeforePostCurrent

            Balance

Decimal

13.2

N

 

FIXED-RATE-OPT-BEF-POST-CUR-BAL

            FixedRateOption

            AfterPostCurrent

            Balance

Decimal

13.2

N

 

FIXED-RATE-OPT-AFT-POST-CUR-BAL

         ChargeList

 

 

N

 

 

            ChargeAmount

Decimal

13.2

Y

 

CAA-FINANCE-CHARGE

         DueDateList

 

 

N

 

 

            Date

Date

 

Y

 

CAA-ADVANCE-DUE-DATE

 

   ExecutePaymentReply (Mortgage Payment)

Y

 

 

      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 

Transaction Response Code, Condition Code

      Severity

String

0 to 80

Y

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

Transaction Response Code, Condition Code

      StatusDescription

String

0 to 255

N

Status Description
Status text is provided in the Status Desc field

Transaction Response Code, Condition Code

      ServerStatusCode

String

0 to 20

N

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

Condition Code

      ServerStatusDescription

String

0 to 255

N

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

Condition Code Description

      CustomerPayment

 

 

N

 

 

         TransactionIndicator

String

1

N

 

TransactionPaymentIndicator

         EffectiveDate

Date

 

N

Effective Date of the transaction as determined by Host ODS

EffectiveDate

         BalanceDetail

 

 

N

 

 

            FromAccountPriorTo

            PostingBalance

            Amount

Decimal

13.2

N

 

FR-PRE-POST-BAL

            FromAccountAfter

            PostingBalance

            Amount

Decimal

13.2

N

 

FR-AFT-POST-BAL

            ToAccountPriorTo

            PostingBalance

            Amount

Decimal

13.2

N

 

TO-PRE-POST-BAL

            ToAccountAfter

            PostingBalance

            Amount

Decimal

13.2

N

 

TO-AFT-POST-BAL

 

   ExecutePaymentReply (Preview Payment)

 

Y

 

 

      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 

Transaction Response Code, Condition Code

      Severity

String

0 to 80

Y

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

Transaction Response Code, Condition Code

      StatusDescription

String

0 to 255

N

Status Description
Status text is provided in the Status Desc field

Transaction Response Code, Condition Code

      ServerStatusCode

String

0 to 20

N

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

Condition Code

      ServerStatusDescription

String

0 to 255

N

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

Condition Code Description

      CustomerPayment

 

 

N

 

 

         AdjustedAmount

Decimal

13.2

N

For ALS, ICS, CAA and LOC products:-

This will be the available credit for all advances where the transaction amount exceeds the available credit.

This will be the current payoff balance for all payments where the transaction amount exceeds the payoff balance.

In other words we are preventing more money being advances than is available or making a payment that exceeds the outstanding balance.

ADJUSTED-AMOUNT

         TransferTypeCode

String

3

N

Valid Values:-

TFR - DDA Transfer

PMT -  Payments, Payoffs, Principal Payments

ADV - Advance

TRANSFER-TYPE

         TransactionIndicator

String

8

N

Transaction/Payment Indicator. If the Host ODS returns C then PAYMENTS is assigned and any other returned values are not mapped.

Note:

For Principle only and Escrow payments, to loan and line accounts, the payment will be changed to a regular payment when the account is past due. The indicator will be switched to a C in the Host reply message to indicate the change in payment type. 

TRANSACTION-INDICATOR

         EffectiveDate

Date

 

N

Effective Date of the transaction as determined by ODS

EFFECTIVE-DATE

         BalanceDetail

 

 

N

 

 

            FromAccountPriorTo

            PostingBalance

            Amount

Decimal

13.2

N

See Account Balance Rules

FROM-PRE-POST-AVAIL-BAL

            FromAccountAfter

            PostingBalance

            Amount

Decimal

13.2

N

See Account Balance Rules

FROM-AFT-POST-AVAIL-BAL

            ToAccountPriorTo

            PostingBalance

            Amount

Decimal

13.2

N

See Account Balance Rules

TO-PRE-POST-AVAIL-BAL

            ToAccountAfter

            PostingBalance

            Amount

Decimal

13.2

N

See Account Balance Rules

TO-AFT-POST-AVAIL-BAL

            FixedRateOption

            BeforePostCurrent

            Balance

Decimal

13.2

N

 

FIXED-RATE-OPT-BEF-POST-CUR-BAL

            FixedRateOptionAfter

            PostCurrent

            Balance

Decimal

13.2

N

 

FIXED-RATE-OPT-AFT-POST-CUR-BAL

         ChargeList

 

 

N

 

 

            ChargeAmount

Decimal

13.2

Y

 

CAA-FINANCE-CHARGE

 

         DueDateList

 

 

N

 

 

            Date

Date

 

Y

 

CAA-ADVANCE-DUE-DATE

 

         ThinkTwiceSwitch

Boolean

 

Y

Valid Values:

0

1

CONDITION-CODE

 

   ExecutePaymentReply (External to Internal Payment)

Y

 

 

      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 

CGIO0053-RETURN-CDE, CGIO0053-ERROR-RSN-CDE

      Severity

String

0 to 80

Y

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

CGIO0053-RETURN-CDE, CGIO0053-ERROR-RSN-CDE

      StatusDescription

String

0 to 255

N

Status Description
Status text is provided in the Status Desc field

CGIO0053-RETURN-CDE, CGIO0053-ERROR-RSN-CDE

      ServerStatusCode

String

0 to 20

N

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

CGIO0053-ERROR-RSN-CDE

      ServerStatusDescription

String

0 to 255

N

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

CGIO0053-ERROR-MSG-TXT

 

      CustomerPayment

 

 

N

 

 

         DueDateList

 

 

N

 

 

            Date

Date

 

Y

 

CGIO0053-SYS-PYMT-POST-DTE

 


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 (DDA to DDA Payment for SecureVault Channel Only)

Status Code

Severity

Status Description

Server Status Code

Server Status Description

Additional details

0

Info

Success

64000

Action Successful

 

900

Warning

Message Accepted for Asynchronous Processing

49801

HOGAN IN LOGICAL READ-ONLY PROCESSING

The transaction has been written to the store-and-forward queue for later processing as Hogan is in Read Only mode.

2401

Error

Account not available

15007

ITEM ACCOUNT NOT FOUND

The account indicated in the request is not available.

100

Error

General Error

<Unknown Server code>

<Unknown Host message>

 

StatusCode (Internal Payment & External with Select Product codes Payment)

Status Code

Severity

Status Description

Server Status Code

Server Status Description

Additional details

0

Info

Success

64000

Action Successful

 

900

Warning

Message Accepted for Asynchronous Processing

49801

HOGAN IN LOGICAL READ-ONLY PROCESSING

The transaction has been written to the store-and-forward queue for later processing as Hogan is in Read Only mode.

100

Error

General Error

49801

HOGAN IN LOGICAL READ-ONLY PROCESSING

Unlike other transfers, CDA & CAA transfers cannot be processed during read-only and therefore transfer request is denied during read-only.

2401

Error

Account not available

15007

ITEM ACCOUNT NOT FOUND

The account indicated in the request is not available.

100

Error

General Error

15672

Debit Account Status Closed, Closed in Progress or Purgeable

 

100

Error

General Error

15673

Debit Account Status Dormant

 

100

Error

General Error

15674

Debit Account Status Escheatable

 

100

Error

General Error

15676

Debit Account Restricted Sub Product

 

100

Error

General Error

15675

Debit Account Restraints

 

2940

Error

Insufficient Funds

15616

Debit Account Insufficient Funds

The service provider cannot process the transaction because the specified account does not have sufficient funds.

100

Error

General Error

15660

Credit Account Status Closed, Closed in Progress or Purgeable

 

100

Error

General Error

15661

Credit Account Status Dormant

 

100

Error

General Error

15662

Credit Account Status Escheatable

 

100

Error

General Error

15665

Credit Account Restricted Sub Product

 

100

Error

General Error

15663

Credit Account Restraints

 

2180

Error

Request Is Too Late For Today's Work

15695

PAS/ODS in Cutover mode

The customer has asked to schedule a transfer or payment for today but the cutoff time for today's work has passed.

100

Error

General Error

15696

ODS Effective Date does not match DDA and TDA Processing date

 

100

Error

General Error

15659

DDA Processing Date does not match TDA Processing date

 

100

Error

General Error

15698

Post Date does not match Date Opened

 

2365

Error

Request denied due to Account Status

15697

Invalid Status

The request could not be processed due to the account status.

100

Error

General Error

15583

Debit/Credit LOC Heloc Account

 

100

Error

General Error

15581

Debit LOC Account Past Due

 

100

Error

General Error

15665

Debit/Credit LOC Restricted Sub Product

 

100

Error

General Error

15646

Debit LOC Account unrelated to DDA Account

 

2940

Error

Insufficient Funds

15407

Debit Reserve/Credit Line Account Insufficient Funds

The service provider cannot process the transaction because the specified account does not have sufficient funds.

100

Error

General Error

15570

Credit Account Payoff Balance does not exceed Zero

 

100

Error

General Error

15019

Debit ALS Account Restricted Sub Product

 

100

Error

General Error

15576

Payoff Transaction not allowed due to Do not quote Payoff Indicator

 

100

Error

General Error

60031

Debit/Credit ICS Online Post Error

 

100

Error

General Error

45215

Contribution Limit Exceeded

 

100

Error

General Error

45217

Account Owner is Over Contribution Age

 

100

Error

General Error

15722

CAA Account Ineligible for Advance

 

100

Error

General Error

15067

CAA Min and Max Amounts  do not exceed Zero

 

100

Error

General Error

XXXXX

Various Invalid CAA Status Errors

 

100

Error

General Error

<Unknown Server code>

<Unknown Host message>

 

StatusCode (Mortgage Payment)

Status Code

Severity

Status Description

Server Status Code

Server Status Description

Additional details

0

Info

Success

64000

Action Successful

 

900

Warning

Message Accepted for Asynchronous Processing

49801

HOGAN IN LOGICAL READ-ONLY PROCESSING

The transaction has been written to the store-and-forward queue for later processing as Hogan is in Read Only mode.

2401

Error

Account not available

64110

ACCOUNT NOT ON FILE

The account indicated in the request is not available.

100

Error

General Error

15671

Closed to Post

 

100

Error

General Error

15672

Debit Account Status Closed, Closed in Progress or Purgeable

 

100

Error

General Error

15673

Debit Account Status Dormant

 

100

Error

General Error

15674

Debit Account Status Escheatable

 

100

Error

General Error

15676

Debit Account Restricted Sub Product

 

100

Error

General Error

15675

Debit Account Restraints

 

2940

Error

Insufficient Funds

15616

Debit Account Insufficient Funds

 

2350

Error

Account Closed

15660

Credit Account Status Closed

 

100

Error

General Error

15570

Credit Account Payoff Balance does not exceed Zero

 

100

Error

General Error

<Unknown Server code>

<Unknown Host message>

 

StatusCode (Preview Payment)

Status Code

Severity

Status Description

Server Status Code

Server Status Description

Additional details

0

Info

Success

64000

Action Successful

 

100

Error

General Error

49801

HOGAN IN LOGICAL READ-ONLY PROCESSING

Unlike other transfers, CDA & CAA transfers cannot be processed during read-only and therefore transfer request is denied during read-only.

2401

Error

Account not available

15007

ITEM ACCOUNT NOT FOUND

The account indicated in the request is not available.

100

Error

General Error

15672

Debit Account Status Closed, Closed in Progress or Purgeable

 

100

Error

General Error

15673

Debit Account Status Dormant

 

100

Error

General Error

15674

Debit Account Status Escheatable

 

100

Error

General Error

15676

Debit Account Restricted Sub Product

 

100

Error

General Error

15675

Debit Account Restraints

 

2940

Error

Insufficient Funds

15616

Debit Account Insufficient Funds

The service provider cannot process the transaction because the specified account does not have sufficient funds.

100

Error

General Error

15660

Credit Account Status Closed, Closed in Progress or Purgeable

 

100

Error

General Error

15661

Credit Account Status Dormant

 

100

Error

General Error

15662

Credit Account Status Escheatable

 

100

Error

General Error

15665

Credit Account Restricted Sub Product

 

100

Error

General Error

15663

Credit Account Restraints

 

2180

Error

Request Is Too Late For Today's Work

15695

PAS/ODS in Cutover mode

The customer has asked to schedule a transfer or payment for today but the cutoff time for today's work has passed.

100

Error

General Error

15696

ODS Effective Date does not match DDA and TDA Processing date

 

100

Error

General Error

15659

DDA Processing Date does not match TDA Processing date

 

100

Error

General Error

15698

Post Date does not match Date Opened

 

2365

Error

Request denied due to Account Status

15697

Invalid Status

The request could not be processed due to the account status.

100

Error

General Error

15583

Debit/Credit LOC Heloc Account

 

100

Error

General Error

15581

Debit LOC Account Past Due

 

100

Error

General Error

15665

Debit/Credit LOC Restricted Sub Product

 

100

Error

General Error

15646

Debit LOC Account unrelated to DDA Account

 

2940

Error

Insufficient Funds

15407

Debit Reserve/Credit Line Account Insufficient Funds

The service provider cannot process the transaction because the specified account does not have sufficient funds.

100

Error

General Error

15570

Credit Account Payoff Balance does not exceed Zero

 

100

Error

General Error

15019

Debit ALS Account Restricted Sub Product

 

100

Error

General Error

15576

Payoff Transaction not allowed due to Do not quote Payoff Indicator

 

100

Error

General Error

60031

Debit/Credit ICS Online Post Error

 

100

Error

General Error

45215

Contribution Limit Exceeded

 

100

Error

General Error

45217

Account Owner is Over Contribution Age

 

0

Warning

Success

15744

START Acc Think Twice Warning

 

100

Error

General Error

15722

CAA Account Ineligible for Advance

 

100

Error

General Error

15067

CAA Min and Max Amounts  do not exceed Zero

 

100

Error

General Error

XXXXX

Various Invalid CAA Status Errors

 

100

Error

General Error

<Unknown Server code>

<Unknown Host message>

 


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 services 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 USBSOAPFault operation 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

 

 

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

Environment

Service URL

DEV

https://dev-publicservice.us.bank-dns.com:8104/ElectronicPaymentService_V_3_0

IT

https://it-publicservice.usbank.com/ElectronicPaymentService_V_3_0

UAT

https://uat-publicservice.usbank.com/ElectronicPaymentService_V_3_0

PROD

https://publicservice.usbank.com/ElectronicPaymentService_V_3_0

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/ElectronicPaymentService_V_3_0

IT: OBC

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

UAT: EPOC

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

UAT: OBC

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

PROD: EPOC

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

PROD: OBC

https://internalserviceobc.us.bank-dns.com/ElectronicPaymentService_V_3_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 ElectronicPaymentService.

ElectronicPaymentService 3.0 PRJ00008968

ExecutePayment

Request Message

Date

Change Type

Description or Fields Added/Removed/Modified

11/05/2013

Modify

Changed TransactionTypeCode from Enum to String Type and made it Required

11/05/2013

Modify

Made ChannelCode a Required element

 

 

 

Reply Message

Date

Change Type

Description or Fields Added/Removed/Modified

 

 

 

 

 

 

 

 

 

 

 


Refactored Service and Operation Cross-Reference Table

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

        

Operation Name

OLD Schema (Service.Operation)

 

NEW Schema (Service.Operation)

 

Comments

Aggregate Name

Element Name

Aggregate Name

Element Name

 

[Insert Name Here]Request

[Insert Name Here]Request

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

[Insert Name Here]Reply

[Insert Name Here]Reply

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Appendix A              Definitions, Acronyms and Abbreviations

The following table defines the acronyms or terms specific to ESD and/or this services interface.

Acronym/Term

Definition

CCB

COBOL Copybook. A section of high-level code that defines the layout of program data.

CICS

Customer Information Control System. A transaction server that runs on the mainframe.

CIM

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

DEV

Development. A testing environment.

EPOC

Energy Park Operations Center. A U.S. Bank data center.

EMS

Enterprise Messaging System. Part of the TIBCO products.

ESD

Enterprise Service Development. The U.S. Bank department that creates and manages enterprise Web services.

FFD

Flat File Definition. A plain text file format. Sometimes referred to COBOL Copybook (CCB).

PAS

Platform Automation System. PAS is designed to be a general gateway between non-3270 device and host applications. PAS is the Application Processing Interface (API) for all devices into Hogan applications for all non-financial transaction activity.

HTTPS

HyperText Transport Protocol Secure. Websites use this protocol to transmit and receive data securely through a secure socket layer (SSL).

IT

Integration Testing. A testing environment.

MQ

Messaging software that is part of the IBM WebSphere product.

OBC

Olathe Business Center. A U.S. Bank data center.

OSB

Oracle Service Bus. An enterprise service bus (ESB) that connects, mediates and manages interactions between services and applications.

PROD

Production. The production environment.

SOAP

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

SOR

System of Record. The authoritative data source for a piece of information, for example Hogan.

TIBCO

The Information Bus Company. Real-time, event-enabled infrastructure software that provides an interface to date on the mainframe. U.S. Bank currently uses Business Works (BW), BusinessConnect (BC), EMS, Rendezvous, Active Database Adapter, Hawk and Administrator.

UAT

User Acceptance Testing. A testing environment.

WSDL

Web service Definition Language (WSDL). Version 1.1 is the W3C specification for WSDL files.

XML

Extensible Markup Language. An open standard for describing data from the W3C.

XSD

XML Schema Definition. XML-based language that describes and controls the structure of XML documents.