Acceptance Model TSD
0
`
Technical Specification
Document - Acceptance Model v14
[Version 14]
Copyright © 2004-2024 NPCI ® All Rights Reserved
Acceptance Model TSD
1
`
National Payments Corporation of India (NPCI), Mumbai, Maharashtra, India the Programs, which
include both the software and documentation, contain information that is proprietary to National
Payments Corporation of India and its licensors; they are provided under a license agreement
containing restrictions on use and disclosure and are also protected by copyright and other intellectual
and industrial property laws. Except as may be expressly permitted in such license agreement, no part
of the Programs may be reproduced or transmitted in any form or by any means, electronic or
mechanical, for any purpose. The information contained in this document is subject to change without
notice. If you find any problems in the documentation, please report them to us in writing. This
document is not warranted to be error-free. NPCI product names are trademarks of National Payments
Corporation of India. Other names may be trademarks of their respective owners.
Acceptance Model TSD
2
`
Version Control Summary
Version Created by Released Date Reviewed by Remarks
Version14 Dhruvi Monga 09/04/2024 Anindita Joardar Updated acronyms,
Added API tables,
Updated the flow
diagrams as per the
testcase sheet(Refer 3);
Appendix Table
updated(Refer 6); Added
missing tags in ChkTxn
under ref tag and
Payment Credit(Refer
5.3)Added reference to
the docs(Refer 7)(See
highlighted)
Version Controls
Version
Number
Description Release Date Remarks
11 Technical Specification
Document (TSD) –
International Partner_V11
New model added under
section 4; API specification
updated with section 7
11.3 Technical Specification
Document (TSD) –
International
Partner_V11.3
08/11/2022 Check transaction flow added
(optional); section 7.2
updated; section 4.5 added;
new tag “baseCurr” added in
ReqValQr API ; Device tag
updated (correction);
11.4 Technical Specification
Document (TSD) –
International
Partner_V11.4
09/11/2022 TxnConfirmation added to
sponsor
11.6 Technical Specification
Document (TSD) –
International
Partner_V11.6
23/03/2023 Reverse acceptance model
removed; Appendix – Rules
updated;
12 Technical Specification
Document (TSD) –
International
Partner_V11.6
28/03/2023 Invoice tag definition added
13 Technical Specification
Document (TSD) –
International Partner_V13
10-05-2023 Payee à Amount tag and
orgTxnId description details
Acceptance Model TSD
3
`
TABLE OF CONTENTS
1. Introduction ................................................................................................... 4
1.1 Purpose ................................................................................................... 4
1.2 Scope ...................................................................................................... 4
1.3 Definitions/Acronyms ................................................................................... 4
2. Acceptance Flow ............................................................................................. 5
2.1 User Journey ............................................................................................. 5
2.2 Sample Use Cases: ....................................................................................... 6
2.3 Transaction Flow ........................................................................................ 8
2.4 QR Validation ............................................................................................ 8
2.5 Financial Flow ........................................................................................... 10
3. Acceptance Scenarios ...................................................................................... 11
3.1 Scenario 1: Success financial flow ................................................................... 11
3.2 Scenario 2: International entity response on ReqPay (Reversal) ................................ 12
3.3 Scenario 3: Transaction Timeout at international entity’s End (DEEMED) ..................... 13
3.4 Scenario 4: CREDIT failure ............................................................................ 14
4. List of API .................................................................................................... 16
5. API Specification (CREDIT to International merchant) .................................................. 17
5.1 Validation of QR ..................................................................................... 17
5.2 International Credit request/response ........................................................... 31
5.3 Check Transaction .................................................................................. 61
6. Appendix - Rules ............................................................................................ 71
7. References ................................................................................................... 92
Acceptance Model TSD
4
`
1. INTRODUCTION
Unified Payments Interface (UPI) is an instant payment system that facilitates interbank person-to-person
and person-to-merchant transactions.
Along with domestic payments, UPI also supports both Foreign Remittances and international merchant
payments.
Outward Remittance is a process of transferring money in the form of foreign exchange, by a resident
from a particular country, say India, to a beneficiary who is located outside the concerned country for
any purpose that is approved under the Foreign Exchange Management Act (FEMA).
The purpose of this document is to detail the Global UPI Acceptance flow wherein a domestic (Indian)
user travelling abroad and scanning UPI supported QR to make the payments to international merchants.
1.1 PURPOSE
The purpose of this document is to detail the Global UPI Acceptance flow and give an understanding of
person to merchant transactions. This outlines the API specifications along with transaction flow
scenarios.
1.2 SCOPE
The Scope of this document contains the following :
a. User Journey for the Acceptance Model(P2M FOR)
b. API specification and message structure of each API used in the acceptance flow.
1.3 DEFINITIONS/ACRONYMS
• Payer PSP – Bank, Payment Bank, PPI is allowed to acquire customers and provide payment
(credit/debit) services to individuals and entities.
Any Domestic Bank can provide Payment services or any app providers that enables Indian Customers
to make payment to international merchants.
• Remitter Bank (Debiting Bank / Customer’s bank) – Bank that Holds the customer’s account.
• UPI settlement bank/ beneficiary bank of International Network/ Partner – Domestic settlment bank
for International network. Any Indian Bank that is acts as a settelment banks
• Sponsor Bank –. The sponser bank is UPI certified bank that traverse the credit to the International
Merchant directly. Merchant is acquired by the sponsor bank directly.
Acceptance Model TSD
5
`
• UPI application/ customer application – An Application that initiates payment.
• IP - International Network/ Partner/Bank – International entity acquiring merchants.
Table of Abbreviations
NPCI National Payment Corporation of India
UPI Unified Payment Interface
iUPI International Stack of UPI
TPAPs Third Party Application Providers
aURCS Acceptance UPI Real Time Clearing and Settlement System
iURCS International UPI Real Time Clearing and Settlement System
PSPs Payment Service Providers
FX Foreign Exchange
VPA Virtual Payment Address
NPCI National Payment Corporation of India
IMA International Merchant Aggregator
IP International Partner
2. ACCEPTANCE FLOW
Acceptance model : An Indian User travelling abroad and scanning UPI supported International
QR to make a transaction.
2.1 USER JOURNEY
To complete a UPI transaction at an international merchant at all corridors is as given below-
1. User activates for international transaction on UPI application.
2. User needs to make the payment to merchant present at the Network approved international
corridors.
3. User initiates a payment to international merchant by scanning merchant QR code using UPI
application.
4. After he/she scans the QR, the app will display merchant details such as Merchant name and other
requisites on the UPI application.
5. After successful payment validation, the user enters his/her UPI Pin to authorize the transaction.
6. Once the transaction is authorized, the payment screen is displayed to user with success status.
*All International partners shall be referred to as IP/IRP in the doc*
Acceptance Model TSD
6
`
7. The merchant then receives confirmation of the payment and accordingly goods to be delivered to
the user.
There are two major flows depending upon the merchant being acquried by international network or by
UPI sponsor banks.
Presently, UPI supports following models for international payments:
1. International merchants acquired by international partner.
2. International merchants acquired by UPI domestic Banks.
2.2 SAMPLE USE CASES:
Example 1: International payment at merchant’s location using dynamic QR.
User- Mary who is on a one-month trip to a foreign country.
Need- To make a payment at the grocery store in the foreign country.
1) Mary asks the vendor to initiate the payment through UPI.
2) She uses her bank provided UPI application installed on her smartphone to scan the dynamic QR
code generated by the international grocery POS application.
3) The dynamic QR carries information about the UPI link of the merchant and the amount of
transaction.
4) UPI application takes her straight to pay screen with all values pre-populated from the QR.
5) UPI application displays info containing foreign currency, FX rate & payable INR value to Mary.
Mary verifies the information and click pay to complete the payment.
6) Both merchant and Mary get confirmation instantly.
Example 2: International payment at merchant’s location using proprietary static QR of International
merchant.
User- Aditya who is on a vacation to a foreign country.
Types of QR:
a. Dynamic QR – When a user scans the dynamic QR, UPI application displays payable amount
in the INR as well as the foreign currency, in addition to that the FX rate and applicable mark
up rate will be displayed on the upi app.
b. Static QR – When a user scans the static QR, UPI application only displays merchant
information and user shall be prompted to input the payable foreign amount. On the basis of
amount entered(payable amount), application displays subsequent INR amount with the
applicable FX and mark-up rate.
Acceptance Model TSD
7
`
Need- To make a payment at a gift shop in a foreign country to buy souvenirs.
1) Aditya is exploring the local markets in a foreign country on the last day of his trip.
2) He notices the decal of UPI at a local gift shop which has been acquired by the international
partner of UPI.
3) Aditya picks the souvenir and scans the proprietary QR of the International partner at the
payment desk through his BHIM UPI application.
4) The static QR carries information about the bank details of the merchant.
5) On scanning the QR, the application shows him the details of the merchant and prompts him to
enter the amount in foreign currency.
6) Aditya verifies the details shown on the application with the merchant.
7) Aditya enters the amount following which BHIM UPI application displays info containing foreign
currency, FX rate & payable INR value.
8) Aditya verifies the information and enters UPI Pin after clicking pay to complete the payment.
9) Both merchant and Aditya get confirmation instantly.
Acceptance Model TSD
8
`
2.3 TRANSACTION FLOW
Following is transaction flow for UPI international transaction.
Fig 1. Transaction Flow Diagram
2.4 QR VALIDATION
The ValQr API is used to validate the international QR. This API is a part of non financial leg. In addition
to the UPI domestic QR, UPI apps have to support international QR too . The aim of this API is to keep
the changes at the UPI app/PSP end very minimal even if UPI onboards any number of international
partners. UPI/PSP have to get International Partners onboarded to this API and this ensures that
they(International Partner) are able to scan any QR across the globe which is supported by UPI.
There are three major types of international QR. One would be the UPI QR itself having international
tags in it and another would be specific to the international network. There would be two model in each,
one static QR and another dynamic QR.
The PSP app should have the capability to differentiate between UPI domestic QR and any other QR. For
UPI domestic QR the PSP will follow the UPI Domestic process. This API also provides a streamlined way
of providing a response back to the PSP so as to construct the ReqPay invariable of the type of QR
international entity and sponsor banks.
Acceptance Model TSD
9
`
2.4.1 QR Validation Flow
Fig 2. QR Validation Flow Diagram: It shows the flow for QR Validation
A. Customer scans the international QR using UPI enabled app. In this flow the QR gets validated
followed by subsequent forex computation.
1. Payer PSP initiates ReqValQr containing the QR parameters along with the complete QR string as
a payload.
2. UPI identifies the network and accordingly convert or parse request and forward the same to
international networks/ sponsor bank. UPI forward the ReqValQr to the international network/
sponsor bank to validate and in response provide the details of merchant.
3. After validation of the QR, the network sends response to UPI. In case of multiple credit bank
accounts, international partner will provide the bank account details in the RespValQr in UPI
global address format.
4. UPI shall convert and parse the response from network/ sponsor bank and validate the details like
expiry time. After successful validation, UPI forward the RespValQr to the Payer PSP with the
following details which will be used by PSP to form the ReqPay.
➢ Network Institution Id (Unique ID for each international institution provided by UPI)
➢ Country Code
➢ Currency Code
➢ Conversion Rate
➢ Mark-Up percentage
➢ Payee UPI ID
➢ Merchant Block
➢ QR block
B. After successful validation, Payer PSP displays merchant information and payable amount to the
customer. Payer PSP then calculates the INR value based on the FX value & markup provided by UPI
in the RespValQr
Acceptance Model TSD
10
`
a. Static QR: Payer PSP prompts customer to enter the payable amount in the merchant
currency (other than INR) and PSP calculates equivalent INR value based on the FX value &
markup provided by UPI in RespValQr
b. Dynamic QR: Since dynamic QR already has the payable amount, payer PSP calculates the
equivalent INR amount and displays both amount payable in INR and merchant accepted
international amount to the customer.
2.5 FINANCIAL FLOW
After QR validation is successfully done, the customer validates the merchant payment information in
the application and authorizes the transaction using the valid Credentials (UPI PIN). Once the customer
inputs the PIN, the application initiates the payment request (Financial flow) to the UPI.
Fig 3. Financial flow diagram
Post QR validation by international enitity (international networks/ sponsor bank), customer
validates the payable amount (in International currency & equivalent INR) and authorises the
transaction by entering the UPI PIN.
1. Payer PSP initiates ReqPay to UPI containing the amount payable in INR and the Fx components.
1.a UPI secures Debit from the customer
2. UPI sends an international credit to entity connected with UPI for credit (transaction
confirmation) to international merchant
3. After merchant’s confirmation, International entity sends a response message to UPI.
4. UPI sends the final RespPay to the Payer PSP with the final status of the transaction.
Acceptance Model TSD
11
`
3. ACCEPTANCE SCENARIOS
This section enlists the scenarios and management of the timeouts and failures in the UPI transaction
lifecycle.
3.1 SCENARIO 1: SUCCESS FINANCIAL FLOW
1. Post securing DEBIT, UPI shall initiate ReqPay (CREDIT) to the international entity.
2. International entity sends successful CREDIT response to UPI.
3. UPI will close the transaction with status as success.
Fig 3. Success Financial Flow
Acceptance Model TSD
12
`
3.2 SCENARIO 2: ITERNATIONAL ENTITY RESPONSE ON REQCHKTXN(NPCI INITIATED)
1. In the following flow, international entity fails to send a response on international credit to
UPI.
2. After 30 seconds, UPI will initiate ReqChkTxn API to get the status of the CREDIT from the
International entity.
3. International Partner can respond to UPI with either of the following :
3a. IP responds with RespChkTxn with status as “SUCCESS”.
3b. IP responds with RespChkTxn with status as “FAILURE” and respective response codes(refer
Error code and Response code document).
4. UPI then close the transaction according to response in (3).
Fig 4. Flow in case there is ChkTxn Response from the international entity
3.3 SCENARIO 3: INTERNATIONAL ENTITY RESPONSE ON REQPAY (REVERSAL)
5. In the following flow, international entity fails to send a response on international credit to
UPI.
6. After 30 seconds, UPI will initiate ReqChkTxn API to get the status of the CREDIT from the
International entity.
7. If the ChkTxn leg times out, UPI shall initiate a ReqPay (REVERSAL) to the International Entity.
Acceptance Model TSD
13
`
8. International Entity can :
9. 4.a Confirm the CREDIT success by populating response code “CS” (CREDIT SUCCESS). UPI will
close the transaction as success.
4.b Confirm REVERSAL of credit with response code “00”. UPI considers this as credit failure
and continues for processing online debit reversal to the customer.
6. UPI wil close the status accordingly.
Fig 5. Flow in case there is Reversal Response from the international entity.
3.4 SCENARIO 4: TRANSACTION TIMEOUT AT INTERNATIONAL ENTITY’S END (DEEMED)
1. In the following flow, International partner fails to send a RespPay (CREDIT) to UPI.
2. After 30 seconds UPI will initiate ReqChkTxn API to get the status of the CREDIT from the
International entity.
3. If International partner fails to send a response for ReqChkTxn within 10 seconds.
4. UPI shall initiate a ReqPay (REVERSAL) to the International Entity and wait 30 seconds for a
response.
5. International partner fails to send a response for ReqPay (REVERSAL).
6. UPI will close transaction as complete credit timeout with status as DEEMED.
Acceptance Model TSD
14
`
Fig 6. Flow in case of timeout at international entity’s end
3.5 SCENARIO 5: CREDIT FAILURE
1. Post securing DEBIT, UPI shall initiate ReqPay (CREDIT) to the International Entity.
2. International entity sends RespPay (CREDIT) with a valid response/Error code in case of Failure.
3. UPI will consider the response/error and initiate DEBIT REVERSAL to the remitter bank.
4. Post successful DEBIT REVERSAL, UPI will close the transaction with status FAILURE.
Acceptance Model TSD
15
`
Fig 7. Failure Financial Flow
NOTE:
1.Response code to be populated as per the latest UPI_Error_and_Response_Codes document.
2.Test cases to be referred for various failure scenarios.
Acceptance Model TSD
16
`
4. LIST OF API
Sr. NO API Name Description of API
Non Financial Leg
1. ReqValQR
ValQr API is an API which is used to verify
the merchant’s QR string.
2. RespValQR
Financial Leg
3. ReqPay
Request Pay is an API for processing the
payment and is being done in :
a.) Debit (Processed by domestic
customer bank)
b.) Credit (Processed by IP) A.ReqPay(DEBIT)
B.ReqPay (CREDIT)
4. RespPay
Response Pay is an API for response from
the respective partners for debit credit
and reversal.
5. ReqChkTxn Request check Transaction is an API to
enquire about the payment status.
1. In case of timeout and failed scenarios,
check transaction is initiated by NPCI.
6. RespChkTxn Response check Transaction is an API for
response for the enquiry about the
payment status.
System Monitoring
7. ReqHbt Request Heartbeat and Response
Heartbeat is to check if the system is up
and running.
Note : Refer UPI Preface document 8. RespHbt
Acceptance Model TSD
17
`
5. API SPECIFICATION (CREDIT TO INTERNATIONAL MERCHANT)
This section enlists the UPI APIs to be used by international networks or sponsor banks to get CREDIT
for their merchants via UPI.
5.1 VALIDATION OF QR
This APIs is used by the Acquirer entity to validate the QR generated by them.
5.1.1 QR VALIDATION REQUEST (REQVALQR)
`
Tag Description Occurren
ce
Datatype Length Mandatory
M/O
Rules
API Name ReqValQr 1..1 M
API Schema
namespace
xmlns 1..1 Alphanum
eric
Min:1
Max:255
M
Header 1..1 Alphabetic Fixed
value
M
This field
indicates the
Version of the API
ver 1..1 Numeric Min:1
Max:6
M 019_Head_Version
This field
indicates the
Request time set
by the creator of
the message
ts 1..1 ISODate
Time
Min : 1
Max
:255
M 020_Head_ts
Acceptance Model TSD
18
`
This field
indicates the ID of
the Organization
that created the
message
orgId 1..1 Numeric Min : 1
Max :
20
M
This field
indicates the
Message
identifier- used to
correlate between
request and
response
msgId 1..1 Alphanum
eric
35 M 021_Head_MsgId
This field
indicates the Meta
data primarily for
analytics purposes
0..1 Alphabetic Fixed
value
O
This field
indicates the
Name of the
property
name 1..n Code Min : 1
Max :
20
M 099_Meta
This field
indicates the
Value of the
property
value 1..n ISODate Min : 1
Max :
255
M 099_Meta
This field
indicates the
Transaction
information,
Carried
throughout the
system which is
visible to all
parties
1..1 Alphabetic Fixed
value
M
This field
indicates the
Unique Identifier
of the
transaction across
all entities,
created by the
originator
id 1..1 Alphanum
eric
35 M 022_Txn_UID
This field
indicates
Remarks/ note
note 1..1 Alphanum
eric
Min : 1
Max :
50
M 067_note
Acceptance Model TSD
19
`
This field
indicates the
Consumer
reference number
to identify (like
Loan
number,consumer
account number,
etc.)
refId 1..1 Alphanum
eric
Min : 1
Max :
35
M 056_refId
This field
indicates the URL
for the
transaction
refUrl 1..1 Alphanum
eric
Min : 1
Max :
35
M 068_refUrl
This field
indicates the
Transaction
origination time
by the creator of
the message
ts 1..1 ISODateTi
me
Min : 1
Max :
255
M 020_Head_ts
This field
indicates the Type
of the Transaction
type 1..1 Code Min : 1
Max :
20
M 076_ValQr_type
069_txnType
This field
indicates the
Customer
reference number
provided by the
initiating party for
the initiated
transaction
custRef 1..1 Numeric 12 M 066_custRef
Acceptance Model TSD
20
`
This field
indicates the
Initiation mode
InitiationM
ode
1..1 Code Min : 1
Max :
35
M 031_Txn_Initiation
_mode
This field
indicates the
Purpose of the txn
purpose 1..1 Code Fixed
value
M 045_ReqPay_Txn_p
urpose
This field
indicates Details
related to the
Payer
1..1 Alphabetic Fixed
value
M
This field
indicates Address
of the Payer
addr 1..1 Alphanum
eric
Min : 1
Max :
255
M 072_addr
This field
indicates Name of
the Payer
name 1..1 Alphanum
eric
Min : 1
Max :
99
M 093_name
This field
indicates Unique
identifier for each
transaction inside
a file including
payer and payee.
(Default value
should be set to 1
except for
Autopay)
seqNum 1..1 Numeric Min : 1
Max :
3
M 063_seqNum
This field
indicates Type of
the Payer
type 1..1 Code Fixed
value
M 029_Payer/Payee_
Type
This field
indicates
Merchant
Classification
Code MCC
code 1..1 Numeric 4 M 024_Txn_code
This field
indicates the
Institution Block
Pyer.Institu
tion
1..1 M
This field
indicates The
Merchant QR
string.
QrPayLoad 1..1 String M 077_QrPayLoad
This field
indicates Network
Institution Id.
This is the Unique
network ID
assigned to
International
network by NPCI
netInstId 0..1 Alphanum
eric
Fixed
value
:10
O 084_netInstId
Acceptance Model TSD
21
`
This field
indicates the
Currency Code at
Merchant’s
location.
This field should
have a 3-digit
value as defined
by ISO4217.
baseCurr 1..1 Text Min : 1
Max : 3
O 079_baseCurr
Acceptance Model TSD
22
`
5.1.2 QR VALIDATION RESPONSE (RESPVALQR)
Acceptance Model TSD
23
`
Tag Description Occurrence Datatype Length Mandatory
M/O
Rules
API Name RespValQr 1..1 M
API Schema
namespace
xmlns 1..1 Alphanumeri
c
Min:1
Max:255
M
Header 1..1 Alphabetic Fixed
value
M
This field indicates
the Version of the
API
ver 1..1 Numeric Min:1
Max:6
M 019_Head_Ver
sion
This field indicates
the Request time
set by the creator
of the message
ts 1..1 ISODate
Time
Min : 1
Max :255
M 020_Head_ts
This field indicates
the ID of the
Organization that
created the
message
orgId 1..1 Numeric Min : 1
Max : 20
M
This field indicates
the Message
identifier- used to
correlate between
request and
response
msgId 1..1 Alphanumeri
c
35 M 021_Head_Msg
Id
This field indicates
the Meta data
primarily for
analytics purposes
0..1 Alphabetic Fixed
value
O
This field indicates
the Meta data
primarily for
analytics purposes
0..1 Alphabetic Fixed
value
O
This field indicates
the Name of the
property
name 1..n Code Min : 1
Max : 20
M
This field indicates
the Value of the
property
value 1..n ISODate Min : 1
Max :
255
M
Acceptance Model TSD
24
`
This field indicates
the Transaction
information,
Carried throughout
the system which is
visible to all
parties
1..1 Alphabetic Fixed
value
M
This field indicates
the Unique
Identifier of the
transaction across
all entities,
created by the
originator
id 1..1 Alphanumeri
c
35 M 022_Txn_UUID
This field indicates
Remarks/ note
note 1..1 Alphanumeri
c
Min : 1
Max :
50
M 067_note
This field indicates
the Consumer
reference number
to identify (like
Loan
number,consumer
account number,
etc.)
refId 1..1 Alphanumeri
c
Min : 1
Max :
35
M 056_refId
This field indicates
the URL for the
transaction
refUrl 1..1 Alphanumeri
c
Min : 1
Max : 35
M 068_refUrl
This field indicates
the Transaction
origination time by
the creator of the
message
ts 1..1 ISODateTime Min : 1
Max :
255
M 020_Head_ts
This field indicates
the Type of the
Transaction
type 1..1 Code Min : 1
Max :
20
M 076_ValQr.typ
e
This field indicates
the Customer
reference number
provided by the
initiating party for
the initiated
transaction
custRef 1..1 Numeric 12 M 066_custRef
This field indicates
the Initiation mode
InitiationM
ode
1..1 Code Min : 1
Max :
35
M 031_Txn_Initia
tion mode
Acceptance Model TSD
25
`
This field indicates
the Purpose of the
txn
purpose 1..1 Code Fixed
value
M 045_ReqPay_T
xn_purpose
This field indicates
the Reference
Category
refCategory 1..n Code Fixed
value
O 052_ReqPay_T
xn_refCategor
y
Qr Block 1..1 M 085_QrBlock
This field indicates
the version of UPI
QR being used.
qVer 1..1 Numeric Min : 1
Max : 6
M 086_qVer
This field indicates
QR generation
timestamp
ts 0..1 ISODateTime Min : 1
Max : 255
O 087_qr_ts
This field indicates
the QR medium tag
denotes Source
channel i.e.
creation point of
the QR.
qrMedium 0..1 Numeric Min :1
Max :99
O 088_qrMedium
This field indicates
QR Expiry date &
time Mapped to
‘QRexpire’
parameter in QR
string.
ExpireTs 0..1 ISODateTime Min :1
Max :255
O 089_ExpireTs
This field indicates
Query
query JSON O 090_query
This field indicates
Verification token
for QR request.
This will be passed
in the financial
request Reference
to International
partner for ValQr
and Financial
request generated
by the
International
Partner
verToken 0..1 String Min :1
Max :80
O 091_verToken
Acceptance Model TSD
26
`
This field indicates
STAN present in QR
It denotes the
value generated
and passed by the
acquiring bank for
internal
reconciliation
stan 0..1 String 6 O 092_stan
This field indicates
the Response
1..1 Alphabetic Fixed
value
M
This field indicates
the Error code if
failed
errCode 1..1 Alphanumeri
c
Min : 1
Max : 20
M 062_errCode
This field indicates
the Result of the
transaction
result 1..1 Code Min : 1
Max : 20
M 025_Response
_ApprovalNum
053_Response
_result
This field indicates
the Request
Message identifier
reqMsgId 1..1 Alphanumeri
c
35 M 060_reqMsgId
This field indicates
Details related to
the Payer
1..1 Alphabetic Fixed
value
O
This field indicates
Address of the
Payer
addr 1..1 Alphanumeri
c
Min : 1
Max :
255
M 072_addr
This field indicates
Name of the Payer
name 1..1 Alphanumeri
c
Min : 1
Max :
99
M 093_name
This field indicates
Unique identifier
for each
transaction inside a
file including payer
and payee.
(Default value
should be set to 1
except for
Autopay)
seqNum 1..1 Numeric Min : 1
Max : 3
M 063_seqNum
This field indicates
Type of the Payer
type 1..1 Code Fixed
value
M 029_Payer/Pay
ee_Type
This field indicates
Merchant
Classification Code - MCC
code 1..1 Numeric 4 M 024_Txn_code
This field indicates
the Institution
Block
1..1 M
This field indicates
The Merchant QR
string.
QrPayLoad 1..1 String M 077_QrPayLoa
d
Acceptance Model TSD
27
`
This field indicates
Network Institution
Id.
This is the Unique
network ID
assigned to
International
network by NPCI
netInstId 0..1 Alphanumeri
c
Fixed
value :10
O 084_netInstId
This field indicates
the country of the
merchant
acceptance device
conCode 1..1 Alphabet Fixed
value :2
M 094_conCode
This field indicates
Details related to
the Payees
1..1 Alphabetic Fixed
value
M
This field indicates
Details related to
the Payees
1..1 Alphabetic Fixed
value
M
This field indicates
the Address of the
Payee
addr 1..1 Alphanumeri
c
Min : 1
Max :
255
M 072_addr
This field indicates
the Name of the
Payee
name 1..1 Alphanumeri
c
Min : 1
Max : 99
M 093_name
Merchant
Classification Code
MCC
code 1..1 Numeric 4 Y 024_Txn_code
This field indicates
the unique
identifier for each
transaction inside a
file including Payee
and payer.
(Default value
should be set to 1
except for
AutoPay)
seqNum 1..1 Numeric Min : 1
Max : 3
M 074_seqNum
This field indicates
the Type of Payee.
type 1..1 Code Fixed
value
M 029_Payer/Pay
ee_Type
This field indicates
the Payee Identity.
1..1 Alphabetic Fixed
value
O
This field indicates
the Type of
Identifier.
type 1..1 Code Fixed
value
M
This field indicates
the Name as per
Identifier.
verifiedNa
me
1..1 Alphanumeri
c
Min : 1
Max : 99
M
This field indicates
the ID of the
Identifier.
id 1..1 Alphanumeri
c
Min : 1
Max : 99
M
Acceptance Model TSD
28
`
This field indicates
the rating of the
payee.
0..1 Alphabetic Fixed
value
O
This field indicates
the Verified
Address.
verified
Address
0..1 Code Boolean
TRUE/FAL
SE
O 026_Payer/Pay
ee_InfoRating
This field indicates
the details of
device from which
the transaction was
initiated.
1..1 Alphabetic Fixed
value
M
This field indicates
the details of the
device tag.
1..n Alphabetic Fixed
value
O 034_ReqPay_D
eviceDetails_
Values
This field indicates
the Name of the
property.
name 1..n Code Fixed
value
M
This field indicates
the Value of the
property.
value 1..n Alphanumeri
c
Min : 1
Max : 99
M
Only one entity is
allowed for a
payee.
1..1 Alphabetic Fixed
value
M
This field indicates
the Type of
address.
addrType 1..1 Code Min : 1
Max : 20
M 048_ReqPay_A
c_name_Accou
nt
This field indicates
the Details related
to Payee Address.
1..n Alphabetic Fixed
value
M 048_ReqPay_A
c_name_Accou
nt
This field indicates
the Name of the
property.
name 1..n Code Fixed
value
M
This field indicates
the Value of the
property.
value 1..n Alphanum Min : 1
Max : 99
M
This field indicates
to the information
related to the
amounts in the
transaction.
1..1 Alphabetic Fixed
value
O 055_Payee.Am
ount
This field indicates
the Transaction
amount.
value 1..1 Numeric minInclusi
ve: 0
totalDi
gits: 15
M 051_ReqPay_
Amount_Value
This field indicates
the Currency of the
Transaction.
curr 1..1 Text Min : 1
Max :3
M
Acceptance Model TSD
29
`
This field indicates
details of
Transaction
Amount.
0..1 Alphabetic Fixed
value
O
This field indicates
the Name of the
property.
name 1..n Code Fixed
value
M
This field indicates
the Value of the
property.
value 1..n Alphanu
meric
Min : 1
Max : 99
M
This field indicates
the Merchant
Block.
0..1 Alphabetic Fixed
value
M 037_ReqPay_
Payer/Payee_
MerchantTag
This field indicates
the Payee
Merchant
Identifier.
0..1 Alphabetic Fixed
value
O
This field indicates
the SubCode.
subCode 0..1 Code 4 O
This field indicates
the Merchant
Identifier.
mid 0..1 Alphanumeri
c
Min : 1
Max : 20
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field indicates
the Store Id.
sid 0..1 Alphanumeri
c
Min : 1
Max : 20
O 037_ReqPay_P
ayer/Payee_
MerchantTag
This field indicates
the Terminal
Identifier.
It is the POS
terminal identifier
value.
tid 0..1 Alphanumeri
c
Min : 1
Max : 20
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field indicates
the Merchant Type.
merchantT
ype
1..n Alphabetic Fixed
value
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field indicates
the Merchant
Genre.
merchantG
enre
0..1 Alphabetic Fixed
value
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field indicates
the Merchant
Onboarding Type.
onBoarding
Type
1..1 Alphabetic Fixed
value
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field indicates
the Merchant
Institution Code.
It is the unique ID
for each merchant
provided by the
acquiring party.
merchantIn
stCode
0..1 Alphanumeri
c
Min :1
Max :20
O 024_Txn_code
Acceptance Model TSD
30
`
This field indicates
the Payee
Merchant Name
0..1 Alphabetic Min : 1
Max : 99
M
This field indicates
the Brand Name.
brand 1..n Alphanumeri
c
Min : 1
Max : 99
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field indicates
the Legal Name.
legal 0..1 Alphanumeri
c
Min : 1
Max : 99
O 037_ReqPay_P
ayer/Payee_
MerchantTag
This field indicates
the Franchise
Name.
franchise 0..1 Alphanumeri
c
Min : 1
Max : 99
O 037_ReqPay_P
ayer/Payee_
MerchantTag
Type of Ownership Ownership
type
0..1 Alphabetic Fixed
value
O 038_ReqPay_M
erchant
This field indicates
the invoice details.
1..1 M
This field indicates
the Invoice Name.
name 1..1 Aplhanumeri
c
Min : 1
Max : 99
M 105_Payee.Me
rchant.Invoice
_name
This field indicates
the Invoice
Number.
num 1..1 Alphanumeri
c
Max :20 M 106_Payee.Me
rchant.Invoice
_num
This field indicates
the Invoice Date.
date 1..1 ISODateTime Min : 1
Max : 255
M 107_Payee.Me
rchant.Invoice
_date
This field gives the
Fx List.
1..1 M 054_Fxlist
This field denotes
the Fx rate details
1..n M
This field denotes
the Foreign
Payable Amount.
baseAmoun
t
1..1 Numeric Min
Inclusive
: 0
totalDigit
s: 15
M 102_payee.fx_
baseAmount
Acceptance Model TSD
31
`
This field indicates
the Currency Code
at Merchant’s
location.
This field should
have a 3-digit
value as defined by
ISO4217.
baseCurr 1..1 Text Min : 1
Max : 3
M 100_payee.fx_
baseCurr
This field indicates
active currency
active 1..1 M 101_payee.fx_
active
This field denotes
the Foreign
Exchange Rate.
Fx 1..1 Numeric Min
Inclusive
: 0
totalDigit
s: 15
M 103_payee.fx_
fx
This field gives the
Mark Up rate in
percentage.
The value in this
field should have
two digits after the
decimal point.
Example: If the
Mark Up rate is
2.5% then the value
in said field will be
,
Mkup = 2.50
Mkup 1..1 Numeric Min :1
Max :99
M 104_payee.fx_
mkup
This field gives the
last modified date
of the Foreign
Exchange (Fx).
lastModifie
dTs
0..1 ISODateTime Min :1
Max : 255
O
Note:
UPI will provide the final RespValQr with payee global address. The same needs to be used in the
financial ReqPay by Payer PSP.
5.2 INTERNATIONAL CREDIT REQUEST/RESPONSE
This API is used to initiate the payment request to the IP/sponsor bank for crediting the merchant.
(Refer section 3.4 for the flow)
5.2.1 INTERNATIONAL CREDIT REQUEST (REQPAY)
Acceptance Model TSD
32
`
Acceptance Model TSD
33
`
Tag
Description
Occurrence Datatype Length Mandatory
M/O
Rules
API Name 1..1 M
API Schema
namespace
xmlns 1..1 Alphanume
ric
Min:1
Max:255
M
Header 1..1 Alphabetic Fixed
value
M
Acceptance Model TSD
34
`
This field
indicates the
Version of
the API
ver 1..1 Numeric Min:1
Max:6
M 019_Head_Ver
sion
This field
indicates the
Request time
set by the
creator of
the message
ts 1..1 ISODate
Time
Min : 1
Max :255
M 020_Head_ts
This field
indicates the
ID of the
Organization
that created
the message
orgId 1..1 Numeric Min : 1
Max : 20
M 059_OrgId
This Field
indicate the
type of
product
prodType 0..1 Alphabetic Fixed
value
O 108_prodType
This field
indicates the
Message
identifier-
used to
correlate
between
request and
response
msgId 1..1 Alphanume
ric
35 M 021_Head_Msg
Id
Acceptance Model TSD
35
`
This field
indicates the
Meta data
primarily for
analytics
purposes
0..1 Alphabetic Fixed
value
O
This field
indicates the
Meta data
primarily for
analytics
purposes
1..1 Alphabetic Fixed
value
M
Acceptance Model TSD
36
`
This field
indicates the
Unique
Identifier of
the
transaction
across all
entities,
created by
the
originator
id 1..1 Alphanume
ric
35 M 022_Txn_UUID
This field
indicates
Remarks/
note
note 1..1 Alphanume
ric
Min : 1
Max :
50
M 067_note
This field
indicates the
Consumer
reference
number to
identify (like
Loan
number,
consumer
account
number,
etc.)
refId 1..1 Alphanume
ric
Min : 1
Max :
35
M 056_refId
This field
indicates the
URL for the
transaction
refUrl 1..1 Alphanume
ric
Min : 1
Max : 35
M 068_refUrl
This field
indicates the
Transaction
origination
time by the
creator of
the message
ts 1..1 ISODateTim
e
Min : 1
Max :
255
M 020_Head_ts
Acceptance Model TSD
37
`
This field
indicates the
Type of the
Transaction
type 1..1 Code Min : 1
Max :
20
M 001_ReqPay_P
ay
004_ReqPay_C
redit
006_ReqPa
y_CreditRever
sal
This field
indicates the
Original
transaction
ID when
reversal/Ref
und has to
be done
orgTxnId 1..1 Alphanume
ric
35 M 023_Txn_orgT
xnId
This field
indicates the
Customer
reference
number
provided by
the initiating
party for the
initiated
transaction
custRef 1..1 Numeric 12 M 066_custRef
This field
indicates the
Subtype of
transaction
subType 0..1 Code Min : 1
Max :
20
O 030_Txn_SubT
ype
This field
indicates the
Initiation
mode
InitiationMod
e
1..1 Code Min : 1
Max :
35
M 031_Txn_Initia
tion_mode
Acceptance Model TSD
38
`
This field
indicates the
OrgRespCode
of the
transaction
OrgRespCode 1..1 Alphanume
ric
Min : 1
Max :
20
O 039_ReqPay_
OrgRespCode
This field
indicates the
Purpose of
the txn
purpose 1..1 Code Fixed
value
M 045_ReqPay_T
xn_purpose
This field
indicates the
Original RRN
orgRrn 0..1 Numeric 12 O 065_orgRRN
This field
indicates the
Original Date
of the txn
orgTxnDate 0..1 ISODateTim
e
Min : 1
Max :
255
O 075_orgTxnDat
e
This field
indicates the
Reference
Category
refCategory 0..1 Code Fixed
value
O 052_ReqPay_T
xn_refCategor
y
This field
indicates
Risk Score
related to
the
transaction
and the
entities
0..1 Alphabetic Fixed
value
O
Acceptance Model TSD
39
`
This field
indicates
Risk Score
related to
the
transaction
and the
entities
0..n Alphabetic Fixed
value
O 095_Txn_riskS
core
This field
indicates
Entity
providing the
risk score
provider 1..1 Code Min : 1
Max :
20
M 080_provider
This field
indicates
Type of risk
type 1..1 Code Min : 1
Max :
99
M 096_Txn_riskS
core_Type
This field
indicates
Value of risk
evaluation
value 1..1 Integer Min : 1
Max :
50
M 097_Txn_riskS
core_Value
Qr Block 1..1 M 085_QrBlock
This field
indicates the
version of
UPI QR being
used.
qVer 1..1 Numeric Min : 1
Max : 6
M 086_qVer
This field
indicates QR
generation
timestamp
ts 0..1 ISODateTim
e
Min : 1
Max : 255
O 087_qr_ts
This field
indicates the
QR medium
tag denotes
Source
channel i.e.
creation
qrMedium 0..1 Numeric Min :1
Max :99
O 088_qrMedium
Acceptance Model TSD
40
`
point of the
QR.
This field
indicates QR
Expiry date
& time
Mapped to
‘QRexpire’
parameter in
QR string.
ExpireTs 0..1 ISODateTim
e
Min :1
Max :255
O 089_ExpireTs
This field
indicates
Query
query JSON O 090_query
This field
indicates
Verification
token for QR
request. This
will be
passed in the
financial
request
Reference to
International
partner for
ValQr and
Financial
request
generated by
the
International
Partner
verToken 0..1 String Min :1
Max :80
O 091_verToken
This field
indicates
STAN present
in QR
It denotes
the value
generated
and passed
by the
acquiring
bank for
internal
reconciliatio
n
stan 0..1 String 6 O 092_stan
This field
indicates
Details
related to
the Payer
1..1 Alphabetic Fixed
value
M
Acceptance Model TSD
41
`
This field
indicates
Address of
the Payer
addr 1..1 Alphanume
ric
Min : 1
Max :
255
M 072_addr
This field
indicates
Name of the
Payer
name 1..1 Alphanume
ric
Min : 1
Max :
99
M 093_name
This field
indicates
Unique
identifier for
each
transaction
inside a file
including
payer and
payee.
(Default
value should
be set to 1
except for
Autopay)
seqNum 1..1 Numeric Min : 1
Max : 3
M 063_seqNum
This field
indicates
Type of the
Payer
type 1..1 Code Fixed
value
M 029_Payer/Pay
ee_Type
This field
indicates
Merchant
Classification
Co–e - MCC
code 1..1 Numeric 4 M 024_Txn_code
This field
indicates the
Institution
Block
Pyer.Instituti
on
1..1 M
This field
indicates
The
Merchant QR
string.
QrPayLoad 1..1 String M 077_QrPayLoa
d
Acceptance Model TSD
42
`
This field
indicates
Network
Institution
Id.
This is the
Unique
network ID
assigned to
International
network by
NPCI
netInstId 1..1 Alphanume
ric
Fixed
value :10
M 084_netInstId
This field
indicates the
country of
the
merchant
acceptance
device
conCode 1..1 Alphabet Fixed
value :2
M 094_conCode
This field
indicates
Information
related to
the Payer
1..1 Alphabetic Fixed
value
M
This field
indicates
Payer
Identity
1..1 Alphabetic Min : 1
Max :
20
M Is mandatory
for “pay” and
optional for
“collect”
This field
indicates Id
of the
identifier
id 1..1 Alphanume
ric
Min : 1
Max :
99
M
This field
indicates
Type of the
identifier
type 1..1 Code Fixed
value
M 029_Payer/Pay
ee_Type
This field
indicates
Name as per
the
identifier
verifiedNam
e
1..1 Alphanume
ric
Min : 1
Max :
99
M
Acceptance Model TSD
43
`
This field
indicates
Rating of the
payer
0..1 Alphabetic Fixed
value
O
This field
indicates the
verified
Address
verified
Address
0..1 Code Boolean
TRUE/FAL
SE
O 026_Payer/
Payee_InfoRati
ng
This field
indicates
Details of
device from
which the
transaction
was initiated
1..1 Alphabetic Fixed
value
M
This field
indicates
Device Tag
1..n Alphabetic Fixed
value
M
This field
indicates
Name of the
property
name 1..n Code(MOBI
LE,GEOCOD
E,LOCATIO
N,IP,TYPE,I
D,OS,APP,C
APABILITY,
TELECOM
Fixed
value
M
This field
indicates
Value of the
property
value 1..n Alphanume
ric
Min : 1
Max : 20
M 034_ReqPay_D
eviceDetails_V
alues
035_ReqPay_D
eviceDetails_t
ype
036_ReqPay_D
eviceDetails_O
S
This field
indicates
Account
details of
the Payer
1..1 Alphabetic Fixed
value
M Only one
entity is
allowed for a
payer
Acceptance Model TSD
44
`
This field
indicates
Type of the
address
addrType 1..1 Code Min : 1
Max :
20
M 046_ReqPay_
Ac_addrType
This field
indicates
Details
related to
Payer
Address
1..n Alphabetic Min : 1
Max :
255
M
This field
indicates
Name of the
property
name 1..n Code Fixed
value
M 048_ReqPay_
Ac_name_Acco
unt
This field
indicates
Value of the
property
value 1..n Alphanume
ric
Min : 1
Max :
20
M
This field
indicates
Information
related to
Payer
Credentials
1..1 Alphabetic Min : 1
Max :
20
O 109_Payer_cre
ds
This field
indicates
Credentials
used to
authenticate
the request
1..1 Alphabetic Min : 1
Max :
20
O 040_ReqPay_C
redblock
007_ReqPay_P
reApproved
025_Response
_ApprovalNum
This field
indicates
Type of
financial
instrument
used for
authenticati
on
type 1..1 Code Fixed
value
M
Acceptance Model TSD
45
`
This field
indicates
subType
subType 1..1 Code Fixed M 040_ReqPay_C
redblock
This field
indicates
base-64
encoded/
encrypted
authenticati
on data
1..1 Alphabetic Fixed
value
M
This field
indicates
Data Code
Data. Code 1..1 Code Fixed
value
M
This field
indicates Key
Index
Ki 1..1 Code Fixed
value
M
This field
indicates
Meta tag for
Aadhaar
transaction
1..1 Alphabetic Fixed
value
M
This field
indicates
License Key
assigned to
the AUA
lk 1..1 Alphanume
ric
Min : 1
Max : 64
M
This field
indicates A
unique code
for AUA
ac 1..1 AlphaNume
ric
Max :10 M
This field
indicates A
unique
sub_AUA
code
sa 1..1 AlphaNume
ric
Max :10 M
Acceptance Model TSD
46
`
This field
indicates
Aadhaar
number of
the person
being
authenticate
d
uid 1..1 AlphaNume
ric
Max :12 M
This field
indicates
Version of
the API
ver 1..1 Numeric Min : 1
Max : 6
M
This field
indicates
Information
related to
the amounts
in the
transaction
1..1 Alphabetic Fixed
value
M 110_Payer_am
ount
This field
indicates
Transaction
amount
value 1..1 Numeric minInclusi
ve: 0
totalDigit
s: 15
M 051_ReqPay_
Amount_Value
This field
indicates
Currency of
the
transaction
curr 1..1 Text Min : 1
Max : 3
M
This field
indicates
Details of
transaction
amount
0..1 Alphabetic Fixed
value
O
This field
indicates
Name of the
property
name 1..n Code Min : 1
Max : 20
M
Acceptance Model TSD
47
`
This field
indicates
Value of the
property
value 1..n Alphanume
ric
Min : 1
Max : 99
M
This field
indicates
Details
related to
the Payees
1..1 Alphabetic Fixed
value
M
This field
indicates
Details
related to
the Payees
1..1 Alphabetic Fixed
value
M
This field
indicates the
Address of
the Payee
addr 1..1 Alphanume
ric
Min : 1
Max :
255
M 072_addr
This field
indicates the
Name of the
Payee
name 1..1 Alphanume
ric
Min : 1
Max : 99
M 093_name
This field
indicates the
unique
identifier for
each
transaction
inside a file
including
Payee and
payer.
(Default
value should
be set to 1
except for
AutoPay)
seqNum 1..1 Numeric Min : 1
Max : 3
M 074_seqNum
Acceptance Model TSD
48
`
This field
indicates the
Type of
Payee.
type 1..1 Code Fixed
value
M 029_Payer/Pay
ee_Type
This field
indicates
Merchant
Classification
Code - MCC
code 1..1 Numeric 4 M 024_Txn_code
This field
indicates the
Payee
Identity.
1..1 Alphabetic Fixed
value
M 111_Payee_inf
o
This field
indicates the
Type of
Identifier.
type 1..1 Code Fixed
value
M
This field
indicates the
Name as per
Identifier.
verifiedNam
e
1..1 Alphanume
ric
Min : 1
Max : 99
M
This field
indicates the
ID of the
Identifier.
id 1..1 Alphanume
ric
Min : 1
Max : 99
M
This field
indicates the
rating of the
payee.
1..1 Alphabetic Fixed
value
M
This field
indicates the
Verified
Address.
verified
Address
1..1 Code Boolean
TRUE/FAL
SE
M 026_Payer/Pay
ee_InfoRating
Acceptance Model TSD
49
`
This field
indicates the
details of
device from
which the
transaction
was
initiated.
0..1 Alphabetic Fixed
value
O
This field
indicates the
details of
the device
tag.
1..n Alphabetic Fixed
value
M
This field
indicates the
Name of the
property.
name 1..n Code Fixed
value
M
This field
indicates the
Value of the
property.
value 1..n Alphanume
ric
Min : 1
Max : 99
M
Only one
entity is
allowed for a
payee.
1..1 Alphabetic Fixed
value
M 048_ReqPay_A
c_name_Accou
nt
This field
indicates the
Type of
address.
addrType 1..1 Code Min : 1
Max : 20
M 048_ReqPay_A
c_name_Accou
nt
This field
indicates the
Details
related to
Payee
Address.
1..n Alphabetic Fixed
value
M
Acceptance Model TSD
50
`
This field
indicates the
Name of the
property.
name 1..n Code Fixed
value
M
This field
indicates the
Value of the
property.
value 1..n Alphanum Min : 1
Max : 99
M
This field
indicates to
the
information
related to
the amounts
in the
transaction.
1..1 Alphabetic Fixed
value
M 055_Payee.Am
ount
This field
indicates the
Transaction
amount.
value 1..1 Numeric minInclusi
ve: 0
totalDi
gits: 15
M 051_ReqPay_
Amount_Value
This field
indicates the
Currency of
the
Transaction.
curr 1..1 Text Min : 1
Max :3
M
This field
indicates
details of
Transaction
Amount.
0..1 Alphabetic Fixed
value
O
This field
indicates the
Name of the
property.
name 1..n Code Fixed
value
M
Acceptance Model TSD
51
`
This field
indicates the
Value of the
property.
value 1..n Alphanu
meric
Min : 1
Max : 99
M
This field
indicates the
Merchant
Block.
1..1 Alphabetic Fixed
value
M 037_ReqPay_
Payer/Payee_
MerchantTag
This field
indicates the
Payee
Merchant
Identifier.
0..1 Alphabetic Fixed
value
O
This field
indicates the
SubCode.
subCode 0..1 Code 4 O 037_ReqPay_P
ayer/Payee_
MerchantTag
This field
indicates the
Merchant
Identifier.
mid 1..1 Alphanume
ric
Min : 1
Max : 20
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field
indicates the
Store Id.
sid 0..1 Alphanume
ric
Min : 1
Max : 20
O 037_ReqPay_P
ayer/Payee_
MerchantTag
This field
indicates the
Terminal
Identifier.
It is the POS
terminal
identifier
value.
tid 1..1 Alphanume
ric
Min : 1
Max : 20
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field
indicates the
Merchant
Type.
merchantTyp
e
1..1 Alphabetic Fixed
value
M 037_ReqPay_P
ayer/Payee_
MerchantTag
Acceptance Model TSD
52
`
This field
indicates the
Merchant
Genre.
merchantGe
nre
1..1 Alphabetic Fixed
value
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field
indicates the
Merchant
Onboarding
Type.
onBoardingT
ype
1..1 Alphabetic Fixed
value
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field
indicates the
Registeration
Id
regId 0..1 Alphanume
ric
Max 35 O
This field
indicates the
Area pincode
pinCode 0..1 Numeric Fixed : 4 O
This field
indicates the
tier of the
city
tier 0..1 Alphanume
ric
Code O
This field
indicates the
merchant
location
merchantLoc 1..1 Alphanume
ric
Max:70 M
Acceptance Model TSD
53
`
This field
indicates the
Merchant
Institution
Code.
It is the
unique ID for
each
merchant
provided by
the acquiring
party.
merchantInst
Code
0..1 Alphanume
ric
Min :1
Max :20
O 024_Txn_code
This field
indicates the
Payee
Merchant
Name
1..1 Alphabetic Min : 1
Max : 99
M
This field
indicates the
Brand Name.
brand 1..1 Alphanume
ric
Min : 1
Max : 99
M 037_ReqPay_P
ayer/Payee_
MerchantTag
This field
indicates the
Legal Name.
legal 0..1 Alphanume
ric
Min : 1
Max : 99
O 037_ReqPay_P
ayer/Payee_
MerchantTag
This field
indicates the
Franchise
Name.
franchise 0..1 Alphanume
ric
Min : 1
Max : 99
O 037_ReqPay_P
ayer/Payee_
MerchantTag
Type of
Ownership
Ownership
type
0..1 Alphabetic Fixed
value
O 038_ReqPay_M
erchant
This field
indicates the
invoice
details.
1..1 M
This field
indicates the
name 1..1 Aplhanume
ric
Min : 1
Max : 99
M
Acceptance Model TSD
54
`
Invoice
Name.
105_Payee.Me
rchant.Invoice
_name
This field
indicates the
Invoice
Number.
num 1..1 Alphanume
ric
Max :20 M 106_Payee.Me
rchant.Invoice
_num
This field
indicates the
Invoice Date.
date 1..1 ISODateTim
e
Min : 1
Max : 255
M 107_Payee.Me
rchant.Invoice
_date
This field
gives the Fx
List.
1..1 M 054_Fxlist
This field
denotes the
Fx rate
details
1..n M
This field
denotes the
Foreign
Payable
Amount.
baseAmount 1..1 Numeric Min
Inclusive
: 0
totalDigit
s: 15
M 102_payee.fx_
baseAmount
This field
indicates the
Currency
Code at
Merchant’s
location.
This field
should have
a 3-digit
value as
defined by
ISO4217.
baseCurr 1..1 Text Min : 1
Max : 3
M 079_baseCurr
This field
indicates
active
currency
active 1..1 M 101_payee.fx_
active
This field
denotes the
Fx 1..1 Numeric Min
Inclusive
M 103_payee.fx_
fx
Acceptance Model TSD
55
`
Foreign
Exchange
Rate.
: 0
totalDigit
s: 15
This field
gives the
Mark Up rate
in
percentage.
The value in
this field
should have
two digits
after the
decimal
point.
Example: If
the Mark Up
rate is 2.5%
then the
value in said
field will be ,
Mkup = 2.50
Mkup 1..1 Numeric Min :1
Max :99
M 104_payee.fx_
Mkup
This field
gives the last
modified
date of the
Foreign
Exchange
(Fx).
lastModified
Ts
0..1 ISODateTim
e
Min :1
Max : 255
O
5.2.2 INTERNATIONAL CREDIT RESPONSE (RESPPAY)
Acceptance Model TSD
56
`
[ 1..n Alphabetic Fixed
value
M
This field
indicates the
Reference
type
type 1..1 Code Fixed
value
M 016_RespPay_
Pay
017_RespPay_
Collect
This field
indicates the
Sequence
Number
(Default value
should be set
to 1 except for
Autopay)
seqNum 1..1 Numeric Min : 1
Max : 3
M 074_seqNum
This field
indicates the
Payment
address
addr 1..1 Alphanumeri
c
Min : 1
Max :
255
M 072_addr
This field
indicates the
settAmount 1..1 Numeric minInclu
sive: 0
M 051_ReqPay_A
mount_Value
Acceptance Model TSD
61
`
Settlement
Amount
totalDigit
s: 15
This field
indicates the
Settlement
Currency
settCurrenc
y
1..1 Text Min : 1
Max : 3
M 081_settCurre
ncy
This field
indicates the
Approval
Reference
Number
approvalNu
m
1..1 Alphanumeri
c
6 M 025_Response
_ApprovalNum
This field
indicates the
Response code
respCode 1..1 Alphanumeri
c
Min : 1
Max : 20
M 064_respCode
This field
indicates the
Registered
name with
bank
regName 1..1 Alphanumeri
c
Min : 1
Max : 99
M 082_regName
This field
indicates the
Original
amount
orgAmount 1..1 Numeric minInclu
sive: 0
totalDigit
s: 15
M 051_ReqPay_A
mount_Value
This field
indicates the
Reversal
Response Code
reversalRes
p Code
0..1 Alphanumeri
c
Min : 1
Max : 20
O 098_respCode
_Reversal
This field
indicates the
Account
number
acNum 1..1 Alphanumeri
c
Min : 1
Max : 30
M 083_acNum
Merchant
Classification
Code - MCC
code 1..1 Numeric 4 M 024_Txn_code
This field
indicates the
IFSC code
IFSC 1..1 Alphanumeri
c
11 M 032_RespPay_
Ref Tag_IFSC
This field
indicates the
Account type
accType 1..1 Code Fixed
Value
M 048_ReqPay_A
c_
name_Account
Note- The International entity will populate the valid UPI response code value in the respCode and
errCode tags in RespPay CREDIT. UPI shall provide the respective Error code in the final response.
5.3 CHECK TRANSACTION(NPCI INITIATED)
Acceptance Model TSD
62
`
This API will be used by NPCI for getting the status of CREDIT from International partner, given the
CREDIT request is timed out.
Note: A ReqChkTxn message will be fired from NPCI to IRP, if there is a timeout of ReqPay (CREDIT). In
case of sponsor bank fails to send RespChkTxn, then UPI will initiate ReqPay (REVERSAL). In case of
timeout for ReqPay (REVERSAL) the transaction shall be closed by UPI with status as DEEMED.
5.3.1 CHECK TRANSACTION REQUEST (REQCHKTXN)
Tag
Description
Occurrence Datatype Length Mandatory
M/O
Rules
API Name ReqChkTxn 1..1
M
API Schema
namespace
xmlns 1..1 Alphanume
ric
Min:1
Max:255
M
Header 1..1 Alphabetic Fixed
value
M
This field
indicates the
Version of the
API
ver 1..1 Numeric Min:1
Max:6
M 019_Head_Versi
on
This field
indicates the
Request time
set by the
creator of the
message
ts 1..1 ISODate
Time
Min : 1
Max :255
M 020_Head_ts
Acceptance Model TSD
63
`
This field
indicates the
ID of the
Organization
that created
the message
orgId 1..1 Numeric Min : 1
Max : 20
M 059_OrgId
This Field
indicate the
type of
product
prodType 0..1 Alphabetic Fixed
value
O 108_prodType
This field
indicates the
Message
identifier-
used to
correlate
between
request and
response
msgId 1..1 Alphanume
ric
35 M 021_Head_msgI
d
This field
indicates the
Transaction
information,
Carried
throughout
the system
which is
visible to all
parties
1..1 Alphabetic Fixed
value
M
This field
indicates the
Unique
Identifier of
the
transaction
across all
entities,
created by
the originator
id 1..1 Alphanume
ric
35 M 022_Txn_UUID
This field
indicates
Remarks/
note
note 1..1 Alphanume
ric
Min : 1
Max :
50
M 067_note
This field
indicates the
Consumer
reference
number to
identify (like
Loan
number,consu
mer account
number, etc.)
refId 1..1 Alphanume
ric
Min : 1
Max :
35
M 056_refId
Acceptance Model TSD
64
`
This field
indicates the
URL for the
transaction
refUrl 1..1 Alphanume
ric
Min : 1
Max : 35
M 068_refUrl
This field
indicates the
Reference
Category
refCategory 1..1 Code Fixed
value
O 052_ReqPay_Tx
n_refCategory
This field
indicates the
Subtype of
transaction
subType 1..1 Code Min : 1
Max : 20
M 030_Txn_SubTy
pe
This field
indicates the
Transaction
origination
time by the
creator of the
message
ts 1..1 ISODateTim
e
Min : 1
Max :
255
M 020_Head_ts
Type of the
Transaction
type 1..1 Code Min
Length : 1
Max
Length :
20
M 069_txnType
Original Date
of the txn
orgTxnDate 0..1 ISODateTim
e
Min .: 1
Max .:
255
O 075_orgTxnDate
Initiation
mode
InitiationMo
de
1..1 Code Min .: 1
Max .: 35
M 031_Txn_Initiati
onmode
This field
indicates the
Original
transaction ID
when
reversal/Refu
nd has to be
done
orgTxnId 1..1 Alphanume
ric
35 M 023_Txn_
orgTxnId
Original
message Id
orgMsgId 0..1 Alphanume
ric
35 O 078_orgmsgId
This field
indicates the
Purpose of
the txn
purpose 1..1 Code Fixed
value
M 045_ReqPay_Tx
n_purpose
5.3.2 CHECK TRANSACTION RESPONSE (RESPCHKTXN)
This API shall be used by IRP to confirm the status of CREDIT to NPCI.
Acceptance Model TSD
65
`
][
]
Tag
Description
Occurrence Datatype Length Mandatory
M/O
Rules
API Name respchktxn 1..1
M
API Schema
namespace
xmlns 1..1 Alphan
umeric
Min:1
Max:255
M
Header 1..1 Alphab
etic
Fixed value M
This field
indicates the
Version of
the API
ver 1..1 Numer
ic
Min:1
Max:6
M 019_Head_Versio
n
This field
indicates the
Request time
set by the
creator of
the message
ts 1..1 ISODat
e Time
Min : 1
Max :255
M 020_Head_ts
Acceptance Model TSD
66
`
This field
indicates the
ID of the
Organization
that created
the message
orgId 1..1 Numer
ic
Min : 1
Max : 20
M 059_OrgId
This field
indicates the
Message
identifier-
used to
correlate
between
request and
response
msgId 1..1 Alphan
umeric
35 M 021_Head_MsgId
This field
indicates the
Transaction
information,
Carried
throughout
the system
which is
visible to all
parties
1..1 Alphab
etic
Fixed value M
Acceptance Model TSD
67
`
This field
indicates the
Unique
Identifier of
the
transaction
across all
entities,
created by
the
originator
id 1..1 Alphan
umeric
35 M 022_Txn_UID
This field
indicates
Remarks/
note
note 1..1 Alphan
umeric
Min : 1
Max : 50
M Description of the
transaction(which
will be printed
on Pass book)
This field
indicates the
Consumer
reference
number to
identify (like
Loan
number,
consumer
account
number,
etc.)
refId 1..1 Alphan
umeric
Min : 1
Max : 35
M 056_refId
This field
indicates the
URL for the
transaction
refUrl 1..1 Alphan
umeric
Min : 1
Max : 35
M 068_refUrl
This field
indicates the
Reference
Category
refCategor
y
1..n Code Fixed value M 052_ReqPay_Txn_
refCategory
Acceptance Model TSD
68
`
This field
indicates the
Request time
set by the
creator of
the message
ts 1..1 ISODat
e Time
Min : 1
Max :255
M 020_Head_ts
This field
indicates the
Subtype of
transaction
subType 0..1 Code Min : 1
Max : 20
O 030_Txn_SubType
Type of the
Transaction
type 1..1 Code Min Length
: 1 Max
Length : 20
M 001_ReqPay_Pay
002_ReqPay_Coll
ect 003_ReqPa
y_Debit
004_ReqPay_Cred
it 005_ReqPa
y_DebitReversal
006_ReqPa
y_CreditReversal
This field
indicates the
Purpose of
the txn
purpose 1..1 Code Fixed value M 045_ReqPay_Txn_
purpose
Original Date
of the txn
orgTxnDate 0..1 ISODat
eTime
Min .: 1
Max .: 255
O 075_orgTxnDate
Acceptance Model TSD
69
`
Initiation
mode
InitiationM
ode
1..1 Code Min .: 1
Max .: 35
M 031_Txn_Initiatio
n mode
This field
indicates the
Original
transaction
ID when
reversal/Ref
und has to
be done
orgTxnId 1..1 Alphan
umeric
35 M 023_Txn_
orgTxnId
Original
message Id
orgMsgId 0..1 Alphan
umeric
35 O 078_orgMsgId
This field
indicates the
Request
Message
identifier
reqMsgId 1..1 Alphan
umeric
35 M 060_reqMsgId
This field
indicates the
Result of the
transaction
result 1..1 Code Min : 1
Max : 20
M 053_Response_res
ult
061_Resp_Result
This field
indicates the
Error code if
failed
errCode 1..1 Alphan
umeric
Min : 1
Max : 20
M 062_errCode
Response
Reference
ref type 1..n Alphab
etic
Fixed M 073_refType
This field
indicates
Unique
identifier for
each
transaction
inside a file
including
payer and
payee.
(Default
seqNum 1..1 Numer
ic
Min : 1
Max : 3
M 074_seqNum
Acceptance Model TSD
70
`
value should
be set to 1
except for
Autopay)
This field
indicates the
Address of
the Payee
addr 1..1 Alphan
umeric
Min : 1
Max : 255
M 072_addr
Merchant
Classification
Code - MCC
code 1..1 Numer
ic
4 M 024_Txn_code
This field
indicates the
Response
code
respCode 1..1 Alphan
umeric
Min : 1
Max : 20
M 064_respCode
Acceptance Model TSD
71
`
6 APPENDIX - RULES
Rule Id Condition Value Action
001_ReqPay_Pay if(type=PAY) PAY If it is a PAY txn below tags are
mandatory
Under Payer
1. Info Tag
2. Device tag
3. Account tag
4. Amount tag.
5. Cred tag
Under Payee
1. Payee tag.
2. Amount tag.
002_ReqPay_Colle
ct
if(type=COLLECT
)
COLLECT If it is a COLLECT txn below tags
are mandatory.
Under payeetag
1. Info Tag
2. Device tag details
3. Account tag
4. Amount tag.
Under Payer tag
1. Amount tag.
Acceptance Model TSD
72
`
003_ReqPay_Debit if(type=DEBIT) DEBIT If type is DEBIT below tags are
mandatory.
Under Payer tag
1. Info Tag
2. Device tag
3. Account tag
4. Amount tag.
5. Cred tag
Under Payee tag
1. Info tag
2. Account tag
3. Amount tag
004_ReqPay_Credi
t
if(type=CREDIT) CREDIT If type is CREDIT below tags are
mandatory.
Under Payer tag
1. Info Tag
2. Device tag
3. Account tag
4. Amount tag
Under Payee tag
1. Info tag
2. Account tag
Amount tag
005_ReqPay_Debit
Reversal
if(type=
REVERSAL)
REVERSAL This leg will be sent for reversal
from UPI to Remitter
If type is REVERSAL below tags
are mandatory.
Under Payer tag
1. Info Tag
2. Account tag
Amount tag
Acceptance Model TSD
73
`
006_ReqPay_Credi
tReversal
if(type=REVERSAL) REVERSAL This leg will be sent for reversal
from UPI to international
partner
If type is REVERSAL below tags
are mandatory.
Under Payee tag
1. Info Tag
2. Account tag
Amount tag
007_ReqPay_PreAp
proved
if(type=PAY&&Cr
ed.type=”PREAPP ROVED”)
/(type=COLLECT
&&Cred.type=”PR
EAPPROVED”)
PREAPPRO
VED
1. If txn type is PAY and
PREAPPROVED then the
following cred block should be
present in ReqPay
2. If txn type is COLLECT
and PREAPPROVED then the
following cred block should be
present in RespAuthDetails
Format: respCode|approvalNum
Example –00|972345
"|" - to be used as delimiter
008_ReqAuth_Pay if(type=PAY) PAY If type is PAY below tags are
mandatory in ReqAuthDetails
Under Payer tag
1. Info Tag
2. Account tag
3. Amount tag
Under Payee tag
1. Amount tag
Acceptance Model TSD
74
`
009_ReqAuth_Coll
ect
if(type=COLLECT
)
COLLECT If type is COLLECT below tags
are mandatory in
ReqAuthDetails
Under Payer tag
1. Amount tag
Under Payee tag
1. Info Tag
2. Account tag
3. Amount tag
010_RespAuth_Pay if(type=PAY) PAY If type is PAY below tags are
mandatory in RespAuthDetails
Under Payer tag
1. Info Tag
2. Account tag
3. Amount tag
Under Payee tag
1. Info Tag
2. Account tag
3. Amount tag
011_RespAuth_Coll
ect
if(type=COLLECT
)
COLLECT If type is COLLECT below tags
are mandatory in
RespAuthDetails
Under Payer tag
1. Info Tag
2. Account tag
3. Amount tag
4. Device tag
5. Cred tag
Under Payee tag
1. Info Tag
2. Account tag
3. Amount tag
012_ReqTxn_Pay if(type=PAY) PAY Ref tag of payee details will be
present in the
ReqTxnConfirmation.
013_ReqTxn_Colle
ct
if(type= COLLECT) COLLECT Ref tag of payer details will be
present in the
ReqTxnConfirmation
Acceptance Model TSD
75
`
016_RespPay_Pay if(type=DEBIT) DEBIT Ref tag of payer details will only
be sent in the RespPay
017_RespPay_Colle
ct
if(type=CREDIT) CREDIT Ref tag of payee details will
only be sent in the RespPay
018_RespPay_Reve
rsal
if(type=REVERSAL) REVERSAL Ref tag of Payer details will be
sent in debit reversal
Ref tag of Payee details will be
sent in credit reversal
019_Head_Version General Numeric Default is ’2.0’
Acceptance Model TSD
76
`
020_Head_ts General ISO Date
time
format
The string format should be:
YYYY-MM-DDTHH:mm:ss.sssZ,
where:
YYYY-MM-DD – is the date: year-
month-day.
The character "T" is used as the
delimiter.
HH:mm:ss: sss – is the time:
hours, minutes, seconds and
milliseconds.
The 'Z' part denotes the
time zone in the format +-
hh:mm
HH/hh = two digits of hour (00
through 23) (am/pm NOT
allowed)
mm = two digits of minute (00
through 59)
ss = two digits of second (00
through 59)
sss= three digit of milli second
(000 through 999)
+/- hh:mm = followed by time
zone difference from GMT in
hours and minutes. This is
Mandatory, this keeps on
changing with each leg of the
transaction
021_Head_MsgId General Alphanum
eric
Message ID is unique for
particular API leg as well as all
transactions. It should be always
35 Digits. First 3 digits should be
bank Participation code assigned
by NPCI followed by 32 digit
generated by UUID logic
No special Characters
permitted. Message id changes
with each leg.
022_Txn_UUID General Alphanum
eric
Transaction ID is unique for the
any transaction. It should be
always 35 Digits. First 3 digits
should be bank Participation
code assigned by NPCI followed
by 32 digit generated by UUID
logic
No special Characters permitted
Acceptance Model TSD
77
`
023_Txn_ orgTxnId A. if(type= REVERSAL)
B.if (type = REFUND ) or
C.ValQr linked Payment
D. chkTxn linked to payment
Alphanume
ric
A. VALQR linked Payment : All
International Merchant QRs are
validated with the ValQr API.
The paymnet is initiated against
QR validation call.
orgTxnId in ReqPay contains the
transaction id of the ValQr
transaction done prior.
The orgTxnId shall have the
value of the original transaction
id from payment request linked
to which the REVERSAL is
initiated
(Refer to Section 3.3, fig g)
B. REFUND : IP can initiate a
refund against a successful
payment transaction.
The REFUND will be initiated
with the details from the
payment transaction.
The orgTxnId in ReqPay (type =
REFUND) shall have the value of
the original transaction id linked
to it.
C.REVERSAL : In case of
timeout, ReqPay (type =
REVERSAL) shall be initiated
from NPCI to the IP.
The txnId in REVERSAL changes
to a new value.
D. chkTxn linked to payment: IP
can raise a chkTxn to NPCI for
fetching the final status of a
payment .
Acceptance Model TSD
78
`
.The ReqChkTxn shall contain
the txnId of the payment in the
orgTxnId tag.
024_Txn_code
It contains MCC(Merchant
Category Code) of the entity.
.if PAYER/PAYEE is individual,
then code="0000"
.if PAYER/PAYEE is an Entity,
then code will be the Merchant
category code
*This will always be 4 digits
numeric code
025_Response_App
rovalNum
if(Result=SUCCESS|FAILURE|P
ARTIAL|DEEMED|PENDING)
Alphanume
ric
6 digits must be Alphanumeric.
If result is success, Approval
number is mandatory
026_Payer/Payee_I
nfoRating
General Numeric TRUE|FALSE
Acceptance Model TSD
79
`
027_Response_Err
Code
General Alphanume
ric
only if FAILURE
028_Response_Rev
ersal
if(type=REVERSAL) Numeric Mandatory only if FAILURE
029_Payer/Payee_
Type
General PERSON/
ENTITY
Either PERSON/ENTITY
In case of Acceptance model
1. Payer type will always be
"PERSON"
2. Payee type will always be =
"ENTITY"
030_Txn_SubType 1. ChkTxn API -
a. For ChkTxn from IP to UPI,
subType="PAY"
b. For Chktxn from UPI to IP,
subType="CREDIT" (Refer section
for credit timeout flow)
2. ReqPay API -
a. if(type="CREDIT"),
then(subType="PAY")
b. if(type ="REVERSAL"),
then(subType="CREDIT")
Acceptance Model TSD
80
`
031_Txn_Initiation
_mode
If(type=PAY|
COLLECT|DEBIT|
CREDIT|REVERSAL|
REFUND|ChkTxn|
TxnConfirmation)
In mandate, if
(type=CREATE|U
PDATE|REVOKE)
01/02/
04/05/
/15/16/19
/20/22/00
00=Default 01= Static QR
Code(Offline)
02=Static Secure QR
Code(Offline) 04=Intent
05=Secure Intent
15=Dynamic QR Code(Offline)
16= Dynamic Secure QR Code
(Offline)
19=Online Static QR Code
20=Online Static Secure QR Code
22=Online Dynamic QR Code
032_RespPay_RefT
ag_IFSC
IFSC IFSC code of the respective bank
branch and should be 11 digits
Acceptance Model TSD
81
`
034_ReqPay_Devic
eDetails_ Values
if(DEVICE.Tag occurs) Device
Values
MOBILE:91nnnnnnnnnn
GEOCODE:nn.nnnn,nn.nnnn
LOCATION:Area with city, state
and Country Code
01-23- Terminal Address
24-36- Terminal City
37-38- Terminal State Code
39-40- Terminal Country Code
IP:Valid IP address format(v4,v6)
TYPE:Min – 1 , Max – 20 (Refer
Rule_035) ID:Min – 1 , Max – 35
OS:Min – 1 , Max – 20
APP:Min – 1 , Max – 20
CAPABILITY:Min – 1 , Max –
99 (refer to DE-
61) e.g:
“520000020001000400063929292
9292 “.
For more details, refer annexure
document
TELECOM OPERATOR:Min
-1,Max -99 (It is mandatory for
USSD)
The payee Device should be
populated as per the agreement
with IP and NIPL.
035_ReqPay_Devic
eDetails_ type
If(Device.tag.name=”Type”) Device
type
Initiating Channel
1. MOB(Mobile)
2. INET(Internet)
3. USDC/USDB(USSD)
4. POS(Point of Sale)
036_ReqPay_Devic
eDetails_ OS
If(Device.tag.nam e=”OS”) Device OS OS of the initiating Device
1. iOS
2. Android
Acceptance Model TSD
82
`
037_ReqPay_Payer
/Payee_
MerchantTag
If(Payer.type=EN TITY) or
(Payee.type=ENTITY)
Payer/Pay
ee
Merchant
block
If the merchant comes through
an aggregator then the
merchant block element will
contain the merchant details as
follows
1. Identifier.subCode=MCC
code of the merchant
2. Identifier.mid=”Merchant
id”
3. Identifier.sid=”Store id”
4. Identifier.tid=”Terminal
id”
5. Name.brand = Brand any
of the merchant
6. Name.Legal=Legal Name
of the merchant
7. Name.Franchise=Franchis
e agent name
8. Ownership.type= See rule
038
9. merchantType=”SMALL
10. |LARGE”
11. merchantGenre=”OFFLINE
|ONLINE”
12. onBoardingType=”BANK|AGG
REGATOR|TPAP|NETWORK"
038_ReqPay_Merch
ant
Tag_Ownership_Ty
pe
If(Payer.type=ENTITY) or
(Payee.type=ENTITY)
Payer/Pay
ee
Merchant
tag_owne
r_type
Type of Ownership:
PROPRIETARY | PARTNERSHIP |
PRIVATE| PUBLIC | OTHERS
039_ReqPay_OrgRe
spCode
If(txn.type=REVERSAL) Txn
tag_Revers
al
Possible only if Reversal/Refund
scenario occurs
045_ReqPay_Txn_p
urpose
purpose=”11”
Acceptance Model TSD
83
`
046_ReqPay_Ac_ad
drType
If(addrType=AAD
HAAR|ACCOUN
T|MOBILE|CARD
)
Account
values
1. If addrType= AADHAAR is
applicable for Aadhaar txn’s
2. If addrType=ACCOUNT is
applicable for account + IFSC
txn’s
3. If addrType=MOBILE is
applicable for mobile banking
txn’s
4. If addrType=CARD is
applicable for card payments.
048_ReqPay_Ac_na
me_Account
If(addrType=ACCOUNT)
Account
values
If addrType=ACCOUNT, then
below three details are
mandatory and the
enumerations shall be populated
in the "Detail.name" tag.
IFSC= It should be 11 digits
alphanumeric
ACTYPE= It should be a fixed
value SAVINGS|CURRENT|NRE|
NRO|PPIWALLET|
BANKWALLET|CREDIT|SOD| UOD
ACNUM= it should be max 30
digits
The payee account details
should contain IP's settlement
bank account details(As per NIPL
agreement with IP and
settlement bank).
051_ReqPay_Amou
nt_Value
If(amount, orgAmount,
settamount)
Amount
value
The amount value should be
numeric. It should be populated
in below format.
2 digits should come after the
decimal.
E.g.(Amount Value=”100.00”).
Note: 1. Transation amount
populated in orgAmount
2. Settlemnt amount will be
0.00 if the result = "Failure"
3. Stlmnt amount will be
orgAmount if the result =
"Success"
Acceptance Model TSD
84
`
052_ReqPay_Txn_r
efCategory
If(txn_type=PAY|REFUND|REV
ERSAL| DEBIT|CREDIT)
For mandate txn also
The refCategory field is used to
identify the category of the
transaction.
Default value is 00.
If the value is 02, then refUrl
will have an invoice attachment
link.
053_Response_res
ult
if(result=FAILURE) Following tags are only
mandatory-
1. Head tag
2. Resp tag
3. Txn tag
(This rule represents that the
tags mentioned or listed are the
only mandatory tags needed for
both failure and timeout
responses)
054_Fxlist For respValQr, Fxlist tag is
mandatory
Only baseAmount, baseCurr to
be passed by IP to NPCI. Other
subtags are mandatory and shall
be passed by NPCI.
055_Payee.Amount
Tag is optional and can be used
to populate the amount by the
partner as per the current
implementation. For dynamic
and static QR identification
refer to Fx tag
056_refId This is a unique 35 digit
alphanumeric value.
057_Payer.info Is mandatory for “pay” and
optional for “collect”
Acceptance Model TSD
85
`
058_txn.ts
The string format should be:
YYYY-MM-DDTHH:mm:ss.sssZ,
where:
YYYY-MM-DD – is the date: year-
month-day.
The character "T" is used as the
delimiter.
HH:mm:ss: sss – is the time:
hours, minutes, seconds and
milliseconds.
The 'Z' part denotes the
time zone in the format +-
hh:mm
HH/hh = two digits of hour (00
through 23) (am/pm NOT
allowed)
mm = two digits of minute (00
through 59)
ss = two digits of second (00
through 59)
sss= three digit of milli second
(000 through 999)
(+/-) hh:mm = followed by time
zone difference from GMT in
hours and minutes. Transaction
Timestamp remains constant for
the entire transaction leg
059_orgId
Value assigned by NPCI to be
shared by partner
When it is orignated by NPCI, it
can be UPI/iUPI/NPCI
060_reqMsgId reqMsgId contains the respectiv
request message id.
It is used to link the request msg
with the response msg.
061_Resp_Result 1. Non financial/meta APIs has
possible values:
SUCCESS|FAILURE
2. The financial API will have
values:
SUCCESS|FAILURE|DEEMED
3. Only for ChkTxn iniated by IP
to NPCI, if the payment/
financial txn is in progress result
will be : PENDING
062_errCode 1. Error Code doc reference as
proivded by NPCI
2. Error Code
Acceptance Model TSD
86
`
063_seqNum It Denotes the number of payers
and payees
Default value is 1
064_respCode Failure Reasons/ Response codes
shared by IRP/IMA.
Kindly refer the doc (Response
Code sheet v1)
065_orgRRN It Contains the respective
original Payment custRef tag
value (Customer Refernce)
.This will only be present in the
reqChkTxn from IP to NPCI
066_custRef Specific format as per product
revised office circular(refer
NPCI/UPI/OC-107/2020/21)
067_note Note contains the description of
the transaction(which will be
printed on Pass book)
It is Payer initiated remarks.
Special Characters allowed are
Dot(.) and Hyphen (-)
068_refUrl This will be the website url for
the sender of the message
This is hardcoded value "sender's
URL"
069_txnType 1. hbt API type="Hbt"
2. ReqPay API- enumeration
lists:"PAY|CREDIT|REVERSAL"
3.ChkTxn API type="ChkTxn"
4. ValQr API type="IntlQr"
070_HbtMsg_type HbtMsg_type="EOD|ALIVE"
071_value value="DATE|NA"
072_addr 1. This contains the UPI id or
VPA
2. Permited special Characters
(.) (-)
3. VPA should not begin with
special characters
4. Total length of VPA is
inclusive of the handle
Acceptance Model TSD
87
`
073_refType It defines the type of the sender
Enumeration are
:"PAYER|PAYEE"
1. RespPay API
if txn type = "CREDIT",
refType="PAYEE".
if txn type = "REVERSAL",
refType="PAYEE"
2. ChkTxn API
if txn type refType="PAYEE"
075_orgTxnDate orgTxnDate is used in a refund
transaction (refer the refund
doc)
It is Used to link the original
payment transaction timestamp
to the refund transaction
The string format should be:
YYYY-MM-DDTHH:mm:ss.sssZ,
where:
YYYY-MM-DD – is the date: year-
month-day.
The character "T" is used as the
delimiter.
HH:mm:ss: sss – is the time:
hours, minutes, seconds and
milliseconds.
The 'Z' part denotes the
time zone in the format +-
hh:mm
HH/hh = two digits of hour (00
through 23) (am/pm NOT
allowed)
mm = two digits of minute (00
through 59)
ss = two digits of second (00
through 59)
sss= three digit of milli second
(000 through 999)
+/- hh:mm = followed by time
zone difference from GMT in
hours and minutes. This is
Mandatory, this keeps on
Acceptance Model TSD
88
`
changing with each leg of the
transaction
076_ValQr_type It contains mandatory tags:
1.Head
2.Transaction
3.Payer
4.Institution
077_QrPayLoad It contains the merchant QR
string payload passed by the
payer PSP and forwarded as is to
the international partner.
International partner
authenticates the QR string for
the transaction to be processed
further.
078_orgMsgId It contains the message Id of the
linked payment
Acceptance Model TSD
89
`
079_baseCurr baseCurr field is mandatory in
case in RespValQR from
IP/Merchant.
This will be the IP/Merchant
country currency
080_provider Default value of the 'provider'
tag is NPCI
In case of other initiating PSP
populating risk Score provider
shall contain the name of the
PSP
081_settCurrency settCurrency tag Needs to be in
INR
082_regName regName is the Payee - name
registered with Bank/IP
It contains the same value as
the name of the Payee.
083_acNum acNum is the Account Number of
the payer(Debit) or Payee
(Credit)
084_netInstId netInstId contains the value
passed by UPI to payer PSP in
RespValQr.
Payer PSP to pass the same to
UPI in reqPay
085_QrBlock All the tags under QR block to
be populated by IP in RespValQr
as per the values present in the
QR string generated by the
merchant/IP
086_qVer qVer tag is Mapped to ‘ver’
parameter in QR string.
It is used to specify the QR
version
"ver=01"
087_qr_ts qr_ts is the time stamp when
the QR was generated.
Acceptance Model TSD
90
`
088_qrMedium This field indicates the Source
channel i.e. creation point of
the string.
01 - PICK FROM GALLERY
02 - APP
03 – POS
04 – PHYSICAL/ Share Intent
mode
05– ATM
06 – WEB
IP/IMA to populate the tag in
RespValQr as per the value
present in the QR string, code
02 to 06 to be used.
Code 01 – Pick from Gallery,
applicable only to Payer PSP to
identify and pass
089_ExpireTs qr_ExpireTs is the QR expiry
Date and time. It denotes the
validity of the QR.
090_query Additional info for future use
091_verToken Verification token internal to
IRP and optional
092_stan stan tag denotes System trance
audit number.
Internal reference Value can be
passed in this tag. It can be used
by IP for internal referencing.
093_name Name is the Name of the
Payer/Payee :
1. If it is Payer.name, it is the
Name of the Payer
2. If it is the Payee.name, it is
the Name of the
Payee/Merchant(Special
Character allowed are Dot(.)
and Hyphen (-)
094_conCode conCode is the merchant
country code.
[A 2-character alpha value, as
defined by ISO 3166-1]
Value for conCode tag is
provided by IP in RespValQr.
Acceptance Model TSD
91
`
095_Txn_riskScore 1. Txn_riskScore contains the
score calculated by NPCI post
validation of platform specific
rules
2.These rules include txn
velocity and amount validation.
3. In case if any rule is breached
UPI shall decline the same
without further processing of
debit and credit.
4. This is used by the Remitter
bank for fraud detection at the
time of debit. To be ignored by
the Bene bank/IP
096_Txn_riskScore
_Type
The Default Value = "TXNRISK"
097_Txn_riskScore
_Value
Txn_riskScore_Value contains
the score.
098_respCode_Rev
ersal
Reversal respCode will be
mandatory if the result = Failure
It will be populated as :
RB - In case of Deemed (UPI
shall auto populate RB)
Comes only at the time of
Credit/Debit Timeout
099_Meta Tag for future use as of now, to
be used for analytics wrt. End to
end transaction processing
latency
The Subtags in Meta tag are
conditional, if is
there then the tags under are
mandatory, else optional
100_payee.fx_base
Curr
It is the currency of the
IP/Merchant
101_payee.fx_acti
ve
active Tag denotes the currency
is active in the NPCI repository.
Fx_active is provided by
NPCI/UPI
102_payee.fx_base
Amount
baseAmount is the amount
payable in base currency of the
IP/Merchant.
103_payee.fx_fx Fx Rate is the baseCurrency to
quote currency conversion rate.
It is provided by NPCI/UPI
Acceptance Model TSD
92
`
104_payee.fx_Mku
p
Mkup is the processing fee
obtained by NPCI/NIPL for cross
border remittance.
Mkup is provided by NPCI/UPI
105_Payee.Mercha
nt.Invoice_name
name tag consist of the name on
the invoice printed or shared to
the customer.
106_Payee.Mercha
nt.Invoice_num
name tag consist of the Number
on the invoice printed or shared
to the customer.
107_Payee.Mercha
nt.Invoice_date
name tag consist of the date on
the invoice printed or shared to
the customer.
108_prodType prodType will always be
populated by NPCI
109_Payer_creds This is applicable for only
customer/Remitter bank
110_Payer_amount Payer amount tag is the amount
payable by the payer/Customer
111_Payee_info Payee info tag consists of the
value of Account number,
verified/Merchant name
Note :
1.All the optional tags that are not applicable to the partner are to be skipped.
2.Blank or null tags are not accepted by UPI.
3.Tags having fixed/enumeration value to be referred from rules and appendix
7 REFERENCES
1. UPI Preface – International v1. doc.
2. Response Code Sheet v1.0 doc.
3. UPI Linking Specification cer 1 7 2_V06
***** END OF DOCUMENT *****