QMS – Gateway

API
Integration Specification Document

Dec 27, 2022

Version 2.1
 Contents

1.1. Incoming Flow.........................................................................................................................1

1.2. Outgoing Flow.........................................................................................................................1
2.1. APIs Exposed by QMS...........................................................................................................1
2.1.1. Receive Ack/Nack from IMS Gateway.............................................................................1
2.1.2. Receive Message from IMS............................................................................................1
2.2. APIs Exposed by Gateway.....................................................................................................1
2.2.1. Send messages/requests to IMS.....................................................................................1
1. High Level Workflow

1.1. Incoming Flow

1.2. Outgoing Flow

2. Integration

2.1. APIs Exposed by QMS

2.1.1. Receive Ack/Nack from IMS Gateway

The following is the specification and message structure for Ack-Nack API that need to be consumed.

Method Type : POST

Method Name : acks
URL : /acks
Purpose : To receive Ack/Nack from IMS
DEV URL : http://192.168.45.19:30160/intg/acks
QA URL : http://192.168.45.60:30160/intg/acks

Request:

Parameter Type: Header

Name Type Size Required Description

Basic Auth Basic Authorization - Base64 encoded value of
Authorization M
username and password.
 E.g: Authorization: Basic
YWRtaW46YWRtaW4kMQ==

Username: admin
Password: admin1$

Parameter Type: Body

Name Type Size Required Description

NUMBER Response Code. E.g: 0/1
statusCode 1 M

AN Response Description
statusComment 40 M

message

ALPHA
type 10 O Type of Message. E.g: 103
NUMERIC
ALPHA Unique Id/ Reference id passed in the header
refId 20 M
NUMERIC of sendtoIMS req

direction ALPHABET 10 M Inward/Outward wrt to EPH

Status of the messages. Eg:

status ALPHABET 20 M
ACK_RCVD/NACK_RCVD
ALPHA
content NUMERIC 500 M Message encoded in base64

Sample Response Received:

Success Response:

Case 1: ACK ack_Req

Case 2: NACK nack_Req

Response:

Parameter Type: Body

Name Type Size Required Description

NUMBER Response Code
code 1 M
 0 – Success(Succesfully submitted to QMS)
1 – Failure(Internal Server Error)
AN Response Status. Eg: success,failure
status 1 M

AN Response Description
message 40 M

Response Sent: ackNack_Resp

2.1.2. Receive Message from IMS

The following is the specification and message structure for the Receive from IMS (sendToQms) that
must be consumed.

Method Type : POST

Method Name : messages
URL : /messages
Purpose : To receive Response from IMS
DEV URL : http://192.168.45.19:30160/intg/messages
QA URL : http://192.168.45.60:30160/intg/messages

Request:

Parameter Type: Header

Name Type Size Require Description

d
Basic Auth Basic Authorization - Base64 encoded value of
Authorization M
username and password.
E.g: Authorization: Basic
YWRtaW46YWRtaW4kMQ==

Username: admin
Password: admin$1

Parameter Type: Body

Name Type Size Required Description

AN Unique Id / User Reference
code 40 M
 description AN 25 O Message description

message

AN Query type
type 10 M

id AN 25 M Unique id

content AN 10 O Message encoded in base64

Sample:

Sample Request: messages_Req

Response:

Parameter Type: Body

Name Type Size Required Description

NUMBER Response Code
code 1 M
0 – Success(Succesfully submitted to QMS)
1 – Failure(Internal Server Error)
AN Response Status. Eg: success, failure
status 1 M

AN Response Description
message 40 M

Response Sent: messages_Resp

2.2. APIs Exposed by Gateway

2.2.1. Send messages/requests to IMS

The following is the specification and message structure for the sendToIMS API that must be consumed.

Method Type : POST

Method Name : sendToIMS
URL : /sendToIMS
Purpose : To send messages/requests to IMS
DEV URL : http://192.168.45.19:30160/intg/sendToIMS
QA URL : http://192.168.45.60:30160/intg/sendToIMS

Request:

Parameter Type: Header

Name Type Size Required Description

Basic Auth Basic Authorization - Base64 encoded value
Authorization M
of username and password.
E.g: Authorization: Basic
YWRtaW46YWRtaW4xJA==

Username: admin
Password: admin

Parameter Type: Body

Name Type Size Required Description

dataHeader
Timestamp Current Date. Format: yyyy-MM-
timestamp M
dd'T'HH:mm:ss.SSSZ

E.g: 2022-09-20T12:41:32.330+0530
AN Unique Id / User Reference
uniqueId 40 M

data

type AN 25 O Type of Message e.g. "pacs.008", “PROP”, etc.

content AN M Message encoded in base64

encoding AN 10 M base64

paymentChannel AN 10 M Payment Channel. E.g: SWIFT

Addenda (Optional and Repetitive tag)

Key AN O Name of the additional parameter

 Value AN O Value of the additional parameter

Sample:

Sample Request: sendToIms_Req

Response:

Parameter Type: Body

Name Type Size Required Description

Header
Timestamp Current Date. Format: yyyy-MM-
timestamp M
dd'T'HH:mm:ss.SSSZ
AN Unique Id / User Reference
uniqueId 40 M

response

type AN 25 O Type of Message

statusCode N 6 M Success Code – 001 (Successfully processed

the message)
statusComment AN 200 O Response Description
Eg: Request Received

Sample:

Success Response: sendToIms_Resp