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 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 | <xs:element name="MpiConfiguration" type="MpiConfigurationType" /> <xs:complexType name="MpiConfigurationType"> <xs:sequence> <xs:element name="TimeoutSeconds" type="TimeoutSeconds" minOccurs="0"> <xs:annotation> <xs:documentation> <![CDATA[ Timeouts configuration. If not configured, default timeout seconds will be applied. Check the TimeoutSeconds type declaration below, for default timeout values. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="Scheme" type="Scheme" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> <![CDATA[ The list of Schemes. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="UpopParameters" type="UpopParameters" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation> <![CDATA[ The Union Pay configuration. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="Acquirer" type="Acquirer" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> <![CDATA[ The list of Acquirers. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="Merchant" type="Merchant" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> <![CDATA[ The list of Merchants. Merchants configuration is optional, if the Merchant data is in the Payment Platform, it can be passed through the MPI API. ]]> </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:complexType name="Scheme"> <xs:sequence> <xs:element name="DirectoryServer" type="DirectoryServer"> <xs:annotation> <xs:documentation> <![CDATA[ The Directory Server used by this Scheme. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="SignatureValidationRootCertificate" type="RootCertificate"> <xs:annotation> <xs:documentation> <![CDATA[ The Root Certificate used for signature validation. ]]> </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="id" type="SchemeId" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The ID of the scheme (Visa, MasterCard, JCB, American Express, Diners or any other scheme). ]]> </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="DirectoryServer"> <xs:sequence> <xs:element name="DirectoryServerEndpoint" type="DirectoryServerEndpoint" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> <![CDATA[ The list of endpoints provided by this Directory Server. If communication with the Directory Server fails using an endpoint, the MPI tries again with the next endpoint in the list. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="TrustedRootCertificate" type="RootCertificate" minOccurs="0"> <xs:annotation> <xs:documentation> <![CDATA[ The trusted Root Certificate to use when communicating with this Directory Server. Optional in case the Root Certificate is already included in Java as a trusted Root Certificate (i.e. contained in the cacerts file of your Java distribution). ]]> </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:complexType name="UpopParameters"> <xs:sequence> <xs:element name="SignatureValidationRootCertificate" type="RootCertificate" minOccurs="0"> <xs:annotation> <xs:documentation> <![CDATA[ Signature Validation Root Certificate for UPOP. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="TrustedRootCertificate" type="RootCertificate" minOccurs="0"> <xs:annotation> <xs:documentation> <![CDATA[ The trusted Root Certificate to use when communicating with the UPOP server (for inquiry). Optional in case the Root Certificate is already included in Java as a trusted Root Certificate (i.e. contained in the cacerts file of your Java distribution). ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="BackendUrl" type="xs:anyURI" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation> <![CDATA[ Backend URL. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="FrontendUrl" type="xs:anyURI" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation> <![CDATA[ Frontend URL. ]]> </xs:documentation> </xs:annotation> </xs:element> <xs:element name="InquiryUrl" type="xs:anyURI" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation> <![CDATA[ Inquiry URL. ]]> </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:complexType name="TimeoutSeconds"> <xs:attribute name="paRes" type="xs:integer" default="300" > <xs:annotation> <xs:documentation> <![CDATA[ The time in seconds to wait for a PaRes to be sent back from the ACS. Recommendation from Visa is to use a timeout value of 300 seconds, recognizing that cardholders may become distracted while completing the authentication. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="veRes" type="xs:integer" default="10" > <xs:annotation> <xs:documentation> <![CDATA[ The time in seconds to wait for a VERes to be sent back from the Directory Server. Recommendation from Visa is to allow at least 10 seconds for the Directory Server to send a VERes message in response to the MPI VEReq message. ]]> </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="DirectoryServerEndpoint"> <xs:attribute name="url" type="xs:anyURI" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The URL of this endpoint. The URL is used by the MPI to post the VEReq to. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="enabled" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation> <![CDATA[ Can be used to temporarily disable an endpoint. A disabled endpoint will not be used by the MPI to communication with the Directory Server. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="authenticationMethod" type="AuthenticationMethod" default="Certificate"> <xs:annotation> <xs:documentation> <![CDATA[ Authentication mode for the endpoint. The endpoint is used for the corresponding authentication method (e.g. if the merchant has a password configured to authenticate, VEReqs are sent to directory server endpoints with authentication method 'Password'. The same rule applies when given a ClientCertificate for authentication with Directory Server). In case when there are both Client Certificate and Password for a given Merchant, both the Certificate and Password endpoints are used, with Certificate endpoints having a higher priority than Password endpoints. Possible values are: * Certificate * Password Default value is Certificate. ]]> </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="Merchant"> <xs:sequence> <xs:element name="MerchantAcquirer" type="MerchantAcquirer" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> <![CDATA[ The list of Acquirer relations for this Merchant. ]]> </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="url" type="MerchantUrl" use="required" > <xs:annotation> <xs:documentation> <![CDATA[ The URL of this Merchant. Will be sent to the Directory Server as part of the VEReq.Merchant structure. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="name" type="MerchantName" use="required" > <xs:annotation> <xs:documentation> <![CDATA[ The Name of this Merchant. Will be sent to the Directory Server as part of the VEReq.Merchant structure. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="category" type="MerchantCategory" use="optional" > <xs:annotation> <xs:documentation> <![CDATA[ The Category of this Merchant. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="abbreviation" type="MerchantAbbreviation" use="optional" > <xs:annotation> <xs:documentation> <![CDATA[ The Abbreviation of this Merchant. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="id" type="MerchantId" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The Acquirer-defined merchant identifier. Will be sent to the Directory Server as part of the VEReq.Merchant structure. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="enabled" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation> <![CDATA[ Can be used to temporarily disable a Merchant. A disabled Merchant will not be used by the MPI. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="countryCode" type="Country" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The country code of this Merchant. Will be sent to the Directory Server as part of the VEReq.Merchant structure. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="defaultPurchaseCurrency" type="Currency"> <xs:annotation> <xs:documentation> <![CDATA[ The default purchase currency used by this Merchant. If there is no currency defined for a purchase, the Merchant's default currency will be used. Will be sent to the ACS as part of the PAReq.Purchase structure. ]]> </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="MerchantAcquirer"> <xs:sequence> <xs:element name="ClientCertificate" type="ClientCertificate" minOccurs="0"> <xs:annotation> <xs:documentation> <![CDATA[ The Client Certificate used to authenticate the merchant with the Directory Server. NOTE: MPI uses a priority resolving when trying to decide on the authentication method for a given merchant to a Directory Server. The hierarchy is: 1 - Password on MerchantAcquirer level [MOST IMPORTANT] 2 - ClientCertificate on MerchantAcquirer level 3 - Password on acquirer Bin level 4 - ClientCertificate on acquirer Bin level [LEAST IMPORTANT] When both ClientCertificate and Password are configured for a given Merchant, MPI will use both of them when contacting the Directory Server endpoint(s). ]]> </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="acquirerBin" type="AcquirerBin" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The acquiring institution identification code (references configured Acquirer Bin). ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="scheme" type="SchemeId" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The schemeId associated with this Acquirer relation. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="password" type="xs:string"> <xs:annotation> <xs:documentation> <![CDATA[ The password used to authenticate with the Directory Server. Usage of a password (instead of a Client certificate) for authentication is Scheme- and region-specific. NOTE: MPI uses a priority resolving when trying to decide on the authentication method for a given merchant to a Directory Server. The hierarchy is: 1 - Password on MerchantAcquirer level [MOST IMPORTANT] 2 - ClientCertificate on MerchantAcquirer level 3 - Password on acquirer Bin level 4 - ClientCertificate on acquirer Bin level [LEAST IMPORTANT] When both ClientCertificate and Password are configured for a Merchant, MPI will use both of them when contacting the Directory Server endpoint(s). ]]> </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="Acquirer"> <xs:sequence> <xs:element name="Bin" type="Bin" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> <![CDATA[ The list of BINs for this Acquirer. ]]> </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="name" type="xs:string"> <xs:annotation> <xs:documentation> <![CDATA[ The name of the Acquirer. ]]> </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="Bin"> <xs:sequence> <xs:element name="ClientCertificate" type="ClientCertificate" minOccurs="0"> <xs:annotation> <xs:documentation> <![CDATA[ The Client Certificate used to authenticate with the Directory Server. NOTE: MPI uses a priority resolving when trying to decide on the authentication method for a given merchant to a Directory Server. The hierarchy is: 1 - Password on MerchantAcquirer level [MOST IMPORTANT] 2 - ClientCertificate on MerchantAcquirer level 3 - Password on acquirer Bin level 4 - ClientCertificate on acquirer Bin level [LEAST IMPORTANT] When both ClientCertificate and Password are configured for an Acquirer and its Merchant(s), MPI will use both of them when contacting the Directory Server endpoint(s). ]]> </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="value" type="AcquirerBin" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The actual BIN number. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="scheme" type="SchemeId" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The Scheme associated with this BIN. ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="password" type="xs:string"> <xs:annotation> <xs:documentation> <![CDATA[ The password used to authenticate with the Directory Server. NOTE: MPI uses a priority resolving when trying to decide on the authentication method for a given merchant to a Directory Server. The hierarchy is: 1 - Password on MerchantAcquirer level [MOST IMPORTANT] 2 - ClientCertificate on MerchantAcquirer level 3 - Password on acquirer Bin level 4 - ClientCertificate on acquirer Bin level [LEAST IMPORTANT] When both ClientCertificate and Password are configured for an Acquirer and its Merchant(s), MPI will use both of them when contacting the Directory Server endpoint(s). ]]> </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="Certificate" abstract="true"> <xs:attribute name="keystoreResource" type="xs:string" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The Java keystore resource location. Use a prefix to specifiy where the resource should be loaded from: * file: to load from the filesystem (e.g. file:/etc/mpi/keystore.jks) * http: to load as an URL (e.g. http://myserver/mpi/keystore.jks) * classpath: to load from the classpath (e.g. classpath:mpi/keystore.jks) ]]> </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="keystorePassword" type="xs:string" use="required"> <xs:annotation> <xs:documentation> <![CDATA[ The password to access the Java keystore. ]]> </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="ClientCertificate"> <xs:annotation> <xs:documentation> <![CDATA[ Client Certificate configuration. ]]> </xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="Certificate" /> </xs:complexContent> </xs:complexType> <xs:complexType name="RootCertificate"> <xs:annotation> <xs:documentation> <![CDATA[ Root Certificate configuration. ]]> </xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="Certificate" /> </xs:complexContent> </xs:complexType> <xs:simpleType name="AuthenticationMethod"> <xs:annotation> <xs:documentation> <![CDATA[ Directory Server authentication method. ]]> </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:enumeration value="Certificate" /> <xs:enumeration value="Password" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="SchemeId"> <xs:annotation> <xs:documentation> <![CDATA[ Supported payment schemes. ]]> </xs:documentation> </xs:annotation> <xs:restriction base="xs:string" /> </xs:simpleType> <xs:simpleType name="Country"> <xs:annotation> <xs:documentation> <![CDATA[ ISO 3166 three digit country code. Valid country code examples: 756 - Switzerland 276 - Germany 040 - Austria Excluded countries range: 900-999 - reserved by ISO to designate country names not otherwise defined ]]> </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:length value="3" /> <xs:pattern value="[0-9]{3}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="Currency"> <xs:annotation> <xs:documentation> <![CDATA[ ISO 4217 three digit currency code. Valid currency code examples: 756 - CHF 978 - EUR 826 - GBP Excluded currencies are: 955 - European Composite Unit 956 - European Monetary Unit 957 - European Unit of Account-9 958 - European Unit of Account-17 959 - Gold 960 - I.M.F. 961 - Silver 962 - Platinum 963 - Reserved for testing 964 - Palladium 999 - no currency is involved ]]> </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:length value="3" /> <xs:pattern value="[0-9]{3}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="MerchantUrl"> <xs:restriction base="xs:anyURI"> <xs:minLength value="1" /> <xs:maxLength value="2048" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="MerchantName"> <xs:restriction base="xs:string"> <xs:minLength value="1" /> <xs:maxLength value="25" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="MerchantId"> <xs:restriction base="xs:string"> <xs:minLength value="1" /> <xs:maxLength value="24" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="MerchantCategory"> <xs:restriction base="xs:string"> <xs:minLength value="4" /> <xs:maxLength value="4" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="MerchantAbbreviation"> <xs:restriction base="xs:string"> <xs:minLength value="1" /> <xs:maxLength value="16" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="AcquirerBin"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,11}"/> <xs:maxLength value="11"/> <xs:minLength value="1"/> </xs:restriction> </xs:simpleType></xs: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 | <?xml version="1.0" encoding="UTF-8"?><MpiConfiguration> <!-- <TimeoutSeconds veRes="10" paRes="600" /> --> <!-- Configuration for Union Pay transactions --> <!-- <UpopParameters> <SignatureValidationRootCertificate keystoreResource="file:..." keystorePassword="..." /> <TrustedRootCertificate keystoreResource="file:..." keystorePassword="..." /> <BackendUrl>https://...</BackendUrl> <FrontendUrl>https://...</FrontendUrl> <InquiryUrl>https://...</InquiryUrl> </UpopParameters> --> <!-- Configuration for 3-D Secure transactions --> <!-- <Scheme id="Visa"> <DirectoryServer> <DirectoryServerEndpoint url="https://..." enabled="true" /> <TrustedRootCertificate keystoreResource="file:..." keystorePassword="..." /> </DirectoryServer> <SignatureValidationRootCertificate keystoreResource="file:..." keystorePassword="..." /> </Scheme> --> <!-- Configuration for both 3-D Secure and Union Pay transactions --> <!-- <Acquirer name="..."> <Bin value="..." scheme="Visa"> <ClientCertificate keystoreResource="file:..." keystorePassword="..." /> </Bin> </Acquirer> --> <!-- <Merchant id="..." countryCode="..." defaultPurchaseCurrency="..." enabled="true" name="..." url="http://..." category="..." abbreviation="..."> <MerchantAcquirer scheme="Visa" acquirerBin="..."> <ClientCertificate keystoreResource="file:..." keystorePassword="..." /> </MerchantAcquirer> </Merchant> --></MpiConfiguration> |