81:I[30285,["6268","static/chunks/f5718501-d50f0cdeddf74bbb.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","2122","static/chunks/9071f66d-65831af376c95d36.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","9246","static/chunks/9246-1df5a88dbb0722cb.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","6213","static/chunks/6213-fcd8f601a9fdf399.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","6811","static/chunks/6811-b5a1327b6b81e44f.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","8925","static/chunks/8925-fd6f6c8daa919d4e.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","9935","static/chunks/9935-f80be46e49f5110b.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","2335","static/chunks/2335-a5a4329b5d42f302.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","4825","static/chunks/4825-f35482f8ae1516fc.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","1668","static/chunks/1668-9deb883a08ddb855.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","3305","static/chunks/3305-3753466f8418a488.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","8617","static/chunks/app/sites/static/%5Bmode%5D/%5BsiteURL%5D/%5BsiteData%5D/(content)/%5BpagePath%5D/page-663cb362f1be2d7d.js?dpl=p-46b3a18b25b2dbb282efc77e79c716"],"OpenAPIBlockLazy"] 94:I[39237,["6268","static/chunks/f5718501-d50f0cdeddf74bbb.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","2122","static/chunks/9071f66d-65831af376c95d36.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","9246","static/chunks/9246-1df5a88dbb0722cb.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","6213","static/chunks/6213-fcd8f601a9fdf399.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","6811","static/chunks/6811-b5a1327b6b81e44f.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","8925","static/chunks/8925-fd6f6c8daa919d4e.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","9935","static/chunks/9935-f80be46e49f5110b.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","2335","static/chunks/2335-a5a4329b5d42f302.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","4825","static/chunks/4825-f35482f8ae1516fc.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","1668","static/chunks/1668-9deb883a08ddb855.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","3305","static/chunks/3305-3753466f8418a488.js?dpl=p-46b3a18b25b2dbb282efc77e79c716","8617","static/chunks/app/sites/static/%5Bmode%5D/%5BsiteURL%5D/%5BsiteData%5D/(content)/%5BpagePath%5D/page-663cb362f1be2d7d.js?dpl=p-46b3a18b25b2dbb282efc77e79c716"],"ScrollSectionsList"] 82:T576,The user and card information encrypted in a JWE structure (see security section in the documentation). Once decrypted, the JWE plaintext contains the following JSON object: |JSON field parameter name|description|MOC|Length| |-------|-------|-------|-------| |fpan|The funding pan to tokenize.
Value expected when 'source' parameter is 'MANUAL' or 'ON_FILE'.|C|Up to 19| |exp|The expiry date in format MMYY.
Value expected when 'source' parameter is 'MANUAL' or 'ON_FILE'.
Optional when VCES feature is activated for VISA|C|4| |token|Token number.
Value expected when 'source' parameter is 'TOKEN'.|C|Up to 19| |name|The card holder name in the format FIRSTNAME LASTNAME or as written on the card. MDES limits the length to 27 characters so ETP may truncate the provided value.
This parameter is mandatory for Discover card tokenization.|O|256| |cvv|The security code.
It can help the issuer in the decision of approving the payment.|O|3 or 4| |accountId|The card holder account identifier defined by the Merchant.
It can help the issuer in the decision of approving the payment.|O|24| |email|The card holder email.
This parameter is mandatory for AMEX card tokenization.|O|128| Example: {"fpan":"5123456789012345", "exp":"0822", "name":"JOHN DOE", "cvv":"123", "accountId":"johndoe", "email":"john@doe.com"}83:T6e9,

The user and card information encrypted in a JWE structure (see security section in the documentation).

Once decrypted, the JWE plaintext contains the following JSON object:

JSON field parameter name	description	MOC	Length
fpan	The funding pan to tokenize. Value expected when 'source' parameter is 'MANUAL' or 'ON_FILE'.	C	Up to 19
exp	The expiry date in format MMYY. Value expected when 'source' parameter is 'MANUAL' or 'ON_FILE'. Optional when VCES feature is activated for VISA	C	4
token	Token number. Value expected when 'source' parameter is 'TOKEN'.	C	Up to 19
name	The card holder name in the format FIRSTNAME LASTNAME or as written on the card. MDES limits the length to 27 characters so ETP may truncate the provided value. This parameter is mandatory for Discover card tokenization.	O	256
cvv	The security code. It can help the issuer in the decision of approving the payment.	O	3 or 4
accountId	The card holder account identifier defined by the Merchant. It can help the issuer in the decision of approving the payment.	O	24
email	The card holder email. This parameter is mandatory for AMEX card tokenization.	O	128

Example: {"fpan":"5123456789012345", "exp":"0822", "name":"JOHN DOE", "cvv":"123", "accountId":"johndoe", "email":"john@doe.com"}

84:T495,The user and card information encrypted in a JWE structure (see security section in the documentation). Once decrypted, the JWE plaintext contains the following JSON object: |JSON field parameter name|description|MOC|Length| |-------|-------|-------|-------| |fpan|The funding pan to tokenize.|M|Up to 19| |exp|The expiry date in the format MMYY.
Optional when VCES feature is activated for VISA|C|4| |name|The card holder name in the format FIRSTNAME LASTNAME or as written on the card. MDES limits the length to 27 characters so ETP may truncate the provided value.
This parameter is mandatory for Discover card tokenization.|O|256| |cvv|The security code.
It can help the issuer in the decision of approving the payment.|O|3 or 4| |accountId|The card holder account identifier defined by the Merchant.
It can help the issuer in the decision of approving the payment.|O|24| |email|The card holder email.
This parameter is mandatory for AMEX card tokenization.|O|128| Example: {"fpan":"5123456789012345", "exp":"0822", "name":"JOHN DOE", "cvv":"123", "accountId":"johndoe", "email":"john@doe.com"}85:T5de,

The user and card information encrypted in a JWE structure (see security section in the documentation).

Once decrypted, the JWE plaintext contains the following JSON object:

JSON field parameter name	description	MOC	Length
fpan	The funding pan to tokenize.	M	Up to 19
exp	The expiry date in the format MMYY. Optional when VCES feature is activated for VISA	C	4
name	The card holder name in the format FIRSTNAME LASTNAME or as written on the card. MDES limits the length to 27 characters so ETP may truncate the provided value. This parameter is mandatory for Discover card tokenization.	O	256
cvv	The security code. It can help the issuer in the decision of approving the payment.	O	3 or 4
accountId	The card holder account identifier defined by the Merchant. It can help the issuer in the decision of approving the payment.	O	24
email	The card holder email. This parameter is mandatory for AMEX card tokenization.	O	128

Example: {"fpan":"5123456789012345", "exp":"0822", "name":"JOHN DOE", "cvv":"123", "accountId":"johndoe", "email":"john@doe.com"}

86:T550,

The user information encrypted in a JWE structure (see security section in the documentation).

Once decrypted, the JWE plaintext contains the following JSON object:

JSON field parameter name	description	MOC	Length
name	The card holder name in format FIRSTNAME LASTNAME.	O	256
address.line1	The card holder address.	O	256
address.line2	The card holder address.	O	256
address.city	The card holder address.	O	256
address.countrySubdivision	The card holder address.	O	32
address.postalCode	The card holder address.	O	32
address.country	The Card holder country in ISO-3166-1 alpha-2 two-letter country code.	O	2
email	The card holder email.	O	128
phoneNumber	The card holder phone number.	O	128
personalId	A card holder personal identifier that may be required in some regions.	O	128

87:T435,

Risk level associated to the account. If provided, the value is forwarded to Mastercard TSP (MDES) or Visa TSP (VTS).

Value	Description
1	High risk level: No successful authentication within last 30 days. Suspect behavior (frequent token delete). Fraudulent activity due to illegitimate consumer behavior identified.
2	Risky account: Recent password reset. Recent unusual number of failed logins.
3	Neutral account: New account or no known good or bad history.
4	Trusted account: Account tenure of at least 6 months AND positive financial activity each month for at least three months.
5	Highly trusted account: Consumer successfully authenticated within last 30 days. Account tenure of at least 12 months AND positive financial activity each month for at least six months.

88:T435,

Risk level associated to the account. If provided, the value is forwarded to Mastercard TSP (MDES) or Visa TSP (VTS).

Value	Description
1	High risk level: No successful authentication within last 30 days. Suspect behavior (frequent token delete). Fraudulent activity due to illegitimate consumer behavior identified.
2	Risky account: Recent password reset. Recent unusual number of failed logins.
3	Neutral account: New account or no known good or bad history.
4	Trusted account: Account tenure of at least 6 months AND positive financial activity each month for at least three months.
5	Highly trusted account: Consumer successfully authenticated within last 30 days. Account tenure of at least 12 months AND positive financial activity each month for at least six months.

89:T465,

The payment credentials data encrypted in a JWE structure (see security section in the documentation).

Once decrypted, the JWE plaintext contains the following JSON object:

JSON field parameter name	description	MOC	Length
dpan	The token PAN value provided for network token.	C	Up to 19
exp	The token expiry date in the format MMYY provided for network token.	C	4
cryptogram	The payment cryptogram to use with the token for a payment. Presence of the cryptogram depends on the transaction type and the scheme.	C	Up to 256
fpan	The funding card PAN value. Only provided for PCI token.	C	Up to 19
fpanExp	The funding card expiry date in the format MMYY. Only provided for PCI token.	C	4

Example: {"dpan:"9580981500100002", "exp":"1222", "cryptogram": "45f8grzty7f4f5gs5s2c"}

8a:T1311,One of the below configuration must be provided:
- businessIdentificationType and businessIdentificationValue or
- acquirerId and acquirerMerchantId.

Merchant business identification type. |BusinessIdentificationType|Description|Format| |-------|-------|-------| |ABN|Australian business number|11 numeric digits| |ACN|Australian company number|9 numeric digits| |BID|VISA business identification number; all countries. You must contact your Visa representative before using BID |8 numeric digits| |BIN|Kazakhstan business identification number|12 numeric digits| |BIR|Philippines certificate of registration|12 numeric digits; hyphen-separated| |BN|Canadian business number|9 numeric digits| |BRN|South Korea business registration number|10 numeric digits; hyphen-separated| |BRNO|Malaysia only.|Up to 10 numeric digits followed by a hyphen and a single character or 12 numeric digits| |CL|Commercial License Number Qatar|4-6 numeric digits| |CLN|Company License Number Kuwait|5-7 numeric digits| |CORPORATE_NUMBER|Japan corporate number|13 numeric digits; leading digit is a non-zero check digit for the following 12 digits| |CNPJ|Brazil only.|14 alphanumeric characters, identified by n in the example, and punctuation characters (period, slash, and hyphen)| |CR|Company Registration Number Saudi Arabia.|10-12 numeric digits| |CUIT|Argentina only.|11 numeric digits| |EDRPOU|Ukraine. Ukrainian corporations|8 numeric digits and 10 numeric digits for Ukrainian individual entrepeneurs| |EIN|US Federal tax ID (US only).|9 numeric digits| |HKBR|Hong Kong only.|11 numeric digits and a hyphen| |INI|Andorran General Indirect Tax.|8 alphanumeric characters; the first and last characters must be alphabetic.| |NATIONAL_ID|Dominican Republic (DO). Cedula de Identidad (Merchant Owner ID)|DO + 11 digits| |NIB|Indonesia business identification number|13 numeric digits| |NID|South Africa national identification number|13 numeric digits| |NZBN|New Zealand business number.|13 numeric digits| |PAN|Indian business identification number|10 alphanumeric characters| |PAN|Belarus payer account number|9 numeric digits| |RFC|Mexico only.|12 alphanumeric characters for corporations and 13 alphanumeric characters for individuals| |RNC|Dominican Republic (DO). Registro Nacional de Contribuyentes (National Contributors Number)|DO + 9 digits| |RUC|Peru only.|11 numeric digits| |RUT|Chile and Colombia only.|8 numeric digits followed by a hyphen and one verification character or digit for Chile; 10 numeric digits for Columbia| |SIN|Canadian social insurance number|9 numeric digits| |SSN|US social security number (US only)|9 numeric digits| |TC|Vietnam tax code|10 or 13 numeric digits| |UEN|Singapore only|9 or 10 alphanumeric characters| |USCI|China united social credit code|18 alphanumeric characters| |VAT|Austria, Belgium, Bulgaria, Croatia, Czech Republic, Denmark, Estonia, Finland, Faroe Islands, France, Germany, Greece, Hungary, Iceland, Ireland, Isle of Man, Israel, Italy, Latvia, Lithuania, Luxembourg, Malta, Netherlands, Norway, Poland, Portugal, Republic of Cyprus, Romania, Saudi Arabia, Slovak Republic, Slovenia, South Africa, Spain, Sweden, Switzerland, Thailand, Turkey, Ukraine, United Arab Emirates, United Kingdom|

Austria AT + 9 characters in which the first character is always a 'U'

Belgium BE + 10 characters. Prefix with zero '0' if the customer provides a 9 digit VAT number

Bulgaria BG + 9 or 10 characters

Croatia HR + 11 characters

Cyprus CY + 9 characters

Czech Republic CZ + 8, 9 or 10 characters.

Denmark DK + 8 characters

Estonia EE + 9 characters

Finland FI + 8 characters

Faroe Islands FO + 6 characters

France FR + 11 characters

Germany DE + 9 characters

Greece EL + 9 characters

Hungary HU + 8 characters

Iceland IS + 5 or 6 characters

Ireland IE + 8 numeric or alphabetic characters

Israel IL + 9 numeric digits

Isle of Man GB + 9 or 12 digits; first 2 digits must be 00

Italy IT + 11 characters

Latvia LV + 11 characters

Lithuania LT + 9 or 12 characters

Luxembourg LU + 8 characters

Malta MT + 8 characters.

Netherlands NL + 12 characters of which the tenth character is always B.

Norway NO + 9 digits and the letters + MVA

Poland PL + 10 alphanumeric characters

Portugal PT + 9 characters

Republic of Cyprus CY + 9 characters. The last character must always be a letter.

Romania RO + 2 to 10 characters.

Saudi Arabia 15 numeric digits

Slovak Republic SK + 10 characters

Slovenia SI + 8 characters

South Africa 10 or 11 digits

Spain ES + 9 numeric digits

Sweden SE + 12 digits

Switzerland CH + 9 digits + MWST (German part), TVA(French part), or IVA(Italian part)

Thailand 13 numeric digits

Turkey TR + 10 characters

Ukraine 9 or 12 digits

United Arab Emirates 15 digits

United Kingdom GB + 9 digits|8b:T18e7,

One of the below configuration must be provided:
- businessIdentificationType and businessIdentificationValue or
- acquirerId and acquirerMerchantId.

Merchant business identification type.

BusinessIdentificationType	Description	Format
ABN	Australian business number	11 numeric digits
ACN	Australian company number	9 numeric digits
BID	VISA business identification number; all countries. You must contact your Visa representative before using BID	8 numeric digits
BIN	Kazakhstan business identification number	12 numeric digits
BIR	Philippines certificate of registration	12 numeric digits; hyphen-separated
BN	Canadian business number	9 numeric digits
BRN	South Korea business registration number	10 numeric digits; hyphen-separated
BRNO	Malaysia only.	Up to 10 numeric digits followed by a hyphen and a single character or 12 numeric digits
CL	Commercial License Number Qatar	4-6 numeric digits
CLN	Company License Number Kuwait	5-7 numeric digits
CORPORATE_NUMBER	Japan corporate number	13 numeric digits; leading digit is a non-zero check digit for the following 12 digits
CNPJ	Brazil only.	14 alphanumeric characters, identified by n in the example, and punctuation characters (period, slash, and hyphen)
CR	Company Registration Number Saudi Arabia.	10-12 numeric digits
CUIT	Argentina only.	11 numeric digits
EDRPOU	Ukraine. Ukrainian corporations	8 numeric digits and 10 numeric digits for Ukrainian individual entrepeneurs
EIN	US Federal tax ID (US only).	9 numeric digits
HKBR	Hong Kong only.	11 numeric digits and a hyphen
INI	Andorran General Indirect Tax.	8 alphanumeric characters; the first and last characters must be alphabetic.
NATIONAL_ID	Dominican Republic (DO). Cedula de Identidad (Merchant Owner ID)	DO + 11 digits
NIB	Indonesia business identification number	13 numeric digits
NID	South Africa national identification number	13 numeric digits
NZBN	New Zealand business number.	13 numeric digits
PAN	Indian business identification number	10 alphanumeric characters
PAN	Belarus payer account number	9 numeric digits
RFC	Mexico only.	12 alphanumeric characters for corporations and 13 alphanumeric characters for individuals
RNC	Dominican Republic (DO). Registro Nacional de Contribuyentes (National Contributors Number)	DO + 9 digits
RUC	Peru only.	11 numeric digits
RUT	Chile and Colombia only.	8 numeric digits followed by a hyphen and one verification character or digit for Chile; 10 numeric digits for Columbia
SIN	Canadian social insurance number	9 numeric digits
SSN	US social security number (US only)	9 numeric digits
TC	Vietnam tax code	10 or 13 numeric digits
UEN	Singapore only	9 or 10 alphanumeric characters
USCI	China united social credit code	18 alphanumeric characters
VAT	Austria, Belgium, Bulgaria, Croatia, Czech Republic, Denmark, Estonia, Finland, Faroe Islands, France, Germany, Greece, Hungary, Iceland, Ireland, Isle of Man, Israel, Italy, Latvia, Lithuania, Luxembourg, Malta, Netherlands, Norway, Poland, Portugal, Republic of Cyprus, Romania, Saudi Arabia, Slovak Republic, Slovenia, South Africa, Spain, Sweden, Switzerland, Thailand, Turkey, Ukraine, United Arab Emirates, United Kingdom	Austria AT + 9 characters in which the first character is always a 'U' Belgium BE + 10 characters. Prefix with zero '0' if the customer provides a 9 digit VAT number Bulgaria BG + 9 or 10 characters Croatia HR + 11 characters Cyprus CY + 9 characters Czech Republic CZ + 8, 9 or 10 characters. Denmark DK + 8 characters Estonia EE + 9 characters Finland FI + 8 characters Faroe Islands FO + 6 characters France FR + 11 characters Germany DE + 9 characters Greece EL + 9 characters Hungary HU + 8 characters Iceland IS + 5 or 6 characters Ireland IE + 8 numeric or alphabetic characters Israel IL + 9 numeric digits Isle of Man GB + 9 or 12 digits; first 2 digits must be 00 Italy IT + 11 characters Latvia LV + 11 characters Lithuania LT + 9 or 12 characters Luxembourg LU + 8 characters Malta MT + 8 characters. Netherlands NL + 12 characters of which the tenth character is always B. Norway NO + 9 digits and the letters + MVA Poland PL + 10 alphanumeric characters Portugal PT + 9 characters Republic of Cyprus CY + 9 characters. The last character must always be a letter. Romania RO + 2 to 10 characters. Saudi Arabia 15 numeric digits Slovak Republic SK + 10 characters Slovenia SI + 8 characters South Africa 10 or 11 digits Spain ES + 9 numeric digits Sweden SE + 12 digits Switzerland CH + 9 digits + MWST (German part), TVA(French part), or IVA(Italian part) Thailand 13 numeric digits Turkey TR + 10 characters Ukraine 9 or 12 digits United Arab Emirates 15 digits United Kingdom GB + 9 digits

80:["$","$L81",null,{"variant":"schemas","data":{"schemas":[{"name":"merchantId","schema":{"type":"string","description":"Identifier of the merchant provided by Thales at on-boarding.","minLength":1,"maxLength":128,"x-gitbook-description-html":"

Identifier of the merchant provided by Thales at on-boarding.

","title":"merchantId"}},{"name":"encryptedUserInfoSync","schema":{"type":"string","minLength":1,"maxLength":8196,"description":"$82","x-gitbook-description-html":"$83","title":"encryptedUserInfoSync"}},{"name":"encryptedUserInfoAsync","schema":{"type":"string","minLength":1,"maxLength":8196,"description":"$84","x-gitbook-description-html":"$85","title":"encryptedUserInfoAsync"}},{"name":"encryptedUserInfoPci","schema":{"type":"string","minLength":1,"maxLength":8196,"description":"The user and card information encrypted in a JWE structure (see security section in the documentation).\n\nOnce decrypted, the JWE plaintext contains the following JSON object:\n\n|JSON field parameter name|description|MOC|Length|\n|-------|-------|-------|-------|\n|fpan|The funding pan to tokenize.|M|Up to 19|\n|exp|The expiry date in the format MMYY.|M|4|\n\nExample: {\"fpan\":\"5123456789012345\", \"exp\":\"0822\"}","x-gitbook-description-html":"

The user and card information encrypted in a JWE structure (see security section in the documentation).

Once decrypted, the JWE plaintext contains the following JSON object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

JSON field parameter name	description	MOC	Length
fpan	The funding pan to tokenize.	M	Up to 19
exp	The expiry date in the format MMYY.	M	4

Example: {\"fpan\":\"5123456789012345\", \"exp\":\"0822\"}

","title":"encryptedUserInfoPci"}},{"name":"pushProvisioningPayload","schema":{"type":"string","description":"The push provisioning payload provided by the Issuer to the merchant application.\n\nFor Mastercard, it corresponds to the 'pushAccountReceipt'.\n\nFor Visa, it corresponds to the 'encPaymentInstrument'.","minLength":1,"maxLength":8196,"x-gitbook-description-html":"

The push provisioning payload provided by the Issuer to the merchant application.

For Mastercard, it corresponds to the 'pushAccountReceipt'.

For Visa, it corresponds to the 'encPaymentInstrument'.

","title":"pushProvisioningPayload"}},{"name":"encryptedMerchantInfoPushProvisioning","schema":{"type":"string","minLength":1,"maxLength":8196,"description":"The user information encrypted in a JWE structure (see security section in the documentation).\n\nOnce decrypted, the JWE plaintext contains the following JSON object:\n\n|JSON field parameter name|description|MOC|Length|\n|-------|-------|-------|-------|\n|accountId|The card holder account identifier defined by the Merchant.|O|24|\n|email|The card holder email.|O|128|\n\nExample: {\"accountId:\"johndoe\", \"email\":\"john@doe.com\"}","x-gitbook-description-html":"

The user information encrypted in a JWE structure (see security section in the documentation).

Once decrypted, the JWE plaintext contains the following JSON object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

JSON field parameter name	description	MOC	Length
accountId	The card holder account identifier defined by the Merchant.	O	24
email	The card holder email.	O	128

Example: {\"accountId:\"johndoe\", \"email\":\"john@doe.com\"}

","title":"encryptedMerchantInfoPushProvisioning"}},{"name":"encryptedIssuerInfoPushProvisioning","schema":{"type":"string","maxLength":8196,"description":"The user information encrypted in a JWE structure (see security section in the documentation).\n\nOnce decrypted, the JWE plaintext contains the following JSON object:\n\n|JSON field parameter name|description|MOC|Length|\n|-------|-------|-------|-------|\n|name|The card holder name in format FIRSTNAME LASTNAME.|O|256|\n|address.line1|The card holder address.|O|256|\n|address.line2|The card holder address.|O|256|\n|address.city|The card holder address.|O|256|\n|address.countrySubdivision|The card holder address.|O|32|\n|address.postalCode|The card holder address.|O|32|\n|address.country|The Card holder country in ISO-3166-1 alpha-2 two-letter country code.|O|2|\n|email|The card holder email.|O|128|\n|phoneNumber|The card holder phone number.|O|128|\n|personalId|A card holder personal identifier that may be required in some regions.|O|128|","x-gitbook-description-html":"$86","title":"encryptedIssuerInfoPushProvisioning"}},{"name":"sourceSync","schema":{"type":"string","maxLength":32,"description":"The card info entry mode.
'MANUAL' It can help the issuer in the decision of approving the payment.
'TOKEN' is allowed just for Visa, used by token per token feature","enum":["CARD_ON_FILE","MANUAL","TOKEN"],"x-gitbook-description-html":"

The card info entry mode.
'MANUAL' It can help the issuer in the decision of approving the payment.
'TOKEN' is allowed just for Visa, used by token per token feature

","title":"sourceSync"}},{"name":"sourceAsync","schema":{"type":"string","maxLength":32,"description":"The card info entry mode.
'MANUAL' It can help the issuer in the decision of approving the payment.","enum":["CARD_ON_FILE","MANUAL"],"x-gitbook-description-html":"

The card info entry mode.
'MANUAL' It can help the issuer in the decision of approving the payment.

","title":"sourceAsync"}},{"name":"language","schema":{"type":"string","default":"en","minLength":2,"maxLength":2,"description":"Card holder language in ISO-639-1 two-letter language code.","examples":["en"],"x-gitbook-description-html":"

Card holder language in ISO-639-1 two-letter language code.

","title":"language"}},{"name":"country","schema":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code.","examples":["US"],"x-gitbook-description-html":"

Card holder country in ISO-3166-1 alpha-2 two-letter country code.

","title":"country"}},{"name":"accountScore","schema":{"type":"integer","minimum":1,"maximum":5,"description":"Risk level associated to the account.\nIf provided, the value is forwarded to Mastercard TSP (MDES) or Visa TSP (VTS).\n\n|Value|Description|\n|-------|-------|\n|1| High risk level:

No successful authentication within last 30 days.

Suspect behavior (frequent token delete).

Fraudulent activity due to illegitimate consumer behavior identified.

|\n|2|Risky account:

Recent password reset.

Recent unusual number of failed logins.

|\n|3|Neutral account:

New account or no known good or bad history.

|\n|4|Trusted account:

Account tenure of at least 6 months AND positive financial activity each month for at least three months.

|\n|5|Highly trusted account:

Consumer successfully authenticated within last 30 days.

Account tenure of at least 12 months AND positive financial activity each month for at least six months.

|","examples":[5],"x-gitbook-description-html":"$87","title":"accountScore"}},{"name":"risk","schema":{"type":"object","description":"Parameters linked to the risk level evaluated by the Token Requestor.
It can help the issuer in the decision of approving the payment.","properties":{"accountScore":{"type":"integer","minimum":1,"maximum":5,"description":"Risk level associated to the account.\nIf provided, the value is forwarded to Mastercard TSP (MDES) or Visa TSP (VTS).\n\n|Value|Description|\n|-------|-------|\n|1| High risk level:

No successful authentication within last 30 days.

Suspect behavior (frequent token delete).

Fraudulent activity due to illegitimate consumer behavior identified.

|\n|2|Risky account:

Recent password reset.

Recent unusual number of failed logins.

|\n|3|Neutral account:

New account or no known good or bad history.

|\n|4|Trusted account:

Account tenure of at least 6 months AND positive financial activity each month for at least three months.

|\n|5|Highly trusted account:

Consumer successfully authenticated within last 30 days.

Account tenure of at least 12 months AND positive financial activity each month for at least six months.

|","examples":"$80:props:data:schemas:11:schema:examples","x-gitbook-description-html":"$88","title":"accountScore"}},"x-gitbook-description-html":"

Parameters linked to the risk level evaluated by the Token Requestor.
It can help the issuer in the decision of approving the payment.

","title":"risk"}},{"name":"ipAddress","schema":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4 or IPv6. The parameter is mandatory for AMEX card digitization in case the 'source' is 'MANUAL'.
For the other schemes, it is optional and is sent to Visa or Mastercard if format is IPv4.","examples":["172.16.254.1"],"x-gitbook-description-html":"

The card holder's device IP address in format IPv4 or IPv6. The parameter is mandatory for AMEX card digitization in case the 'source' is 'MANUAL'.
For the other schemes, it is optional and is sent to Visa or Mastercard if format is IPv4.

","title":"ipAddress"}},{"name":"ipAddressSimpleDesc","schema":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4.","examples":["172.16.254.1"],"x-gitbook-description-html":"

The card holder's device IP address in format IPv4.

","title":"ipAddressSimpleDesc"}},{"name":"location","schema":{"type":"string","minLength":1,"maxLength":32,"description":"The card holder's device location.
\n
Format requirements:\n* Latitude is between -90 and 90 degrees.\n* Longitude is between -180 and 180 degrees.\n* For positive value, the sign '+' shall not be provided.\n* Values are provided in decimal degrees with a precision of 4 decimal places.\n* Latitude and longitude are separated by a comma.\n* Spaces are not allowed.\n\nExamples: \n* '47.0880,2.3635'\n* '51.5306,-133.7224'\n* '-10.0000,-111.0000'","examples":["47.0880,2.3635"],"x-gitbook-description-html":"

The card holder's device location.
\n
Format requirements:

Latitude is between -90 and 90 degrees.
Longitude is between -180 and 180 degrees.
For positive value, the sign '+' shall not be provided.
Values are provided in decimal degrees with a precision of 4 decimal places.
Latitude and longitude are separated by a comma.
Spaces are not allowed.

Examples:

'47.0880,2.3635'
'51.5306,-133.7224'
'-10.0000,-111.0000'

","title":"location"}},{"name":"device","schema":{"type":"object","description":"Information about the card holder's device.
It can help the issuer in the decision of approving the payment.","properties":{"ipAddress":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4 or IPv6. The parameter is mandatory for AMEX card digitization in case the 'source' is 'MANUAL'.
For the other schemes, it is optional and is sent to Visa or Mastercard if format is IPv4.","examples":"$80:props:data:schemas:13:schema:examples","x-gitbook-description-html":"

","title":"ipAddress"},"location":{"type":"string","minLength":1,"maxLength":32,"description":"The card holder's device location.
\n
Format requirements:\n* Latitude is between -90 and 90 degrees.\n* Longitude is between -180 and 180 degrees.\n* For positive value, the sign '+' shall not be provided.\n* Values are provided in decimal degrees with a precision of 4 decimal places.\n* Latitude and longitude are separated by a comma.\n* Spaces are not allowed.\n\nExamples: \n* '47.0880,2.3635'\n* '51.5306,-133.7224'\n* '-10.0000,-111.0000'","examples":"$80:props:data:schemas:15:schema:examples","x-gitbook-description-html":"

The card holder's device location.
\n
Format requirements:

Latitude is between -90 and 90 degrees.
Longitude is between -180 and 180 degrees.
For positive value, the sign '+' shall not be provided.
Values are provided in decimal degrees with a precision of 4 decimal places.
Latitude and longitude are separated by a comma.
Spaces are not allowed.

Examples:

'47.0880,2.3635'
'51.5306,-133.7224'
'-10.0000,-111.0000'

","title":"location"}},"x-gitbook-description-html":"

Information about the card holder's device.
It can help the issuer in the decision of approving the payment.

","title":"device"}},{"name":"deviceTransaction","schema":{"type":"object","required":["ipAddress"],"description":"Required for Visa DAF only. deviceId and ipAddress are mandated. location is optional.","properties":{"deviceId":{"type":"string","description":"DEPRECATED! The unique device identifier. Visa deviceId must have 24 characters at maximum.","minLength":1,"maxLength":24,"examples":["1234567890"],"x-gitbook-description-html":"

DEPRECATED! The unique device identifier. Visa deviceId must have 24 characters at maximum.

","title":"deviceIdDeprecated"},"ipAddress":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4.","examples":"$80:props:data:schemas:14:schema:examples","x-gitbook-description-html":"

The card holder's device IP address in format IPv4.

","title":"ipAddressSimpleDesc"},"location":{"type":"string","minLength":1,"maxLength":32,"description":"The card holder's device location.
\n
Format requirements:\n* Latitude is between -90 and 90 degrees.\n* Longitude is between -180 and 180 degrees.\n* For positive value, the sign '+' shall not be provided.\n* Values are provided in decimal degrees with a precision of 4 decimal places.\n* Latitude and longitude are separated by a comma.\n* Spaces are not allowed.\n\nExamples: \n* '47.0880,2.3635'\n* '51.5306,-133.7224'\n* '-10.0000,-111.0000'","examples":"$80:props:data:schemas:15:schema:examples","x-gitbook-description-html":"

The card holder's device location.
\n
Format requirements:

Latitude is between -90 and 90 degrees.
Longitude is between -180 and 180 degrees.
For positive value, the sign '+' shall not be provided.
Values are provided in decimal degrees with a precision of 4 decimal places.
Latitude and longitude are separated by a comma.
Spaces are not allowed.

Examples:

'47.0880,2.3635'
'51.5306,-133.7224'
'-10.0000,-111.0000'

","title":"location"}},"x-gitbook-description-html":"

Required for Visa DAF only. deviceId and ipAddress are mandated. location is optional.

","title":"deviceTransaction"}},{"name":"devicePushProvisioning","schema":{"type":"object","description":"Information about the card holder's device.","required":["ipAddress"],"properties":{"ipAddress":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4.","examples":"$80:props:data:schemas:14:schema:examples","x-gitbook-description-html":"

The card holder's device IP address in format IPv4.

The card holder's device location.
\n
Format requirements:

Latitude is between -90 and 90 degrees.
Longitude is between -180 and 180 degrees.
For positive value, the sign '+' shall not be provided.
Values are provided in decimal degrees with a precision of 4 decimal places.
Latitude and longitude are separated by a comma.
Spaces are not allowed.

Examples:

'47.0880,2.3635'
'51.5306,-133.7224'
'-10.0000,-111.0000'

","title":"location"}},"x-gitbook-description-html":"

Information about the card holder's device.

","title":"devicePushProvisioning"}},{"name":"cardholderEmail","schema":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address.","examples":["jsmith@emailprovider.com"],"x-gitbook-description-html":"

Card holder email address.

","title":"cardholderEmail"}},{"name":"cardholderLine1","schema":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1.","x-gitbook-description-html":"

Card holder address line 1.

","title":"cardholderLine1"}},{"name":"cardholderLine2","schema":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 2.","x-gitbook-description-html":"

Card holder address line 2.

","title":"cardholderLine2"}},{"name":"cardholderCity","schema":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$","examples":["San Francisco"],"x-gitbook-description-html":"

Card holder city.

","title":"cardholderCity"}},{"name":"cardholderSubdivision","schema":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format.","examples":["NY"],"x-gitbook-description-html":"

Card holder state or province code in ISO-3166-1 alpha-2 two-letter format.

","title":"cardholderSubdivision"}},{"name":"cardholderPostalCode","schema":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$","examples":["10016"],"x-gitbook-description-html":"

Card holder postal code or zip code.

","title":"cardholderPostalCode"}},{"name":"cardholderAddress","schema":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1.","x-gitbook-description-html":"

Card holder address line 1.

","title":"cardholderLine1"},"line2":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 2.","x-gitbook-description-html":"

Card holder address line 2.

","title":"cardholderLine2"},"city":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$","examples":"$80:props:data:schemas:22:schema:examples","x-gitbook-description-html":"

Card holder city.

","title":"cardholderCity"},"postalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$","examples":"$80:props:data:schemas:24:schema:examples","x-gitbook-description-html":"

Card holder postal code or zip code.

","title":"cardholderPostalCode"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code.","examples":"$80:props:data:schemas:10:schema:examples","x-gitbook-description-html":"

Card holder country in ISO-3166-1 alpha-2 two-letter country code.

","title":"country"},"subdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format.","examples":"$80:props:data:schemas:23:schema:examples","x-gitbook-description-html":"

Card holder state or province code in ISO-3166-1 alpha-2 two-letter format.

","title":"cardholderSubdivision"}},"x-gitbook-description-html":"

Card holder billing address.

","title":"cardholderAddress"}},{"name":"cardholderBillingAddress","schema":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1.","x-gitbook-description-html":"

Card holder address line 1.

","title":"cardholderLine1"},"line2":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 2.","x-gitbook-description-html":"

Card holder address line 2.

Card holder city.

Card holder postal code or zip code.

Card holder country in ISO-3166-1 alpha-2 two-letter country code.

Card holder state or province code in ISO-3166-1 alpha-2 two-letter format.

","title":"cardholderSubdivision"}},"x-gitbook-description-html":"

Card holder billing address.

","title":"cardholderBillingAddress"}},{"name":"cardholderAddressTAF","schema":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1.","x-gitbook-description-html":"

Card holder address line 1.

","title":"cardholderLine1"},"city":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$","examples":"$80:props:data:schemas:22:schema:examples","x-gitbook-description-html":"

Card holder city.

Card holder postal code or zip code.

Card holder country in ISO-3166-1 alpha-2 two-letter country code.

Card holder state or province code in ISO-3166-1 alpha-2 two-letter format.

","title":"cardholderSubdivision"}},"x-gitbook-description-html":"

Card holder billing address.

","title":"cardholderAddressTAF"}},{"name":"cardholderTransaction","schema":{"type":"object","description":"Required for Visa DAF only.Information about the card holder.\n","required":["email"],"properties":{"email":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address.","examples":"$80:props:data:schemas:19:schema:examples","x-gitbook-description-html":"

Card holder email address.

","title":"cardholderEmail"},"billingAddress":{"type":"object","description":"Card holder billing address.","required":"$80:props:data:schemas:26:schema:required","properties":"$80:props:data:schemas:26:schema:properties","x-gitbook-description-html":"

Card holder billing address.

","title":"cardholderBillingAddress"}},"x-gitbook-description-html":"

Required for Visa DAF only.Information about the card holder.

","title":"cardholderTransaction"}},{"name":"color","schema":{"type":"string","maxLength":32,"description":"Deprecated.","enum":["GREEN"],"examples":["GREEN"],"x-gitbook-description-html":"

Deprecated.

","title":"color"}},{"name":"tokenId","schema":{"type":"string","description":"The token identifier.","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":128,"x-gitbook-description-html":"

The token identifier.

","title":"tokenId"}},{"name":"vProvisionedTokenId","schema":{"type":"string","description":"Specific to Visa. Another token identifier that shall be used only with Visa Cloud Token Framework.","minLength":1,"maxLength":36,"x-gitbook-description-html":"

Specific to Visa. Another token identifier that shall be used only with Visa Cloud Token Framework.

","title":"vProvisionedTokenId"}},{"name":"deviceIdDeprecated","schema":{"type":"string","description":"DEPRECATED! The unique device identifier. Visa deviceId must have 24 characters at maximum.","minLength":1,"maxLength":24,"examples":"$80:props:data:schemas:17:schema:properties:deviceId:examples","x-gitbook-description-html":"

DEPRECATED! The unique device identifier. Visa deviceId must have 24 characters at maximum.

","title":"deviceIdDeprecated"}},{"name":"deviceId","schema":{"type":"string","description":"The unique device identifier. Visa deviceId must have 24 characters at maximum.","minLength":1,"maxLength":36,"examples":["1234567890"],"x-gitbook-description-html":"

The unique device identifier. Visa deviceId must have 24 characters at maximum.

","title":"deviceId"}},{"name":"deviceIdMdes","schema":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":36,"examples":["1234567890"],"x-gitbook-description-html":"

The unique device identifier.

","title":"deviceIdMdes"}},{"name":"tokenLastDigits","schema":{"type":"string","maxLength":5,"description":"The token last digits.","examples":["5589"],"x-gitbook-description-html":"

The token last digits.

","title":"tokenLastDigits"}},{"name":"tokenExpiryDate","schema":{"type":"string","maxLength":4,"description":"The token expiry date in format MMYY. This information can be missing. It is intended for display only at this step.
Rely on token expiry date in create transaction response for storage.","examples":["1022"],"x-gitbook-description-html":"

The token expiry date in format MMYY. This information can be missing. It is intended for display only at this step.
Rely on token expiry date in create transaction response for storage.

","title":"tokenExpiryDate"}},{"name":"cardBin","schema":{"type":"string","description":"The card bin returned by the scheme, just available for VISA and Mastercard SCOF.","minLength":6,"maxLength":8,"examples":["453421"],"x-gitbook-description-html":"

The card bin returned by the scheme, just available for VISA and Mastercard SCOF.

","title":"cardBin"}},{"name":"cardLastDigits","schema":{"type":"string","maxLength":5,"description":"The card last digits.","examples":["2366"],"x-gitbook-description-html":"

The card last digits.

","title":"cardLastDigits"}},{"name":"cardExpiryDate","schema":{"type":"string","maxLength":4,"description":"The card expiry date in format MMYY.","examples":["0420"],"x-gitbook-description-html":"

The card expiry date in format MMYY.

","title":"cardExpiryDate"}},{"name":"issuerName","schema":{"type":"string","maxLength":128,"description":"The card issuer name.","examples":["Bank Name"],"x-gitbook-description-html":"

The card issuer name.

","title":"issuerName"}},{"name":"supportVisaCTF","schema":{"type":"boolean","description":"Indicate if Visa Cloud Token Framework is available.","examples":[true],"x-gitbook-description-html":"

Indicate if Visa Cloud Token Framework is available.

","title":"supportVisaCTF"}},{"name":"supportMastercardTAF","schema":{"type":"boolean","description":"Indicate if Mastercard Token Authentication Framework is available.","examples":[true],"x-gitbook-description-html":"

Indicate if Mastercard Token Authentication Framework is available.

","title":"supportMastercardTAF"}},{"name":"supportMastercardLiabilityShift","schema":{"type":"boolean","description":"For Mastercard indicates whether the Multi Factor Authentication method & account PAN are eligible for Fraud Liability Protection","examples":[true],"x-gitbook-description-html":"

For Mastercard indicates whether the Multi Factor Authentication method & account PAN are eligible for Fraud Liability Protection

","title":"supportMastercardLiabilityShift"}},{"name":"cardDescription","schema":{"type":"string","maxLength":256,"description":"The card description.","examples":["Card description (premium, basic, etc.)."],"x-gitbook-description-html":"

The card description.

","title":"cardDescription"}},{"name":"cardType","schema":{"type":"string","description":"The card type.","maxLength":32,"enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"],"examples":["DEBIT"],"x-gitbook-description-html":"

The card type.

","title":"cardType"}},{"name":"scheme","schema":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA","AMEX","DISCOVER","ELO","UNKNOWN"],"examples":["MASTERCARD"],"x-gitbook-description-html":"

The card primary scheme.

","title":"scheme"}},{"name":"schemeMigration","schema":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD"],"examples":["MASTERCARD"],"x-gitbook-description-html":"

The card primary scheme.

","title":"schemeMigration"}},{"name":"schemePushProvisioning","schema":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA"],"examples":["MASTERCARD"],"x-gitbook-description-html":"

The card primary scheme.

","title":"schemePushProvisioning"}},{"name":"deviceBindings","schema":{"type":"array","description":"The list of device identifiers bound to the token.","items":{"type":"string","description":"The unique device identifier. Visa deviceId must have 24 characters at maximum.","minLength":1,"maxLength":36,"examples":"$80:props:data:schemas:33:schema:examples","x-gitbook-description-html":"

The unique device identifier. Visa deviceId must have 24 characters at maximum.

","title":"deviceId"},"uniqueItems":true,"x-gitbook-description-html":"

The list of device identifiers bound to the token.

","title":"deviceBindings"}},{"name":"termsAndConditionsUrl","schema":{"type":"string","maxLength":512,"description":"Card issuer terms and conditions URL.","examples":["https://bank.com/tncs.html"],"x-gitbook-description-html":"

Card issuer terms and conditions URL.

","title":"termsAndConditionsUrl"}},{"name":"privacyPolicyUrl","schema":{"type":"string","maxLength":512,"description":"Card issuer privacy policy URL.","examples":["https://bank.com/privacyPolicy.html"],"x-gitbook-description-html":"

Card issuer privacy policy URL.

","title":"privacyPolicyUrl"}},{"name":"cardProduct","schema":{"type":"object","description":"Information about the card product.","required":["cardType","scheme"],"properties":{"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name.","examples":"$80:props:data:schemas:40:schema:examples","x-gitbook-description-html":"

The card issuer name.

","title":"issuerName"},"cardType":{"type":"string","description":"The card type.","maxLength":32,"enum":"$80:props:data:schemas:45:schema:enum","examples":"$80:props:data:schemas:45:schema:examples","x-gitbook-description-html":"

The card type.

","title":"cardType"},"scheme":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":"$80:props:data:schemas:46:schema:enum","examples":"$80:props:data:schemas:46:schema:examples","x-gitbook-description-html":"

The card primary scheme.

","title":"scheme"},"supportVisaCTF":{"type":"boolean","description":"Indicate if Visa Cloud Token Framework is available.","examples":"$80:props:data:schemas:41:schema:examples","x-gitbook-description-html":"

Indicate if Visa Cloud Token Framework is available.

","title":"supportVisaCTF"},"supportMastercardTAF":{"type":"boolean","description":"Indicate if Mastercard Token Authentication Framework is available.","examples":"$80:props:data:schemas:42:schema:examples","x-gitbook-description-html":"

Indicate if Mastercard Token Authentication Framework is available.

","title":"supportMastercardTAF"},"supportMastercardLiabilityShift":{"type":"boolean","description":"For Mastercard indicates whether the Multi Factor Authentication method & account PAN are eligible for Fraud Liability Protection","examples":"$80:props:data:schemas:43:schema:examples","x-gitbook-description-html":"

For Mastercard indicates whether the Multi Factor Authentication method & account PAN are eligible for Fraud Liability Protection

","title":"supportMastercardLiabilityShift"},"cardDescription":{"type":"string","maxLength":256,"description":"The card description.","examples":"$80:props:data:schemas:44:schema:examples","x-gitbook-description-html":"

The card description.

","title":"cardDescription"},"cardArts":{"type":"object","properties":{"foregroundColor":{"type":"string","maxLength":6,"description":"Color used for the text displayed on the card (last digits, expiry date). Hexadecimal RGB color format.","examples":["7FB8C8"],"x-gitbook-description-html":"

Color used for the text displayed on the card (last digits, expiry date). Hexadecimal RGB color format.

"},"backgroundColor":{"type":"string","maxLength":6,"description":"Color used for card background. Hexadecimal RGB color format.","examples":["7FB8C9"],"x-gitbook-description-html":"

Color used for card background. Hexadecimal RGB color format.

"},"cardBackgroundImageId":{"type":"string","maxLength":128,"description":"Asset identifier of the card background image. It doesn't contain the issuer/brand/co-brand logo.","examples":["2ee5c858-a6a4-43f1-a503-ffde6c41fad9"],"x-gitbook-description-html":"

Asset identifier of the card background image. It doesn't contain the issuer/brand/co-brand logo.

"},"issuerLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the issuer logo.","examples":["1fd8594c-5284-4aeb-bb73-6129c1d6cdb2"],"x-gitbook-description-html":"

Asset identifier of the issuer logo.

"},"brandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the primary brand logo.","examples":["623046b7-4a8f-4550-bca8-45b38c9498a3"],"x-gitbook-description-html":"

Asset identifier of the primary brand logo.

"},"cobrandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the cobrand logo.","examples":["5548eb95-3aee-4bb8-9abf-38a7ab2c1cf3"],"x-gitbook-description-html":"

Asset identifier of the cobrand logo.

"},"completeCardImageId":{"type":"string","maxLength":128,"description":"Asset identifier of the complete card image. Shall be preferred over the other assets when present.","examples":["15ac4371-dcb9-4310-867e-b12338970276"],"x-gitbook-description-html":"

Asset identifier of the complete card image. Shall be preferred over the other assets when present.

"},"cardIconId":{"type":"string","maxLength":128,"description":"Asset identifier of the card icon.","examples":["14e3044fa-949e-4900-800f-88b8fc6cc3d5"],"x-gitbook-description-html":"

Asset identifier of the card icon.

"},"cardImageUrl":{"type":"string","maxLength":512,"description":"HTTP location of the card image. If present, no other identifier is provided and getAsset operation is not needed.","examples":["https://stage.assets.mastercard.com/card-art/combined-image-asset/MyBank-mastercard.png"],"x-gitbook-description-html":"

HTTP location of the card image. If present, no other identifier is provided and getAsset operation is not needed.

"}},"title":"cardArts"},"termsAndConditionsUrl":{"type":"string","maxLength":512,"description":"Card issuer terms and conditions URL.","examples":"$80:props:data:schemas:50:schema:examples","x-gitbook-description-html":"

Card issuer terms and conditions URL.

","title":"termsAndConditionsUrl"},"privacyPolicyUrl":{"type":"string","maxLength":512,"description":"Card issuer privacy policy URL.","examples":"$80:props:data:schemas:51:schema:examples","x-gitbook-description-html":"

Card issuer privacy policy URL.

","title":"privacyPolicyUrl"}},"x-gitbook-description-html":"

Information about the card product.

","title":"cardProduct"}},{"name":"cardProductPush","schema":{"type":"object","description":"Information about the card product.","required":["cardType","scheme"],"properties":{"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name.","examples":"$80:props:data:schemas:40:schema:examples","x-gitbook-description-html":"

The card issuer name.

The card type.

The card primary scheme.

Indicate if Visa Cloud Token Framework is available.

","title":"supportVisaCTF"},"cardDescription":{"type":"string","maxLength":256,"description":"The card description.","examples":"$80:props:data:schemas:44:schema:examples","x-gitbook-description-html":"

The card description.

","title":"cardDescription"},"cardArts":{"type":"object","properties":"$80:props:data:schemas:52:schema:properties:cardArts:properties","title":"cardArts"},"termsAndConditionsUrl":{"type":"string","maxLength":512,"description":"Card issuer terms and conditions URL.","examples":"$80:props:data:schemas:50:schema:examples","x-gitbook-description-html":"

Card issuer terms and conditions URL.

Card issuer privacy policy URL.

","title":"privacyPolicyUrl"}},"x-gitbook-description-html":"

Information about the card product.

","title":"cardProductPush"}},{"name":"cardProductMigration","schema":{"type":"object","description":"Information about the card product.","required":["cardType"],"properties":{"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name.","examples":"$80:props:data:schemas:40:schema:examples","x-gitbook-description-html":"

The card issuer name.

The card type.

","title":"cardType"},"scheme":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":"$80:props:data:schemas:47:schema:enum","examples":"$80:props:data:schemas:47:schema:examples","x-gitbook-description-html":"

The card primary scheme.

","title":"schemeMigration"},"cardDescription":{"type":"string","maxLength":256,"description":"The card description.","examples":"$80:props:data:schemas:44:schema:examples","x-gitbook-description-html":"

The card description.

Color used for the text displayed on the card (last digits, expiry date). Hexadecimal RGB color format.

HTTP location of the card image. If present, no other identifier is provided and getAsset operation is not needed.

"}},"title":"cardArtsMigration"}},"x-gitbook-description-html":"

Information about the card product.

","title":"cardProductMigration"}},{"name":"cardArtsMigration","schema":{"type":"object","properties":"$80:props:data:schemas:54:schema:properties:cardArts:properties","title":"cardArtsMigration"}},{"name":"cardArts","schema":{"type":"object","properties":"$80:props:data:schemas:52:schema:properties:cardArts:properties","title":"cardArts"}},{"name":"asset","schema":{"type":"object","required":["mediaType","encodedData"],"properties":{"mediaType":{"type":"string","maxLength":64,"description":"The media type of the asset.","enum":["application/pdf","image/pdf","image/png","image/jpeg","image/svg","text/plain","text/html"],"x-gitbook-description-html":"

The media type of the asset.

"},"encodedData":{"type":"string","description":"The asset encoded in base64.","x-gitbook-description-html":"

The asset encoded in base64.

"},"height":{"type":"string","maxLength":10,"description":"The asset height specified in pixels.","x-gitbook-description-html":"

The asset height specified in pixels.

"},"width":{"type":"string","maxLength":10,"description":"The asset width specified in pixels.","x-gitbook-description-html":"

The asset width specified in pixels.

"}},"title":"asset"}},{"name":"transactionId","schema":{"type":"string","description":"The unique transaction identifier.","minLength":1,"maxLength":128,"x-gitbook-description-html":"

The unique transaction identifier.

","title":"transactionId"}},{"name":"transactionType","schema":{"type":"string","maxLength":64,"description":"","enum":["SINGLE","SPLIT","RECURRING"],"examples":["SINGLE"],"title":"transactionType"}},{"name":"visaSignedPayload","schema":{"type":"string","description":"Required only for Visa CTF and Visa CTF with DAF. Set with the signature (JWT) generated by Thales ETP SDK.","minLength":1,"maxLength":4096,"x-gitbook-description-html":"

Required only for Visa CTF and Visa CTF with DAF. Set with the signature (JWT) generated by Thales ETP SDK.

","title":"visaSignedPayload"}},{"name":"visaSignedPayloadTrxV2","schema":{"type":"string","description":"Set with the signature (JWT) generated by Thales ETP SDK.","minLength":1,"maxLength":4096,"x-gitbook-description-html":"

Set with the signature (JWT) generated by Thales ETP SDK.

","title":"visaSignedPayloadTrxV2"}},{"name":"amount","schema":{"type":"string","description":"Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.","minLength":1,"maxLength":13,"pattern":"^(([1-9]{1}(\\d+)?)(\\.\\d+)?)|^([0]\\.(\\d+)?([1-9]{1})(\\d+)?)$","examples":["15.55"],"x-gitbook-description-html":"

Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.

","title":"amount"}},{"name":"currencyCode","schema":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters.","examples":["EUR"],"x-gitbook-description-html":"

ISO 4217 alphabetic currency code on 3 characters.

","title":"currencyCode"}},{"name":"transactionData","schema":{"type":"object","description":"Required only for Visa DAF. When transactionData is present, both amount and currencyCode must be specified.","required":["amount","currencyCode"],"properties":{"amount":{"type":"string","description":"Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.","minLength":1,"maxLength":13,"pattern":"^(([1-9]{1}(\\d+)?)(\\.\\d+)?)|^([0]\\.(\\d+)?([1-9]{1})(\\d+)?)$","examples":"$80:props:data:schemas:62:schema:examples","x-gitbook-description-html":"

Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.

","title":"amount"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters.","examples":["EUR"],"x-gitbook-description-html":"

ISO 4217 alphabetic currency code on 3 characters.

"}},"x-gitbook-description-html":"

Required only for Visa DAF. When transactionData is present, both amount and currencyCode must be specified.

","title":"transactionData"}},{"name":"transactionDataSrci","schema":{"type":"object","description":"Transaction data for Click to pay.","required":["amount","currencyCode"],"properties":{"amount":{"type":"string","description":"Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.","minLength":1,"maxLength":13,"pattern":"^(([1-9]{1}(\\d+)?)(\\.\\d+)?)|^([0]\\.(\\d+)?([1-9]{1})(\\d+)?)$","examples":"$80:props:data:schemas:62:schema:examples","x-gitbook-description-html":"

Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.

","title":"amount"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters.","examples":"$80:props:data:schemas:63:schema:examples","x-gitbook-description-html":"

ISO 4217 alphabetic currency code on 3 characters.

","title":"currencyCode"}},"x-gitbook-description-html":"

Transaction data for Click to pay.

","title":"transactionDataSrci"}},{"name":"confirmationData","schema":{"type":"object","description":"Confirmation data for transaction","required":["eventType","eventStatus","status","timestamp","networkTransactionIdentifier"],"properties":{"eventType":{"type":"string","description":"Event type associated with the update.","maxLength":12,"enum":["AUTHORISE","CAPTURE","REFUND","CANCEL","FRAUD","CHARGEBACK","OTHER"],"examples":["CAPTURE"],"x-gitbook-description-html":"

Event type associated with the update.

"},"eventStatus":{"type":"string","description":"Event type associated with the order.","maxLength":20,"enum":["CREATED","CONFIRMED","CANCELLED","FRAUD_CANCELLED","OTHERS"],"examples":["CONFIRMED"],"x-gitbook-description-html":"

Event type associated with the order.

"},"status":{"type":"string","description":"Status of the event as provided by the SRC Initiator in the Confirmation message.","maxLength":10,"enum":["SUCCESS","FAILURE","OTHER"],"examples":["SUCCESS"],"x-gitbook-description-html":"

Status of the event as provided by the SRC Initiator in the Confirmation message.

"},"reason":{"type":"string","description":"Description of the reason for the event associated with the order.","maxLength":64,"examples":["Order Successfully Created"],"x-gitbook-description-html":"

Description of the reason for the event associated with the order.

"},"timestamp":{"type":"string","minLength":1,"maxLength":64,"description":"Merchant confirmation timestamp when the transaction was completed, compliant with ISO 8601.","examples":["2025-11-10T09:08:24.479Z"],"x-gitbook-description-html":"

Merchant confirmation timestamp when the transaction was completed, compliant with ISO 8601.

","title":"confirmationTimestamp"},"networkAuthorizationCode":{"type":"string","description":"Authorisation code associated with an approved transaction.","maxLength":25,"examples":["2020404"],"x-gitbook-description-html":"

Authorisation code associated with an approved transaction.

"},"networkTransactionIdentifier":{"type":"string","description":"Unique authorisation related tracing value assigned by a Payment Network and provided in an authorisation response.","minLength":1,"maxLength":25,"examples":["mastercard"],"x-gitbook-description-html":"

Unique authorisation related tracing value assigned by a Payment Network and provided in an authorisation response.

"}},"x-gitbook-description-html":"

Confirmation data for transaction

","title":"confirmationData"}},{"name":"encryptedPaymentCredentials","schema":{"type":"string","maxLength":8196,"description":"The payment credentials data encrypted in a JWE structure (see security section in the documentation).\n\nOnce decrypted, the JWE plaintext contains the following JSON object:\n\n|JSON field parameter name|description|MOC|Length|\n|-------|-------|-------|-------|\n|dpan|The token PAN value provided for network token.|C|Up to 19|\n|exp|The token expiry date in the format MMYY provided for network token.|C|4|\n|cryptogram|The payment cryptogram to use with the token for a payment. Presence of the cryptogram depends on the transaction type and the scheme.|C|Up to 256|\n|fpan|The funding card PAN value. Only provided for PCI token.|C|Up to 19|\n|fpanExp|The funding card expiry date in the format MMYY. Only provided for PCI token.|C|4|\n\nExample: {\"dpan:\"9580981500100002\", \"exp\":\"1222\", \"cryptogram\": \"45f8grzty7f4f5gs5s2c\"}","x-gitbook-description-html":"$89","title":"encryptedPaymentCredentials"}},{"name":"cryptogramExpiryDate","schema":{"type":"string","maxLength":64,"description":"Cryptogram expiry date in ISO 8601. Provided for Visa only.","examples":["2021-09-27T17:06:09.000Z"],"x-gitbook-description-html":"

Cryptogram expiry date in ISO 8601. Provided for Visa only.

","title":"cryptogramExpiryDate"}},{"name":"eci","schema":{"type":"string","minLength":2,"maxLength":2,"description":"The Electronic Commerce Indicator. Payment System-specific value to indicate the results of the attempt to authenticate the cardholder. Provided only for Visa & Mastercard SCOF.","examples":["07"],"x-gitbook-description-html":"

The Electronic Commerce Indicator. Payment System-specific value to indicate the results of the attempt to authenticate the cardholder. Provided only for Visa & Mastercard SCOF.

","title":"eci"}},{"name":"isDAF","schema":{"type":"boolean","description":"If present and set to 'true', VISA confirms it is a Digital Authentication Framework transaction. \nCan be present only if the transaction type is 'VISA_DAF'.","examples":[true],"x-gitbook-description-html":"

If present and set to 'true', VISA confirms it is a Digital Authentication Framework transaction.\nCan be present only if the transaction type is 'VISA_DAF'.

","title":"isDAF"}},{"name":"par","schema":{"type":"string","maxLength":29,"description":"Payment Account Reference returned by the Scheme TSP.","examples":["5001a9f027e5629d11e3949a0800a"],"x-gitbook-description-html":"

Payment Account Reference returned by the Scheme TSP.

","title":"par"}},{"name":"tokenState","schema":{"type":"string","maxLength":64,"description":"Token state.
PCI token state can only be 'ACTIVE' or 'DELETED'.","enum":["ACTIVE","SUSPENDED","DELETED","PENDING"],"examples":["ACTIVE"],"x-gitbook-description-html":"

Token state.
PCI token state can only be 'ACTIVE' or 'DELETED'.

","title":"tokenState"}},{"name":"migratedTokenState","schema":{"type":"string","maxLength":64,"description":"Token state.","enum":["ACTIVE","SUSPENDED","PENDING"],"examples":["ACTIVE"],"x-gitbook-description-html":"

Token state.

","title":"migratedTokenState"}},{"name":"returnUriType","schema":{"type":"string","maxLength":32,"description":"Issuer application/website URI type depending on the device. This parameter could be returned only for VISA.","enum":["ANDROID","IOS","WEB"],"examples":["WEB"],"x-gitbook-description-html":"

Issuer application/website URI type depending on the device. This parameter could be returned only for VISA.

","title":"returnUriType"}},{"name":"returnUri","schema":{"type":"string","maxLength":512,"description":"Issuer application/website URI. This parameter could be returned only for VISA.","examples":["https://bank.com/pushprovisioning.html"],"x-gitbook-description-html":"

Issuer application/website URI. This parameter could be returned only for VISA.

","title":"returnUri"}},{"name":"merchantName","schema":{"type":"string","description":"An unique merchant name that is end user friendly.","minLength":1,"maxLength":60,"pattern":"^[A-Za-z0-9-_. ]+$","examples":["My Merchant"],"x-gitbook-description-html":"

An unique merchant name that is end user friendly.

","title":"merchantName"}},{"name":"supportedCardType","schema":{"type":"string","maxLength":6,"description":"Indication about the card type supported by the merchant.","enum":["DEBIT","CREDIT","BOTH"],"examples":["CREDIT"],"x-gitbook-description-html":"

Indication about the card type supported by the merchant.

","title":"supportedCardType"}},{"name":"dunsNumber","schema":{"type":"string","minLength":9,"maxLength":9,"description":"Dun and Bradestreet number.","examples":["568918742"],"x-gitbook-description-html":"

Dun and Bradestreet number.

","title":"dunsNumber"}},{"name":"tokenRequestorServiceTypes","schema":{"type":"array","description":"The list of token requestor service types.","maxItems":2,"minItems":1,"items":{"type":"string","maxLength":20,"enum":["PURCHASE","VISA_DIRECT"]},"uniqueItems":true,"examples":[["PURCHASE","VISA_DIRECT"]],"x-gitbook-description-html":"

The list of token requestor service types.

","title":"tokenRequestorServiceTypes"}},{"name":"merchantLegalName","schema":{"type":"string","minLength":1,"maxLength":60,"description":"Legal name of the merchant.","pattern":"^[A-Za-z0-9-_. ]+$","x-gitbook-description-html":"

Legal name of the merchant.

","title":"merchantLegalName"}},{"name":"websiteUrl","schema":{"type":"string","minLength":1,"maxLength":100,"description":"Merchant website URL.","pattern":"^[A-Za-z0-9-_.:/]+$","examples":["http://www.mymerchant.com"],"x-gitbook-description-html":"

Merchant website URL.

","title":"websiteUrl"}},{"name":"primaryContactEmail","schema":{"type":"string","minLength":1,"maxLength":100,"description":"Email address of the merchant primary contact.","pattern":"^[A-Za-z0-9-_.@]+$","examples":["jsmith@mymerchant.com"],"x-gitbook-description-html":"

Email address of the merchant primary contact.

","title":"primaryContactEmail"}},{"name":"merchantCity","schema":{"type":"string","minLength":1,"maxLength":100,"description":"City of the merchant address.","pattern":"^[A-Za-z0-9-_. ]+$","examples":["San Francisco"],"x-gitbook-description-html":"

City of the merchant address.

","title":"merchantCity"}},{"name":"merchantCountry","schema":{"type":"string","minLength":2,"maxLength":2,"description":"Merchant country in ISO-3166-1 alpha-2 two-letter country code.","examples":["US"],"x-gitbook-description-html":"

Merchant country in ISO-3166-1 alpha-2 two-letter country code.

","title":"merchantCountry"}},{"name":"allowCardUpdateNotification","schema":{"type":"boolean","description":"Visa charges to the acquirers the update of the token when a card is renewed. The acquirers may reflect the service fees to the customer. allowCardUpdateNotification = true enables the service.
\nWhen allowCardUpdateNotification = false the token is no more valid after the card renewal. No Token Update notification is sent.","title":"allowCardUpdateNotification","examples":[true],"x-gitbook-description-html":"

Visa charges to the acquirers the update of the token when a card is renewed. The acquirers may reflect the service fees to the customer. allowCardUpdateNotification = true enables the service.
\nWhen allowCardUpdateNotification = false the token is no more valid after the card renewal. No Token Update notification is sent.

"}},{"name":"businessIdentificationType","schema":{"type":"string","maxLength":12,"description":"$8a","enum":["ABN","ACN","BID","BIN","BIR","BN","BRN","BRNO","CL","CLN","CORPORATE_NUMBER","CNPJ","CR","CUIT","EDRPOU","EIN","HKBR","INI","NATIONAL_ID","NIB","NID","NZBN","PAN","RFC","RNC","RUC","RUT","SIN","SSN","TC","UEN","USCI","VAT"],"examples":["BID"],"x-gitbook-description-html":"$8b","title":"businessIdentificationType"}},{"name":"businessIdentificationValue","schema":{"type":"string","minLength":1,"maxLength":32,"description":"One of the below configuration must be provided:
- businessIdentificationType and businessIdentificationValue or
- acquirerId and acquirerMerchantId.

The format of merchant business identification value depends on the business identification type.","examples":["12345678"],"x-gitbook-description-html":"

One of the below configuration must be provided:
- businessIdentificationType and businessIdentificationValue or
- acquirerId and acquirerMerchantId.

The format of merchant business identification value depends on the business identification type.

","title":"businessIdentificationValue"}},{"name":"acquirerId","schema":{"type":"string","pattern":"^([0-9]*$)","description":"One of the below configuration must be provided:
- businessIdentificationType and businessIdentificationValue or
- acquirerId and acquirerMerchantId.

Numeric acquirer identifier.","minLength":1,"maxLength":11,"x-gitbook-description-html":"

One of the below configuration must be provided:
- businessIdentificationType and businessIdentificationValue or
- acquirerId and acquirerMerchantId.

Numeric acquirer identifier.

","title":"acquirerId"}},{"name":"acquirerIdMastercard","schema":{"type":"string","pattern":"^([0-9a-zA-Z]*$)","description":"Acquiring institution identification code","minLength":1,"maxLength":11,"x-gitbook-description-html":"

Acquiring institution identification code

","title":"acquirerIdMastercard"}},{"name":"locale","schema":{"type":"string","description":"Locale identifier following BCP 47 (e.g., en-US, es-MX)","minLength":1,"maxLength":10,"examples":["en-US"],"x-gitbook-description-html":"

Locale identifier following BCP 47 (e.g., en-US, es-MX)

","title":"locale"}},{"name":"acquirerMerchantId","schema":{"type":"string","description":"One of the below configuration must be provided:
- businessIdentificationType and businessIdentificationValue or
- acquirerId and acquirerMerchantId.

Acquirer merchant identifier.","minLength":1,"maxLength":25,"x-gitbook-description-html":"

One of the below configuration must be provided:
- businessIdentificationType and businessIdentificationValue or
- acquirerId and acquirerMerchantId.

Acquirer merchant identifier.

","title":"acquirerMerchantId"}},{"name":"firstAuthenticationFactor","schema":{"type":"string","description":"First factor used to authenticate the card holder.","enum":["LOGIN_PASSWORD","DEVICE_UNLOCK","OTP_SMS","OTP_EMAIL","FIDO_BIOMETRIC","FIDO_PASSCODE","FIDO_NO_AUTH","VISA_CTF_BINDING"],"x-gitbook-description-html":"

First factor used to authenticate the card holder.

","title":"firstAuthenticationFactor"}},{"name":"secondAuthenticationFactor","schema":{"type":"string","description":"Second factor used to authenticate the card holder as specified by Visa.","enum":["LOGIN_PASSWORD","DEVICE_UNLOCK","OTP_SMS","OTP_EMAIL","FIDO_BIOMETRIC","FIDO_PASSCODE","FIDO_NO_AUTH","VISA_CTF_BINDING"],"x-gitbook-description-html":"

Second factor used to authenticate the card holder as specified by Visa.

","title":"secondAuthenticationFactor"}},{"name":"authenticationTransaction","schema":{"type":"object","description":"Required only for Visa DAF.","required":["firstFactor"],"properties":{"firstFactor":{"type":"string","description":"First factor used to authenticate the card holder.","enum":"$80:props:data:schemas:92:schema:enum","x-gitbook-description-html":"

First factor used to authenticate the card holder.

","title":"firstAuthenticationFactor"},"secondFactor":{"type":"string","description":"Second factor used to authenticate the card holder as specified by Visa.","enum":"$80:props:data:schemas:93:schema:enum","x-gitbook-description-html":"

Second factor used to authenticate the card holder as specified by Visa.

","title":"secondAuthenticationFactor"}},"x-gitbook-description-html":"

Required only for Visa DAF.

","title":"authenticationTransaction"}},{"name":"creationTimestamp","schema":{"type":"string","maxLength":64,"description":"Token creation timestamp compliant with ISO 8601.","examples":["2025-11-10T09:08:24.479Z"],"x-gitbook-description-html":"

Token creation timestamp compliant with ISO 8601.

","title":"creationTimestamp"}},{"name":"lastUpdateTimestamp","schema":{"type":"string","maxLength":64,"description":"Token last update timestamp compliant with ISO 8601. Provided only in case the token was updated after its creation.","examples":["2025-11-13T11:012:41.165Z"],"x-gitbook-description-html":"

Token last update timestamp compliant with ISO 8601. Provided only in case the token was updated after its creation.

","title":"lastUpdateTimestamp"}},{"name":"timestamp","schema":{"type":"string","minLength":1,"maxLength":64,"description":"A timestamp compliant with ISO 8601.","examples":["2025-08-01T09:12:09.128Z"],"x-gitbook-description-html":"

A timestamp compliant with ISO 8601.

","title":"timestamp"}},{"name":"supportedCardBrands","schema":{"type":"array","description":"Card networks that are supported for DPA registration.","maxItems":4,"minItems":1,"items":{"type":"string","maxLength":20,"enum":["MASTERCARD","VISA","DISCOVER","AMEX"]},"examples":[["MASTERCARD","VISA","DISCOVER","AMEX"]],"x-gitbook-description-html":"

Card networks that are supported for DPA registration.

","title":"supportedCardBrands"}},{"name":"confirmationTimestamp","schema":{"type":"string","minLength":1,"maxLength":64,"description":"Merchant confirmation timestamp when the transaction was completed, compliant with ISO 8601.","examples":"$80:props:data:schemas:66:schema:properties:timestamp:examples","x-gitbook-description-html":"

Merchant confirmation timestamp when the transaction was completed, compliant with ISO 8601.

","title":"confirmationTimestamp"}},{"name":"errorDetails","schema":{"type":"string","maxLength":256,"description":"Additional information about the error. This optional parameter has no specific format as it depends on the different TSP API. It is sent for logging and troubleshooting purpose.","x-gitbook-description-html":"

Additional information about the error. This optional parameter has no specific format as it depends on the different TSP API. It is sent for logging and troubleshooting purpose.

","title":"errorDetails"}},{"name":"schemeCorrelationId","schema":{"type":"string","maxLength":128,"description":"Identifier used by the schemes for additional support.","x-gitbook-description-html":"

Identifier used by the schemes for additional support.

","title":"schemeCorrelationId"}},{"name":"mcServiceId","schema":{"type":"string","maxLength":256,"description":"Reserved for future use.
A unique identifier assigned by Mastercard for which tokens are created uniquely for the entity onboarded.","x-gitbook-description-html":"

Reserved for future use.
A unique identifier assigned by Mastercard for which tokens are created uniquely for the entity onboarded.

","title":"mcServiceId"}},{"name":"merchantCategory","schema":{"type":"string","minLength":1,"maxLength":256,"description":"Required only for Payment Facilitator model. Can define a type of merchants group. merchantCategory value is forwarded to the issuers. Thales recommends to set it to the generic value 'payfac'. ","x-gitbook-description-html":"

Required only for Payment Facilitator model. Can define a type of merchants group. merchantCategory value is forwarded to the issuers. Thales recommends to set it to the generic value 'payfac'.

","title":"merchantCategory"}},{"name":"transactionTypeV2","schema":{"type":"string","maxLength":64,"description":"The request content depends on the transaction type.","enum":["EMV_TOKEN","PCI_TOKEN","VISA_DAF","MASTERCARD_TAF_IAAV","MASTERCARD_TAF_FIDO","MASTERCARD_THALES_AUTHENTICATOR"],"examples":["EMV_TOKEN"],"x-gitbook-description-html":"

The request content depends on the transaction type.

","title":"transactionTypeV2"}},{"name":"isRecurring","schema":{"type":"boolean","description":"Indicate if the payment is recurring (like a monthly subscription)","examples":[false],"x-gitbook-description-html":"

Indicate if the payment is recurring (like a monthly subscription)

","title":"isRecurring"}},{"name":"bindingType","schema":{"type":"string","maxLength":64,"description":"The request content depends on the binding type.","enum":["MASTERCARD_TAF_FIDO_IAAV"],"examples":["MASTERCARD_TAF_FIDO_IAAV"],"x-gitbook-description-html":"

The request content depends on the binding type.

","title":"bindingType"}},{"name":"mcCertifiedSolutionId","schema":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of the Mastercard TAF certified MFA method.","examples":["43SA5"],"x-gitbook-description-html":"

Unique identifier of the Mastercard TAF certified MFA method.

","title":"mcCertifiedSolutionId"}},{"name":"credentialId","schema":{"type":"string","minLength":1,"maxLength":128,"description":"UUID identifying the FIDO authenticator.","examples":["bf8c5b2b-28ce-48d8-acbc-cc82f51478c6"],"x-gitbook-description-html":"

UUID identifying the FIDO authenticator.

","title":"credentialId"}},{"name":"fidoRelyingParty","schema":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO relying party.","examples":["relyingparty.com"],"x-gitbook-description-html":"

The FIDO relying party.

","title":"fidoRelyingParty"}},{"name":"fidoUserId","schema":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO user identifier.","examples":["ca7ac6fe-1eec-11ed-861d-0242ac120002"],"x-gitbook-description-html":"

The FIDO user identifier.

","title":"fidoUserId"}},{"name":"isSpcEnabled","schema":{"type":"boolean","description":"Indicates if Secure Payment Confirmation is enabled.","examples":[false],"x-gitbook-description-html":"

Indicates if Secure Payment Confirmation is enabled.

","title":"isSpcEnabled"}},{"name":"fidoAuthenticationResponse","schema":{"type":"object","description":"A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO assertion.\n
Required if fidoRegistrationResponse is not provided.

\nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"SZY...In0\",
\n\"authenticatorData\": \"o2Nm...AAA\",
\n\"signature\": \"MEU...VQQ\",
\n\"userHandle\": \"ca7...002\"\n\"transports\": [
\n \"internal\"
\n ]
\n},
\n\"clientExtensionResults\": {}
\n}
","x-gitbook-description-html":"

A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO assertion.\n
Required if fidoRegistrationResponse is not provided.

\nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"SZY...In0\",
\n\"authenticatorData\": \"o2Nm...AAA\",
\n\"signature\": \"MEU...VQQ\",
\n\"userHandle\": \"ca7...002\"\n\"transports\": [
\n\"internal\"
\n]
\n},
\n\"clientExtensionResults\": {}
\n}

","title":"fidoAuthenticationResponse"}},{"name":"fidoRegistrationResponse","schema":{"type":"object","description":"A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO attestation.\n
Required if fidoAuthenticationResponse is not provided \nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"eyJ0...In0\",
\n\"attestationObject\": \"o2Nm...0inQ\",
\n\"transports\": [
\n \"internal\"
\n ]
\n},
\n\"clientExtensionResults\": {}
\n}
","x-gitbook-description-html":"

A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO attestation.\n
Required if fidoAuthenticationResponse is not provided\nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"eyJ0...In0\",
\n\"attestationObject\": \"o2Nm...0inQ\",
\n\"transports\": [
\n\"internal\"
\n]
\n},
\n\"clientExtensionResults\": {}
\n}

","title":"fidoRegistrationResponse"}},{"name":"fidoPublicKeyCredential","schema":{"type":"object","description":"A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO assertion.

\nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"SZY...In0\",
\n\"authenticatorData\": \"o2Nm...AAA\",
\n\"signature\": \"MEU...VQQ\",
\n\"userHandle\": \"ca7...002\"\n\"transports\": [
\n \"internal\"
\n ]
\n},
\n\"clientExtensionResults\": {}
\n}
","x-gitbook-description-html":"

A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO assertion.

\nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"SZY...In0\",
\n\"authenticatorData\": \"o2Nm...AAA\",
\n\"signature\": \"MEU...VQQ\",
\n\"userHandle\": \"ca7...002\"\n\"transports\": [
\n\"internal\"
\n]
\n},
\n\"clientExtensionResults\": {}
\n}

","title":"fidoPublicKeyCredential"}},{"name":"mcTransactionAssertion","schema":{"type":"string","minLength":1,"maxLength":8196,"description":"The transaction assertion JWT as per Mastercard specifications.","examples":["Mastercard assertionJWT"],"x-gitbook-description-html":"

The transaction assertion JWT as per Mastercard specifications.

","title":"mcTransactionAssertion"}},{"name":"mcBindingAssertion","schema":{"type":"string","minLength":1,"maxLength":8196,"description":"The binding assertion JWT as per Mastercard specifications.","examples":["Mastercard bindingAssertionJWT"],"x-gitbook-description-html":"

The binding assertion JWT as per Mastercard specifications.

","title":"mcBindingAssertion"}},{"name":"merchantCategoryCode","schema":{"type":"string","minLength":1,"maxLength":4,"description":"The merchant category code.","examples":["1234"],"x-gitbook-description-html":"

The merchant category code.

","title":"merchantCategoryCode"}},{"name":"mcIaav","schema":{"type":"string","minLength":1,"maxLength":8196,"description":"The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64.","examples":["Base64-encoded-string"],"x-gitbook-description-html":"

The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64.

","title":"mcIaav"}},{"name":"mcIaavTransactionId","schema":{"type":"string","minLength":1,"maxLength":128,"description":"The transaction identifier as present in the issuer IAAV.","examples":["abd3babb-f6af-424d-81f6-499a313479c5"],"x-gitbook-description-html":"

The transaction identifier as present in the issuer IAAV.

","title":"mcIaavTransactionId"}},{"name":"EMV_TOKEN","schema":{"type":"object","description":"List the parameters that are accepted to get a cryptogram for a transaction with the token.","required":["isRecurring"],"properties":{"isRecurring":{"type":"boolean","description":"Indicate if the payment is recurring (like a monthly subscription)","examples":"$80:props:data:schemas:105:schema:examples","x-gitbook-description-html":"

Indicate if the payment is recurring (like a monthly subscription)

","title":"isRecurring"},"amount":{"type":"string","description":"Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the currency code.\n
If amount is defined, currencyCode must be present also.","minLength":1,"maxLength":13,"pattern":"^(([1-9]{1}(\\d+)?)(\\.\\d+)?)|^([0]\\.(\\d+)?([1-9]{1})(\\d+)?)$","examples":["15.55"],"x-gitbook-description-html":"

Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the currency code.\n
If amount is defined, currencyCode must be present also.

"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters.\nIf currencyCode is defined, amount must be present also.","examples":["EUR"],"x-gitbook-description-html":"

ISO 4217 alphabetic currency code on 3 characters.\nIf currencyCode is defined, amount must be present also.

"}},"x-gitbook-description-html":"

List the parameters that are accepted to get a cryptogram for a transaction with the token.

","title":"EMV_TOKEN"}},{"name":"VISA_DAF","schema":{"type":"object","description":"List the parameters that are required to get a Visa DAF compliant cryptogram.","required":["firstFactor","visaSignedPayload","amount","currencyCode","ipAddress","email"],"properties":{"firstFactor":{"type":"string","description":"First factor used to authenticate the card holder.","enum":"$80:props:data:schemas:92:schema:enum","x-gitbook-description-html":"

First factor used to authenticate the card holder.

Second factor used to authenticate the card holder as specified by Visa.

","title":"secondAuthenticationFactor"},"visaSignedPayload":{"type":"string","description":"Set with the signature (JWT) generated by Thales ETP SDK.","minLength":1,"maxLength":4096,"x-gitbook-description-html":"

Set with the signature (JWT) generated by Thales ETP SDK.

","title":"visaSignedPayloadTrxV2"},"amount":{"type":"string","description":"Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.","minLength":1,"maxLength":13,"pattern":"^(([1-9]{1}(\\d+)?)(\\.\\d+)?)|^([0]\\.(\\d+)?([1-9]{1})(\\d+)?)$","examples":"$80:props:data:schemas:62:schema:examples","x-gitbook-description-html":"

Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.

ISO 4217 alphabetic currency code on 3 characters.

","title":"currencyCode"},"ipAddress":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4.","examples":"$80:props:data:schemas:14:schema:examples","x-gitbook-description-html":"

The card holder's device IP address in format IPv4.

The card holder's device location.
\n
Format requirements:

Latitude is between -90 and 90 degrees.
Longitude is between -180 and 180 degrees.
For positive value, the sign '+' shall not be provided.
Values are provided in decimal degrees with a precision of 4 decimal places.
Latitude and longitude are separated by a comma.
Spaces are not allowed.

Examples:

'47.0880,2.3635'
'51.5306,-133.7224'
'-10.0000,-111.0000'

","title":"location"},"email":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address.","examples":"$80:props:data:schemas:19:schema:examples","x-gitbook-description-html":"

Card holder email address.

","title":"cardholderEmail"},"billingAddress":{"type":"object","description":"Card holder billing address.","required":"$80:props:data:schemas:25:schema:required","properties":"$80:props:data:schemas:25:schema:properties","x-gitbook-description-html":"

Card holder billing address.

","title":"cardholderAddress"}},"x-gitbook-description-html":"

List the parameters that are required to get a Visa DAF compliant cryptogram.

","title":"VISA_DAF"}},{"name":"MASTERCARD_TAF_FIDO","schema":{"type":"object","description":"List the parameters that are required to get a Mastercard TAF compliant cryptogram for a token bound to a FIDO authenticator. All cardholder related parameters must be provided if they are collected according to compliance with applicable laws and local regulation.","required":["amount","currencyCode","merchantCategoryCode","merchantCountry","deviceId","mcCertifiedSolutionId","credentialId","fidoRelyingParty","fidoUserId","isSpcEnabled","fidoAuthenticationResponse","mcTransactionAssertion"],"properties":{"amount":{"type":"string","description":"Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.","minLength":1,"maxLength":13,"pattern":"^(([1-9]{1}(\\d+)?)(\\.\\d+)?)|^([0]\\.(\\d+)?([1-9]{1})(\\d+)?)$","examples":"$80:props:data:schemas:62:schema:examples","x-gitbook-description-html":"

Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.

ISO 4217 alphabetic currency code on 3 characters.

","title":"currencyCode"},"deviceId":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":36,"examples":"$80:props:data:schemas:34:schema:examples","x-gitbook-description-html":"

The unique device identifier.

","title":"deviceIdMdes"},"ipAddress":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4.","examples":"$80:props:data:schemas:14:schema:examples","x-gitbook-description-html":"

The card holder's device IP address in format IPv4.

The card holder's device location.
\n
Format requirements:

Latitude is between -90 and 90 degrees.
Longitude is between -180 and 180 degrees.
For positive value, the sign '+' shall not be provided.
Values are provided in decimal degrees with a precision of 4 decimal places.
Latitude and longitude are separated by a comma.
Spaces are not allowed.

Examples:

'47.0880,2.3635'
'51.5306,-133.7224'
'-10.0000,-111.0000'

","title":"location"},"mcCertifiedSolutionId":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of the Mastercard TAF certified MFA method.","examples":"$80:props:data:schemas:107:schema:examples","x-gitbook-description-html":"

Unique identifier of the Mastercard TAF certified MFA method.

","title":"mcCertifiedSolutionId"},"credentialId":{"type":"string","minLength":1,"maxLength":128,"description":"UUID identifying the FIDO authenticator.","examples":"$80:props:data:schemas:108:schema:examples","x-gitbook-description-html":"

UUID identifying the FIDO authenticator.

","title":"credentialId"},"fidoRelyingParty":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO relying party.","examples":"$80:props:data:schemas:109:schema:examples","x-gitbook-description-html":"

The FIDO relying party.

","title":"fidoRelyingParty"},"fidoUserId":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO user identifier.","examples":"$80:props:data:schemas:110:schema:examples","x-gitbook-description-html":"

The FIDO user identifier.

","title":"fidoUserId"},"isSpcEnabled":{"type":"boolean","description":"Indicates if Secure Payment Confirmation is enabled.","examples":"$80:props:data:schemas:111:schema:examples","x-gitbook-description-html":"

Indicates if Secure Payment Confirmation is enabled.

","title":"isSpcEnabled"},"fidoAuthenticationResponse":{"type":"object","description":"A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO assertion.

\nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"SZY...In0\",
\n\"authenticatorData\": \"o2Nm...AAA\",
\n\"signature\": \"MEU...VQQ\",
\n\"userHandle\": \"ca7...002\"\n\"transports\": [
\n \"internal\"
\n ]
\n},
\n\"clientExtensionResults\": {}
\n}
","x-gitbook-description-html":"

","title":"fidoPublicKeyCredential"},"mcTransactionAssertion":{"type":"string","minLength":1,"maxLength":8196,"description":"The transaction assertion JWT as per Mastercard specifications.","examples":"$80:props:data:schemas:115:schema:examples","x-gitbook-description-html":"

The transaction assertion JWT as per Mastercard specifications.

","title":"mcTransactionAssertion"},"email":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address.","examples":"$80:props:data:schemas:19:schema:examples","x-gitbook-description-html":"

Card holder email address.

","title":"cardholderEmail"},"billingAddress":{"type":"object","description":"Card holder billing address.","required":"$80:props:data:schemas:27:schema:required","properties":"$80:props:data:schemas:27:schema:properties","x-gitbook-description-html":"

Card holder billing address.

","title":"cardholderAddressTAF"},"shippingAddress":{"type":"object","description":"Card holder billing address.","required":"$80:props:data:schemas:27:schema:required","properties":"$80:props:data:schemas:27:schema:properties","x-gitbook-description-html":"

Card holder billing address.

","title":"cardholderAddressTAF"},"merchantCategoryCode":{"type":"string","minLength":1,"maxLength":4,"description":"The merchant category code.","examples":"$80:props:data:schemas:117:schema:examples","x-gitbook-description-html":"

The merchant category code.

","title":"merchantCategoryCode"},"merchantCountry":{"type":"string","minLength":2,"maxLength":2,"description":"Merchant country in ISO-3166-1 alpha-2 two-letter country code.","examples":"$80:props:data:schemas:84:schema:examples","x-gitbook-description-html":"

Merchant country in ISO-3166-1 alpha-2 two-letter country code.

","title":"merchantCountry"}},"x-gitbook-description-html":"

List the parameters that are required to get a Mastercard TAF compliant cryptogram for a token bound to a FIDO authenticator. All cardholder related parameters must be provided if they are collected according to compliance with applicable laws and local regulation.

","title":"MASTERCARD_TAF_FIDO"}},{"name":"MASTERCARD_TAF_IAAV","schema":{"type":"object","description":"List the parameters that are required to get a Mastercard TAF compliant cryptogram from and issuer IAAV. All cardholder related parameters must be provided if they are collected according to compliance with applicable laws and local regulation.","required":["amount","currencyCode","mcIaav","mcIaavTransactionId","verificationTimestamp","merchantCategoryCode","merchantCountry"],"properties":{"amount":{"type":"string","description":"Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.","minLength":1,"maxLength":13,"pattern":"^(([1-9]{1}(\\d+)?)(\\.\\d+)?)|^([0]\\.(\\d+)?([1-9]{1})(\\d+)?)$","examples":"$80:props:data:schemas:62:schema:examples","x-gitbook-description-html":"

Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.

ISO 4217 alphabetic currency code on 3 characters.

The card holder's device IP address in format IPv4.

The card holder's device location.
\n
Format requirements:

Latitude is between -90 and 90 degrees.
Longitude is between -180 and 180 degrees.
For positive value, the sign '+' shall not be provided.
Values are provided in decimal degrees with a precision of 4 decimal places.
Latitude and longitude are separated by a comma.
Spaces are not allowed.

Examples:

'47.0880,2.3635'
'51.5306,-133.7224'
'-10.0000,-111.0000'

","title":"location"},"mcIaav":{"type":"string","minLength":1,"maxLength":8196,"description":"The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64.","examples":"$80:props:data:schemas:118:schema:examples","x-gitbook-description-html":"

The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64.

","title":"mcIaav"},"mcIaavTransactionId":{"type":"string","minLength":1,"maxLength":128,"description":"The transaction identifier as present in the issuer IAAV.","examples":"$80:props:data:schemas:119:schema:examples","x-gitbook-description-html":"

The transaction identifier as present in the issuer IAAV.

","title":"mcIaavTransactionId"},"verificationTimestamp":{"type":"string","minLength":1,"maxLength":64,"description":"A timestamp compliant with ISO 8601.","examples":"$80:props:data:schemas:97:schema:examples","x-gitbook-description-html":"

A timestamp compliant with ISO 8601.

","title":"timestamp"},"email":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address.","examples":"$80:props:data:schemas:19:schema:examples","x-gitbook-description-html":"

Card holder email address.

Card holder billing address.

The merchant category code.

Merchant country in ISO-3166-1 alpha-2 two-letter country code.

","title":"merchantCountry"}},"x-gitbook-description-html":"

List the parameters that are required to get a Mastercard TAF compliant cryptogram from and issuer IAAV. All cardholder related parameters must be provided if they are collected according to compliance with applicable laws and local regulation.

","title":"MASTERCARD_TAF_IAAV"}},{"name":"BINDING_MASTERCARD_TAF_FIDO_IAAV","schema":{"type":"object","description":"List the parameters that are required to bind a token with a FIDO authenticator as per Mastercard TAF.\n\nAt least one 'fidoAuthenticationResponse' or 'fidoRegistrationResponse' must be provided in the request.\n","required":["mcCertifiedSolutionId","credentialId","deviceId","fidoRelyingParty","fidoUserId","isSpcEnabled","mcIaav","verificationTimestamp","mcBindingAssertion"],"properties":{"mcCertifiedSolutionId":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of the Mastercard TAF certified MFA method.","examples":"$80:props:data:schemas:107:schema:examples","x-gitbook-description-html":"

Unique identifier of the Mastercard TAF certified MFA method.

UUID identifying the FIDO authenticator.

","title":"credentialId"},"deviceId":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":36,"examples":"$80:props:data:schemas:34:schema:examples","x-gitbook-description-html":"

The unique device identifier.

","title":"deviceIdMdes"},"fidoRelyingParty":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO relying party.","examples":"$80:props:data:schemas:109:schema:examples","x-gitbook-description-html":"

The FIDO relying party.

The FIDO user identifier.

Indicates if Secure Payment Confirmation is enabled.

","title":"isSpcEnabled"},"fidoAuthenticationResponse":{"type":"object","description":"A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO assertion.\n
Required if fidoRegistrationResponse is not provided.

\nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"SZY...In0\",
\n\"authenticatorData\": \"o2Nm...AAA\",
\n\"signature\": \"MEU...VQQ\",
\n\"userHandle\": \"ca7...002\"\n\"transports\": [
\n \"internal\"
\n ]
\n},
\n\"clientExtensionResults\": {}
\n}
","x-gitbook-description-html":"

","title":"fidoAuthenticationResponse"},"fidoRegistrationResponse":{"type":"object","description":"A JSON FIDO public key as per https://www.w3.org/TR/webauthn-3/#iface-pkcredential.\n
Also known as FIDO attestation.\n
Required if fidoAuthenticationResponse is not provided \nExample:\n
{
\n\"type\": \"public-key\",
\n\"id\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"rawId\": \"h0mC9xtLjggpcvxq4YXepkemUt2oNL5F_-NPpCCcHNE\",
\n\"authenticatorAttachment\": \"platform\",
\n\"response\": {
\n\"clientDataJSON\": \"eyJ0...In0\",
\n\"attestationObject\": \"o2Nm...0inQ\",
\n\"transports\": [
\n \"internal\"
\n ]
\n},
\n\"clientExtensionResults\": {}
\n}
","x-gitbook-description-html":"

","title":"fidoRegistrationResponse"},"mcIaav":{"type":"string","minLength":1,"maxLength":8196,"description":"The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64.","examples":"$80:props:data:schemas:118:schema:examples","x-gitbook-description-html":"

The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64.

","title":"mcIaav"},"verificationTimestamp":{"type":"string","minLength":1,"maxLength":64,"description":"A timestamp compliant with ISO 8601.","examples":"$80:props:data:schemas:97:schema:examples","x-gitbook-description-html":"

A timestamp compliant with ISO 8601.

","title":"timestamp"},"mcBindingAssertion":{"type":"string","minLength":1,"maxLength":8196,"description":"The binding assertion JWT as per Mastercard specifications.","examples":"$80:props:data:schemas:116:schema:examples","x-gitbook-description-html":"

The binding assertion JWT as per Mastercard specifications.

","title":"mcBindingAssertion"}},"x-gitbook-description-html":"

List the parameters that are required to bind a token with a FIDO authenticator as per Mastercard TAF.

At least one 'fidoAuthenticationResponse' or 'fidoRegistrationResponse' must be provided in the request.

","title":"BINDING_MASTERCARD_TAF_FIDO_IAAV"}},{"name":"MASTERCARD_THALES_AUTHENTICATOR","schema":{"type":"object","description":"List the parameters that are required to get a Mastercard TAF compliant cryptogram using their proprietary PKI as their MFA method. All cardholder related parameters must be provided if they are collected according to compliance with applicable laws and local regulation.","required":["amount","currencyCode","deviceId","tafAssertionPayload","merchantCategoryCode","merchantCountry"],"properties":{"amount":{"type":"string","description":"Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.","minLength":1,"maxLength":13,"pattern":"^(([1-9]{1}(\\d+)?)(\\.\\d+)?)|^([0]\\.(\\d+)?([1-9]{1})(\\d+)?)$","examples":"$80:props:data:schemas:62:schema:examples","x-gitbook-description-html":"

Transaction amount or maximum amount authorized. Shall be positive value. Digits after the '.' are required in accordance with the scheme and currency code.

ISO 4217 alphabetic currency code on 3 characters.

The unique device identifier.

","title":"deviceIdMdes"},"tafAssertionPayload":{"type":"string","minLength":1,"maxLength":10000,"description":"JSON assertion payload Base64 encoded, generated by Thales ETP SDK.","examples":["Base64 encoded Mastercard assertion payload"],"x-gitbook-description-html":"

JSON assertion payload Base64 encoded, generated by Thales ETP SDK.

"},"merchantCategoryCode":{"type":"string","minLength":1,"maxLength":4,"description":"The merchant category code.","examples":"$80:props:data:schemas:117:schema:examples","x-gitbook-description-html":"

The merchant category code.

Merchant country in ISO-3166-1 alpha-2 two-letter country code.

","title":"merchantCountry"},"email":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address.","examples":"$80:props:data:schemas:19:schema:examples","x-gitbook-description-html":"

Card holder email address.

","title":"cardholderEmail"},"location":{"type":"string","minLength":1,"maxLength":32,"description":"The card holder's device location.
\n
Format requirements:\n* Latitude is between -90 and 90 degrees.\n* Longitude is between -180 and 180 degrees.\n* For positive value, the sign '+' shall not be provided.\n* Values are provided in decimal degrees with a precision of 4 decimal places.\n* Latitude and longitude are separated by a comma.\n* Spaces are not allowed.\n\nExamples: \n* '47.0880,2.3635'\n* '51.5306,-133.7224'\n* '-10.0000,-111.0000'","examples":"$80:props:data:schemas:15:schema:examples","x-gitbook-description-html":"

The card holder's device location.
\n
Format requirements:

Latitude is between -90 and 90 degrees.
Longitude is between -180 and 180 degrees.
For positive value, the sign '+' shall not be provided.
Values are provided in decimal degrees with a precision of 4 decimal places.
Latitude and longitude are separated by a comma.
Spaces are not allowed.

Examples:

'47.0880,2.3635'
'51.5306,-133.7224'
'-10.0000,-111.0000'

","title":"location"},"ipAddress":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4.","examples":"$80:props:data:schemas:14:schema:examples","x-gitbook-description-html":"

The card holder's device IP address in format IPv4.

","title":"ipAddressSimpleDesc"},"billingAddress":{"type":"object","description":"Card holder billing address.","required":"$80:props:data:schemas:27:schema:required","properties":"$80:props:data:schemas:27:schema:properties","x-gitbook-description-html":"

Card holder billing address.

","title":"cardholderAddressTAF"}},"x-gitbook-description-html":"

List the parameters that are required to get a Mastercard TAF compliant cryptogram using their proprietary PKI as their MFA method. All cardholder related parameters must be provided if they are collected according to compliance with applicable laws and local regulation.

","title":"MASTERCARD_THALES_AUTHENTICATOR"}}],"x-expandAllModelSections":"$undefined"},"grouped":true,"specUrl":"https://openapi.gitbook.com/o/fwy1mtbRONGA2YDKDBr0/spec/merchant-tokenization-server-api.yaml","icons":{"chevronDown":"$L8c","chevronRight":"$L8d","plus":"$L8e","copy":"$L8f","check":"$L90","lock":"$L91","mcp":"$L92","hashtag":"$L93"},"expandAllResponses":false,"expandAllModelSections":false,"headless":"$undefined","scalarRuntimeURL":"https://static-2v.gitbook.com/~gitbook/static/scalar/scalar-api-client@1.3.46.mjs","id":"undefined","blockKey":"McH9ZvazD2Ty","locale":"ja","mode":"default","codeTheme":{"light":"default-light","dark":"default-dark"},"proxyUrl":"https://open-2v.gitbook.com/~scalar/proxy?allowed_origin=openapi.gitbook.com%2Fo%2Ffwy1mtbRONGA2YDKDBr0%2Fspec%2Fmerchant-tokenization-server-api.yaml&site_id=site_gHszZ&token=a5c35fc4d03684a98b569554d0ca7f5721e64156c80c87868c5ba1b13623f15a","headingNode":null,"descriptionNode":null,"className":"openapi-block"}] 6e:["$","div",null,{"data-gb-page-outline":true,"className":"overflow-y-auto","children":["$","$L94",null,{"sections":[{"id":"merchantid","title":"merchantId","depth":1},{"id":"encrypteduserinfosync","title":"encryptedUserInfoSync","depth":1},{"id":"encrypteduserinfoasync","title":"encryptedUserInfoAsync","depth":1},{"id":"encrypteduserinfopci","title":"encryptedUserInfoPci","depth":1},{"id":"pushprovisioningpayload","title":"pushProvisioningPayload","depth":1},{"id":"encryptedmerchantinfopushprovisioning","title":"encryptedMerchantInfoPushProvisioning","depth":1},{"id":"encryptedissuerinfopushprovisioning","title":"encryptedIssuerInfoPushProvisioning","depth":1},{"id":"sourcesync","title":"sourceSync","depth":1},{"id":"sourceasync","title":"sourceAsync","depth":1},{"id":"language","title":"language","depth":1},{"id":"country","title":"country","depth":1},{"id":"accountscore","title":"accountScore","depth":1},{"id":"risk","title":"risk","depth":1},{"id":"ipaddress","title":"ipAddress","depth":1},{"id":"ipaddresssimpledesc","title":"ipAddressSimpleDesc","depth":1},{"id":"location","title":"location","depth":1},{"id":"device","title":"device","depth":1},{"id":"devicetransaction","title":"deviceTransaction","depth":1},{"id":"devicepushprovisioning","title":"devicePushProvisioning","depth":1},{"id":"cardholderemail","title":"cardholderEmail","depth":1},{"id":"cardholderline1","title":"cardholderLine1","depth":1},{"id":"cardholderline2","title":"cardholderLine2","depth":1},{"id":"cardholdercity","title":"cardholderCity","depth":1},{"id":"cardholdersubdivision","title":"cardholderSubdivision","depth":1},{"id":"cardholderpostalcode","title":"cardholderPostalCode","depth":1},{"id":"cardholderaddress","title":"cardholderAddress","depth":1},{"id":"cardholderbillingaddress","title":"cardholderBillingAddress","depth":1},{"id":"cardholderaddresstaf","title":"cardholderAddressTAF","depth":1},{"id":"cardholdertransaction","title":"cardholderTransaction","depth":1},{"id":"color","title":"color","depth":1},{"id":"tokenid","title":"tokenId","depth":1},{"id":"vprovisionedtokenid","title":"vProvisionedTokenId","depth":1},{"id":"deviceiddeprecated","title":"deviceIdDeprecated","depth":1},{"id":"deviceid","title":"deviceId","depth":1},{"id":"deviceidmdes","title":"deviceIdMdes","depth":1},{"id":"tokenlastdigits","title":"tokenLastDigits","depth":1},{"id":"tokenexpirydate","title":"tokenExpiryDate","depth":1},{"id":"cardbin","title":"cardBin","depth":1},{"id":"cardlastdigits","title":"cardLastDigits","depth":1},{"id":"cardexpirydate","title":"cardExpiryDate","depth":1},{"id":"issuername","title":"issuerName","depth":1},{"id":"supportvisactf","title":"supportVisaCTF","depth":1},{"id":"supportmastercardtaf","title":"supportMastercardTAF","depth":1},{"id":"supportmastercardliabilityshift","title":"supportMastercardLiabilityShift","depth":1},{"id":"carddescription","title":"cardDescription","depth":1},{"id":"cardtype","title":"cardType","depth":1},{"id":"scheme","title":"scheme","depth":1},{"id":"schememigration","title":"schemeMigration","depth":1},{"id":"schemepushprovisioning","title":"schemePushProvisioning","depth":1},{"id":"devicebindings","title":"deviceBindings","depth":1},{"id":"termsandconditionsurl","title":"termsAndConditionsUrl","depth":1},{"id":"privacypolicyurl","title":"privacyPolicyUrl","depth":1},{"id":"cardproduct","title":"cardProduct","depth":1},{"id":"cardproductpush","title":"cardProductPush","depth":1},{"id":"cardproductmigration","title":"cardProductMigration","depth":1},{"id":"cardartsmigration","title":"cardArtsMigration","depth":1},{"id":"cardarts","title":"cardArts","depth":1},{"id":"asset","title":"asset","depth":1},{"id":"transactionid","title":"transactionId","depth":1},{"id":"transactiontype","title":"transactionType","depth":1},{"id":"visasignedpayload","title":"visaSignedPayload","depth":1},{"id":"visasignedpayloadtrxv2","title":"visaSignedPayloadTrxV2","depth":1},{"id":"amount","title":"amount","depth":1},{"id":"currencycode","title":"currencyCode","depth":1},{"id":"transactiondata","title":"transactionData","depth":1},{"id":"transactiondatasrci","title":"transactionDataSrci","depth":1},{"id":"confirmationdata","title":"confirmationData","depth":1},{"id":"encryptedpaymentcredentials","title":"encryptedPaymentCredentials","depth":1},{"id":"cryptogramexpirydate","title":"cryptogramExpiryDate","depth":1},{"id":"eci","title":"eci","depth":1},{"id":"isdaf","title":"isDAF","depth":1},{"id":"par","title":"par","depth":1},{"id":"tokenstate","title":"tokenState","depth":1},{"id":"migratedtokenstate","title":"migratedTokenState","depth":1},{"id":"returnuritype","title":"returnUriType","depth":1},{"id":"returnuri","title":"returnUri","depth":1},{"id":"merchantname","title":"merchantName","depth":1},{"id":"supportedcardtype","title":"supportedCardType","depth":1},{"id":"dunsnumber","title":"dunsNumber","depth":1},{"id":"tokenrequestorservicetypes","title":"tokenRequestorServiceTypes","depth":1},{"id":"merchantlegalname","title":"merchantLegalName","depth":1},{"id":"websiteurl","title":"websiteUrl","depth":1},{"id":"primarycontactemail","title":"primaryContactEmail","depth":1},{"id":"merchantcity","title":"merchantCity","depth":1},{"id":"merchantcountry","title":"merchantCountry","depth":1},{"id":"allowcardupdatenotification","title":"allowCardUpdateNotification","depth":1},{"id":"businessidentificationtype","title":"businessIdentificationType","depth":1},{"id":"businessidentificationvalue","title":"businessIdentificationValue","depth":1},{"id":"acquirerid","title":"acquirerId","depth":1},{"id":"acquireridmastercard","title":"acquirerIdMastercard","depth":1},{"id":"locale","title":"locale","depth":1},{"id":"acquirermerchantid","title":"acquirerMerchantId","depth":1},{"id":"firstauthenticationfactor","title":"firstAuthenticationFactor","depth":1},{"id":"secondauthenticationfactor","title":"secondAuthenticationFactor","depth":1},{"id":"authenticationtransaction","title":"authenticationTransaction","depth":1},{"id":"creationtimestamp","title":"creationTimestamp","depth":1},{"id":"lastupdatetimestamp","title":"lastUpdateTimestamp","depth":1},{"id":"timestamp","title":"timestamp","depth":1},{"id":"supportedcardbrands","title":"supportedCardBrands","depth":1},{"id":"confirmationtimestamp","title":"confirmationTimestamp","depth":1},{"id":"errordetails","title":"errorDetails","depth":1},{"id":"schemecorrelationid","title":"schemeCorrelationId","depth":1},{"id":"mcserviceid","title":"mcServiceId","depth":1},{"id":"merchantcategory","title":"merchantCategory","depth":1},{"id":"transactiontypev2","title":"transactionTypeV2","depth":1},{"id":"isrecurring","title":"isRecurring","depth":1},{"id":"bindingtype","title":"bindingType","depth":1},{"id":"mccertifiedsolutionid","title":"mcCertifiedSolutionId","depth":1},{"id":"credentialid","title":"credentialId","depth":1},{"id":"fidorelyingparty","title":"fidoRelyingParty","depth":1},{"id":"fidouserid","title":"fidoUserId","depth":1},{"id":"isspcenabled","title":"isSpcEnabled","depth":1},{"id":"fidoauthenticationresponse","title":"fidoAuthenticationResponse","depth":1},{"id":"fidoregistrationresponse","title":"fidoRegistrationResponse","depth":1},{"id":"fidopublickeycredential","title":"fidoPublicKeyCredential","depth":1},{"id":"mctransactionassertion","title":"mcTransactionAssertion","depth":1},{"id":"mcbindingassertion","title":"mcBindingAssertion","depth":1},{"id":"merchantcategorycode","title":"merchantCategoryCode","depth":1},{"id":"mciaav","title":"mcIaav","depth":1},{"id":"mciaavtransactionid","title":"mcIaavTransactionId","depth":1},{"id":"emv-token","title":"EMV_TOKEN","depth":1},{"id":"visa-daf","title":"VISA_DAF","depth":1},{"id":"mastercard-taf-fido","title":"MASTERCARD_TAF_FIDO","depth":1},{"id":"mastercard-taf-iaav","title":"MASTERCARD_TAF_IAAV","depth":1},{"id":"binding-mastercard-taf-fido-iaav","title":"BINDING_MASTERCARD_TAF_FIDO_IAAV","depth":1},{"id":"mastercard-thales-authenticator","title":"MASTERCARD_THALES_AUTHENTICATOR","depth":1}]}]}]