Service Oriented Architecture Guide GPP SOA STP Validation

User Manual: Pdf

Open the PDF directly: View PDF .
Page Count: 20

Download
Open PDF In Browser	View PDF

Global PAYplus Version 4.6.6
STP Validation
Service-Oriented Architecture Guide

Global PAYplus Service-Oriented Architecture Guide

Page 1

Copyright
© 209-2017 D+H Global Transaction Banking Solutions. All rights reserved. D+H is a trademark of D+H Limited
Partnership.
PROPRIETARY AND CONFIDENTIAL - This document contains information, which contains Confidential and
Know How property of D+H. Disclosure to or use by persons who are not expressly authorized in writing by D+H is
strictly prohibited.
D+H reserves the right to alter the specifications and descriptions in this publication without prior notice. No part of
this publication shall be deemed to be part of any contract or warranty unless specifically incorporated by reference
into such contract or warranty.
All brand or product names are the trademarks or registered trademarks of their respective holders.
The information contained herein is merely descriptive in nature, and does not constitute a binding offer for the li

Catalog ID: GPP4.6-00-S12-02-201704

STP Validation

Version Control

Version Control
Version

Date

1.0
2.0

Summary of Changes
Document created

Dec 2015

Document updated for rebranding

Global PAYplus Service-Oriented Architecture Guide

Page 3

STP Validation

Table of Contents

Table of Contents
1

INTRODUCTION ............................................................................................................................. 5
1.1
1.2

Target Audience ....................................................................................................................... 5
About This Book ....................................................................................................................... 5
STPRULESERVICE DESCRIPTION .............................................................................................. 6

2.1
2.2
2.3
2.4
2.5
2.6
2.7
2.7.1
2.7.2
2.8
3

Functional Description ............................................................................................................. 6
Pre-requisites (N/A) ................................................................................................................. 6
Service Function ...................................................................................................................... 6
Inputs (N/A) .............................................................................................................................. 6
Processing (N/A) ...................................................................................................................... 6
Output (N/A) ............................................................................................................................. 6
Fine Grain Services ................................................................................................................. 6
ValidateSTPRules ................................................................................................................ 6
LoadSTPRules ................................................................................................................... 11
Errors ..................................................................................................................................... 14

EXAMPLES................................................................................................................................... 16
3.1
Validation Mode Example ...................................................................................................... 16
3.1.1
Request .............................................................................................................................. 16
3.1.2
Response ........................................................................................................................... 17
3.2
Load Mode Example .............................................................................................................. 18
3.2.1
Request .............................................................................................................................. 18
3.2.2
Response ........................................................................................................................... 19

APPENDIX A: GLOSSARY ..................................................................................................................... 20

Global PAYplus Service-Oriented Architecture Guide

Page 4

STP Validation

Introduction

Note: This SOA Guide has not yet been certified for GPP V4.6; therefore, there may be inaccuracies in
this document that may require amendments in the future. For more information, please contact your
D+H Project Manager.

1.1

Target Audience

GPP is a robust payment engine whose workflow emulates the business flow of the bank or other
financial institution. Configurable reference data profiles control the sequence of workflow steps and the
actions performed in each step.
The STP Validation Service (STPRulesService) increases Straight Through Processing (STP) rates for
payment messages. This service can be used by customers before the messages are processed by
GPP. This service enhances payment processing by eliminating errors and omissions before they can
cause a delay in payment.
This service is based on a business rule that defines an STP validation profile. This profile consists of
payment attribute validations that are performed on the payment.
For example, when sending a tax payment to a certain country, the beneficiary account number must
be 9 or 10 alphanumeric characters and payment details must not exceed 32 SWIFT-compliant
characters.

1.2

About This Book

This guide describes Service Oriented Architecture (SOA) services that enable 3rd party applications to
interface with GPP. It includes information about these SOA fine grain services:


ValidateSTPRules



LoadSTPRules

Global PAYplus Service-Oriented Architecture Guide

Page 5

STP Validation

STPRuleService Description

2.1

Functional Description

For more information, see Introduction.

2.2

Pre-requisites (N/A)

2.3

Service Function

Perform either the Validate STP Rule Fine Grain Service or Load STP Rule Fine Grain Service.

2.4

Inputs (N/A)

2.5

Processing (N/A)

2.6

Output (N/A)

2.7

Fine Grain Services

2.7.1

ValidateSTPRules

2.7.1.1

Service Overview

2.7.1.2

Prerequisites

2.7.1.3

Service Function (N/A)

2.7.1.4

Input

Note: Unlike other services, in this service the credentials are not part of the service input parameters
Parameter

Tag Name

Format

D+H message

+Msg

ISO based details

++Pmnt

Any pre-defined ISO-based payment
type (example PAIN 001 or PACS
008)

D+H extension

++Extn

D+H extension attributes. See Table
1: D+H Extension Attributes for some
highlights and explanations

Global PAYplus Service-Oriented Architecture Guide

Comment
A known structure (such as D+H
message format)

Page 6

STP Validation

STPRuleService Description

An example of possible input values located under the D+H message structure.
Table 1: D+H Extension Attributes
Parameter

Tag Name

Format

Processing info.

ProcessingPersistentInfo

Office

+P_OFFICE

Office information is taken into
account when accessing the
relevant static data.

Department

+P_DEPARTMENT

Department is required for
entitlement checks

Debit side info.

DebitSide

An example of an input that
requires validation (assuming
there is proper setup in the
system to evaluate the field
structure)

Debit account
number

+P_DBT_ACCT_NB

Debit account number to
validate

Processing interim
attributes

ProcessingTransientInfo

Field ID to validate

+D_STP_FIELDS_TO_VALI
D

String
{0..1}

Comment

This optional field defines a
specific attribute for validation.
If not provided, the service
validates the input of each field
that is present.

Global PAYplus Service-Oriented Architecture Guide

Page 7

STP Validation

2.7.1.5

STPRuleService Description

Processing

The STP validation service can be activated in two different modes:


Full mode: Where the payment is fully validated against all of the Validation profile fields.



Partial mode: Where the service receives a list of Payment fields that need to be validated against
the payment.

The service follows the following processing steps:
1 . STP Validation Load Service: To enable a third party to perform the STP validation checks outside
of GPP, it is possible to perform a load call to the service. In this case, GPP responds with the
following details:


Payment details



Payment type (as described below)



STP validation profile (as described below)

2 . Define Payment type:
a. If Payment type is provided (P_PAYMENT_TP is not null), then skip this step.
b. If Payment type is not provided, then assess Payment type selection business rules and select
Payment type for the payment.
i.

If the business rule action = STOP or no matching rule is found, leave P_PAYMENT_TP
field empty and fail the service (prompt error #60046).

ii.

If a matching profile is found, continue processing (assess a Manipulation rule if found over
the profile).

3 . Define STP Validation profile: The purpose of this phase is to define a profile with a list of
validations. It is expected that there will be two different type of profiles:


Profiles with the same name as the payment type



Profiles with a new/unique name.

The processing described below allows selection of either, as follows:
a. Assess the STP validation selection business rules.
i.

If a STOP action is defined, use the payment type as a profile name.

If a selected profile is not found – terminate the service with a proper error.

ii.

If no matching action is found, prompt error #.

iii. If a profile is selected, continue as described below.
b. Following the service mode (full or partial), validate all profile fields (in full mode) or selective list
of fields (in partial mode) versus the payment attribute.
c.

Perform ALL validations for each Payment field, i.e. min/max length, char. Set etc.)

Global PAYplus Service-Oriented Architecture Guide

Page 8

STP Validation

STPRuleService Description

Note: Continue processing even if a validation fails.
d. Validate all relevant profile fields.
e. Set message error for every failed validation.
f.

If the field is not found over the message, which may happen with an undefined UDF, prompt
the following errors #60050, 60051, 60052, 60053, 60054, 60055, 60056 and 60057

g. If at least 1 validation error occurred, create validation entry errors in message error.
h. If all validations passed:

Continue processing

ii.

Service passed validation

If no error is found, assess the Field Validation rules.
i.

These rules may create soft or hard errors (depending on the validation rule setup)

If no error is found, assess the Field Manipulation rules

Perform Message Validation rules assessment. These assessments allow for the creation of
more complex validations rules (conditional rules: if field X exist then field Y should also exists)

If Message Validation rules passed, assess Message Manipulation rules.

2.7.1.6

Output

D+H message is returned. It includes the errors that may be found per validation (see Table5: Message
Errors) and some generic response information (see Table 4: Generic Output Attributes).
Table 2: Output
Parameter

Tag Name

Format

D+H message

+Msg

A known structure (such as D+H
message format)

ISO based
details

++Pmnt

Any pre-defined ISO-based payment
type (example PAIN 001 or PACS
008)

D+H extension

++Extn

D+H extension attributes

Message errors

+++MsgErrors

Specific validation errors that were
created due to STP Validation profile
assessment. See Table5: Message
Errors.

Global PAYplus Service-Oriented Architecture Guide

Comment

Page 9

STP Validation

STPRuleService Description

Table 3: Message Errors
Parameter

Level

Format

Comment

M_MSGERR_LINE

F_MSGERR_CODE

Number

Error code for the failed validation as
specified setup by the error profiles

F_MSGERR_TIME_STAMP

Time

Time stamp.

Place holder for repetitive possible
errors

Example: 2011-01-06 13:36:35.851
F_MSGERR_SEVERITY

Number

A severity level as defined by the
error profile.

F_MSGERR_CREATE_DAT
E

Time

Error create date.
Example: 2011-01-04T23:16:35

F_MSGERR_TIME_ZONE

(A..Z,0..9)

Office time zone. Example: ‘EST’

{3,3}
F_MSGERR_PARAMS

String

Binding parameters when an error
uses a dynamically derived
information. Different binding
parameters are divided by @@
Example: @@Dbt acct
nb@@STRING@@@@,@@5@@S
TRING@@

F_MSGERR_FIELD_LOGIC
AL_ID

String

The field ID that failed validation.
Example: ‘P_DBT_ACCT_NB’

Table 4: Generic Output Attributes
Parameter

Level

ResponseDetails

returnCode

Format

Comment
Response details

Number

Holds the service error code.
Set to zero when a passed service
validation.
Example: 60093

description

String

Holds the service failure description.
Example: ‘STP validation failure’

Global PAYplus Service-Oriented Architecture Guide

Page 10

STP Validation

STPRuleService Description

Return code where code 0 means that validation passed.

2.7.2

LoadSTPRules

2.7.2.1

Service Overview

This service returns the related reference data (STP Validation and Char Set profiles) so that the
information is available for a third party to perform the validation. This service is invoked by a third
party, and GPP only returns the related reference data.
2.7.2.2

Prerequisites

2.7.2.3

Service Function (N/A)

2.7.2.4

Input

Parameter

Tag Name

Format

Comment

Header

--------

Service definitions

Body

--------

Service detailed information

Load STP Rules
Request

+loadSTPRulesRequest

---------

Name of the service Load STP
Rules Request

Request message

++Msg

---------

Any declared and known
message

Payment info.

+++Pmnt

---------

Any information that resides
under the ISO based section of
the message

Extension info.

+++Extn

---------

Any information that resides
under the D+H extension
section of the message

Processing info.

++++ProcessingPersist
entInfo

---------

Payment type

+++++P_PAYMENT_T
P

String
{1..1}

Customized
message attributes

++++UserDefinedFields

---------

Level

+++++System

Payment category

++++++PMT_CTGORY

Global PAYplus Service-Oriented Architecture Guide

Mandatory Payment type
attribute

Defines the level of the
customized fields (system, office
or customer)
String
{0..1}

Page 11

STP Validation

2.7.2.5

STPRuleService Description

Processing

1 . Ensure payment type attributes is provided.
a. If not provided, generate an appropriate error #60046.
2 . Select STP rules selection business rule
a. If a rule is not found, find an STP profile under the exact name of the provided payment type.
b. If not found, generate error #60047.
3 . Return the selected STP validation rule information.
2.7.2.6

Output

Parameter

Tag Name

L Format

Comment

Body

Response body

Load STP
Rules
Response

+loadSTPRulesResponse

1 ‘loadSTP
RulesRes
ponse’
{1..1}

Name of the service
‘loadSTPRulesResponse’

Message STP
Rules

++messageStpRules

2 {0..n}

D+H extension attributes

STP Profile
Name

+++MESSAGE_STP_RULES_
NAME

3 String

STP Profile name

STP Profile
description

+++MESSAGE_STP_RULES_
DESCR

3 String

STP Profile
record status

+++REC_STATUS

3 ‘AC’

STP Profile
unique profile
ID

+++UID_MESSAGE_STP_RUL
ES

3 String

Message STP
Field Rule

++messageStpFieldRule

Repetitive list of different
validation rules.

Message STP
Field Rule Line

+++messageStpFieldRuleLine

3 {0..n}

See Table 5: STP Validation
Profile Fields

{1..1}

Global PAYplus Service-Oriented Architecture Guide

STP Profile description

{1..1}
STP Profile record status
(always expect ‘AC’ for active
entry)
STP profile unique ID

{1..1}

Page 12

STP Validation

STPRuleService Description

This table specifies the list of attributes that are set (and returned) in the STP Validation profile and,
where required, from the Character Set profile. For an explanation about each field, refer to the GPP
User Guide.
Table 5: STP Validation Profile Fields
Element name

UI Field name

Example

FIELD_LOGICAL_ID

Field ID

P_DBT_ACCT_NB

FIELD_LOGICAL_ID_XPATH

/FndtMsg/Msg/Extn/Extn/ProcessingPersi
stentInfo/DebitSide/P_DBT_ACCT_NB

SPECIAL_CAPTION_CODE

Special caption code

True

STATE_IN_MESSAGE

State in message

STATE_IN_TEMPLATE

State in template

FIELD_DATA_TYPE

N/A

STRING

MIN_LENGTH

Min. length

MAX_LENGTH

Max. length

Precision
CONTENT_SOURCE

combo ID

P_=28

CASE_FORMAT

Case definition

CHAR_SET_IND

Char set validation

I (see Table 6 Char Set Profile Attributes
when this field value is set to ‘V’)

CHAR_SETS

Char set

ABCD

DEFAULT_VALUE

Default

MIN_VALUE

Min. value

MAX_VALUE

Max. value

VALIDATION_RULES_IND

Special validation rule

false

MANIPULATION_RULES_IND

Manipulation Rule

false

UID_MESSAGE_STP_FIELD_
RULE

N/A

FEDWIRE^P_DBT_ACCT_NB

Global PAYplus Service-Oriented Architecture Guide

Page 13

STP Validation

STPRuleService Description

List of relevant character set attributes where CHAR_SET_IND is set to ‘V’
Table 6 Char Set Profile Attributes
Element name

UI field name

Example

CHAR_LIST

Char list

0123456789

SPACE_IND

Include space

false

LINE_FEED_IND

Include line feed

false

CARRIAGE_RETURN_IND

Include carriage
return

false

2.8

Errors

This list is comprised of system validation errors that are set and managed by the user and system
generated errors that are prompted by the system.
Table 7: Errors
Code

Description

60060

Value '[Field value]' of STP field '[STP field alias]' does not exist in following list: [Related
content source list]

60061

Validation failed for STP field [STP field alias] Rule action: [Rule action]

60046

No payment type was selected

60047

Payment type [Payment type] is not defined in the system

60048

No STP rule was defined for payment type [Payment type]

60049

Field [Field logical ID] is not defined in the system

60050

STP rule for the following field is not provided: [Field logical ID]

60051

STP field '[STP field alias]' is marked as mandatory but has no value

60052

STP field '[STP field alias]' is marked as hidden but has a value in it

60053

Length of STP field '[STP field alias]' value is less then defined minimum length: [Defined
min length]

60054

Length of STP field '[STP field alias]' value is greater than defined maximum length:
[Defined max length]

60055

Precision of STP field '[STP field alias]' value is less then defined field precision: [Defined
field precision]

Global PAYplus Service-Oriented Architecture Guide

Page 14

STP Validation

STPRuleService Description

Code

Description

60056

Value of STP field '[STP field alias]' value is less then defined minimum value: [Defined min
value]

60057

Value of STP field '[STP field alias]' value is greater than defined maximum value: [Defined
max value]

60058

No char sets can be derived for STP field [STP field alias]. MESSAGE_STP_FIELD_RULE
UID: [MESSAGE_STP_FIELD_RULE UID]

28560

A generic error has occurred while trying to perform this action

Global PAYplus Service-Oriented Architecture Guide

Page 15

STP Validation

Examples

3.1
3.1.1

Validation Mode Example
Request

Input parameters are: execution date, instruction ID, instruction amount and currency and debit account
number.

2009-05-04

PT_TST_1_1

5000

US1
PSV

1234567

Global PAYplus Service-Oriented Architecture Guide

Page 16

STP Validation

3.1.2
3.1.2.1

Examples

Response
Passed validation

Web service return code 0 along with elapsed time indication

[STPRules]:6.375

3.1.2.2

Failed validation

There are 2 return codes. 1 (60053) per field that was defined by the user in the STP validation profile
and one (60093) for the service final error code.

60053
2011-01-06 13:36:35.851

Global PAYplus Service-Oriented Architecture Guide

Page 17

STP Validation

Examples

0
2011-01-04T23:16:35
EST

@@Dbt acct nb@@STRING@@@@,@@5@@STRING@@
0
P_DBT_ACCT_NB

[STPRules]:2.784

60093
STP validation failure

3.2
3.2.1

Load Mode Example
Request

Input parameters for load service are: extension information such as office & department, debit account
details, payment type & payment category

US1
PSV

22222222
USD
US1

FEDWIRE

1234

Global PAYplus Service-Oriented Architecture Guide

Page 18

STP Validation

Examples

3.2.2

Response

This is an extract from the entire service response.
It includes a list of STP rule profiles (named: MESSAGE_STP_RULES_NAME &
MESSAGE_STP_RULES_DESCR) and then a list of all associated messageStpFieldRule (different
validations that are associated with the profile)

FEDWIRE
Fed Wire validation profile
AC
FEDWIRE

***^ABC01634

O
O

false
false
FEDWIRE^***^ABC01634

Global PAYplus Service-Oriented Architecture Guide

Page 19

STP Validation

Appendix A: Glossary

Appendix A: Glossary
The table below lists the terms used in this document.
Term

Description

Financial Institution

GPP

Global PAYplus Services Platform

ISO

International Organization for Standardization

PACS

Payments Clearing and Settlement

PAIN

Payment Initiation

SOA

Service-Oriented Architecture

STP

Straight-Through Processing

SWIFT

Society for Worldwide Interbank Financial Telecommunication

Global PAYplus Service-Oriented Architecture Guide

Page 20

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Language                        : en-US
Tagged PDF                      : Yes
XMP Toolkit                     : Adobe XMP Core 5.2-c001 63.139439, 2010/09/27-13:37:26
Format                          : application/pdf
Creator                         : D+H
Description                     : STP Validation
Title                           : Service-Oriented Architecture Guide
Create Date                     : 2017:06:19 18:25:19+03:00
Creator Tool                    : Microsoft® Word 2013
Modify Date                     : 2017:06:19 18:25:27+03:00
Metadata Date                   : 2017:06:19 18:25:27+03:00
Producer                        : Microsoft® Word 2013
Document ID                     : uuid:a2c7175d-7e30-46c6-bd3c-4022d55b1043
Instance ID                     : uuid:5c1e3c95-e633-4f34-a163-07417239c801
Page Mode                       : UseOutlines
Page Count                      : 20
Author                          : D+H
Keywords                        : Global, PAYplus
Subject                         : STP Validation

EXIF Metadata provided by EXIF.tools

Service Oriented Architecture Guide GPP SOA STP Validation

Navigation menu

Versions of this User Manual:

Views

Navigation