3DS 1.0 API

3DS 1.0 Flow

3DS 1.0 Authentication Flow

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

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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
  elementFormDefault="unqualified" attributeFormDefault="unqualified" targetNamespace="http://mpi.netcetera.com">
 
  <xs:import schemaLocation="mpi-common.xsd" namespace="http://mpi.netcetera.com/common" />
  <xs:import schemaLocation="ThreeDSecure.xsd" />
 
  <xs:annotation>
    <xs:documentation>
      <![CDATA[
      MPI API Naming convention:
       
      * All names of element with complex type are starting with an upper case letter (in line with 3-D Secure protocol messages)
 
      * All names of element with simple type are starting with a lower case letter (in line with 3-D Secure protocol messages)
       
      * All attribute names start with a lower case letter (in line with 3-D Secure protocol messages)
       
      * Elements containing 3-D Secure protocol messages are pre-fixed with "ThreeDSecure"
        and post-fixed with the message they contain. (e.g. ThreeDSecurePAReq for a PAReq message)
         
      * Elements passed between the Merchant and the ACS via the cardholder browser
        use names as specified by the 3-D Secure protocol documentation. (PaRes, PaReq)
       
        ]]>
    </xs:documentation>
  </xs:annotation>
  <xs:element name="PaReqCreationRequest">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Root element of the PaReq creation request.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:annotation>
        <xs:documentation>
          <![CDATA[
            The PaReqCreationRequest passed to MPI for the createPaReqIfEnrolled call.
          ]]>
        </xs:documentation>
      </xs:annotation>
      <xs:sequence>
        <xs:element name="Cardholder" type="mpi:Cardholder" minOccurs="0" />
        <xs:element name="Purchase" type="mpi:Purchase" minOccurs="0" />
        <xs:element name="Merchant" type="mpi:Merchant" minOccurs="0" />
        <xs:element name="Browser" type="mpi:Browser" minOccurs="0" />
        <xs:element name="Extension" type="xs:anyType" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
  <xs:element name="PaReqCreationResponse">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Root element of the PaReq creation response.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:annotation>
        <xs:documentation>
          <![CDATA[
            The response returned from the createPaReqIfEnrolled call.
          ]]>
        </xs:documentation>
      </xs:annotation>
      <xs:sequence>
        <xs:element name="sessionId" type="mpi:SessionId" minOccurs="1" />
        <xs:element name="SessionData" type="mpi:SessionData" minOccurs="0" />
        <xs:element name="PaReq" type="xs:string" minOccurs="0" />
        <xs:element name="ThreeDSecureVEReq" type="ThreeDSecureType" minOccurs="0" />
        <xs:element name="ThreeDSecureVERes" type="ThreeDSecureType" minOccurs="0" />
        <xs:element name="Error" type="mpi-common:ErrorDetails" minOccurs="0" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
  <xs:element name="PaResValidationRequest">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Root element of the PaRes validation request.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:annotation>
        <xs:documentation>
          <![CDATA[
            The PaResValidationRequest passed to MPI for the validatePaRes call.
          ]]>
        </xs:documentation>
      </xs:annotation>
      <xs:sequence>
        <xs:element name="PaRes" type="xs:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
                The deflated and base64 encoded PARes, as returned from the ACS.
              ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="SessionData" type="mpi:SessionData" minOccurs="0" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
  <xs:element name="PaResValidationResponse">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Root element of the PaRes validation response.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:annotation>
        <xs:documentation>
          <![CDATA[
            The PaResValidationResponse returned to the Merchant after Payer Authentication Process.
          ]]>
        </xs:documentation>
      </xs:annotation>
      <xs:sequence>
        <xs:element name="sessionId" type="mpi:SessionId" minOccurs="1" />
        <xs:element name="cavv" type="xs:string" minOccurs="0" >
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
                Cardholder authentication verification value. It is a 28 byte value (Base64 encoded 20 byte cavv).
              ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="cavvHex" type="xs:string" minOccurs="0" >
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
                Cardholder authentication verification value. It is a hexadecimal encoded cavv.
              ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="eci" type="xs:string" minOccurs="0" />
        <xs:element name="transactionStatus" type="xs:string" minOccurs="0" />
        <xs:element name="xid" type="xs:string" minOccurs="0" >
          <xs:annotation>
              <xs:documentation>
              <![CDATA[
                Transaction identifier. It is a 28 byte value (Base64 encoded 20 byte xid).
              ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="xidHex" type="xs:string" minOccurs="0" >
          <xs:annotation>
            <xs:documentation>
              <![CDATA[
                Transaction identifier. It is a hexadecimal encoded xid.
              ]]>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="ThreeDSecurePARes" type="ThreeDSecureType" minOccurs="0" maxOccurs="1"/>
        <xs:element name="Error" type="mpi-common:ErrorDetails" minOccurs="0" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
   
  <xs:complexType name="SessionData">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Element containing all the session data, needed by the MPI when the session is disabled.
          It is used in the validation of PARes.
        ]]>     
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
      <xs:element name="ThreeDSecurePAReq" type="ThreeDSecureType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
           <![CDATA[
              Use the same value returned by the MPI in the PaReqCreationResponse.
            ]]>         
          </xs:documentation>
        </xs:annotation>
      </xs:element>   
      <xs:element name="paReqCreationTime" type="mpi:DateTime" minOccurs="0" >
        <xs:annotation>
          <xs:documentation>
           <![CDATA[
              Use the same value returned by the MPI in the PaReqCreationResponse.
            ]]>         
          </xs:documentation>
        </xs:annotation>
      </xs:element>   
      <xs:element name="pan" type="xs:string" minOccurs="0" >
        <xs:annotation>
          <xs:documentation>
           <![CDATA[
              The last 4 digits of the actual pan as used in PaReqCreationRequest, padded with zeroes from left.
            ]]>         
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="scheme" type="mpi:SchemeId" minOccurs="0" >
        <xs:annotation>
          <xs:documentation>
           <![CDATA[
              The actual schemeId as used in PaReqCreationRequest.
            ]]>         
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="acsUrl" type="xs:string" minOccurs="0" >
        <xs:annotation>
          <xs:documentation>
           <![CDATA[
              The ACS URL from the PaReqCreationResponse.
            ]]>         
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="masterCardTokenized" type="xs:string" minOccurs="0" >
        <xs:annotation>
          <xs:documentation>
            Use the same value returned by the MPI in the PaReqCreationResponse.
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
 
  <xs:complexType name="Cardholder">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          The element containing cardholder related data.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
      <xs:element name="pan" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              The cardholder pan.
   
              - Length: 13-19 characters
              - Format: numeric digits
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
       
      <xs:element name="scheme" type="mpi:SchemeId" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              The schemeId for the pan. (configured scheme i.e. Visa, MasterCard, JCB, American Express, Diners...)
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="expiry" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Expiration Date supplied to merchant by cardholder (YYMM).
   
              - Length: 4 characters
              - Format: numeric digits
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
 
  <xs:complexType name="Browser">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          The element containing browser related data.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
      <xs:element name="accept" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              The exact content of the HTTP accept sent to the merchant from the cardholder's browser.
   
              - Length: 0-2048 characters
              - Format: any characters
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="userAgent" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              The exact content of the HTTP accept sent to the merchant from the cardholder's browser.
   
              - Length: 0-256 characters
              - Format: any characters
            ]]>
          </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="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Purchase amount in minor units of currency with all punctuation removed.
   
              - Length: 1-12 characters
              - Format: numeric digits
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="currency" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              ISO 4217 three digit currency code.
                             
              - Length: 3 characters
              - Format: numeric digits
              - Value:  ISO 4217 three digit currency
                        code, other than those listed in
                        Table C-9 of the 3-D Secure protocol
                        specification.
 
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
       
      <xs:element name="exponent" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              ISO 4217 exponent.
   
              - Length: 1 character
              - Format: numeric digit
              - Value:  ISO 4217 exponent
 
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
       
      <xs:element name="Recur" type="mpi:Recur" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Recurring payment option.
               
              Required if the merchant and cardholder have agreed to recurring payments.
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
       
      <xs:element name="install" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              The maximum number of permitted authorizations for installment payments.
               
              - Length: 0-3 character
              - Format: numeric digits
              - Value:  must be > 1
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="description" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Brief description of items purchased.
   
              - Length: 0-125 characters
              - Format: any characters
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="xid" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Transaction identifier determined by merchant or generated by 3DS Server if absent.
              Can be 20 byte value UTF-8 encoded (not Base64 encoded) that will be Base64 encoded by the MPI,
              giving a 28 byte result; or a 28 byte value resulting from Base64 encoding a 20 byte value
              (this one will be used by the MPI as-is).
   
              - Length: 20 byte value UTF-8 encoded or,
                        20 byte value Base64 encoded resulting in a 28 byte value or,
                        20 byte value Hexadecimal encoded
              - Format: any character
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="date" type="mpi:DateTime" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Date and time of purchase.
            ]]>
          </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="acquirerBin" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Acquiring institution identification code.
   
              - Length: 1-11 characters
              - Format: numeric digits
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="password" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Merchant password provided by merchant's acquirer.
   
              - Length: 8 characters
              - Format: alphanumeric
            ]]>
          </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
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="id" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Acquirer-defined merchant identifier.
   
              - Length: 1-24 characters
              - Format: any characters
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
 
      <xs:element name="name" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Merchant name to be displayed on Authentication Request Page.
   
              - Length: 1-25 characters
              - Format: any characters
            ]]>
          </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-2048 characters
              - Format: any characters
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
   
  <xs:complexType name="Recur">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Recurring payment.
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:sequence>
      <xs:element name="frequency" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              Indicates the minimum number of days between authorizations.
             
              - Length: 0-4 characters
              - Format: numeric digits
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="endRecur" type="mpi:Date" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <![CDATA[
              The date after which no further authorizations should be performed.
            ]]>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
 
 
  <xs:simpleType name="Date">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
            Date and time expressed in GMT.
             
            - Length: 8 characters
            - Format: YYYYMMDD where:
             
              - YYYY = 4 numeric digits
              - MM = 2 numeric digits with value 01-12
              - DD = 2 numeric digits with value 01-31
          ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string" />
  </xs:simpleType>
   
  <xs:simpleType name="DateTime">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
            Date and time expressed in GMT.
             
            - Length: 17 characters
            - Format: YYYYMMDD HH:MM:SS where:
             
              - YYYY = 4 numeric digits
              - MM = 2 numeric digits with value 01-12
              - DD = 2 numeric digits with value 01-31
              - a single space follows the date
              - HH = 2 numeric digits with value 00 24, followed by a colon (":")
              - MM = 2 numeric digits with value 00 59, followed by a colon (":")
              - SS = 2 numeric digits with value 00 59
          ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string" />
  </xs:simpleType>
   
  <xs:simpleType name="SchemeId">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Payment schemes.
           
          - One of the following values:
           
            - Visa
            - MasterCard
            - American Express
            - JCB
            - Diners
        ]]>
      </xs:documentation>
    </xs:annotation>
    <xs:restriction base="xs:string" />
  </xs:simpleType>
 
  <xs:simpleType name="SessionId">
    <xs:annotation>
      <xs:documentation>
        <![CDATA[
          Correlation id between Verify Enrollment and Payer Authentication processes.
        ]]>
      </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 3DSecure 1.x includes the 3-D Secure schema (ThreeDSecure.xsd) to refer to 3-D Secure protocol messages used in the response structures.

PaReqCreationRequest samples

There are two possibilities to transfer the merchant data to the Directory Server:

  • Merchant configured via the Admin application
  • Merchant configuration data passed in the PaReqCreationRequest

Merchant configured via the Admin application

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

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

  • merchant.id
  • purchase.amount
  • purchase.currency
  • cardholder.expiry
  • cardholder.pan

Optional is:

  • purchase.xid
  • purchase.exponent
PaReqCreationRequest (minimum valid JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "Cardholder": {
    "pan": "4234123412340000",
    "expiry": "1612"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756"
  },
  "Merchant": {
    "id": "merId"
  }
}
PaReqCreationRequest (JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "Cardholder": {
    "pan": "4234123412340000",
    "expiry": "1612"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756",
    "exponent": "2",
    "description": "description",
    "xid": "ohwh6kwpIYuBXALo2jHd"
  },
  "Merchant": {
    "id": "merId"
  },
  "Browser": {
    "accept": "application/xml",
    "userAgent": "mozilla"
  }
}
PaReqCreationRequest (XML)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<mpi:PaReqCreationRequest xmlns:mpi="http://mpi.netcetera.com">
  <Cardholder>
    <pan>4234123412340000</pan>
    <expiry>1612</expiry>
  </Cardholder>
  <Purchase>
    <amount>10000</amount>
    <currency>756</currency>
    <exponent>2</exponent>
    <description>description</description>
    <xid>ohwh6kwpIYuBXALo2jHd</xid>
  </Purchase>
  <Merchant>
    <id>merId</id>
  </Merchant>
  <Browser>
    <accept>application/xml</accept>
    <userAgent>mozilla</userAgent>
  </Browser>
</mpi:PaReqCreationRequest>
PaReqCreationRequest (POST parameters)
1
Cardholder.pan=4234123412340000&Cardholder.expiry=1612&Purchase.xid=ohwh6kwpIYuBXALo2jHd&Purchase.amount=10000&Purchase.currency=756&Purchase.exponent=2&Purchase.description=description&Merchant.id=merId&Browser.accept=application/xml&browser.userAgent=mozilla

Merchant configuration data in PaReqCreationRequest

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

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

  • merchant.acquirerBin
  • merchant.countryCode
  • merchant.id
  • merchant.name
  • merchant.url
  • purchase.currency
  • purchase.amount
  • cardholder.expiry
  • cardholder.pan

Optional is:

  • merchant.password
  • purchase.xid
  • purchase.exponent
PaReqCreationRequest & Merchant data (minimum valid JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "Cardholder": {
    "pan": "4234123412340000",
    "expiry": "1612"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756"
  },
  "Merchant": {
    "acquirerBin": "123456",
    "countryCode": "756",
    "id": "merId",
    "name": "Merchant",
  }
}
PaReqCreationRequest & 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
24
25
26
{
  "Cardholder": {
    "pan": "4234123412340000",
    "scheme": "Visa",
    "expiry": "1612"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756",
    "exponent": "2",
    "description": "description",
    "xid": "ohwh6kwpIYuBXALo2jHd"
  },
  "Merchant": {
    "acquirerBin": "123456",
    "password": "password",
    "countryCode": "756",
    "id": "merId",
    "name": "Merchant",
  },
  "Browser": {
    "accept": "application/xml",
    "userAgent": "mozilla"
  }
}
PaReqCreationRequest & 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
24
25
26
<mpi:PaReqCreationRequest xmlns:mpi="http://mpi.netcetera.com">
  <Cardholder>
    <pan>4234123412340000</pan>
    <scheme>Visa</scheme>
    <expiry>1612</expiry>
  </Cardholder>
  <Purchase>
    <amount>10000</amount>
    <currency>756</currency>
    <exponent>2</exponent>
    <description>description</description>
    <xid>ohwh6kwpIYuBXALo2jHd</xid>
  </Purchase>
  <Merchant>
    <acquirerBin>123456</acquirerBin>
    <password>password</password>
    <countryCode>756</countryCode>
    <id>merId</id>
    <name>Merchant</name>
    <url>http://localhost:8080/mpi</url>
  </Merchant>
  <Browser>
    <accept>application/xml</accept>
    <userAgent>mozilla</userAgent>
  </Browser>
</mpi:PaReqCreationRequest>
PaReqCreationRequest & Merchant data (POST parameters)
1
Cardholder.pan=4234123412340000&Cardholder.scheme=Visa&Cardholder.expiry=1612&Purchase.xid=ohwh6kwpIYuBXALo2jHd&Purchase.amount=10000&Purchase.currency=756&Purchase.exponent=2&Purchase.description=description&Merchant.acquirerBin=123456&Merchant.password=password&Merchant.countryCode=756&Merchant.id=merId&Merchant.url=http%3A%2F%2Flocalhost%3A8080%2Fshop&Merchant.name=Merchant&Browser.accept=application/xml&Browser.userAgent=mozilla

3-D Secure extension in PaReqCreationRequest

3-D Secure extensions are supported. They must be sent as a xml string for all media type requests.

PaReqCreationRequest & Extensions (minimum valid JSON)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "Cardholder": {
    "pan": "4234123412340000",
    "expiry": "1612"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756"
  },
  "Merchant": {
    "acquirerBin": "123456",
    "countryCode": "756",
    "id": "merId",
    "name": "Merchant",
  },
  "Extension": ["<Extension id=\"foo\" critical=\"false\"><foo>foo</foo><bar>bar</bar></Extension>"]
}
PaReqCreationRequest & Extensions (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
{
  "Cardholder": {
    "pan": "4234123412340000",
    "scheme": "Visa",
    "expiry": "1612"
  },
  "Purchase": {
    "amount": "10000",
    "currency": "756",
    "exponent": "2",
    "description": "description",
    "xid": "ohwh6kwpIYuBXALo2jHd"
  },
  "Merchant": {
    "acquirerBin": "123456",
    "password": "password",
    "countryCode": "756",
    "id": "merId",
    "name": "Merchant",
  },
  "Browser": {
    "accept": "application/xml",
    "userAgent": "mozilla"
  },
  "Extension": ["<Extension id=\"foo\" critical=\"false\"><foo>foo</foo><bar>bar</bar></Extension>"]
}
PaReqCreationRequest & Extensions (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
<mpi:PaReqCreationRequest xmlns:mpi="http://mpi.netcetera.com">
  <Cardholder>
    <pan>4234123412340000</pan>
    <scheme>Visa</scheme>
    <expiry>1612</expiry>
  </Cardholder>
  <Purchase>
    <amount>10000</amount>
    <currency>756</currency>
    <exponent>2</exponent>
    <description>description</description>
    <xid>ohwh6kwpIYuBXALo2jHd</xid>
  </Purchase>
  <Merchant>
    <acquirerBin>123456</acquirerBin>
    <password>password</password>
    <countryCode>756</countryCode>
    <id>merId</id>
    <name>Merchant</name>
    <url>http://localhost:8080/mpi</url>
  </Merchant>
  <Browser>
    <accept>application/xml</accept>
    <userAgent>mozilla</userAgent>
  </Browser>
  <Extension id="foo" critical="false">
    <foo>foo</foo>
    <bar>bar</bar>
  </Extension>
</mpi:PaReqCreationRequest>
PaReqCreationRequest & Extensions (POST parameters)
1
Cardholder.pan=4234123412340000&Cardholder.scheme=Visa&Cardholder.expiry=1612&Purchase.xid=ohwh6kwpIYuBXALo2jHd&Purchase.amount=10000&Purchase.currency=756&Purchase.exponent=2&Purchase.description=description&Merchant.acquirerBin=123456&Merchant.password=password&Merchant.countryCode=756&Merchant.id=merId&Merchant.url=http%3A%2F%2Flocalhost%3A8080%2Fshop&Merchant.name=Merchant&Browser.accept=application/xml&Browser.userAgent=mozilla&Extensions[0]=<Extension id="foo" critical="false"><foo>foo</foo><bar>bar</bar></Extension>

PaReqCreationResponse samples

PaReqCreationResponse (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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
{
  "sessionId" : "bc49647b-df73-4133-bf1f-4d641dacd6bb",
  "SessionData": {
    "paReqCreationTime" : "20131015 16:45:00",
    "pan" : "0000000000003445",
    "scheme" : "Visa",
    "acsUrl" : "http://www.acs-url.com",
    "masterCardTokenized" : "false",
    "ThreeDSecurePAReq" : {
      "Message" : [ {
        "PAReq" : {
          "version" : "1.0.2",
          "Merchant" : {
            "acqBIN" : "123456",
            "merID" : "merId",
            "password" : "p@ssword",
            "name" : "Groovy Merchant",
            "country" : "756",
            "url" : "http://groovy-merchant.com"
          },
          "Purchase" : {
            "xid" : "aXql9ldTUg7OHzBSHJax",
            "date" : "20131015 16:45:00",
            "amount" : "725",
            "purchAmount" : "725",
            "currency" : "756",
            "exponent" : "2",
            "desc" : "description"
          },
          "CH" : {
            "acctID" : "11111110000",
            "expiry" : "1612"
          }
        },
        "id" : "pa9d4eb548-db62-43b7-8cc8-8731ac202de2"
      } ]
    }
  },
  "PaReq" : "4j6h89g4kd92ks2==",
  "ThreeDSecureVEReq" : {
    "Message" : [ {
      "VEReq" : {
        "version" : "1.0.2",
        "pan" : "4234123412340000",
        "Merchant" : {
          "acqBIN" : "123456",
          "merID" : "merId"
        },
        "Browser" : {
          "deviceCategory" : "0",
          "accept" : "application/xml",
          "userAgent" : "mozilla"
        }
      },
      "id" : "veb7b8a083-aca2-4d9b-9bc4-be24c7981257"
    } ]
  },
  "ThreeDSecureVERes" : {
    "Message" : [ {
      "VERes" : {
        "version" : "1.0.2",
        "CH" : {
          "enrolled" : "Y",
          "acctID" : "11111110000"
        },
        "url" : "http://groovy-merchant.com",
        "protocol" : [ "ThreeDSecure" ]
      },
      "id" : "veb7b8a083-aca2-4d9b-9bc4-be24c7981257"
    } ]
  }
}

PaReqCreationResponse (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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<mpi:PaReqCreationResponse xmlns:mpi="http://mpi.netcetera.com">
  <sessionId>bc49647b-df73-4133-bf1f-4d641dacd6bb</sessionId>
  <SessionData>
    <ThreeDSecurePAReq>
      <Message id="pa9d4eb548-db62-43b7-8cc8-8731ac202de2">
        <PAReq>
          <version>1.0.2</version>
          <Merchant>
            <acqBIN>123456</acqBIN>
            <merID>merId</merID>
            <password>p@ssword</password>
            <name>Groovy Merchant</name>
            <country>756</country>
            <url>http://groovy-merchant.com</url>
          </Merchant>
          <Purchase>
            <xid>aXql9ldTUg7OHzBSHJax</xid>
            <date>20131015 16:45:00</date>
            <amount>725</amount>
            <purchAmount>725</purchAmount>
            <currency>756</currency>
            <exponent>2</exponent>
            <desc>description</desc>
          </Purchase>
          <CH>
            <acctID>11111110000</acctID>
            <expiry>1612</expiry>
          </CH>
        </PAReq>
      </Message>
    </ThreeDSecurePAReq>
    <paReqCreationTime>20131015 16:45:00</paReqCreationTime>
    <pan>0000000000003445</pan>
    <scheme>Visa</scheme>
    <acsUrl>http://www.acs-url.com</acsUrl>
    <masterCardTokenized>false</masterCardTokenized>
  </SessionData>
  <PaReq>4j6h89g4kd92ks2==</PaReq>
  <ThreeDSecureVEReq>
    <Message id="veb7b8a083-aca2-4d9b-9bc4-be24c7981257">
      <VEReq>
        <version>1.0.2</version>
        <pan>4234123412340000</pan>
        <Merchant>
          <acqBIN>123456</acqBIN>
          <merID>merId</merID>
        </Merchant>
        <Browser>
          <deviceCategory>0</deviceCategory>
          <accept>application/xml</accept>
          <userAgent>mozilla</userAgent>
        </Browser>
      </VEReq>
    </Message>
  </ThreeDSecureVEReq>
  <ThreeDSecureVERes>
    <Message id="veb7b8a083-aca2-4d9b-9bc4-be24c7981257">
      <VERes>
        <version>1.0.2</version>
        <CH>
          <enrolled>Y</enrolled>
          <acctID>11111110000</acctID>
        </CH>
        <url>http://www.acs-url.com</url>
        <protocol>ThreeDSecure</protocol>
      </VERes>
    </Message>
  </ThreeDSecureVERes>
 
</mpi:PaReqCreationResponse>

PaResValidationRequest samples

In order to verify the contents in the Payer Authentication Process step, values from the Verify Enrollment Step are needed. This data can be:

  • cached internally, or
  • could be provided externally through the API in the SessionData element.

Cached internally

PaResValidationRequest (JSON)
1
2
3
{
  "PaRes" : "4j6h89g4kd92ks2=="
}
PaResValidationRequest (XML)
1
2
3
<mpi:PaResValidationRequest xmlns:mpi="http://mpi.netcetera.com">
  <PaRes>4j6h89g4kd92ks2==</PaRes>
</mpi:PaResValidationRequest>
PaResValidationRequest (POST parameters)
1
PaRes=4j6h89g4kd92ks2==

Please note that the real PaReq value has 3-4Kb in length and the above example just demonstrates the request format.

Provided externally through the API

PaResValidationRequest & 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
{
  "PaRes" : "4j6h89g4kd92ks2==",
  "SessionData" : {
    "ThreeDSecurePAReq" : {
      "Message" : [ {
        "PAReq" : {
          "version" : "1.0.2",
          "Merchant" : {
            "acqBIN" : "123456",
            "merID" : "merId",
            "name" : "the merchant name",
            "country" : "756",
            "url" : "http://groovy-merchant.com"
          },
          "Purchase" : {
            "xid" : "aXql9ldTUg7OHzBSHJax",
            "date" : "20131015 16:45:00",
            "amount" : "725",
            "currency" : "756",
            "exponent" : "2",
            "desc" : "This is the description"
          },
          "CH" : {
            "acctID" : "accountId",
            "expiry" : "1612"
          }
        },
        "id" : "pa9d4eb548-db62-43b7-8cc8-8731ac202de2"
      } ]
    },
    "paReqCreationTime" : "20131015 16:45:01",
    "pan" : "0000000000005432",
    "scheme" : "Visa",
    "acsUrl" : "http://www.acs-url.com",
    "masterCardTokenized" : "false"
  }
}
PaResValidationRequest & 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
34
35
36
37
38
<mpi:PaResValidationRequest xmlns:mpi="http://mpi.netcetera.com">
  <PaRes>4j6h89g4kd92ks2==</PaRes>
  <SessionData>
    <ThreeDSecurePAReq>
      <Message id="pa9d4eb548-db62-43b7-8cc8-8731ac202de2">
        <PAReq>
          <version>1.0.2</version>
          <Merchant>
            <acqBIN>123456</acqBIN>
            <merID>merId</merID>
            <password>super secret password</password>
            <name>the merchant name</name>
            <country>756</country>
            <url>http://groovy-merchant.com</url>
          </Merchant>
          <Purchase>
            <xid>aXql9ldTUg7OHzBSHJax</xid>
            <date>20131015 16:45:00</date>
            <amount>725</amount>
            <purchAmount>725</purchAmount>
            <currency>756</currency>
            <exponent>2</exponent>
            <desc>This is the description</desc>
          </Purchase>
          <CH>
            <acctID>accountId</acctID>
            <expiry>1612</expiry>
          </CH>
        </PAReq>
      </Message>
    </ThreeDSecurePAReq>
    <paReqCreationTime>20131015 16:45:01</paReqCreationTime>
    <pan>0000000000005432</pan>
    <scheme>Visa</scheme>
    <acsUrl>http://www.acs-url.com</acsUrl>
    <masterCardTokenized>false</masterCardTokenized>
  </SessionData>
</mpi:PaResValidationRequest>
PaResValidationRequest & Session data (POST parameters)
1
PaRes=4j6h89g4kd92ks2==&SessionData.paReqCreationTime=20131015%2016:45:01&SessionData.pan=4234123412340000&SessionData.scheme=Visa&SessionData.acsUrl=http://www.acs-url.com&SessionData.ThreeDSecurePAReq.messages[0].id=pa9d4eb548-db62-43b7-8cc8-8731ac202de2&sessionData.threeDSecurePAReq.messages[0].paReq.version=1.0.2&sessionData.threeDSecurePAReq.messages[0].paReq.merchant.acqBIN=123456&sessionData.threeDSecurePAReq.messages[0].paReq.merchant.merID=merId&sessionData.threeDSecurePAReq.messages[0].paReq.merchant.name=the%20merchant%20name&sessionData.threeDSecurePAReq.messages[0].paReq.merchant.country=756&sessionData.threeDSecurePAReq.messages[0].paReq.merchant.url=http://groovy-merchant.com&sessionData.threeDSecurePAReq.messages[0].paReq.purchase.xid=aXql9ldTUg7OHzBSHJax&sessionData.threeDSecurePAReq.messages[0].paReq.purchase.date=20131015%2016:45:00&sessionData.threeDSecurePAReq.messages[0].paReq.purchase.amount=725&sessionData.threeDSecurePAReq.messages[0].paReq.purchase.currency=756&sessionData.threeDSecurePAReq.messages[0].paReq.purchase.exponent=2&sessionData.threeDSecurePAReq.messages[0].paReq.purchase.desc=This%20is%20the%20description&sessionData.threeDSecurePAReq.messages[0].paReq.CH.acctID=accountId&sessionData.threeDSecurePAReq.messages[0].paReq.CH.expiry=1612&sessionData.masterCardTokenized=false

PaResValidationResponse samples

PaResValidationResponse (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
{
  "sessionId" : "tYjRM3Yub2YWNDxaC2kwZvmK",
  "cavv" : "PrA7BJNfcaYsZrEHNECrKrnJ",
  "cavvHex": "50726166424a4e3132617364667245484e4543724b726e4a",
  "eci" : "05",
  "transactionStatus": "Y",
  "xid" : "aXql9ldTUg7OHzBSHJax",
  "xidHex" : "6173646632333435333234666173646661736466",
  "ThreeDSecurePARes" : {
    "Message" : [ {
      "PARes" : {
        "Purchase" : {
          "xid" : "aXql9ldTUg7OHzBSHJax",
          "date" : "20131015 16:45:00",
          "amount" : "725",
          "currency" : "756",
          "exponent" : "2",
          "desc" : "description"
        },
        "pan" : "0000000000000000",
        "TX" : {
          "time" : "16:45:02",
          "status" : "Y",
          "cavv" : "PrA7BJNfcaYsZrEHNECrKrnJ",
          "eci" : "05",
          "cavvAlgorithm" : "2"
        },
        "id" : "123456789"
      },
      "id" : "pa9d4eb548-db62-43b7-8cc8-8731ac202de2"
    } ]
  }
}

PaResValidationResponse (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
<mpi:PaResValidationResponse xmlns:mpi="http://mpi.netcetera.com">
  <sessionId>tYjRM3Yub2YWNDxaC2kwZvmK</sessionId>
  <cavv>PrA7BJNfcaYsZrEHNECrKrnJ</cavv>
  <cavvHex>50726166424a4e3132617364667245484e4543724b726e4a</cavvHex>
  <eci>05</eci>
  <transactionStatus>Y</transactionStatus>
  <xid>aXql9ldTUg7OHzBSHJax</xid>
  <xidHex>6173646632333435333234666173646661736466</xidHex>
  <ThreeDSecurePARes>
    <Message id="pa9d4eb548-db62-43b7-8cc8-8731ac202de2">
      <PARes id="123456789">
        <Purchase>
          <xid>aXql9ldTUg7OHzBSHJax</xid>
          <date>20131015 16:45:00</date>
          <amount>725</amount>
          <currency>756</currency>
          <exponent>2</exponent>
          <desc>description</desc>
        </Purchase>
        <pan>0000000000000000</pan>
        <TX>
          <time>20131015 16:45:02</time>
          <status>Y</status>
          <cavv>PrA7BJNfcaYsZrEHNECrKrnJ</cavv>
          <eci>05</eci>
          <cavvAlgorithm>2</cavvAlgorithm>
        </TX>
      </PARes>
    </Message>
  </ThreeDSecurePARes>
</mpi:PaResValidationResponse>