Service Oriented Architecture GPP SOA Guide Actions On Payments
User Manual: Pdf
Open the PDF directly: View PDF 
.
Page Count: 40
| Download | |
| Open PDF In Browser | View PDF |
Global PAYplus Version 4.6.2
Actions on Payments
Service-Oriented Architecture
Copyright
© 2009-2016 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
license of the product described herein.
Catalog ID: GPP4.6-00-S03-03-201603
Actions on Payments
Version Control
Version Control
Version
Date
1.0
Summary of Changes
Document Created
2.0
Aug 2015
Document restructured on new template.
3.0
Nov 2015
Rebranded on new template.
Global PAYplus Service-Oriented Architecture
Page 3
Actions on Payments
Table of Contents
Table of Contents
1
INTRODUCTION .......................................................................................................................... 5
1.1
1.2
2
Overview ............................................................................................................................... 5
Target Audience .................................................................................................................... 5
MESSAGE LOAD SERVICE DESCRIPTION ............................................................................. 6
2.1
2.2
2.3
2.3.1
2.3.2
2.4
2.5
2.6
2.6.1
2.6.2
2.6.3
2.6.4
3
Overview ............................................................................................................................... 6
Service Function ................................................................................................................... 6
Input ...................................................................................................................................... 6
Output Request ................................................................................................................. 7
Processing ......................................................................................................................... 9
Output ................................................................................................................................... 9
Errors .................................................................................................................................... 9
Examples .............................................................................................................................. 9
Example 1: Ad-hock Structure - Load Specific Payment Fields........................................ 9
Example 2: Presets with Output Mode FULL + Convert to SWIFT 103 .......................... 11
Example 3: Non-existing MID .......................................................................................... 18
Example 4: Presets with Output Mode ORIG_PERSISTENT_DATA ............................. 19
MESSAGESUBMITSERVICE DESCRIPTION .......................................................................... 22
3.1
3.2
3.3
3.3.1
3.4
3.5
3.6
3.7
3.7.1
3.7.2
3.7.3
3.7.4
4
Overview ............................................................................................................................. 22
Service Functions................................................................................................................ 22
Input .................................................................................................................................... 23
Service Input Table Legend ............................................................................................ 23
Processing .......................................................................................................................... 23
Output ................................................................................................................................. 25
Errors .................................................................................................................................. 25
Examples ............................................................................................................................ 26
Example 1: Manual Creation of a Payment..................................................................... 26
Example 2: Final Approve of an Existing Payment ......................................................... 29
Example 3: Cancel a Payment ........................................................................................ 31
Example 4: When an Action is not Allowed for the Queue ............................................. 33
ERRORS .................................................................................................................................... 37
4.1
4.2
4.3
Generic Errors ..................................................................................................................... 37
Static Data Related Error Codes......................................................................................... 38
Message Processing Related Error Codes ......................................................................... 38
APPENDIX A ........................................................................................................................................ 39
List of System Users.......................................................................................................................... 39
List of System Entitlements ............................................................................................................... 39
Document Preservation ..................................................................................................................... 39
Message Load Service .................................................................................................................. 39
Message Submit Service ............................................................................................................... 39
APPENDIX B: GLOSSARY .................................................................................................................. 40
Global PAYplus Service-Oriented Architecture
Page 4
Actions on Payments
1
Introduction
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
Overview
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.
GPP processes and manages payments. As part of the message processing flow, the payment is
always associated with a message status (msg sts). When a payment reaches the end of processing,
the status is Complete. Where a payment is being held for manual intervention, it would be set to
Repair or any other available/relevant status.
To be able to handle payments outside of GPP, the following standalone services are used:
•
QueueListService: Provides a list of payments which meet a given selection criteria and are
filtered by user restrictions, for example, it will include a list of all payments that meet the
combined criteria of the input, such as payments with same message status that the user has
permissions to view. For more information, see GPP SOA Guide Queue List Service.
•
MessageLoadService: Loads a specific payment, i.e. the third party application gets all payment
details
•
MessageSubmitService: Takes a manual action on a specific payment, such as Submit or Cancel
This document describes the last two services and focuses on the ability to simulate the UI ability to
load and take action on payments. For more information about the QueueListService, see GPP SOA
Queue List Service document.
1.2
Target Audience
This book describes GPP web services that are based on a Service-Oriented Architecture (SOA)
concept which enables 3rd party applications to interact with GPP.
Global PAYplus Service-Oriented Architecture
Page 5
Actions on Payments
2
Message Load Service Description
Message Load Service Description
2.1
Overview
This service enables a user to retrieve full or partial data for a single payment transaction, based on
the unique payment ID (MID).
The service also enables a user to retrieve the output in a different message format. For example, the
original payment message type is pain.001, and the user can request to receive the output as
message type pacs.008.
2.2
Service Function
This service supports the single MessageLoadService method only.
2.3
Input
The table below describes the required input parameters.
The L column lists the level for each parameter, which is the element level in the file. The + indicators
in Tag Name column are accordance to the level number.
Parameter
Tag Name
L Format
Comment
Header
Header
0
Request header
D+H
Header
+FndtHeader
1
Service Header
Credentials
++Credentials
2 {1..1}
Credentials
User ID
+++UserID
3 String
{1..1}
A valid GPP user (see List of System
Users). User name is case sensitive.
Use the exact user name.
The user must have the following
credentials: User exists, and active
(status = AC) and not logged in
(LOGGED_IN <> 2)
User
Entitlement
code
+++Role
3 String
{1..1}
A valid GPP entitlement profile (see List
of System Entitlements).
Credentials check: The entitlement
exists and assigned to the login user.
Also where applicable the relevant
access permission is granted.
Body
Body
0 {1..1}
Service Body
Request
details
+PerformMessage
LoadRequest
1 {1..1}
Request details
Audit user
++UserID
2 String
{0..1}
Audit user only. This input is not being
validated. Where applicable, this would
be used as the audit user
++P_MID
2 String
(length
16) {1..1}
Message ID
Unique
Inputs
MID
Global PAYplus Service-Oriented Architecture
Page 6
Actions on Payments
Parameter
Message Load Service Description
Tag Name
L Format
Output
request
Comment
Payments are stored in D+H message
structure in the database. Where not
specified, the output would be D+H
message (as-is). The following options
(one of 2) are allowed. And one of them
must be present.in the input.
Ad-hock
structured
++fndtMsgSubset
2 {0..1} or
An ad-hoc defined structure that is
defined by this element. Allows
retrieving specific information about a
payment.
Presets
++ParseOutputMode
2 {0..1}
A preset of allowed outputs. FULL,
ORIG_PERSISTENT_DATA,
PERSISTENT_DATA. (See section
Presets for Further Details)
2.3.1
origPmntConversionType
Defines the original XML message
structure.
Possible values: AS IS (the output
would be exactly what is stored in GPP
database), or xml type from Xml Type.
pmntConversionType
Defines the outgoing XML message
structure.
If empty, the output will be the same as
set in the database (i.e. AS-IS). If not
empty, can get a value from Xml Type.
Requesting a specific output format (the
service converts the input format).
Output Request
The service output may provide one of the following structures:
2.3.1.1
Ad-hock Structure
This structure enables retrieving partial data available for a single payment, based on the payment
unique ID (MID). The input shall include the specific logical fields requested by the user.
(See Example 1: Ad-hock Structure - Load Specific Payment Fields.)
2.3.1.2
Presets
This structure enables retrieving data available for a single payment, based on the payment unique ID
(MID). The returned output fields will be determined by the input’s output mode.
This table shows the allowed Output Modes for Presets:
Output Mode
Support Type
Output Provided
FULL
Fully supported
ALL MINF Relational columns
All Monitor Fields
All User Defined Fields
Updated Xml pmnt Section
Original Message
Global PAYplus Service-Oriented Architecture
Page 7
Actions on Payments
Output Mode
Message Load Service Description
Support Type
Output Provided
Msg Extension
ORIG_PERSISTENT_DATA
Fully supported
Original Message
Msg Extension (if provided)
PERSISTENT_DATA
Fully supported
ALL MINF Relational columns
All Monitor Fields
All User Defined Fields
Updated Xml pmnt Section
This table is an extract from system tables: XML_DOCUMENT_TYPES for the different
DOCUMENT_ID. It shows the Applicable XML Types that can be used as a preset for each.
Xml Type
Support Type
ACMT_023
As-is
ACMT_024
As-is
CAMT_052
As-is
CAMT_054
As-is
EXTN
As-is
FNDT_MSG
As-is
MOP_OUT
As-is
N90
As-is
N91
As-is
N92
As-is
N95
As-is
N96
As-is
N98
As-is
N99
As-is
Pacs_002
As-is
Pacs_004
As-is
Pacs_008
As-is
Pacs_009
As-is
Pain_001
As-is
Pain_002
As-is
SWIFT_103
As-is
SWIFT_190
As-is
SWIFT_191
As-is
SWIFT_192
As-is
SWIFT_195
As-is
SWIFT_196
As-is
SWIFT_199
As-is
SWIFT_202
As-is
SWIFT_202COV
As-is
Content
Also PACS_00801 is version 001 support is required.
Global PAYplus Service-Oriented Architecture
Page 8
Actions on Payments
Xml Type
Support Type
SWIFT_210
As-is
SWIFT_290
As-is
SWIFT_291
As-is
SWIFT_292
As-is
SWIFT_295
As-is
SWIFT_296
As-is
SWIFT_299
As-is
SWIFT_400
As-is
SWIFT_401
As-is
SWIFT_402
As-is
SWIFT_900
As-is
SWIFT_910
As-is
2.3.2
Message Load Service Description
Content
Processing
1. A query is constructed and a single payment is fetched.
2. The payment may be converted as requested in the output request.
3. When no message is found, the relevant error is returned.
Note: This service can be used for both payments and templates.
2.4
Output
The output depends on the input parameters. That is, either a response that is taking an extract of the
message (see Example 1: Ad-hock Structure - Load Specific Payment Fields) or a full message with
the ability to convert the original/outgoing XML to any message type.
2.5
Errors
This table shows the relevant Error Messages:
Code
Description
77782
Message was not found for MID [MID not found in MINF]
See also Errors.
2.6
Examples
2.6.1
Example 1: Ad-hock Structure - Load Specific Payment Fields
Invoke the service with an existing MID (10801N3428AO0448) request for specific attributes (logical
fields) from MINF (Message information table in the DB).
2.6.1.1
Request
SERVICES
ADMIN
audit3
10801N3428AO0448
2.6.1.2
Response
WAIT_CONFIRMATION
636.36
USD
PSV
PAY
Pain_001
US1
2010-04-20
2010-08-02 00:03:16.956
Global PAYplus Service-Oriented Architecture
Page 10
Actions on Payments
Message Load Service Description
AUD
50006789
700
USD1SACITIUS33XXX
CRSCCY
8552502
700
US1SACOMPUS33XXX
BOOK
US1^STANDARD
[MessageLoad]:5.684
0
2.6.2
Example 2: Presets with Output Mode FULL + Convert to SWIFT 103
Invoke the service with an existing MID (1042984940CK0208) request for FULL (one of the use
presets) and convert the original payment format (Message type pain.001) into message type SWIFT
103 xml format.
2.6.2.1
Request
MASTERUSER
ADMIN
1042984940CK0208
audit3
FULL
2.6.2.2
Response
Global PAYplus Service-Oriented Architecture
Page 11
Actions on Payments
Message Load Service Description
1042984940CK0208
2008-0625T06:19:06
CTv422-001
2010-05-02
USD
755.00
CTv41-52
USD
755.00
CTv422-8/2008-06-25
CRED
BOFAUS31XXX
22222222
THE US COMPANY
CITIUS33XXX
3333421212
40171
2010-04-29 18:59:54.367
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
40171
2010-04-29 18:59:54.366
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
40171
Global PAYplus Service-Oriented Architecture
Page 12
Actions on Payments
Message Load Service Description
2010-04-29 18:59:54.365
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
40171
2010-04-29 18:59:54.364
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
40171
2010-04-29 18:59:54.363
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
40171
2010-04-29 18:59:54.362
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
40035
2010-04-29 18:59:54.361
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
@@2010-0303@@STRING@@@@,@@PROCESSING@@STRING@@@@,@@SLA-PROCS@@STRING@@
false
1001
2010-04-29 18:59:54.360
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
@@PEND_APPROV@@STRING@@@@,@@SCHEDULE@@STRING@@
false
40090
ADMIN2
2010-04-29 08:49:40.472
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
@@Submit@@STRING@@
false
40171
ADMIN2
2010-04-29 08:49:40.471
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
Global PAYplus Service-Oriented Architecture
Page 13
Actions on Payments
Message Load Service Description
40171
ADMIN2
2010-04-29 08:49:40.470
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
40171
ADMIN2
2010-04-29 08:49:40.469
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
false
1001
ADMIN2
2010-04-29 08:49:40.468
2010-04-29T00:00:00
2010-04-29T00:00:00
EST
@@(RECEIVED)@@STRING@@@@,@@PEND_APPROV@@STRING@@
false
USER1
LINE 1 TEXT
2010-04-29 08:49:42.025
2010-04-29 08:49:42
(EST)
true
//NoteFile1.txt
AC
USD
33334567812
US1
755
false
USD1SACITIUS33XXX
BOOK
US1^STANDARD
CRBOFA
2010-05-02
USD
22222222
US1
755
false
US1SACOMPUS33XXX
BOOK
US1^STANDARD
DRBOFA
2010-05-02
755
USD
US1^BASE
Global PAYplus Service-Oriented Architecture
Page 14
Actions on Payments
Message Load Service Description
US1
false
PSV
PAIN001
0
0
PAY
COMPLETE
Pain_001
false
US1
US1SACOMPUS33XXX
Pain_001
FEDWIRE
900
2010-05-02
HVP
false
2010-05-02 14:54:01.528
false
SLA-CLEAR
B
2010-05-02T15:30:00
SLA-PROCS
B
2010-05-02T18:00:00
SLA-TRSURY
B
2010-05-02T18:00:00
1234
X
X
X
X
X
X
X
X
X
X
X
X
N
B
N
X
P
X
X
X
X
S
X
X
X
Global PAYplus Service-Oriented Architecture
Page 15
Actions on Payments
Message Load Service Description
X
P
X
X
X
H
102030
US
US1SACOMPUS33XXX
THE US COMPANY
CU
PSV
7878712
111, WALL STREET
TEST2 ADDRESSS
8585
NEW YORK
IE
CITIBANK N.A.
CITIUS33XXX
10043
false
IN
false
false
false
BOOK
false
SA
1
false
false
false
false
false
BOOK
false
SA
1
false
false
CITIUS33XXX
[MessageLoad]:558.9982
Global PAYplus Service-Oriented Architecture
Page 16
Actions on Payments
Message Load Service Description
CTv422-001
2008-06-25T06:19:06
THE US COMPANY
US1SACOMPUS33XXX
2009-05-04
THE US COMPANY
US1SACOMPUS33XXX
22222222
USD
BOFAUS31XXX
SHAR
CTv41-52
CTv422-8/2008-06-25
755
CRED
CITIUS33XXX
3333421212
Global PAYplus Service-Oriented Architecture
Page 17
Actions on Payments
Message Load Service Description
US1
PSV
22222222
USD
US1
Submit
1234
1
//NoteFile1.txt
LINE 1 TEXT
USER1
2010-0126T18:42:42.914+02:00
AC
0
2.6.3
Example 3: Non-existing MID
Invoke service with a non-existing MID (10729B4917DE3425) - service returns a fail response.
2.6.3.1
Request
MASTERUSER
ADMIN
10729B4917DE3425
audit3
FULL
Global PAYplus Service-Oriented Architecture
Page 18
Actions on Payments
2.6.3.2
Message Load Service Description
Response
28560
Message was not found for MID |1
28560
Message was not found for MID 10729B4917DE3425
2.6.4
Example 4: Presets with Output Mode ORIG_PERSISTENT_DATA
Invoke the service with an existing MID (1042984940CK0208) request for
ORIG_PERSISTENT_DATA (one of the use presets). No format conversion is required.
2.6.4.1
Request
YUVBOFA
ADMIN
audit3
1042984940CK0208
ORIG_PERSISTENT_DATA
2.6.4.2
Response
1042984940CK0208
Global PAYplus Service-Oriented Architecture
Page 19
Actions on Payments
Message Load Service Description
2010-05-02 14:54:01.528
[MessageLoad]:13.054
CTv422-001
2008-06-25T06:19:06
THE US COMPANY
US1SACOMPUS33XXX
TRF
2009-05-04
THE US COMPANY
US1SACOMPUS33XXX
22222222
USD
BOFAUS31XXX
SHAR
CTv41-52
CTv422-8/2008-06-25
755
CRED
CITIUS33XXX
Global PAYplus Service-Oriented Architecture
Page 20
Actions on Payments
Message Load Service Description
3333421212
US1
PSV
22222222
USD
US1
Submit
1234
1
//NoteFile1.txt
LINE 1 TEXT
USER1
2010-0126T18:42:42.914+02:00
AC
0
Global PAYplus Service-Oriented Architecture
Page 21
Actions on Payments
3
Message Submit Service Description
Message Submit Service Description
3.1
Overview
This service creates a new message in GPP or amends an existing one. The service includes some
action button validations (i.e., the action button is allowed for the message status) and some payment
attributes validations (for example, mandatory attributes are set correctly), as well as user
authorization to perform the action.
The service can accept a batch (i.e. multiple payments) or a single payment action.
3.2
Service Functions
This service only supports a single method: MessageSubmitService.
This table lists the possible action buttons available for use in the service:
Button ID
Description
Submit
Performs validations and processes the payment when a new
message is manually created.
Reject
Prompts a rejection (PACS 002) for a payment
CancelTemplate
Cancels/deletes a templates
Approve
Releases the payment/template into the processing flow from the
Pending Approval status queue
CreatePaymentFromTemplate
Receives the template ID Receives the template ID and changed
fields, and generates individual/multiple payments (in this case,
the payment information is derived from the template and from
the quick fill fields).
Step 1 – Get the list of templates that belong to the selected
template set (by user). For this step use the GetQueueListService
with the operator In Template Set.
Step 2 – Generate individual/multiple payments by sending the
template ID and the fields that the user entered (such as value
date and amount).
Send to Repair
Sends the payment to Repair status
Save
Saves payment without performing validation (set payment status
to Timed Hold)
AcceptDupex
Confirms the payment is not a duplicate for payments that are
waiting in possible duplicate queue
Cancel Request
Initiates the cancellation process. That is, changing message
status to Pending cancellation request from which a user can
either RefuseCancel or Cancel the payment.
RefuseCancel
Refuse to cancel a payment (for a cancellation request). Payment
returns to its previous status
Cancel
Sends payment to Cancel status queue
Validate
Returns all errors without saving the payment
FinalApprove
Perform final approval step for pending approval messages
Note: An additional capability is to store user notes for every action that will be associated with the
message. These notes are defined as internal or external notes. Each note may contain a link to a
reference file. Some notes can be accessed and edited.
Global PAYplus Service-Oriented Architecture
Page 22
Actions on Payments
3.3
Message Submit Service Description
Input
•
A subset of D+H standard message
•
These Input Parameters must be part of the input request:
Mandatory extension fields for MessageSubmitService input.
Parameter
Tag Name
L
Format
Comment
Extension
Extn
0
{1..1}
D+H Extension
Persistent
Information
+ProcessingPersiste
ntInfo
1
{1..1}
Office
++P_OFFICE
2
String
{0..1}
A 3 letter code from BANKS table in the
DB
Department
++P_DEPARTMENT
2
String {0..1}
The relevant Office Department code
Operational
instructions
+OperationalSection
1
{1..1}
Action
name
++D_BUTTON_ID
2
String {1..1}
3.3.1
The action name is a valid button ID
taken from MESSAGEBUTTONS table
(See Action Buttons)
Service Input Table Legend
The table explains the symbols used in the Service Input tables.
Symbol
Description
L
Element level in the file
++++
Shows the element indentation
3.4
Processing
Input validations that include:
1. Action button exists (MESSAGEBUTTONS.BUTTONID) AND.
2. Message button is allowed for the message status (P_MSG_STS).
a. Assess Message fields sets selection system rule to identify the relevant button screen set
(see list of Screen SetScreen Set).
These are the Screen Sets for the Different Message Statuses:
Condition
Screen set
[P_MSG_STS] = APPROVE_CANCEL
WSI_STTN_APPR_CNCL
[P_MSG_STS] = COMPLETE AND [P_IS_HISTORY] = 2
WSI_STTN_CMPLT_TMP
[P_MSG_STS] = DUPEX
WSI_STTN_DUPX
[P_MSG_STS] = NAK
WSI_STTN_NAK
[P_MSG_STS] = PEND_APPROV
WSI_STTN_PND_APPR
[P_MSG_STS] = (RECEIVED)
WSI_STTN_RCVD
Global PAYplus Service-Oriented Architecture
Page 23
Actions on Payments
Message Submit Service Description
Condition
Screen set
[P_MSG_STS] = REPAIR
WSI_STTN_RPR
[P_IS_HISTORY] = 2 AND [P_MSG_STS] = REPAIR
WSI_STTN_RPR_TMPLT
[P_MSG_STS] = SCHEDULE
WSI_STTN_SCHED
[P_MSG_STS] = VERIFY
WSI_STTN_VRFY
With screen set defined, assess the available action buttons for the screen and make sure the
provided button ID is allowed for this screen set:
Screen Set
Message Status
Button ID
WSI_STTN_CMPLT_TMP
Complete templates
Submit
WSI_STTN_CMPLT_TMP
Complete templates
CreatePaymentFromTemplate
WSI_STTN_APPR_CNCL
Approve cancel
Approve
WSI_STTN_APPR_CNCL
Approve cancel
RefuseCancel
WSI_STTN_APPR_CNCL
Approve cancel
Reject
WSI_STTN_PND_APPR
Pending approval
Approve
WSI_STTN_PND_APPR
Pending approval
Cancel
WSI_STTN_PND_APPR
Pending approval
CancelTemplate
WSI_STTN_PND_APPR
Pending approval
FinalApprove
WSI_STTN_PND_APPR
Pending approval
Reject
WSI_STTN_PND_APPR
Pending approval
Submit
WSI_STTN_RPR_TMPLT
Repair template
CancelTemplate
WSI_STTN_DUPX
Possible duplicate
AcceptDupex
WSI_STTN_CMPLT_TMP
Complete templates
CancelTemplate
WSI_STTN_CMPLT_TMP
Complete templates
Reject
WSI_STTN_CMPLT_TMP
Complete templates
Send to Repair
WSI_STTN_DUPX
Possible duplicate
Cancel
WSI_STTN_DUPX
Possible duplicate
Reject
WSI_STTN_DUPX
Possible duplicate
Submit
WSI_STTN_DUPX
Possible duplicate
Validate
WSI_STTN_RCVD
Received
Save
WSI_STTN_RCVD
Received
Submit
WSI_STTN_RCVD
Received
Validate
WSI_STTN_RPR
Repair
Cancel
WSI_STTN_RPR
Repair
Save
WSI_STTN_RPR
Repair
Validate
WSI_STTN_RPR
Repair
Submit
WSI_STTN_SCHED
Schedule
Cancel
WSI_STTN_NAK
NAK
Send to Repair
WSI_STTN_NAK
NAK
Cancel
Global PAYplus Service-Oriented Architecture
Page 24
Actions on Payments
3.5
Message Submit Service Description
Output
•
Successful creation of a new message in GPP repository (MINF table)
•
A D+H message format is returned, along with a message ID that was associated with the
message
This table is an extract from D+H message showing the important additional derived information that
is returned together with the response.
Parameter
Tag Name
Format
Comment
Message ID
P_MID
String {1..1}
Message unique ID in GPP
Message status
P_MSG_STS
String {1..1}
The queue where the payment is. This
would be MSG_STATUS from
STATUSES system table
Time stamp
P_TIME_STAMP
Date time {1..1}
Server time representing the last time
the message was modified
Payment/Template
indicator
P_IS_HISTORY
[0,2]{1..1}
Valid Values:
0 - Active Partition
1 - Historical Partition
2 - Templates Partition
3.6
Errors
Code
Description
40037
Party cannot be found. Invalid account
number: [invalid account number].
40039
Unable to identify 1st in credit chain
40040
Unable to identify 1st in debit chain
40041
Failed to derive account number
40078
Sender ([Original Sender BIC]) has no debit
authorization on account number ([Debit
account number]) (BIC = [Debit party BIC])
40083
Party cannot be found. Invalid ABA: [Invalid
ABA].
40079
Initiating party [Name of the party] has no
debit authorization on account number
[Debit account number]
Debit authorization check has been failed
40102
Payment status does not allow cancellation
Error message which will be issued when
cancellation request cannot be processed
because the original payment status does
not allow cancellation
40161
Payment future value date (|1) is greater
than the MOP max extension (|2)
60019
Dbtr is empty
60020
Dbtr BIC is invalid
60021
Dbtr Agent ID is invalid
60022
Dbtr Agent BIC is invalid
60023
Instg Rmbrsmnt Agent is empty
Global PAYplus Service-Oriented Architecture
Notes
Debit authorization check has been failed
Page 25
Actions on Payments
Code
Description
60024
Instg Rmbrsmnt Agent BIC is invalid
60025
Instd Rmbrsmnt Agent is empty
60026
Instd Rmbrsmnt Agent BIC is invalid
60027
Thrd Rmbrsmnt Agent is empty
60028
Thrd Rmbrsmnt Agent BIC is invalid
60029
Intrmy Agent1 should be empty
60030
Intrmy Agent1 is empty
60031
Intrmy Agent1 BIC is invalid
60032
Cdtr Agent is empty
60033
Cdtr Agent BIC is invalid
60034
Cdtr is empty
60084
The action ButtonID used in the submit
action is not allowed for a message with
status Current message status
60035
Cdtr BIC is invalid
40199
Cancel action is not permitted on a
Template pending Future changes
40200
No action is permitted on a Template
pending Future changes
Message Submit Service Description
Notes
See also Generic Errors.
3.7
Examples
3.7.1
3.7.1.1
Example 1: Manual Creation of a Payment
Request
Provide payment details and action button (D_BUTTON_ID) as submit.
SERVICES
ADMIN
audit3
Global PAYplus Service-Oriented Architecture
Page 26
Actions on Payments
Message Submit Service Description
CTv422-002
2008-06-25T06:19:06
false
1
700
GRPD
THE US COMPANY
US1SACOMPUS33XXX
TRF
2009-05-04
THE US COMPANY
US1SACOMPUS33XXX
8552502
EUR
BOFAUS31XXX
AD_27
Csa40E-27
731
CRED
CITIUS33XXX
3333421212
Global PAYplus Service-Oriented Architecture
Page 27
Actions on Payments
Message Submit Service Description
GDDS
CINV
ABC-13679
2009-05-04
US1
PSV
Submit
10C02A4104J00231
0
PEND_APPROV
2010-12-02 10:41:06.134
Global PAYplus Service-Oriented Architecture
Page 28
Actions on Payments
Message Submit Service Description
Use Case 2: Message already exists (payment is created but moving to possible duplicate queue)
10C02A3752KR0425
6042
2010-12-02 10:37:53.726
2010-11-30T20:17:53
EST
0
0
DUPEX
05
2010-12-02 10:37:53.775
3.7.2
Example 2: Final Approve of an Existing Payment
Provide payment reference (P_MID), payment time stamp (P_TIME_STAMP) and action button
(D_BUTTON_ID) as FinalApprove.
3.7.2.1
Request
SERVICES
ADMIN
Global PAYplus Service-Oriented Architecture
Page 29
Actions on Payments
Message Submit Service Description
audit3
11313E2230DI0630
US1
PSV
2011-03-13 14:22:31.887
FinalApprove
3.7.2.2
Response
Use case 1: The Final Approval step was performed for a payment in pending approval status. (Final
approve button is available for this status)
11313E2230DI0630
0
COMPLETE
2011-03-13 14:23:26.432
Use case 2: The final approval step was performed for a payment in Repair status. (Final approve
button is not available for this status), the user gets error code 60084 meaning: The action
FinalApprove is not allowed for a message with status REPAIR.
Global PAYplus Service-Oriented Architecture
Page 30
Actions on Payments
Message Submit Service Description
true
11313E1430EZ0219
60084
2011-03-13 14:15:34.242
0
2011-03-13T03:45:34.24205:00
EST
@@ @@STRING@@@@,@@ @@STRING@@
0
0
REPAIR
2011-03-13 14:14:31.342
3.7.3
Example 3: Cancel a Payment
Cancel processing flow to an existing payment by providing the MID and the action button cancel.
3.7.3.1
Request
SERVICES
ADMIN
muli2
Muli 2
10B29H2451640188
US1SACOMPUS33XXX
2011-09-26
US1
PSV
2010-11-29 17:24:51.905
0
Cancel
Global PAYplus Service-Oriented Architecture
Page 32
Actions on Payments
Message Submit Service Description
3.7.3.2
Response
Message ID is cancelled.
true
10B29H2451640188
40227
2010-12-02 10:51:41.613
0
2010-11-30T20:31:41
EST
@@ @@STRING@@
0
0
CANCELED
2010-12-01 15:52:26.772
3.7.4
Example 4: When an Action is not Allowed for the Queue
•
Message is in PEND_APPROVE and user tries to perform retract
•
First step – create the message (also demonstrates the quick fill button):
3.7.4.1
Request
Global PAYplus Service-Oriented Architecture
Page 33
Actions on Payments
Message Submit Service Description
SERVICES
ADMIN
audit3
2009-05-04
CTv41as
AA0018
905.00
US1
PSV
TEMPLATE_UPDATEaf
10A04K1340292853
CreatePaymentFromTemplate
3.7.4.2
Response
Global PAYplus Service-Oriented Architecture
Page 34
Actions on Payments
Message Submit Service Description
10C23F4124960431
0
PEND_APPROV
TEMPLATE_UPDATEaf
TEMPLA
2010-12-23 15:41:25.738
Second step – button ID is Retract.
3.7.4.3
Request
SERVICES
ADMIN
audit3
10C23F4124960431
US1
PSV
2010-12-23 15:41:25.738
Retract
Global PAYplus Service-Oriented Architecture
Page 35
Actions on Payments
Message Submit Service Description
3.7.4.4
Response
true
10C23F4124960431
60084
2010-12-23 15:42:41.331
0
2010-12-22T01:22:41
EST
@@ @@STRING@@@@,@@ @@STRING@@
0
0
PEND_APPROV
TEMPLATE_UPDATEaf
TEMPLA
2010-12-23 15:41:25.738
Global PAYplus Service-Oriented Architecture
Page 36
Actions on Payments
4
Errors
Errors
4.1
Generic Errors
Code
Description
28560
An error has occurred while trying to perform this
action
40087
Service [service name] failure
40071
[Office name] is not a valid Office
40127
Service [service name] failure, (last step: [Last step
name])
3104
Payment currency should equal to debit account or
credit account currency
Error message reported when
neither the Debit nor Credit
account's currency is in the
payment's currency. Message is
routed to the Repair queue.
10002
Interface severe error during processing. Reason:
[Reason for the crash]
The Alerts are generated as part of
the transaction and thus are either
persisted into MQ or the entire
transaction is rolled back and the
alert will be generated when the
transaction is completed after the
system is available again
40104
Rule type ID [Rule type ID] – [Rule type description]
- was not found
Error message which will be
issued when message processing,
mandatory rule type was not
found, (e.g. department, business
area, payment classification etc)
60000
The data content of this field may not contain a / as
its first character, nor as its last character; nor may it
contain // (two consecutive slashes) anywhere
within its contents.
60001
Instr Id is empty
60002
Instr Id length should not exceed 16 characters
60003
Instr Id format is invalid
60004
Instr Id is invalid, should not start or end with a slash
/ and should not contain two consecutive slashes //.
60005
Sttlm date is empty
60006
Sttlm ccy is empty
60007
Sttlm amount is empty
60008
Sttlm date is invalid
60009
Year in the Sttlm date is invalid
60010
Sttlm ccy is invalid
60011
Sttlm amount is invalid. Number of decimal digits in
amount exceeds maximum allowed for the currency
60012
Sttlm amount is invalid, the integer part of amount
should contain at least one digit
60013
Decimal separator in Sttlm amount is incorrect,
should be a single comma
Global PAYplus Service-Oriented Architecture
Notes
Office was not found in cache
Page 37
Actions on Payments
Errors
Code
Description
60014
Instd ccy/Instd amount is empty
60015
Instd ccy is invalid
60016
Instd amount is invalid
60017
Instd amount is invalid, the integer part of amount
should contain at least one digit
60018
Decimal separator in Instd amount is incorrect,
should be a single comma
4.2
Notes
Static Data Related Error Codes
Code
Description
Notes
77787
Input parameter(s) [missing parameter names] missing.
An input parameter is missing.
4.3
Message Processing Related Error Codes
Code
Description
Notes
77782
Message was not found for MID
[missing MID]
MID not found in MINF
3104
Payment currency should equal
debit account or credit account
currency
Error message reported when neither the Debit nor
Credit account currency is in the payment's
currency. Message is routed to the Repair queue.
Global PAYplus Service-Oriented Architecture
Page 38
Actions on Payments
Appendix A
Appendix A
List of System Users
GPP users are specified in the System User menu, or in DB in USERS table. For more information,
see GPP Online Help.
List of System Entitlements
GPP users are associated with an appropriate entitlement. Entitlement is a profile in GPP specified in
the Entitlement menu. For more information, see GPP Online Help.
Document Preservation
Message Load Service
Maintenance
Query
Any change in message attributes
Select t.* from LOGICAL_FIELDS
List of supported documents
Select DOCUMENT_ID from
XML_DOCUMENT_TYPES
List of supported message output values
Select distinct XML_TYPE
from LOGICAL_FIELDS_XPATH
union
select distinct FORMAT_TYPE from
XML_FORMAT_TYPE_RELATIONS
Message Submit Service
Maintenance
Query
List of messages that are
allowed for creation
MESSAGEBUTTONS.AVAILABLE_FOR_PAYMENT_CREATION
<> 0
List of message buttons
Select BUTTONID, BUTTONDESCRIPTION from
MESSAGEBUTTONS
Service screen sets
Select PRULES.CONDITIONS_AS_TEXT,
PRULES.RULE_ACTION
from OBJECT_PRULES
inner join PRULES
on PRULES.UID_PRULES = OBJECT_PRULES.RULE_UID
where OBJECT_PRULES.RULE_TYPE_ID = 108 and RULE_UID
such as %WSI%;
List of applicable action
buttons per message status
Select *
from MESSAGE_FIELDS_SETTING
where FIELDS_GROUP_ID = SERVICES_INTERFACE
Global PAYplus Service-Oriented Architecture
Page 39
Actions on Payments
Appendix B: Glossary
Appendix B: Glossary
This table lists the terms used in this document:
Term
Description
GPP
Global PAYplus
Logical field ID
Messages attribute description. With GPP use of logical fields that
are associated to different XML paths, it is possible to define a
message attribute, its type, its display name and other attributes. For
example, the Sttlm amt describes the settlement amount of the
outgoing payment. The logical field ID is used behind the scenes
and is unique (X_STTLM_AMT)
LOGICAL_FIELDS_XPATH
Describes a different XML path location & element name for the
logical field ID for different message types (like PACS008, PAIN
001).
For example: X_STTLM_AMT has different XML path in PACS 008
(/IntrBkSttlmAmt tag name: IntrBkSttlmAmt).
Note that the path may be a relative path. For full path, refer to the
parent path ID that is specified under the logical field.
MID
Message ID –a unique identifier generated by GPP for each
Created/Incoming payment
MINF
Message information table in the database. Stores all messages in
the system. Primary key: P_MID
PACS
Payments Clearing and Settlement.
PAIN
Payment Initiation.
PDO
Payment Data Object (PDO)
SOA
Service-Oriented Architecture
Global PAYplus Service-Oriented Architecture
Page 40
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Author : D+H Category : Global PAYplus Version 4.6.2 Company : COMMERCIAL IN CONFIDENCE Content Type Id : 0x0101009A3327D2C2C93446A7CB9E3DCC9805D1 Create Date : 2016:03:29 15:31:20-04:00 Keywords : Global, PAYplus Modify Date : 2016:03:29 15:36:22-04:00 Source Modified : D:20160329193042 Subject : Actions on Payments Language : EN-US Tagged PDF : Yes XMP Toolkit : Adobe XMP Core 5.6-c015 81.157285, 2014/12/12-00:43:15 Metadata Date : 2016:03:29 15:36:22-04:00 Creator Tool : Acrobat PDFMaker 15 for Word Document ID : uuid:7941759c-b866-44a3-bc60-e6df5f40d9d9 Instance ID : uuid:7579383e-ff9c-4b8d-ada4-c931f90effe8 Format : application/pdf Title : Service-Oriented Architecture Description : Actions on Payments Creator : D+H Producer : Adobe PDF Library 15.0 Headline : Actions on Payments Page Layout : OneColumn Page Mode : UseOutlines Page Count : 40EXIF Metadata provided by EXIF.tools