Union Pay API

UPOP Flow

For information about the API endpoints, please refer to the Integration Manual.

UPOP Authentication Flow

UPOP Inquiry Flow

Schema

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
<xs:schema xmlns:mpi-common="http://mpi.netcetera.com/common" xmlns:mpi-upop="http://mpi.netcetera.com/upop"
           xmlns:xs="http://www.w3.org/2001/XMLSchema"
           elementFormDefault="unqualified" attributeFormDefault="unqualified"
           targetNamespace="http://mpi.netcetera.com/upop">
 
  <xs:import schemaLocation="mpi-common.xsd" namespace="http://mpi.netcetera.com/common"/>
  <xs:import schemaLocation="UnionPay.xsd"/>
 
  <xs:element name="AuthReqCreationRequest">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          The AuthReqCreationRequest passed to MPI for the createAuthenticationReq call.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Cardholder" type="mpi-upop:Cardholder" minOccurs="0"/>
        <xs:element name="Purchase" type="mpi-upop:Purchase" minOccurs="0"/>
        <xs:element name="Merchant" type="mpi-upop:Merchant" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
  <xs:element name="AuthReqCreationResponse">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
            The AuthReqCreationResponse returned from MPI for the createAuthenticationReq call.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="sessionId" type="mpi-upop:SessionId" minOccurs="1"/>
        <xs:element name="AuthReq" type="UPACPPayType" minOccurs="0"/>
        <!-- The Authentication Request message to be posted to the UPOP authentication server -->
        <xs:element name="ACPReq" type="xs:string" minOccurs="0"/>
        <xs:element name="Error" type="mpi-common:ErrorDetails" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
  <xs:element name="AuthResValidationRequest">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
            The AuthResValidationRequest passed to MPI for the validateAuthenticationRes call.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <!-- The Authentication Response message received from the UPOP authentication server -->
        <xs:element name="ACPRes" type="xs:string"/>
        <xs:element name="SessionData" type="mpi-upop:SessionData" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
  <xs:element name="AuthResValidationResponse">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
            The AuthResValidationResponse returned from MPI for the validateAuthenticationRes call.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="sessionId" type="xs:string"/>
        <xs:element name="AuthRes" type="UPACPPayType" minOccurs="0"/>
        <xs:element name="orderId" type="mpi-upop:OrderId">
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
              The Order ID assigned to this transaction.
              ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="authenticationStatus" type="xs:string">
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
              Authentication status.
 
             Y - Authentication Successful Attempt Authentication
             F - Authentication Failed
             L - Authentication Failed(prohibited card)
             N - Non-authentication mode used
            ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="responseCode" type="xs:string">
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
              Response code.
 
             - Length: 2
             - Format: Alpha numeric.
            ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="responseMessage" type="xs:string">
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
              Response Message.
 
             - Length: 1-256
            ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="vcode" type="xs:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
              VCODE
 
             - Length: 20
             - Format: Numeric.
            ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="eci" type="xs:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
              ECI
 
             - Length: 2
             - Format: Numeric.
            ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Error" type="mpi-common:ErrorDetails" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
  <xs:element name="AuthStatusInquiryRequest">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Query request creation request message.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accessType" type="xs:string"/>
        <xs:element name="acquiringInstitutionCode" type="xs:string"/>
        <xs:element name="merchantId" type="xs:string"/>
        <xs:element name="merchantCategory" type="xs:string"/>
        <xs:element name="merchantName" type="xs:string"/>
        <xs:element name="merchantAbbreviation" type="xs:string"/>
        <xs:element name="transactionTime" type="xs:string"/>
        <xs:element name="orderId" type="xs:string"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
 
  <xs:element name="AuthStatusInquiryResponse">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Query request creation response message.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:sequence>
          <xs:element name="authenticationStatus" type="xs:string" minOccurs="0"/>
 
          <xs:element name="originalResponseCode" type="xs:string" minOccurs="0"/>
          <xs:element name="originalResponseMessage" type="xs:string" minOccurs="0"/>
 
          <xs:element name="responseCode" type="xs:string" minOccurs="0"/>
          <xs:element name="responseMessage" type="xs:string" minOccurs="0"/>
 
          <xs:element name="vcode" type="xs:string" minOccurs="0"/>
          <xs:element name="eci" type="xs:string" minOccurs="0"/>
 
          <xs:element name="AuthQueryReq" type="UPACPPayType" minOccurs="0"/>
          <xs:element name="AuthQueryRes" type="UPACPPayType" minOccurs="0"/>
          <xs:element name="Error" type="mpi-common:ErrorDetails" minOccurs="0"/>
        </xs:sequence>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
  <xs:complexType name="Cardholder">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          The element containing cardholder related data.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
      <xs:element name="accountNumber" type="mpi-upop:AccountNumber" minOccurs="0"/>
 
      <xs:element name="channelType" type="mpi-upop:ChannelType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Channel type.
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="ipAddress" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              The cardholder IP address.
 
              - Length: 7-40 characters
              - Format: IP address
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
 
  <xs:complexType name="Purchase">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          The element containing the purchase related data.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
      <xs:element name="amount" type="mpi-upop:Amount" minOccurs="0"/>
 
      <xs:element name="currency" type="mpi-upop:CurrencyCode" minOccurs="0"/>
 
      <xs:element name="description" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Brief description of items purchased.
 
              - Length: 0-512 characters
              - Format: any characters
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="orderId" type="mpi-upop:OrderId" minOccurs="0"/>
 
      <xs:element name="time" type="mpi-upop:DateTime" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Date and time of purchase.
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="relatedTransactionType" type="mpi-upop:RelatedTransactionType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              It is used to indicate the related transaction.
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
 
  <xs:complexType name="Merchant">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          The element containing the merchant related data.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
 
      <xs:element name="accessType" type="mpi-upop:AccessType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Access Type.
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
 
      <xs:element name="id" type="mpi-upop:MerchantId" minOccurs="0"/>
 
      <xs:element name="category" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Merchant category code.
              MCC, which is to be sent when the access type is Acquirer Access.
 
              - Length: 4 characters
              - Format: numeric
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="name" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Merchant name to be sent when the access type is Acquirer Access.
 
              - Length: 1-40 characters
              - Format: any characters
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="abbreviation" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              8 Chinese characters, to be sent when the access type is Acquirer Access
 
              - Length: 1-16 characters
              - Format: any characters
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="countryCode" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              ISO 3166 three digit country code.
 
              - Length: 3 characters
              - Format: numeric digits
              - Value:  ISO 3166 three digit country code
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="url" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Fully qualified URL of merchant Web site or customer care site (http(s)://domainname/...).
 
              - Length: 1-256 characters
              - Format: any characters
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="acquiringInstitutionCode" type="mpi-upop:AcquiringInstitutionCode" minOccurs="0"/>
 
    </xs:sequence>
  </xs:complexType>
 
  <xs:complexType name="SessionData">
    <xs:sequence>
      <xs:element name="AuthReq" type="UPACPPayType"/>
    </xs:sequence>
  </xs:complexType>
 
  <xs:simpleType name="AccessType">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              Access Type. One of:
 
              - Direct
              - Acquirer
              - Platform
 
              The corresponding UnionPay protocol values are:
 
              - 0: General Merchant Direct Access
              - 1: Acquirer Access
              - 2: Platform Merchant Access
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
 
  <xs:simpleType name="ChannelType">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              Channel Type. One of:
 
              - Internet
              - Mobile
 
              The corresponding UnionPay protocol values are:
 
              - 07: Internet
              - 08: Mobile
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
 
  <xs:simpleType name="RelatedTransactionType">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              Related Transaction Type. One of:
 
              - Purchase
              - Pre-authorization
 
              The corresponding UnionPay protocol values are:
 
              - 01: Purchase
              - 02: Pre-authorization
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
 
  <xs:simpleType name="DateTime">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
            Date and time formatted as an ISO 8601 combined date and time string using the extended format.
 
            - Format: YYYY-MM-DDThh:mm:ssZ
 
              - YYYY = year
              - MM = month
              - DD = day
              - hh = hour
              - mm = minutes
              - ss = seconds
          ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
  <xs:simpleType name="MerchantId">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              Merchant ID.
              The unique identity code assigned by UnionPay when Merchant access UPOP.
 
              - Length: 15 characters
              - Format: alpha numeric
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
  <xs:simpleType name="Amount">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              The transaction payment amount.
              No decimal point appears in this field.
              The decimal place is implied, based on the transaction currency.
 
              - Length: 1-12 characters
              - Format: numeric digits
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
  <xs:simpleType name="CurrencyCode">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              ISO 4217 three digit currency code.
 
              - Length: 3 characters
              - Format: numeric digits
              - Value:  ISO 4217 three digit currency code
 
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
  <xs:simpleType name="AcquiringInstitutionCode">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              Acquiring Institution Code.
 
              - Length: 8-11 characters
              - Format: alpha numeric
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
  <xs:simpleType name="AccountNumber">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              The cardholder account number.
 
              - Length: 1-60 characters
              - Format: alpha numeric
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
  <xs:simpleType name="OrderId">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
              Generated at merchant side or by 3DS Server if absent. Must not contain either symbol minus or underline
 
              - Length: 8-40
              - Format: alpha numeric
            ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
 
  <xs:simpleType name="SessionId">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Correlation id between Authentication Request Creation and Authentication Response Validation phase.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string"/>
  </xs:simpleType>
 
</xs:schema>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           elementFormDefault="unqualified" attributeFormDefault="unqualified" targetNamespace="http://mpi.netcetera.com/common">
 
  <xs:complexType name="ErrorDetails">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          The potential Error result returned to the Merchant after Payer Authentication Process.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
      <xs:element name="message" type="xs:string" minOccurs="0" />
    </xs:sequence>
    <xs:attribute name="code" type="xs:string" use="required" />
    <xs:attribute name="element" type="xs:string" use="optional" />
  </xs:complexType>
 
</xs:schema>

Note that the schema for the Union Pay includes the Union Pay schema (UnionPay.xsd) to refer to Union Pay protocol messages used in the response structures.

AuthReqCreationRequest samples

There are two possibilities to transfer the merchant data to the UPOP:

  • Merchant configured via the Admin (aka General Merchant Direct Access)
  • Merchant configuration data passed in the AuthReqCreationRequest (aka Acquirer Access)

Merchant configured via the Admin (aka General Merchant Direct Access)

The required merchant.id needs to be passed in the AuthReqCreationRequest and it needs to match the id of the configured Merchant.

The required data to be passed in the AuthReqCreationRequest consists of:

  • merchant.id
  • merchant.accessType
  • purchase.amount
  • purchase.currency
  • purchase.time
  • purchase.relatedTransactionType
  • cardholder.accountNumber
  • cardholder.channelType

Optional is:

  • cardholder.ipAddress
  • purchase.description
  • purchase.orderId
AuthReqCreationRequest (minimum valid JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "Cardholder": {
    "accountNumber": "4234123412340000",
    "channelType": "Internet"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756",
    "time": "2016-03-03T12:12:12Z",
    "relatedTransactionType": "Purchase"
  },
  "Merchant": {
    "id": "123456789012345",
    "accessType": "Acquirer"
  }
}
AuthReqCreationRequest (JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "Cardholder": {
    "accountNumber": "4234123412340000",
    "ipAddress": "123.123.123.123",
    "channelType": "Internet"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756",
    "description": "description",
    "orderId": "ohwh6kwpIYuBXALo2jHd",
    "relatedTransactionType": "Purchase",
    "time": "2016-03-03T12:12:12Z"
  },
  "Merchant": {
    "id": "123456789012345",
    "accessType": "Acquirer"
  }
}
AuthReqCreationRequest (XML)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<mpi-upop:AuthReqCreationRequest xmlns:mpi-upop="http://mpi.netcetera.com/upop">
  <Cardholder>
    <accountNumber>4234123412340000</accountNumber>
    <ipAddress>123.123.123.123</ipAddress>
    <channelType>Internet</channelType>
  </Cardholder>
  <Purchase>
    <amount>10000</amount>
    <currency>756</currency>
    <description>description</description>
    <orderId>ohwh6kwpIYuBXALo2jHd</orderId>
    <relatedTransactionType>Purchase</relatedTransactionType>
    <time>2016-03-03T12:12:12Z</time>
  </Purchase>
  <Merchant>
    <id>123456789012345</id>
    <accessType>Acquirer</accessType>
  </Merchant>
</mpi-upop:AuthReqCreationRequest>
AuthReqCreationRequest (POST parameters)
1
Cardholder.accountNumber=4234123412340000&Cardholder.ipAddress=123.123.123.123&Purchase.orderId=ohwh6kwpIYuBXALo2jHd&Purchase.amount=10000&Purchase.currency=756&Purchase.description=description&Purchase.relatedTransactionType=01&Purchase.time=2016-03-03T12:12:12Z&Cardholder.channelType=07&Merchant.id=123456789012345&Merchant.accessType=Acquirer

Merchant configuration data in AuthReqCreationRequest (aka Acquirer Access)

If Merchant data is available in the client's Payment Environment, there is a possibility for it to be passed as part of the AuthReqCreationRequest, instead of configuring it via the Admin.

The required data to be passed in the AuthReqCreationRequest consists of:

  • merchant.id
  • merchant.accessType
  • merchant.acquiringInstitutionCode
  • merchant.category
  • merchant.name
  • merchant.abbreviation
  • purchase.amount
  • purchase.currency
  • purchase.time
  • purchase.relatedTransactionType
  • cardholder.accountNumber
  • cardholder.channelType

Optional is:

  • cardholder.ipAddress
  • purchase.description
  • purchase.orderId
AuthReqCreationRequest & Merchant data (minimum valid JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "Cardholder": {
    "accountNumber": "4234123412340000",
    "channelType": "Internet"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756",
    "time": "2016-03-03T12:12:12Z",
    "relatedTransactionType": "Purchase"
  },
  "Merchant": {
    "acquiringInstitutionCode": "12345678",
    "id": "123456789012345",
    "accessType": "Acquirer",
    "category": "4321",
    "name": "UPOPMerchant",
    "abbreviation": "UPOPM"
  }
}
AuthReqCreationRequest & Merchant data (JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "Cardholder": {
    "accountNumber": "4234123412340000",
    "ipAddress": "123.123.123.123",
    "channelType": "Internet"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756",
    "description": "description",
    "orderId": "ohwh6kwpIYuBXALo2jHd",
    "relatedTransactionType": "Purchase",
    "time": "2016-03-03T12:12:12Z"
  },
  "Merchant": {
    "acquiringInstitutionCode": "12345678",
    "id": "123456789012345",
    "accessType": "Acquirer",
    "category": "4321",
    "name": "UPOPMerchant",
    "abbreviation": "UPOPM"
  }
}
AuthReqCreationRequest & Merchant data (XML)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<mpi-upop:AuthReqCreationRequest xmlns:mpi-upop="http://mpi.netcetera.com/upop">
  <Cardholder>
    <accountNumber>4234123412340000</accountNumber>
    <ipAddress>123.123.123.123</ipAddress>
    <channelType>Internet</channelType>
  </Cardholder>
  <Purchase>
    <amount>10000</amount>
    <currency>756</currency>
    <description>description</description>
    <orderId>ohwh6kwpIYuBXALo2jHd</orderId>
    <relatedTransactionType>Purchase</relatedTransactionType>
    <time>2016-03-03T12:12:12Z</time>
  </Purchase>
  <Merchant>
    <accessType>Acquirer</accessType>
    <acquiringInstitutionCode>12345678</acquiringInstitutionCode>,
    <id>123456789012345</id>
    <category>4321</category>
    <name>UPOPMerchant</name>
    <abbreviation>UPOPM</abbreviation>
  </Merchant>
</mpi-upop:AuthReqCreationRequest>
AuthReqCreationRequest & Merchant data (POST parameters)
1
Cardholder.accountNumber=4234123412340000&Cardholder.ipAddress=123.123.123.123&Purchase.orderId=ohwh6kwpIYuBXALo2jHd&Purchase.amount=10000&Purchase.currency=756&Purchase.description=description&Purchase.relatedTransactionType=01&Purchase.time=2016-03-03T12:12:12Z&Cardholder.channelType=07&Merchant.accessType=Acquirer&Merchant.acquiringInstitutionCode=12345678&Merchant.id=123456789012345&Merchant.category4321&Merchant.name=UPOPMerchant&Merchant.abbreviation=UPOPM

AuthReqCreationResponse samples

AuthReqCreationResponse (JSON)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "sessionId": "5682ed81-c6b0-4f28-930b-53899d384aeb",
  "AuthReq": {
    "MsgReq": {
      "version": "5.0.0",
      "encoding": "UTF-8",
      "certId": "68759529225",
      "signMethod": "01",
      "txnType": "79",
      "txnSubType": "10",
      "bizType": "000301",
      "accessType": "1",
      "channelType": "07",
      "frontUrl": "http://localhost:8080/mpi-demo/validation-upop",
      "backUrl": "http://localhost:8080/mpi-demo/upop",
      "acqInsCode": "33710276",
      "merId": "123456789012345",
      "merCatCode": "1234",
      "merName": "UPOP Merchant",
      "merAbbr": "UPOP",
      "orderId": "ohwh6kwpIYuBXALo2jHd",
      "txnTime": "20160303201212",
      "accType": "01",
      "accNo": "4234123412340000",
      "currencyCode": "756",
      "txnAmt": "10000",
      "reqReserved": "5682ed81-c6b0-4f28-930b-53899d384aeb",
      "reserved": "e2NvdW50cnk9NzU2Jm1lclVybD1odHRwOi8vbG9jYWxob3N0OjgwODAvbXBpJmNvbW1vZGl0eURlc2M9ZGVzY3JpcHRpb259",
      "customerInfo": "",
      "encryptCertId": "",
      "relTxnType": "01",
      "customerIp": "123.123.123.123"
    },
    "Signature": {
      "SignatureValue": "kmbE3DLSC+lhJc47ejgKt1LEY670yBpl4qOXWxcIKpYpbEo2Q+btpn2PPXNxg7y1lj46dwRA/+71ixw6uLvA5Cn30INaQMDhkeBldCyimEwnjc7GhxkIvyn7UBNpOyse2xBCyIBJ8beOzOodfk7IKypXqpxJKGVxTWGeyVj/N91Pz8fhAtjiQkBy8h5K0cotXyAd+VVEVnCtKfWLcratt+O33CZaE0JZJmsAVveeK37DsbPRXlB7byeUtSS91Uvge2Pz73KFDQk1aMZWUt9tiT7ItotMcD6n8Z55vKrEsuv/uJFdI1XA7Mpe2qwnUzALIbwojHjWgbyY16HMnW1WHg=="
    }
  },
  "ACPReq": "<UPACPPay><MsgReq><version>5.0.0</version><encoding>UTF-8</encoding><certId>68759529225</certId><signMethod>01</signMethod><txnType>79</txnType><txnSubType>10</txnSubType><bizType>000301</bizType><accessType>1</accessType><channelType>07</channelType><frontUrl>http://localhost:8080/mpi-demo/validation-upop</frontUrl><backUrl>http://localhost:8080/mpi-demo/upop</backUrl><acqInsCode>33710276</acqInsCode><merId>123456789012345</merId><merCatCode>1234</merCatCode><merName>UPOP Merchant</merName><merAbbr>UPOP</merAbbr><orderId>ohwh6kwpIYuBXALo2jHd</orderId><txnTime>20160303201212</txnTime><accType>01</accType><accNo>4234123412340000</accNo><currencyCode>756</currencyCode><txnAmt>10000</txnAmt><reqReserved>5682ed81-c6b0-4f28-930b-53899d384aeb</reqReserved><reserved>e2NvdW50cnk9NzU2Jm1lclVybD1odHRwOi8vbG9jYWxob3N0OjgwODAvbXBpJmNvbW1vZGl0eURlc2M9ZGVzY3JpcHRpb259</reserved><customerInfo></customerInfo><encryptCertId></encryptCertId><relTxnType>01</relTxnType><customerIp>123.123.123.123</customerIp></MsgReq><Signature><SignatureValue>kmbE3DLSC+lhJc47ejgKt1LEY670yBpl4qOXWxcIKpYpbEo2Q+btpn2PPXNxg7y1lj46dwRA/+71ixw6uLvA5Cn30INaQMDhkeBldCyimEwnjc7GhxkIvyn7UBNpOyse2xBCyIBJ8beOzOodfk7IKypXqpxJKGVxTWGeyVj/N91Pz8fhAtjiQkBy8h5K0cotXyAd+VVEVnCtKfWLcratt+O33CZaE0JZJmsAVveeK37DsbPRXlB7byeUtSS91Uvge2Pz73KFDQk1aMZWUt9tiT7ItotMcD6n8Z55vKrEsuv/uJFdI1XA7Mpe2qwnUzALIbwojHjWgbyY16HMnW1WHg==</SignatureValue></Signature></UPACPPay>"
}

AuthReqCreationResponse (XML)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<mpi-upop:AuthReqCreationResponse xmlns:mpi-upop="http://mpi.netcetera.com/upop">
    <sessionId>7051ca63-e09d-4f6a-af8b-c64dc6354e4e</sessionId>
    <AuthReq>
        <MsgReq>
            <version>5.0.0</version>
            <encoding>UTF-8</encoding>
            <certId>68759529225</certId>
            <signMethod>01</signMethod>
            <txnType>79</txnType>
            <txnSubType>10</txnSubType>
            <bizType>000301</bizType>
            <accessType>1</accessType>
            <channelType>07</channelType>
            <frontUrl>http://localhost:8080/mpi-demo/validation-upop</frontUrl>
            <backUrl>http://localhost:8080/mpi-demo/upop</backUrl>
            <acqInsCode>33710276</acqInsCode>
            <merId>123456789012345</merId>
            <merCatCode>1234</merCatCode>
            <merName>UPOP Merchant</merName>
            <merAbbr>UPOP</merAbbr>
            <orderId>ohwh6kwpIYuBXALo2jHd</orderId>
            <txnTime>20160303201212</txnTime>
            <accType>01</accType>
            <accNo>4234123412340000</accNo>
            <currencyCode>756</currencyCode>
            <txnAmt>10000</txnAmt>
            <reqReserved>7051ca63-e09d-4f6a-af8b-c64dc6354e4e</reqReserved>
            <reserved>e2NvdW50cnk9NzU2Jm1lclVybD1odHRwOi8vbG9jYWxob3N0OjgwODAvbXBpJmNvbW1vZGl0eURlc2M9ZGVzY3JpcHRpb259</reserved>
            <customerInfo></customerInfo>
            <encryptCertId></encryptCertId>
            <relTxnType>01</relTxnType>
            <customerIp>123.123.123.123</customerIp>
        </MsgReq>
        <Signature>
            <SignatureValue>oelY7/EBnO+0VgZ7mDVt6gSch4kE/KNFRwjzvMCGMAxdYG/lIWsB37t2qtzscX/lrVpdEBNOv0KyeL7idltWQPPVDzRiMcxZRJ92sYXWEkbaWdwiqPYla+9MKpygKQJAclIVJWp3PtqtaA5Yj+3v3B9+UY4OWP8CCc0WSofqBlrRmCVtaVxOAvIJVRnAKhmW6fdQEtGD1lDDIy6kNCDZOsToEG5NhJ+U8b9NOV/WnLx9H6P92qVGfOrA0Cmw+9dKs9hS33C096y5Bc5pBXHUb5ytmahysX4kjTKeWqAjdomMuaRdBu60oLBxP/MUMTkELmLz5j3NaRhv/fvh9E4vtQ==</SignatureValue>
        </Signature>
    </AuthReq>
    <ACPReq><UPACPPay><MsgReq><version>5.0.0</version><encoding>UTF-8</encoding><certId>68759529225</certId><signMethod>01</signMethod><txnType>79</txnType><txnSubType>10</txnSubType><bizType>000301</bizType><accessType>1</accessType><channelType>07</channelType><frontUrl>http://localhost:8080/mpi-demo/validation-upop</frontUrl><backUrl>http://localhost:8080/mpi-demo/upop</backUrl><acqInsCode>33710276</acqInsCode><merId>123456789012345</merId><merCatCode>1234</merCatCode><merName>UPOP Merchant</merName><merAbbr>UPOP</merAbbr><orderId>ohwh6kwpIYuBXALo2jHd</orderId><txnTime>20160303201212</txnTime><accType>01</accType><accNo>4234123412340000</accNo><currencyCode>756</currencyCode><txnAmt>10000</txnAmt><reqReserved>7051ca63-e09d-4f6a-af8b-c64dc6354e4e</reqReserved><reserved>e2NvdW50cnk9NzU2Jm1lclVybD1odHRwOi8vbG9jYWxob3N0OjgwODAvbXBpJmNvbW1vZGl0eURlc2M9ZGVzY3JpcHRpb259</reserved><customerInfo></customerInfo><encryptCertId></encryptCertId><relTxnType>01</relTxnType><customerIp>123.123.123.123</customerIp></MsgReq><Signature><SignatureValue>oelY7/EBnO+0VgZ7mDVt6gSch4kE/KNFRwjzvMCGMAxdYG/lIWsB37t2qtzscX/lrVpdEBNOv0KyeL7idltWQPPVDzRiMcxZRJ92sYXWEkbaWdwiqPYla+9MKpygKQJAclIVJWp3PtqtaA5Yj+3v3B9+UY4OWP8CCc0WSofqBlrRmCVtaVxOAvIJVRnAKhmW6fdQEtGD1lDDIy6kNCDZOsToEG5NhJ+U8b9NOV/WnLx9H6P92qVGfOrA0Cmw+9dKs9hS33C096y5Bc5pBXHUb5ytmahysX4kjTKeWqAjdomMuaRdBu60oLBxP/MUMTkELmLz5j3NaRhv/fvh9E4vtQ==</SignatureValue></Signature></UPACPPay></ACPReq>
</mpi-upop:AuthReqCreationResponse>

AuthResValidationRequest samples

In order to verify the contents in the Authentication Response, values from the Authentication Request are needed. This data can be:

  • cached internally, or
  • could by provided externally through the API in the sessionData element.

Cached internally

AuthResValidationRequest (JSON)
1
2
3
{
  "ACPRes" : "<UPACPPay></UPACPPay>"
}
AuthResValidationRequest (XML)
1
2
3
<mpi-upop:AuthResValidationRequest xmlns:mpi-upop="http://mpi.netcetera.com/upop">
  <ACPRes><UPACPPay><MsgRes><version>5.0.0</version><encoding>UTF-8</encoding><certId>68759585097</certId><signMethod>01</signMethod><txnType>79</txnType><txnSubType>10</txnSubType><bizType>000301</bizType><accessType>1</accessType><acqInsCode>33710276</acqInsCode><merId>123456789012345</merId><orderId>5BBLcsMvafYrh9B0359g</orderId><accType>01</accType><accNo>6222821234560017</accNo><currencyCode>156</currencyCode><txnAmt>1000</txnAmt><activateStatus>Y</activateStatus><reqReserved>53071016-c253-41f0-8450-3073ebab6388</reqReserved><reserved>e3Zjb2RlPTIwMTYwNDI5MjA0MzUxMTAwMDgxJmVjaT0wOX0</reserved><respCode>00</respCode><respMsg>Success</respMsg></MsgRes><Signature><SignatureValue>h553aZYpHxgfjZmiyLaHtg6EzbhR83sJRBXZlTT6zsAJeiCGha0g/26yuMle0dErDjbpeiUpm90uzQN0CwlvC6mc6guM3pXfxIWVc3aCpHfjdUdgyCb4iTgZTfeCFHfFtoVwbvXoeJ3g9Az0Eo4Ymly/SYe1G9Y8vV4A7ookFKCBL621/RaAN9fXP41YkJJszYtp8nmsHDGFjRS5hh/L0kz4r0EH1/bpE8n5MuVOiT/LE7S17bzgUXgKDCrN7e8imgigyp6DrvbA6t/d4Q4TJM2LoHBQck2jN/iiKzW2TpZ0MnGmEVTqg/xyhkhlvD+T4egrbVm0LEz6CeK7+jE1Xg==</SignatureValue></Signature></UPACPPay></ACPRes>
</mpi-upop:AuthResValidationRequest>
AuthResValidationRequest (POST parameters)
1
ACPRes=<UPACPPay></UPACPPay>

Provided externally through the API

AuthResValidationRequest & Session data (JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "ACPRes" : "<UPACPPay></UPACPPay>",
  "SessionData": {
    "AuthReq": {
      "MsgReq": {
        "version": "5.0.0",
        "encoding": "UTF-8",
        "certId": "12973642333506194180",
        "signMethod": "01",
        "txnType": "79",
        "txnSubType": "10",
        "bizType": "000301",
        "accessType": "01",
        "channelType": "07",
        "frontUrl": "https://...",
        "backUrl": "https://...",
        "acqInsCode": "123458",
        "merId": "123456789012345",
        "merCatCode": "1234",
        "merName": "UPOP Merchant",
        "merAbbr": "UPOP",
        "orderId": "ohwh6kwpIYuBXALo2jHd",
        "txnTime": "20160363081212",
        "accType": "1",
        "accNo": "4234123412340000",
        "currencyCode": "756",
        "txnAmt": "10000",
        "reqReserved": "add66b53-4069-474b-aac5-41fa3df20a43",
        "reserved": "e2NvdW50cnk9NzU2Jm1lclVybD1odHRwOi8vbG9jYWxob3N0OjgwODAvbXBpJmNvbW1vZGl0eURlc2M9ZGVzY3JpcHRpb259",
        "relTxnType": "01",
        "customerIp": "123.123.123.123"
      },
      "Signature": {
          "SignatureValue": "jqN3J9oSHAc1p2yLPa+qohd9GMtxaaUtqu7LglKFCF3/8w7cLUkRRXXCsxyAsU4s0Bkq3RK810yCCyVbS9oDL1E69oT9BRJ81WMdRN2x8DOWWw5F6VAmTqjQaoMxfWsNbWlKi9/eJcZiGk1azYXR21S8DEK4sWkVu8LNHI2N0JIci85H5qwU4T4HMB0Z0aBIp6BBNchuHB8thrBmgARj9ahTzhXG0fepPZKQXkngGiOrqN5FokhZS6hTjwcrnB3S8Tb1RKK4xtPebUf/6bvjhNMnJyT1h7/vl4fAWlm8m8sgkw4a0rwFBwz6YJQ+kG5leIQ26tla4pJMTa8Ew7vj2Q=="
      }
    }
  }
}
AuthResValidationRequest & Session data (XML)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<mpi-upop:AuthResValidationRequest xmlns:mpi-upop="http://mpi.netcetera.com/upop">
  <ACPRes><UPACPPay><MsgRes><version>5.0.0</version><encoding>UTF-8</encoding><certId>68759585097</certId><signMethod>01</signMethod><txnType>79</txnType><txnSubType>10</txnSubType><bizType>000301</bizType><accessType>1</accessType><acqInsCode>33710276</acqInsCode><merId>123456789012345</merId><orderId>5BBLcsMvafYrh9B0359g</orderId><accType>01</accType><accNo>6222821234560017</accNo><currencyCode>156</currencyCode><txnAmt>1000</txnAmt><activateStatus>Y</activateStatus><reqReserved>53071016-c253-41f0-8450-3073ebab6388</reqReserved><reserved>e3Zjb2RlPTIwMTYwNDI5MjA0MzUxMTAwMDgxJmVjaT0wOX0</reserved><respCode>00</respCode><respMsg>Success</respMsg></MsgRes><Signature><SignatureValue>h553aZYpHxgfjZmiyLaHtg6EzbhR83sJRBXZlTT6zsAJeiCGha0g/26yuMle0dErDjbpeiUpm90uzQN0CwlvC6mc6guM3pXfxIWVc3aCpHfjdUdgyCb4iTgZTfeCFHfFtoVwbvXoeJ3g9Az0Eo4Ymly/SYe1G9Y8vV4A7ookFKCBL621/RaAN9fXP41YkJJszYtp8nmsHDGFjRS5hh/L0kz4r0EH1/bpE8n5MuVOiT/LE7S17bzgUXgKDCrN7e8imgigyp6DrvbA6t/d4Q4TJM2LoHBQck2jN/iiKzW2TpZ0MnGmEVTqg/xyhkhlvD+T4egrbVm0LEz6CeK7+jE1Xg==</SignatureValue></Signature></UPACPPay></ACPRes>
  <SessionData>
     <AuthReq>
        <MsgReq>
            <version>5.0.0</version>
            <encoding>UTF-8</encoding>
            <certId>12973642333506194180</certId>
            <signMethod>01</signMethod>
            <txnType>79</txnType>
            <txnSubType>10</txnSubType>
            <bizType>000301</bizType>
            <accessType>1</accessType>
            <channelType>07</channelType>
            <frontUrl>https://...</frontUrl>
            <backUrl>https://...</backUrl>
            <acqInsCode>33710276</acqInsCode>
            <merId>123456789012345</merId>
            <merName>UPOP Merchant</merName>
            <orderId>5BBLcsMvafYrh9B0359g</orderId>
            <txnTime>20160363081212</txnTime>
            <accType>01</accType>
            <accNo>6222821234560017</accNo>
            <currencyCode>156</currencyCode>
            <txnAmt>1000</txnAmt>
            <reqReserved>53071016-c253-41f0-8450-3073ebab6388</reqReserved>
            <reserved>e2NvdW50cnk9NzU2Jm1lclVybD1odHRwOi8vbG9jYWxob3N0OjgwODAvbXBpJmNvbW1vZGl0eURlc2M9ZGVzY3JpcHRpb259</reserved>
            <relTxnType>01</relTxnType>
            <customerIp>123.123.123.123</customerIp>
        </MsgReq>
     </AuthReq>
  </SessionData>
</mpi-upop:AuthResValidationRequest>
AuthResValidationRequest & Session data (POST parameters)
1
ACPRes=<UPACPPay></UPACPPay>&SessionData.authReq.msgReq.version=5.0.0&SessionData.authReq.msgReq.encoding=UTF-8&SessionData.authReq.msgReq.certId=12973642333506194180&SessionData.authReq.msgReq.signMethod=01&SessionData.authReq.msgReq.txnType=79&SessionData.authReq.msgReq.txnSubType=10&SessionData.authReq.msgReq.bizType=000301&SessionData.authReq.msgReq.accessType=01&SessionData.authReq.msgReq.channelType=07&SessionData.authReq.msgReq.frontUrl=https://...&SessionData.authReq.msgReq.backUrl=https://...&SessionData.authReq.msgReq.acqInsCode=123458&SessionData.authReq.msgReq.merId=123456789012345&SessionData.authReq.msgReq.merCatCode=1234&SessionData.authReq.msgReq.merName=UPOP Merchant&SessionData.authReq.msgReq.merAbbr=UPOP&SessionData.authReq.msgReq.orderId=ohwh6kwpIYuBXALo2jHd&SessionData.authReq.msgReq.txnTime=20160363081212&SessionData.authReq.msgReq.accType=1&SessionData.authReq.msgReq.accNo=42341234123400001&SessionData.authReq.msgReq.currencyCode=7561&SessionData.authReq.msgReq.txnAmt=100001&SessionData.authReq.msgReq.reqReserved=add66b53-4069-474b-aac5-41fa3df20a431&SessionData.authReq.msgReq.reserved=e2NvdW50cnk9NzU2Jm1lclVybD1odHRwOi8vbG9jYWxob3N0OjgwODAvbXBpJmNvbW1vZGl0eURlc2M9ZGVzY3JpcHRpb2591&SessionData.authReq.msgReq.relTxnType=011&SessionData.authReq.msgReq.customerIp=123.123.123.123&SessionData.authReq.Signature.SignatureValue=jqN3J9oSHAc1p2yLPa+qohd9GMtxaaUtqu7LglKFCF3/8w7cLUkRRXXCsxyAsU4s0Bkq3RK810yCCyVbS9oDL1E69oT9BRJ81WMdRN2x8DOWWw5F6VAmTqjQaoMxfWsNbWlKi9/eJcZiGk1azYXR21S8DEK4sWkVu8LNHI2N0JIci85H5qwU4T4HMB0Z0aBIp6BBNchuHB8thrBmgARj9ahTzhXG0fepPZKQXkngGiOrqN5FokhZS6hTjwcrnB3S8Tb1RKK4xtPebUf/6bvjhNMnJyT1h7/vl4fAWlm8m8sgkw4a0rwFBwz6YJQ+kG5leIQ26tla4pJMTa8Ew7vj2Q==

AuthResValidationResponse samples

AuthResValidationResponse (JSON)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "sessionId": "53071016-c253-41f0-8450-3073ebab6388",
  "AuthRes": {
    "MsgRes": {
      "version": "5.0.0",
      "encoding": "UTF-8",
      "certId": "68759585097",
      "signMethod": "01",
      "txnType": "79",
      "txnSubType": "10",
      "bizType": "000301",
      "accessType": "1",
      "acqInsCode": "33710276",
      "merId": "123456789012345",
      "orderId": "5BBLcsMvafYrh9B0359g",
      "accType": "01",
      "accNo": "6222821234560017",
      "currencyCode": "156",
      "txnAmt": "1000",
      "activateStatus": "Y",
      "reqReserved": "53071016-c253-41f0-8450-3073ebab6388",
      "reserved": "e3Zjb2RlPTIwMTYwNDI5MjA0MzUxMTAwMDgxJmVjaT0wOX0",
      "respCode": "00",
      "respMsg": "Success"
    },
    "Signature": {
      "SignatureValue": "h553aZYpHxgfjZmiyLaHtg6EzbhR83sJRBXZlTT6zsAJeiCGha0g/26yuMle0dErDjbpeiUpm90uzQN0CwlvC6mc6guM3pXfxIWVc3aCpHfjdUdgyCb4iTgZTfeCFHfFtoVwbvXoeJ3g9Az0Eo4Ymly/SYe1G9Y8vV4A7ookFKCBL621/RaAN9fXP41YkJJszYtp8nmsHDGFjRS5hh/L0kz4r0EH1/bpE8n5MuVOiT/LE7S17bzgUXgKDCrN7e8imgigyp6DrvbA6t/d4Q4TJM2LoHBQck2jN/iiKzW2TpZ0MnGmEVTqg/xyhkhlvD+T4egrbVm0LEz6CeK7+jE1Xg=="
    }
  },
  "orderId": "5BBLcsMvafYrh9B0359g",
  "authenticationStatus": "Y",
  "responseCode": "00",
  "responseMessage": "Success",
  "vcode": "20160429204351100081",
  "eci": "09"
}

AuthResValidationResponse (XML)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<mpi-upop:AuthReqValidationResponse xmlns:mpi-upop="http://mpi.netcetera.com/upop">
    <sessionId>53071016-c253-41f0-8450-3073ebab6388</sessionId>
    <AuthRes>
        <MsgRes>
            <version>5.0.0</version>
            <encoding>UTF-8</encoding>
            <certId>68759585097</certId>
            <signMethod>01</signMethod>
            <txnType>79</txnType>
            <txnSubType>10</txnSubType>
            <bizType>000301</bizType>
            <accessType>1</accessType>
            <acqInsCode>33710276</acqInsCode>
            <merId>123456789012345</merId>
            <orderId>5BBLcsMvafYrh9B0359g</orderId>
            <accType>01</accType>
            <accNo>6222821234560017</accNo>
            <currencyCode>156</currencyCode>
            <txnAmt>1000</txnAmt>
            <activateStatus>Y</activateStatus>
            <reqReserved>53071016-c253-41f0-8450-3073ebab6388</reqReserved>
            <reserved>e3Zjb2RlPTIwMTYwNDI5MjA0MzUxMTAwMDgxJmVjaT0wOX0</reserved>
            <respCode>00</respCode>
            <respMsg>Success</respMsg>
        </MsgRes>
        <Signature>
            <SignatureValue>h553aZYpHxgfjZmiyLaHtg6EzbhR83sJRBXZlTT6zsAJeiCGha0g/26yuMle0dErDjbpeiUpm90uzQN0CwlvC6mc6guM3pXfxIWVc3aCpHfjdUdgyCb4iTgZTfeCFHfFtoVwbvXoeJ3g9Az0Eo4Ymly/SYe1G9Y8vV4A7ookFKCBL621/RaAN9fXP41YkJJszYtp8nmsHDGFjRS5hh/L0kz4r0EH1/bpE8n5MuVOiT/LE7S17bzgUXgKDCrN7e8imgigyp6DrvbA6t/d4Q4TJM2LoHBQck2jN/iiKzW2TpZ0MnGmEVTqg/xyhkhlvD+T4egrbVm0LEz6CeK7+jE1Xg==</SignatureValue>
        </Signature>
    </AuthRes>
    <orderId>5BBLcsMvafYrh9B0359g</orderId>
    <authenticationStatus>Y</authenticationStatus>
    <responseCode>00</responseCode>
    <responseMessage>Success</responseMessage>
    <vcode>20160429204351100081</vcode>
    <eci>09</eci>
</mpi-upop:AuthReqValidationResponse>

AuthStatusInquiryRequest samples

To query the authentication status of a request, a AuthStatusInquiryRequest is sent to MPI.

AuthStatusInquiryRequest (JSON)

1
2
3
4
5
6
7
{
   "accessType": "Acquirer",
   "acquiringInstitutionCode": "12345678",
   "merchantId": "123456789012345",
   "transactionTime": "2016-03-03T12:12:12Z",
   "orderId": "ohwh6kwpIYuBXALo2jHd"
}

AuthStatusInquiryRequest (XML)

1
2
3
4
5
6
7
<mpi-upop:AuthStatusInquiryRequest xmlns:mpi-upop="http://mpi.netcetera.com/upop">
  <accessType>Acquirer</accessType>
  <acquiringInstitutionCode>33710276</acquiringInstitutionCode>
  <merchantId>123456789012345</merchantId>
  <transactionTime>2016-04-29T13:41:47Z</transactionTime>
  <orderId>ohwh6kwpIYuBXALo2jHd</orderId>
</mpi-upop:AuthStatusInquiryRequest>

AuthStatusInquiryRequest (POST parameters)

1
accessType=Acquirer&acquiringInstitutionCode=12345678&merchantId=123456789012345&transactionTime=2016-03-03T12:12:12Z&orderId=ohwh6kwpIYuBXALo2jHd

AuthStatusInquiryResponse samples

AuthStatusInquiryResponse (JSON)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
  "authenticationStatus": "",
  "originalResponseCode": "",
  "originalResponseMessage": "",
  "responseCode": "10",
  "responseMessage": "报文格式错误[6100030]",
  "AuthQueryReq": {
    "MsgReq": {
      "version": "5.0.0",
      "encoding": "UTF-8",
      "certId": "68759529225",
      "signMethod": "01",
      "txnType": "78",
      "txnSubType": "10",
      "bizType": "000301",
      "accessType": "1",
      "acqInsCode": "33710276",
      "merId": "123456789012345",
      "orderId": "ohwh6kwpIYuBXALo2jHd",
      "txnTime": "20160429214147"
    },
    "Signature": {
      "SignatureValue": "iEUHUJ9m8sl6GQ8hM7jECQim8C/G+avkFwuYFBgxU7ctHuhVtjYLqf8R+8w/7WhaD7GfRyrDzEam5I+TsFbqTo/rvgdPkxnW1awMvO8/NVSiXON+lK87vPNxpRA1PQ7DPYWLwdmupjEcvAXfMpJjEK1yRQGOrntDdgr5sU637HfB59Iv40vkIIAjwWhNo4XLiX/PHWUcjPiHwGiF0Qcj1R4aadFYhqnRstDesx2dzjGbn2HArZzcB4Jt/T11zDZBCJPk/EWHtAzDq/K1RF0Mm1DcT/+n+1Xtk9+eab8oXSaOEJlpoo+8HlHmhx/a76FKJX76Adf6/wXO/jYQawagbg=="
    }
  },
  "AuthQueryRes": {
    "MsgRes": {
      "version": "5.0.0",
      "encoding": "UTF-8",
      "certId": "68759585097",
      "signMethod": "01",
      "txnType": "78",
      "txnSubType": "10",
      "bizType": "000301",
      "accessType": "1",
      "acqInsCode": "33710276",
      "merId": "123456789012345",
      "orderId": "ohwh6kwpIYuBXALo2jHd",
      "txnTime": "20160429214147",
      "accNo": "",
      "currencyCode": "",
      "txnAmt": "",
      "activateStatus": "",
      "reqReserved": "",
      "reserved": "",
      "respCode": "10",
      "respMsg": "报文格式错误[6100030]",
      "origRespCode": "",
      "origRespMsg": ""
    },
    "Signature": {
      "SignatureValue": "posEUhu3mhWSUzSSLJ cV6pZUjSCsk9FVvL6W8Vvzo 7yNL06DlzLvV17Bh1aqlFhAOBBUOuVSXMF9Qg7QCrGD5ZOV5/AZJfDg1YasoBmStJH8m//BItIb06l0PWBV/1yRPV9IMqKNGpGUoROrURe d FFATIUG/KdZlkyFKTbnT569wKfJnExkVRo6OF1LOhyMMW8RPyzmNjsZRbeDDSJc1LnHr2kB39bRdO2YHniq7qD2Vlt3hctV2ZvflM4lCK9KPIFh 3TfZzQsKYcKs5840454bFvQrNkdkia2u1a57CpdOxEN1y7NCbm5GUP51aK 99yVIrEWg9HX0dUfzMA=="
    }
  }
}

AuthStatusInquiryResponse(XML)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<mpi-upop:AuthStatusInquiryResponse xmlns:mpi-upop="http://mpi.netcetera.com/upop">
    <authenticationStatus></authenticationStatus>
    <originalResponseCode></originalResponseCode>
    <originalResponseMessage></originalResponseMessage>
    <responseCode>10</responseCode>
    <responseMessage>报文格式错误[6100030]</responseMessage>
    <AuthQueryReq>
        <MsgReq>
            <version>5.0.0</version>
            <encoding>UTF-8</encoding>
            <certId>68759529225</certId>
            <signMethod>01</signMethod>
            <txnType>78</txnType>
            <txnSubType>10</txnSubType>
            <bizType>000301</bizType>
            <accessType>1</accessType>
            <acqInsCode>33710276</acqInsCode>
            <merId>123456789012345</merId>
            <orderId>ohwh6kwpIYuBXALo2jHd</orderId>
            <txnTime>20160429214147</txnTime>
        </MsgReq>
        <Signature>
            <SignatureValue>iEUHUJ9m8sl6GQ8hM7jECQim8C/G+avkFwuYFBgxU7ctHuhVtjYLqf8R+8w/7WhaD7GfRyrDzEam5I+TsFbqTo/rvgdPkxnW1awMvO8/NVSiXON+lK87vPNxpRA1PQ7DPYWLwdmupjEcvAXfMpJjEK1yRQGOrntDdgr5sU637HfB59Iv40vkIIAjwWhNo4XLiX/PHWUcjPiHwGiF0Qcj1R4aadFYhqnRstDesx2dzjGbn2HArZzcB4Jt/T11zDZBCJPk/EWHtAzDq/K1RF0Mm1DcT/+n+1Xtk9+eab8oXSaOEJlpoo+8HlHmhx/a76FKJX76Adf6/wXO/jYQawagbg==</SignatureValue>
        </Signature>
    </AuthQueryReq>
    <AuthQueryRes>
        <MsgRes>
            <version>5.0.0</version>
            <encoding>UTF-8</encoding>
            <certId>68759585097</certId>
            <signMethod>01</signMethod>
            <txnType>78</txnType>
            <txnSubType>10</txnSubType>
            <bizType>000301</bizType>
            <accessType>1</accessType>
            <acqInsCode>33710276</acqInsCode>
            <merId>123456789012345</merId>
            <orderId>ohwh6kwpIYuBXALo2jHd</orderId>
            <txnTime>20160429214147</txnTime>
            <accNo></accNo>
            <currencyCode></currencyCode>
            <txnAmt></txnAmt>
            <activateStatus></activateStatus>
            <reqReserved></reqReserved>
            <reserved></reserved>
            <respCode>10</respCode>
            <respMsg>报文格式错误[6100030]</respMsg>
            <origRespCode></origRespCode>
            <origRespMsg></origRespMsg>
        </MsgRes>
        <Signature>
            <SignatureValue>posEUhu3mhWSUzSSLJ cV6pZUjSCsk9FVvL6W8Vvzo 7yNL06DlzLvV17Bh1aqlFhAOBBUOuVSXMF9Qg7QCrGD5ZOV5/AZJfDg1YasoBmStJH8m//BItIb06l0PWBV/1yRPV9IMqKNGpGUoROrURe d FFATIUG/KdZlkyFKTbnT569wKfJnExkVRo6OF1LOhyMMW8RPyzmNjsZRbeDDSJc1LnHr2kB39bRdO2YHniq7qD2Vlt3hctV2ZvflM4lCK9KPIFh 3TfZzQsKYcKs5840454bFvQrNkdkia2u1a57CpdOxEN1y7NCbm5GUP51aK 99yVIrEWg9HX0dUfzMA==</SignatureValue>
        </Signature>
    </AuthQueryRes>
</mpi-upop:AuthStatusInquiryResponse>