Introduction

Version

Current version of this document is 1.1.0. To see the details of recent changes, please see Changelog.

Actions

Enroll

URL Method Header parameter - x-action
/mpi POST enroll

Request

Parameter Notation Type Length Description Conditional inclusion
cardNumber M N 13-19 Card number.
cardExpiration M N 4 Card expiration date. Format - YYMM.
txAmount M N 1-12 Transaction amount in cents.
txDescription O ANS 1-125 Transaction description.
txType O N 2 Available types. This field is required in some markets (e.g. for Merchants in Brazil). Otherwise, optional.
txCurrency M N 3 ISO 4217 numeric currency code.
purchaseDate C N 14 Transaction date. Format - YYYYMMDDHHMMSS. Required if messageCategory is 02 and requestorAuthenticationIndicator is 02 or 03.
currencyExponent M N 1 The minor units of currency specified in ISO 4217. For example, US Dollars has a value of 2; Japanese Yen has a value of 0.
okUrl M ANS 1-2048 Fully qualified URL to Merchant. MPI will do POST when finished to this URL in all other cases,except when authentication or signature validation fails.
failUrl M ANS 1-2048 Fully qualified URL to Merchant. MPI will do POST to this URL when authentication or signature validation fails.
merchantData O ANS 1-254 Merchant data that must be returned to the merchant. The content of this field is passed unchanged and without assumptions about its content to the return POST. < and > symbols are not allowed in this field.
recurringFrequency O N 1-4 Recurring frequency for purchase provided as integer days, 28 means monthly.
recurringEnd C N 8 Recurring end date in YYYYMMDD format. If recurringFrequency is present then recurringEnd is required.
installments O N 1-3 Number of installments passed as integer value inside a range 1-999. Note: Install and recurring parameters can not be present at the same time.
scheme O N 1-2 Available schemes. By default scheme is resolved using bin range list but it could be skipped by using this parameter if customer already resolved card scheme.
messageCategory O N 2 Message category. Values: 01 - payment authentication, 02 - non payment authentication, defaults to 01 if not sent.
accountInformation O OBJ - Cardholder Account Information
accountInformation / cardholderAccountAgeIndicator O N 2 Cardholder account age values
accountInformation / cardholderAccountChange O N 8 Date that the cardholder’s account was last changed. Format - YYYYMMDD.
accountInformation / cardholderAccountChangeIndicator O N 2 Cardholder account change values
accountInformation / cardholderAccountDate O N 8 Date that the cardholder opened the account. Format - YYYYMMDD.
accountInformation / cardholderAccountPasswordChange O N 8 Date that cardholder’s account had a password change or account reset. Format - YYYYMMDD.
accountInformation / cardholderAccountPasswordChangeIndicator O N 8 Cardholder account password change values
accountInformation / cardholderAccountPurchaseCount O N 1-4 Number of purchases with this cardholder account during the previous six months.
accountInformation / provisionAttemptsPerDay O N 1-3 Number of Add Card attempts in the last 24 hours.
accountInformation / txActivityPerDay O N 1-3 Number of transactions (successful and abandoned) for this cardholder account across all payment accounts in the previous 24 hours.
accountInformation / txActivityPerYear O N 1-3 Number of transactions (successful and abandoned) for this cardholder account across all payment accounts in the previous year.
accountInformation / paymentAccountAge O N 8 Date that the payment account was enrolled in the cardholder’s account. Format - YYYYMMDD.
accountInformation / paymentAccountAgeIndicator O N 2 Payment account age values
accountInformation / shippingAddressUsage O N 8 Date when the shipping address used for this transaction was first used. Format - YYYYMMDD.
accountInformation / shippingAddressUsageIndicator O N 2 Shipping address change values
accountInformation / shippingNameIndicator O N 1 Shipping name values
accountInformation / suspiciousAccountActivity O N 1 Suspicious account activity values
acquirerBin O N 5-9 Acquirer BIN. Note: If provided will override merchant scheme configuration value.
acquirerMerchantIdentifier O AN 1-35 Acquirer-assigned merchant identifier.
broadcastInfo O ANS 1-4096 Broadcast information JSON as string.
browserAcceptHeader O ANS 1-2048 Exact content of the HTTP accept headers.
cardholderIp O ANS 1-45 IP address of the browser.
browserJavascriptEnabled O B - Represents the ability of the cardholder browser to execute Java.
browserJavaEnabled O B - Represents the ability of the cardholder browser to execute JavaScript.
browserLanguage O ANS 1-8 Value representing the browser language as defined in IETF BCP47.
browserColorDepth O N 1-2 Value representing the bit depth of the colour palette for displaying images, in bits per pixel.
browserScreenHeight O N 1-6 Total height of the Cardholder’s screen in pixels.
browserScreenWidth O N 1-6 Total width of the cardholder’s screen in pixels.
browserTimeZone O NS 1-5 Time-zone offset in minutes between UTC and the Cardholder browser local time.
browserUserAgent O ANS 1-2048 Exact content of the HTTP user-agent header.
decoupledAuthenticationIndicator O A 1 Decoupled authentication indicator. Values: Y - request to utilize decoupled authentication if ACS supports it, N - do not use decoupled authentication.
decoupledAuthenticationMaxTimeout O N 5 Maximum time to wait for decoupled authentication results. Values between 1 and 10080 accepted.
merchantName O ANS 1-40 Merchant name assigned by the Acquirer or Payment System.
merchantCountryCode O N 3 Country Code of the Merchant. ISO 3166-1 numeric three-digit country code,
mcc O N 4 Code describing the Merchant’s type of business, product or service.
cardholderName O ANS 2-45 Cardholder name.
cardholderAccountId O ANS 1-64 Cardholder account identifier.
cardholderAccountType O N 2 Cardholder account type values
email O ANS 6-254 The email address associated with the account that is either entered by the Cardholder.
addressMatchIndicator O A 1 Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Values: Y , N.
billingAddressCity O ANS 1-50 Cardholder billing address city.
billingAddressCountry O N 3 Cardholder billing address ISO 3166-1 numeric three-digit country code.
billingAddressLine1 O ANS 1-50 First line of the street address or equivalent local portion of the Cardholder billing address.
billingAddressLine2 O ANS 1-50 Second line of the street address or equivalent local portion of the Cardholder billing address.
billingAddressLine3 O ANS 1-50 Third line of the street address or equivalent local portion of the Cardholder billing address.
billingAddressPostCode O ANS 1-16 ZIP or other postal code of the Cardholder billing address.
billingAddressState O A 1-3 The state or province of the Cardholder billing address as defined in ISO 3166-2.
shippingAddressCity O ANS 1-50 Cardholder shipping address city.
shippingAddressCountry O N 3 Cardholder shipping address ISO 3166-1 numeric three-digit country code.
shippingAddressLine1 O ANS 1-50 First line of the street address or equivalent local portion of the Cardholder shipping address.
shippingAddressLine2 O ANS 1-50 Second line of the street address or equivalent local portion of the Cardholder shipping address.
shippingAddressLine3 O ANS 1-50 Third line of the street address or equivalent local portion of the Cardholder shipping address.
shippingAddressPostCode O ANS 1-16 ZIP or other postal code of the Cardholder shipping address.
shippingAddressState O A 13 The state or province of the Cardholder shipping address as defined in ISO 3166-2.
homePhone O OBJ - Cardholder home phone number.
homePhone / cc O N 1-3 Country code for geographic area.
homePhone / subscriber O N 1-15 National number.
mobilePhone O OBJ - Cardholder mobile phone number.
mobilePhone / cc O N 1-3 Country code for geographic area.
mobilePhone / subscriber O N 1-15 National number.
workPhone O OBJ - Cardholder work phone number.
workPhone / cc O N 1-3 Country code for geographic area.
workPhone / subscriber O N 1-15 National number.
merchantRiskIndicator O OBJ - Merchant risk information.
merchantRiskIndicator / deliveryEmailAddress O ANS 6-254 For Electronic delivery, the email address to which the merchandise was delivered.
merchantRiskIndicator / deliveryTimeframe O N 2 Delivery timeframe values
merchantRiskIndicator / giftCardAmount O N 1-15 For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units (for example, USD 123.45 is 123).
merchantRiskIndicator / giftCardCount O N 2 For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
merchantRiskIndicator / giftCardCurrency O N 3 For prepaid or gift card purchase, ISO 4217 three-digit currency code of the gift card.
merchantRiskIndicator / preOrderDate O N 8 For a pre-ordered purchase, the expected date that the merchandise will be available. Format - YYYYMMDD.
merchantRiskIndicator / preOrderPurchaseIndicator O N 2 Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. Values: 01 - Merchandise available, '02' - Future availability.
merchantRiskIndicator / reorderItemsIndicator O N 2 Indicates whether the cardholder is reordering previously purchased merchandise. Values: 01 - First time ordered, 02 - Reordered.
merchantRiskIndicator / shippingIndicator O N 2 Shipping indicator values
merchantFraudRate O N 1 Merchant Fraud Rate
acquirerCountryCode O N 3 Acquirer ISO 3166-1 numeric three-digit country code.
secureCorporatePaymentExemption O A 1 Whether the electronic payment transaction uses dedicated payment processes or protocols under PSD2 RTS Article 17’s Secure Corporate Payment Exemption. Values: Y - yes, N - no.
messageExtensions O LIST - Message extensions list.
messageExtensions / id M AN 1-64 A unique identifier for the extension.
messageExtensions / criticalityIndicator M B - A Boolean value indicating whether the recipient must understand the contents of the extension to interpret the entire message.
messageExtensions / data M ANS 1-8059 The data carried in the extension.
messageExtensions / name M ANS 1-64 The name of the extension data set as defined by the extension owner.
requestorId O ANS 1-40 Requestor ID. Note: If provided will override merchant scheme configuration value.
requestorName O ANS 1-35 Requestor name. Note: If provided will override merchant scheme configuration value.
requestorChallengeIndicator O N 2 Requestor challenge indicator values
requestorUrl M ANS 1-2048 Fully qualified URL of requestor website or customer care site.
requestorAuthenticationIndicator O N 2 Requestor authentication indicator values
requestorAuthenticationInfo O OBJ - Information about how the cardholder was authenticated before or during the transaction.
requestorAuthenticationInfo / requestorAuthenticationData O ANS 1-20000 Data that documents and supports a specific authentication process.
requestorAuthenticationInfo / requestorAuthenticationMethod O N 2 Requestor authentication method values
requestorAuthenticationInfo / requestorAuthenticationTimestamp O N 12 Date and time in UTC of the cardholder authentication. Format - YYYYMMDDHHMM.
requestorPriorAuthenticationInfo O OBJ - Information about how the requestor authenticated the cardholder as part of a previous 3DS transaction.
requestorPriorAuthenticationInfo / requestorPriorAuthenticationData O ANS 1-2048 Data that documents and supports a specific authentication process.
requestorPriorAuthenticationInfo / requestorPriorAuthenticationMethod O N 2 Requestor prior authentication method values
requestorPriorAuthenticationInfo / requestorPriorAuthenticationTimestamp O N 12 Date and time in UTC of the prior cardholder authentication. Format - YYYYMMDDHHMM.
requestorPriorAuthenticationInfo / requestorPriorReference O ANS 1-36 This data element provides additional information to the ACS to determine the best approach for handing a request.
requestorInitiatedIndicator C N 2 Requestor initiated indicator values Required if deviceChannel is 03.
requestorAuthenticationMethodIndicator C N 2 Requestor authentication method indicator values Conditional depending on directory server rules.
deviceChannel O N 2 Device channel values. Default value is 02 if not sent.
sdkAppID C ANS 36 Universally unique ID created upon all installations of the requestor app on a Consumer Device. Required if deviceChannel is 01.
sdkEncryptedData C ANS 1-64000 JWE Object (represented as a string) containing data encrypted by the SDK for the DS to decrypt. Required if deviceChannel is 01.
sdkMaxTimeout C N 2 Indicates maximum amount of time (in minutes) for all exchanges. Greater than or = 05. Required if deviceChannel is 01.
sdkReferenceNumber C ANS 1-32 Identifies the vendor and version for the 3DS SDK that is integrated in a 3DS Requestor App. Required if deviceChannel is 01.
sdkTxId C ANS 36 Universally unique transaction identifier assigned by the 3DS SDK to identify a single transaction Required if deviceChannel is 01.
deviceRenderOptions C OBJ - Defines the SDK UI types that the device supports for displaying specific challenge user interfaces within the SDK. Required if deviceChannel is 01.
deviceRenderOptions / sdkInterface R LIST - SDK interface values
deviceRenderOptions / sdkUiType R LIST - SDK UI type values
{
    "cardNumber": "4012001037141112",
    "cardExpiration": "2012",
    "txAmount": "1000",
    "txCurrency": "978",
    "currencyExponent": "2",
    "txDescription": "Sale",
    "okUrl": "http://example.com/ok",
    "failUrl": "http://example.com/fail",
    "merchantData": "Sale number 123456789"
}

Response

Parameter Notation Type Length Description
status M A - Available statuses.
statusCode M N 3 Available status codes.
message O ANS 1-2048 If error occurs and statusCode is not 000 than contains error message.
providerStatusCode C N 1-2 Authentication status code from MPI provider. Available status codes.
xId M ANS 1-255 Transaction ID.
hash M ANS 23 Request ID. Unique per each request.
3dsVersion M ANS 1-6 3DS version. Available values: 1.0.2 , 2.1.0, 2.2.0.
merchantData OE ANS 1-254 Echoed back from request if present.
submitUrl M ANS 1-2048 Authentication page url, user should be redirected here.

Successful response example

{
    "status": "success",
    "xId": "MTU4MTMzODg3ODc3NDE5MDkwNzg=",
    "hash": "h5e4150feb4523279569899",
    "submitUrl": "http://mpi-example.tribe.com/mpi/submit/MTU4MTMzODg3ODc3NDE5MDkwNzg=/h5e4150feb4523279569899",
    "3dsVersion": "2.1.0",
    "merchantData": "Sale number 123456789"
}

Error response example

{
    "status": "error",
    "statusCode": "006",
    "message": "Could not decrypt request!",
    "hash": "h5e4156bc31871752777865"
}

Status

URL Method Header parameter - x-action
/mpi POST status

Request

Parameter Notation Type Length Description
xId M ANS 1-255 Transaction ID from enrollment response.
hash M ANS 23 Request ID from enrollment response.
{
    "xId": "MTU4MTAwMjM3MjE0MDAwNDAwNzg=",
    "hash": "h5e3c2e841a135169178716"
}

Response

Parameter Notation Type Length Description
status M A - Available statuses.
statusCode M N 3 Available status codes.
message O ANS 1-2048 If error occurs and statusCode is not 000 than contains error message.
providerStatusCode C N 1-2 Authentication status code from MPI provider. Available status codes.
xId M ANS 1-255 Transaction ID.
hash M ANS 23 Request ID. Unique per each request.
veresEnrolledStatus M AS 1 Value of VERes enrollement status. Available statuses.
paresTxStatus M AS 1 Value of pares transaction status. Available statuses.
merchantData M ANS 1-254 Value from enrollment request.
eci M N / NULL 2 Electronic commerce indicator.
cavv M ANS / NULL 1-40 Cardholder authentication verification value. Contains a 20-byte value that has been Base64 encoded, giving a 28 byte result.
3dsVersion M ANS 5-8 3DS version. Available values: 1.0.2 , 2.1.0, 2.2.0.
directoryServerTxId M ANS / NULL 1-40 Directory server transaction ID. Note: 2.1.0 specific.
{
    "status": "success",
    "statusCode": "1",
    "providerStatusCode": "1",
    "xId": "MTU4MTM0MTE2NzE0NDMwOTE3NjE=",
    "hash": "h5e415a1a9c75a506650451",
    "veresEnrolledStatus": "Y",
    "paresTxStatus": "Y",
    "merchantData": "Sale number 123456789",
    "eci": "05",
    "cavv": "QUNTQweVMHgheWBOcjRObj86VW0=",
    "directoryServerTxId": "3ab9f417-cf02-5f5b-8000-00000002b040"
}

Error response example

{
    "status": "error",
    "statusCode": "006",
    "message": "Could not decrypt request!",
    "hash": "h5e4156bc31871752777865"
}

Callbacks

Authentication results

When sending enroll request and customer finishes authentication he will be redirected back to provided okUrl or failUrl with these POST parameters:

Parameter Notation Type Length Description
cavv M ANS 1-40 Cardholder Authentication Verification Value. Contains a 20-byte value that has been Base64 encoded, giving a 28 byte result.
eci M N 2 Available ECI values.
merchantData M ANS 1-255 Merchant data echoed back from authenticate request.
PAResVerified M A 1 Is PaRes valid, values: Y or N.
PAResSyntaxOK M A 1 Is PaRes syntax valid, values: Y or N.
protocol M ANS 5-8 3DS version. Available values: 1.0.2 , 2.1.0, 2.2.0.
xId M ANS 1-255 Transaction ID.
status M N 1-2 Authentication status code from MPI provider. Available status codes.
statusMessage M ANS / NULL 1-1024 Status message.
merchantId M AN 1-16 Merchant ID.
veresEnrolledStatus M AS 1 Value of VERes enrollement status. Available statuses.
paresTxStatus M A 1 Available statuses.

Appendix

Changelog

Version Date Updates
1.1.7 April 14, 2021 Added additional scheme field to enroll call.
1.1.6 February 24, 2021 Removed sendPares call.
1.1.5 December 22, 2020 Added additional response codes.
1.1.4 September 8, 2020 Added merchantFraudRate, acquirerCountryCode, secureCorporatePaymentExemption to authenticate call.
1.1.3 August 11, 2020 Major enroll request update with new optional or conditional fields to support 2.2.0.
1.1.2 July 09, 2020 Updated enroll request with optional fields: messageCategory, decoupledAuthenticationIndicator, decoupledAuthenticationMaxTimeout.
1.1.1 June 22, 2020 Updated enroll request with optional fields: acquirerBin, requestorId, requestorName.
1.1.0 April 08, 2020 Updated enroll request recurringFrequency description.
1.0.0 March 24, 2020 Initial version.

Enum

Authentication

To use api you need to send your merchant ID using header with every request you make.

Request Headers

Parameter Notation Type Length Description
x-action M A 1-50 Expected API method: enroll.
x-merchant-id M AN 1-16 Merchant ID.

Cardholder account age values

Value Description Versions
01 No account (guest check-out) >= 2.1.0
02 Created during this transaction >= 2.1.0
03 Less than 30 days >= 2.1.0
04 30−60 days >= 2.1.0
05 More than 60 days >= 2.1.0

Cardholder account change values

Value Description Versions
01 Changed during this transaction >= 2.1.0
02 Less than 30 days >= 2.1.0
03 30−60 days >= 2.1.0
04 More than 60 days >= 2.1.0

Cardholder account password change values

Value Description Versions
01 No change >= 2.1.0
02 Changed during this transaction >= 2.1.0
03 Less than 30 days >= 2.1.0
04 30−60 days >= 2.1.0
05 More than 60 days >= 2.1.0

Cardholder account type values

Value Description Versions
01 Not Applicable >= 2.1.0
02 Credit >= 2.1.0
03 Debit >= 2.1.0

Delivery timeframe values

Value Description Versions
01 Electronic Delivery >= 2.1.0
02 Same day shipping >= 2.1.0
03 Overnight shipping >= 2.1.0
04 Two-day or more shipping >= 2.1.0

Device channel values

Value Description Versions
01 App-based (APP) >= 2.1.0
02 Browser (BRW) >= 2.1.0
03 3DS Requestor Initiated (3RI) >= 2.1.0

ECI

Status Description
02 or 05 Fully authenticated transaction.
01 or 06 Attempted authentication transaction.
00 or 07 Non 3-D secure transaction.

Merchant Fraud Rate

Value Description Versions
1 fraud level <=1 bps >= 2.1.0
2 fraud level >1 and <= 6 bps >= 2.1.0
3 fraud level >6 and <= 13 bps >= 2.1.0
4 fraud level >13 and >= 25 bps >= 2.1.0
5 fraud level >25 bps >= 2.1.0

Pares transaction status

Status Description
Y Successful authentication.
N Failed authentication.
U Unable to complete authentication.
A Authentication attempt.
R Authentication rejected.
- Value is not available due errors.

Payment account age values

Value Description Versions
01 No account (guest check-out) >= 2.1.0
02 Created during this transaction >= 2.1.0
03 Less than 30 days >= 2.1.0
04 30−60 days >= 2.1.0
05 More than 60 days >= 2.1.0

Provider status code

Status Description
0 Authentication failed
1 Fully authenticated transaction
2 Issuer or cardholder not enrolled
3 Not in cache
4 Attempt receipt received and signature valid
5 Authentication unavailable
6 3-D Secure Error
8 Fraud Score blocked
9 Pending transaction
80 Skip device case
91 Network error
92 Directory error
93 Configuration errors
94 Input error
95 No directory found for PAN/cardtype
96 No version 2 directory found for PAN/cardtype
99 System error

Requestor authentication method values

Value Description Versions
01 No 3DS Requestor authentication occurred (i.e. cardholder “logged in” as guest) >= 2.1.0
02 Login to the cardholder account at the 3DS Requestor system using 3DS Requestor’s own credentials >= 2.1.0
03 Login to the cardholder account at the 3DS Requestor system using federated ID >= 2.1.0
04 Login to the cardholder account at the 3DS Requestor system using issuer credentials >= 2.1.0
05 Login to the cardholder account at the 3DS Requestor system using third-party authentication >= 2.1.0
06 Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator >= 2.1.0
07 Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator (FIDO assurance data signed) >= 2.2.0
08 SRC Assurance Data >= 2.2.0

Requestor authentication indicator values

Value Description Versions
01 Payment transaction >= 2.1.0
02 Recurring transaction >= 2.1.0
03 Instalment transaction >= 2.1.0
04 Add card >= 2.1.0
05 Maintain card >= 2.1.0
06 Cardholder verification as part of EMV token ID&V >= 2.1.0

Requestor challenge indicator values

Value Description Versions
01 No preference >= 2.1.0
02 No challenge requested >= 2.1.0
03 Challenge requested (3DS Requestor preference) >= 2.1.0
04 Challenge requested (Mandate) >= 2.1.0
05 No challenge requested (transactional risk analysis is already performed) >= 2.2.0
06 No challenge requested (Data share only) >= 2.2.0
07 No challenge requested (strong consumer authentication is already performed) >= 2.2.0
08 No challenge requested (utilize whitelist exemption if no challenge required) >= 2.2.0
09 Challenge requested (whitelist prompt requested if challenge required) >= 2.2.0

Requestor initiated indicator values

Value Description Versions
01 Recurring transaction >= 2.1.0
02 Instalment transaction >= 2.1.0
03 Add card >= 2.1.0
04 Maintain card information >= 2.1.0
05 Account verification >= 2.1.0
06 Split/delayed shipment >= 2.2.0
07 Top-up >= 2.2.0
08 Mail Order >= 2.2.0
09 Telephone Order >= 2.2.0
10 Whitelist status check >= 2.2.0
11 Other payment >= 2.2.0

Requestor authentication method indicator values

Value Description Versions
01 Verified >= 2.2.0
02 Failed >= 2.2.0
03 Not Performed >= 2.2.0

Requestor prior authentication method values

Value Description Versions
01 Frictionless authentication occurred by ACS >= 2.1.0
02 Cardholder challenge occurred by ACS >= 2.1.0
03 AVS verified >= 2.1.0
04 Other issuer methods >= 2.1.0

Scheme

ID Scheme
1 MasterCard
2 Visa
3 UnionPay
6 JCB

Status

Status
success
error

SDK interface values

Value Description Versions
01 Native >= 2.1.0
02 HTML >= 2.1.0
03 Both >= 2.1.0

SDK UI type values

Value Description Versions
01 Text >= 2.1.0
02 Single select >= 2.1.0
03 Multi select >= 2.1.0
04 OOB >= 2.1.0
05 HTML other >= 2.1.0

Shipping address change values

Value Description Versions
01 This transaction >= 2.1.0
02 Less than 30 days >= 2.1.0
03 30−60 days >= 2.1.0
04 More than 60 days >= 2.1.0

Shipping indicator values

Value Description Versions
01 Ship to cardholder’s billing address >= 2.1.0
02 Ship to another verified address on file with merchant >= 2.1.0
03 Ship to address that is different than the cardholder’s billing address >= 2.1.0
04 “Ship to Store” / Pick-up at local store (Store address shall be populated in shipping address fields >= 2.1.0
05 Digital goods (includes online services, electronic gift cards and redemption codes) >= 2.1.0
06 Travel and Event tickets, not shipped >= 2.1.0
07 Other (for example, Gaming, digital services not shipped, emedia subscriptions, etc.) >= 2.1.0

Shipping name values

Value Description Versions
01 Account Name identical to shipping Name >= 2.1.0
02 Account Name different than shipping Name >= 2.1.0

Status code

Status Description
000 Success.
001 Merchant ID is required.
002 Action is required.
003 Sign is required.
004 Merchant not found.
005 Action not found.
006 Request decryption failed.
007 ! Reserved for futre use.
008 Merchant account is disabled.
009 MPI request signing failed.
010 MPI entry not found by given xid and hash.
011 Invalid MPI provider response.
012 MPI provider error. ERROR
013 Internal error.
014 Could not encrypt response.
015 Could not decrypt request.
016 Merchant account do not have MPI integration configurated for scheme: SCHEME.
017 Merchant account do not have keys configurated for scheme MPI integration.
018 Card number did not match any active bin list item.
019 Request contains unsupported field: FIELD
020 Card number did not match any card range from directory servers.
021 Required field(s) is missing: FIELDS
022 Invalid field data. FIELD : ERROR
023 Invalid directory server response.
024 Card is not enrolled.
025 Configurated keys for scheme MPI integration has expired.
026 Transaction is already being processed.
995 Api maintenance mode. Try again later.

Suspicious account activity values

Value Description Versions
01 No suspicious activity has been observed >= 2.1.0
02 Suspicious activity has been observed >= 2.1.0

Transaction types

Value Description Versions
01 Goods/ Service Purchase >= 2.1.0
03 Check Acceptance >= 2.1.0
10 Account Funding >= 2.1.0
11 Quasi-Cash Transaction >= 2.1.0
28 Prepaid Activation and Load >= 2.1.0

VERes enrollment status

Status Description
Y Authentication available.
N Not enrolled.
U Authentication unavailable.
- Value is not available due errors.

Notation

Parameter requirement

Notation Meaning
M Mandatory
O Optional
C Conditional
ME Mandatory Echo. The data element will be present in a response message and will contain the same value from the request.
CE Conditional Echo. The data element will be present in response message only if it was present in request message. If it was present it will contain the same value from the request.
- Not applicable

Value type

Notation Meaning
Not blank Not empty, not null, isset
A Alphabetic chars only
B Boolean - true or false
N Only numbers
NS Numeric with special symbols listed below
AN Alphanumeric value
ANS Alphanumeric with special symbols listed below
[1,2,3] Possible values: 1 or 2 or 3
[1-3] Range from 1 to 3
LIST List of values
OBJ Object with properties
- Not applicable
Special symbol
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { } ~ |