> For the complete documentation index, see [llms.txt](https://docs.payments.thalescloud.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payments.thalescloud.io/merchant-tokenization/ja/bakkuendo/apis/server-api/models.md). # Models ## The merchantId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"merchantId":{"type":"string","description":"Identifier of the merchant provided by Thales at on-boarding.","minLength":1,"maxLength":128}}}} ``` ## The encryptedUserInfoSync object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"encryptedUserInfoSync":{"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.
Value expected when 'source' parameter is 'MANUAL' or 'ON_FILE'.|C|Up to 19|\n|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|\n|token|Token number.
Value expected when 'source' parameter is 'TOKEN'.|C|Up to 19|\n|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|\n|cvv|The security code.
It can help the issuer in the decision of approving the payment.|O|3 or 4|\n|accountId|The card holder account identifier defined by the Merchant.
It can help the issuer in the decision of approving the payment.|O|24|\n|email|The card holder email.
This parameter is mandatory for AMEX card tokenization.|O|128|\n\nExample: {\"fpan\":\"5123456789012345\", \"exp\":\"0822\", \"name\":\"JOHN DOE\", \"cvv\":\"123\", \"accountId\":\"johndoe\", \"email\":\"john@doe.com\"}"}}}} ``` ## The encryptedUserInfoAsync object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"encryptedUserInfoAsync":{"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.
Optional when VCES feature is activated for VISA|C|4|\n|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|\n|cvv|The security code.
It can help the issuer in the decision of approving the payment.|O|3 or 4|\n|accountId|The card holder account identifier defined by the Merchant.
It can help the issuer in the decision of approving the payment.|O|24|\n|email|The card holder email.
This parameter is mandatory for AMEX card tokenization.|O|128|\n\nExample: {\"fpan\":\"5123456789012345\", \"exp\":\"0822\", \"name\":\"JOHN DOE\", \"cvv\":\"123\", \"accountId\":\"johndoe\", \"email\":\"john@doe.com\"}"}}}} ``` ## The encryptedUserInfoPci object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"encryptedUserInfoPci":{"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\"}"}}}} ``` ## The pushProvisioningPayload object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"pushProvisioningPayload":{"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}}}} ``` ## The encryptedMerchantInfoPushProvisioning object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"encryptedMerchantInfoPushProvisioning":{"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\"}"}}}} ``` ## The encryptedIssuerInfoPushProvisioning object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"encryptedIssuerInfoPushProvisioning":{"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|"}}}} ``` ## The sourceSync object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"sourceSync":{"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"]}}}} ``` ## The sourceAsync object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"sourceAsync":{"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"]}}}} ``` ## The language object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"language":{"type":"string","default":"en","minLength":2,"maxLength":2,"description":"Card holder language in ISO-639-1 two-letter language code."}}}} ``` ## The country object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."}}}} ``` ## The accountScore object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"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.
    • |"}}}} ``` ## The risk object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"risk":{"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":{"$ref":"#/components/schemas/accountScore"}}},"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.
    • |"}}}} ``` ## The ipAddress object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"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."}}}} ``` ## The ipAddressSimpleDesc object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"ipAddressSimpleDesc":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4."}}}} ``` ## The location object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"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'"}}}} ``` ## The device object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"device":{"type":"object","description":"Information about the card holder's device.
    It can help the issuer in the decision of approving the payment.","properties":{"ipAddress":{"$ref":"#/components/schemas/ipAddress"},"location":{"$ref":"#/components/schemas/location"}}},"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."},"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'"}}}} ``` ## The deviceTransaction object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"deviceTransaction":{"type":"object","required":["ipAddress"],"description":"Required for Visa DAF only. deviceId and ipAddress are mandated. location is optional.","properties":{"deviceId":{"$ref":"#/components/schemas/deviceIdDeprecated"},"ipAddress":{"$ref":"#/components/schemas/ipAddressSimpleDesc"},"location":{"$ref":"#/components/schemas/location"}}},"deviceIdDeprecated":{"type":"string","description":"DEPRECATED! The unique device identifier. Visa deviceId must have 24 characters at maximum.","minLength":1,"maxLength":24},"ipAddressSimpleDesc":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4."},"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'"}}}} ``` ## The devicePushProvisioning object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"devicePushProvisioning":{"type":"object","description":"Information about the card holder's device.","required":["ipAddress"],"properties":{"ipAddress":{"$ref":"#/components/schemas/ipAddressSimpleDesc"},"location":{"$ref":"#/components/schemas/location"}}},"ipAddressSimpleDesc":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4."},"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'"}}}} ``` ## The cardholderEmail object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderEmail":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address."}}}} ``` ## The cardholderLine1 object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."}}}} ``` ## The cardholderLine2 object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderLine2":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 2."}}}} ``` ## The cardholderCity object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"}}}} ``` ## The cardholderSubdivision object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."}}}} ``` ## The cardholderPostalCode object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"}}}} ``` ## The cardholderAddress object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderAddress":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"$ref":"#/components/schemas/cardholderLine1"},"line2":{"$ref":"#/components/schemas/cardholderLine2"},"city":{"$ref":"#/components/schemas/cardholderCity"},"postalCode":{"$ref":"#/components/schemas/cardholderPostalCode"},"country":{"$ref":"#/components/schemas/country"},"subdivision":{"$ref":"#/components/schemas/cardholderSubdivision"}}},"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."},"cardholderLine2":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 2."},"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"},"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."}}}} ``` ## The cardholderBillingAddress object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderBillingAddress":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"$ref":"#/components/schemas/cardholderLine1"},"line2":{"$ref":"#/components/schemas/cardholderLine2"},"city":{"$ref":"#/components/schemas/cardholderCity"},"postalCode":{"$ref":"#/components/schemas/cardholderPostalCode"},"country":{"$ref":"#/components/schemas/country"},"subdivision":{"$ref":"#/components/schemas/cardholderSubdivision"}}},"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."},"cardholderLine2":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 2."},"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"},"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."}}}} ``` ## The cardholderAddressTAF object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderAddressTAF":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"$ref":"#/components/schemas/cardholderLine1"},"city":{"$ref":"#/components/schemas/cardholderCity"},"postalCode":{"$ref":"#/components/schemas/cardholderPostalCode"},"country":{"$ref":"#/components/schemas/country"},"subdivision":{"$ref":"#/components/schemas/cardholderSubdivision"}}},"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."},"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"},"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."}}}} ``` ## The cardholderTransaction object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardholderTransaction":{"type":"object","description":"Required for Visa DAF only.Information about the card holder.\n","required":["email"],"properties":{"email":{"$ref":"#/components/schemas/cardholderEmail"},"billingAddress":{"$ref":"#/components/schemas/cardholderBillingAddress"}}},"cardholderEmail":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address."},"cardholderBillingAddress":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"$ref":"#/components/schemas/cardholderLine1"},"line2":{"$ref":"#/components/schemas/cardholderLine2"},"city":{"$ref":"#/components/schemas/cardholderCity"},"postalCode":{"$ref":"#/components/schemas/cardholderPostalCode"},"country":{"$ref":"#/components/schemas/country"},"subdivision":{"$ref":"#/components/schemas/cardholderSubdivision"}}},"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."},"cardholderLine2":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 2."},"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"},"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."}}}} ``` ## The color object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"color":{"type":"string","maxLength":32,"description":"Deprecated.","enum":["GREEN"]}}}} ``` ## The tokenId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"tokenId":{"type":"string","description":"The token identifier.","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":128}}}} ``` ## The vProvisionedTokenId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"vProvisionedTokenId":{"type":"string","description":"Specific to Visa. Another token identifier that shall be used only with Visa Cloud Token Framework.","minLength":1,"maxLength":36}}}} ``` ## The deviceIdDeprecated object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"deviceIdDeprecated":{"type":"string","description":"DEPRECATED! The unique device identifier. Visa deviceId must have 24 characters at maximum.","minLength":1,"maxLength":24}}}} ``` ## The deviceId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"deviceId":{"type":"string","description":"The unique device identifier. Visa deviceId must have 24 characters at maximum.","minLength":1,"maxLength":36}}}} ``` ## The deviceIdMdes object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"deviceIdMdes":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":36}}}} ``` ## The tokenLastDigits object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"tokenLastDigits":{"type":"string","maxLength":5,"description":"The token last digits."}}}} ``` ## The tokenExpiryDate object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"tokenExpiryDate":{"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."}}}} ``` ## The cardBin object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardBin":{"type":"string","description":"The card bin returned by the scheme, just available for VISA and Mastercard SCOF.","minLength":6,"maxLength":8}}}} ``` ## The cardLastDigits object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardLastDigits":{"type":"string","maxLength":5,"description":"The card last digits."}}}} ``` ## The cardExpiryDate object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardExpiryDate":{"type":"string","maxLength":4,"description":"The card expiry date in format MMYY."}}}} ``` ## The issuerName object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name."}}}} ``` ## The supportVisaCTF object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"supportVisaCTF":{"type":"boolean","description":"Indicate if Visa Cloud Token Framework is available."}}}} ``` ## The supportMastercardTAF object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"supportMastercardTAF":{"type":"boolean","description":"Indicate if Mastercard Token Authentication Framework is available."}}}} ``` ## The supportMastercardLiabilityShift object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"supportMastercardLiabilityShift":{"type":"boolean","description":"For Mastercard indicates whether the Multi Factor Authentication method & account PAN are eligible for Fraud Liability Protection"}}}} ``` ## The cardDescription object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardDescription":{"type":"string","maxLength":256,"description":"The card description."}}}} ``` ## The cardType object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardType":{"type":"string","description":"The card type.","maxLength":32,"enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"]}}}} ``` ## The scheme object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"scheme":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA","AMEX","DISCOVER","ELO","UNKNOWN"]}}}} ``` ## The schemeMigration object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"schemeMigration":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD"]}}}} ``` ## The schemePushProvisioning object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"schemePushProvisioning":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA"]}}}} ``` ## The deviceBindings object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"deviceBindings":{"type":"array","description":"The list of device identifiers bound to the token.","items":{"$ref":"#/components/schemas/deviceId"},"uniqueItems":true},"deviceId":{"type":"string","description":"The unique device identifier. Visa deviceId must have 24 characters at maximum.","minLength":1,"maxLength":36}}}} ``` ## The termsAndConditionsUrl object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"termsAndConditionsUrl":{"type":"string","maxLength":512,"description":"Card issuer terms and conditions URL."}}}} ``` ## The privacyPolicyUrl object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"privacyPolicyUrl":{"type":"string","maxLength":512,"description":"Card issuer privacy policy URL."}}}} ``` ## The cardProduct object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardProduct":{"type":"object","description":"Information about the card product.","required":["cardType","scheme"],"properties":{"issuerName":{"$ref":"#/components/schemas/issuerName"},"cardType":{"$ref":"#/components/schemas/cardType"},"scheme":{"$ref":"#/components/schemas/scheme"},"supportVisaCTF":{"$ref":"#/components/schemas/supportVisaCTF"},"supportMastercardTAF":{"$ref":"#/components/schemas/supportMastercardTAF"},"supportMastercardLiabilityShift":{"$ref":"#/components/schemas/supportMastercardLiabilityShift"},"cardDescription":{"$ref":"#/components/schemas/cardDescription"},"cardArts":{"$ref":"#/components/schemas/cardArts"},"termsAndConditionsUrl":{"$ref":"#/components/schemas/termsAndConditionsUrl"},"privacyPolicyUrl":{"$ref":"#/components/schemas/privacyPolicyUrl"}}},"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name."},"cardType":{"type":"string","description":"The card type.","maxLength":32,"enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"]},"scheme":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA","AMEX","DISCOVER","ELO","UNKNOWN"]},"supportVisaCTF":{"type":"boolean","description":"Indicate if Visa Cloud Token Framework is available."},"supportMastercardTAF":{"type":"boolean","description":"Indicate if Mastercard Token Authentication Framework is available."},"supportMastercardLiabilityShift":{"type":"boolean","description":"For Mastercard indicates whether the Multi Factor Authentication method & account PAN are eligible for Fraud Liability Protection"},"cardDescription":{"type":"string","maxLength":256,"description":"The card description."},"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."},"backgroundColor":{"type":"string","maxLength":6,"description":"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."},"issuerLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the issuer logo."},"brandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the primary brand logo."},"cobrandLogoId":{"type":"string","maxLength":128,"description":"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."},"cardIconId":{"type":"string","maxLength":128,"description":"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."}}},"termsAndConditionsUrl":{"type":"string","maxLength":512,"description":"Card issuer terms and conditions URL."},"privacyPolicyUrl":{"type":"string","maxLength":512,"description":"Card issuer privacy policy URL."}}}} ``` ## The cardProductPush object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardProductPush":{"type":"object","description":"Information about the card product.","required":["cardType","scheme"],"properties":{"issuerName":{"$ref":"#/components/schemas/issuerName"},"cardType":{"$ref":"#/components/schemas/cardType"},"scheme":{"$ref":"#/components/schemas/scheme"},"supportVisaCTF":{"$ref":"#/components/schemas/supportVisaCTF"},"cardDescription":{"$ref":"#/components/schemas/cardDescription"},"cardArts":{"$ref":"#/components/schemas/cardArts"},"termsAndConditionsUrl":{"$ref":"#/components/schemas/termsAndConditionsUrl"},"privacyPolicyUrl":{"$ref":"#/components/schemas/privacyPolicyUrl"}}},"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name."},"cardType":{"type":"string","description":"The card type.","maxLength":32,"enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"]},"scheme":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA","AMEX","DISCOVER","ELO","UNKNOWN"]},"supportVisaCTF":{"type":"boolean","description":"Indicate if Visa Cloud Token Framework is available."},"cardDescription":{"type":"string","maxLength":256,"description":"The card description."},"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."},"backgroundColor":{"type":"string","maxLength":6,"description":"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."},"issuerLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the issuer logo."},"brandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the primary brand logo."},"cobrandLogoId":{"type":"string","maxLength":128,"description":"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."},"cardIconId":{"type":"string","maxLength":128,"description":"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."}}},"termsAndConditionsUrl":{"type":"string","maxLength":512,"description":"Card issuer terms and conditions URL."},"privacyPolicyUrl":{"type":"string","maxLength":512,"description":"Card issuer privacy policy URL."}}}} ``` ## The cardProductMigration object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardProductMigration":{"type":"object","description":"Information about the card product.","required":["cardType"],"properties":{"issuerName":{"$ref":"#/components/schemas/issuerName"},"cardType":{"$ref":"#/components/schemas/cardType"},"scheme":{"$ref":"#/components/schemas/schemeMigration"},"cardDescription":{"$ref":"#/components/schemas/cardDescription"},"cardArts":{"$ref":"#/components/schemas/cardArtsMigration"}}},"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name."},"cardType":{"type":"string","description":"The card type.","maxLength":32,"enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"]},"schemeMigration":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD"]},"cardDescription":{"type":"string","maxLength":256,"description":"The card description."},"cardArtsMigration":{"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."},"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."}}}}}} ``` ## The cardArtsMigration object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cardArtsMigration":{"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."},"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."}}}}}} ``` ## The cardArts object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"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."},"backgroundColor":{"type":"string","maxLength":6,"description":"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."},"issuerLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the issuer logo."},"brandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the primary brand logo."},"cobrandLogoId":{"type":"string","maxLength":128,"description":"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."},"cardIconId":{"type":"string","maxLength":128,"description":"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."}}}}}} ``` ## The asset object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"asset":{"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"]},"encodedData":{"type":"string","description":"The asset encoded in base64."},"height":{"type":"string","maxLength":10,"description":"The asset height specified in pixels."},"width":{"type":"string","maxLength":10,"description":"The asset width specified in pixels."}}}}}} ``` ## The transactionId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"transactionId":{"type":"string","description":"The unique transaction identifier.","minLength":1,"maxLength":128}}}} ``` ## The transactionType object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"transactionType":{"type":"string","maxLength":64,"description":"","enum":["SINGLE","SPLIT","RECURRING"]}}}} ``` ## The visaSignedPayload object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"visaSignedPayload":{"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}}}} ``` ## The visaSignedPayloadTrxV2 object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"visaSignedPayloadTrxV2":{"type":"string","description":"Set with the signature (JWT) generated by Thales ETP SDK.","minLength":1,"maxLength":4096}}}} ``` ## The amount object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"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+)?)$"}}}} ``` ## The currencyCode object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters."}}}} ``` ## The transactionData object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"transactionData":{"type":"object","description":"Required only for Visa DAF. When transactionData is present, both amount and currencyCode must be specified.","required":["amount","currencyCode"],"properties":{"amount":{"$ref":"#/components/schemas/amount"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters."}}},"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+)?)$"}}}} ``` ## The transactionDataSrci object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"transactionDataSrci":{"type":"object","description":"Transaction data for Click to pay.","required":["amount","currencyCode"],"properties":{"amount":{"$ref":"#/components/schemas/amount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"}}},"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+)?)$"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters."}}}} ``` ## The confirmationData object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"confirmationData":{"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"]},"eventStatus":{"type":"string","description":"Event type associated with the order.","maxLength":20,"enum":["CREATED","CONFIRMED","CANCELLED","FRAUD_CANCELLED","OTHERS"]},"status":{"type":"string","description":"Status of the event as provided by the SRC Initiator in the Confirmation message.","maxLength":10,"enum":["SUCCESS","FAILURE","OTHER"]},"reason":{"type":"string","description":"Description of the reason for the event associated with the order.","maxLength":64},"timestamp":{"$ref":"#/components/schemas/confirmationTimestamp"},"networkAuthorizationCode":{"type":"string","description":"Authorisation code associated with an approved transaction.","maxLength":25},"networkTransactionIdentifier":{"type":"string","description":"Unique authorisation related tracing value assigned by a Payment Network and provided in an authorisation response.","minLength":1,"maxLength":25}}},"confirmationTimestamp":{"type":"string","minLength":1,"maxLength":64,"description":"Merchant confirmation timestamp when the transaction was completed, compliant with ISO 8601."}}}} ``` ## The encryptedPaymentCredentials object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"encryptedPaymentCredentials":{"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\"}"}}}} ``` ## The cryptogramExpiryDate object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"cryptogramExpiryDate":{"type":"string","maxLength":64,"description":"Cryptogram expiry date in ISO 8601. Provided for Visa only."}}}} ``` ## The eci object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"eci":{"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."}}}} ``` ## The isDAF object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"isDAF":{"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'."}}}} ``` ## The par object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"par":{"type":"string","maxLength":29,"description":"Payment Account Reference returned by the Scheme TSP."}}}} ``` ## The tokenState object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"tokenState":{"type":"string","maxLength":64,"description":"Token state.
    PCI token state can only be 'ACTIVE' or 'DELETED'.","enum":["ACTIVE","SUSPENDED","DELETED","PENDING"]}}}} ``` ## The migratedTokenState object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"migratedTokenState":{"type":"string","maxLength":64,"description":"Token state.","enum":["ACTIVE","SUSPENDED","PENDING"]}}}} ``` ## The returnUriType object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"returnUriType":{"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"]}}}} ``` ## The returnUri object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"returnUri":{"type":"string","maxLength":512,"description":"Issuer application/website URI. This parameter could be returned only for VISA."}}}} ``` ## The merchantName object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"merchantName":{"type":"string","description":"An unique merchant name that is end user friendly.","minLength":1,"maxLength":60,"pattern":"^[A-Za-z0-9-_. ]+$"}}}} ``` ## The supportedCardType object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"supportedCardType":{"type":"string","maxLength":6,"description":"Indication about the card type supported by the merchant.","enum":["DEBIT","CREDIT","BOTH"]}}}} ``` ## The dunsNumber object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"dunsNumber":{"type":"string","minLength":9,"maxLength":9,"description":"Dun and Bradestreet number."}}}} ``` ## The tokenRequestorServiceTypes object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"tokenRequestorServiceTypes":{"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}}}} ``` ## The merchantLegalName object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"merchantLegalName":{"type":"string","minLength":1,"maxLength":60,"description":"Legal name of the merchant.","pattern":"^[A-Za-z0-9-_. ]+$"}}}} ``` ## The websiteUrl object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"websiteUrl":{"type":"string","minLength":1,"maxLength":100,"description":"Merchant website URL.","pattern":"^[A-Za-z0-9-_.:/]+$"}}}} ``` ## The primaryContactEmail object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"primaryContactEmail":{"type":"string","minLength":1,"maxLength":100,"description":"Email address of the merchant primary contact.","pattern":"^[A-Za-z0-9-_.@]+$"}}}} ``` ## The merchantCity object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"merchantCity":{"type":"string","minLength":1,"maxLength":100,"description":"City of the merchant address.","pattern":"^[A-Za-z0-9-_. ]+$"}}}} ``` ## The merchantCountry object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"merchantCountry":{"type":"string","minLength":2,"maxLength":2,"description":"Merchant country in ISO-3166-1 alpha-2 two-letter country code."}}}} ``` ## The allowCardUpdateNotification object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"allowCardUpdateNotification":{"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":""}}}} ``` ## The businessIdentificationType object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"businessIdentificationType":{"type":"string","maxLength":12,"description":"One of the below configuration must be provided:
    - businessIdentificationType and businessIdentificationValue or
    - acquirerId and acquirerMerchantId.

    Merchant business identification type.\n\n|BusinessIdentificationType|Description|Format|\n|-------|-------|-------|\n|ABN|Australian business number|11 numeric digits|\n|ACN|Australian company number|9 numeric digits|\n|BID|VISA business identification number; all countries. You must contact your Visa representative before using BID |8 numeric digits|\n|BIN|Kazakhstan business identification number|12 numeric digits|\n|BIR|Philippines certificate of registration|12 numeric digits; hyphen-separated|\n|BN|Canadian business number|9 numeric digits|\n|BRN|South Korea business registration number|10 numeric digits; hyphen-separated|\n|BRNO|Malaysia only.|Up to 10 numeric digits followed by a hyphen and a single character or 12 numeric digits|\n|CL|Commercial License Number Qatar|4-6 numeric digits|\n|CLN|Company License Number Kuwait|5-7 numeric digits|\n|CORPORATE_NUMBER|Japan corporate number|13 numeric digits; leading digit is a non-zero check digit for the following 12 digits|\n|CNPJ|Brazil only.|14 alphanumeric characters, identified by n in the example, and punctuation characters (period, slash, and hyphen)|\n|CR|Company Registration Number Saudi Arabia.|10-12 numeric digits|\n|CUIT|Argentina only.|11 numeric digits|\n|EDRPOU|Ukraine. \tUkrainian corporations|8 numeric digits and 10 numeric digits for Ukrainian individual entrepeneurs|\n|EIN|US Federal tax ID (US only).|9 numeric digits|\n|HKBR|Hong Kong only.|11 numeric digits and a hyphen|\n|INI|Andorran General Indirect Tax.|8 alphanumeric characters; the first and last characters must be alphabetic.|\n|NATIONAL_ID|Dominican Republic (DO). Cedula de Identidad (Merchant Owner ID)|DO + 11 digits| \n|NIB|Indonesia business identification number|13 numeric digits|\n|NID|South Africa national identification number|13 numeric digits|\n|NZBN|New Zealand business number.|13 numeric digits|\n|PAN|Indian business identification number|10 alphanumeric characters|\n|PAN|Belarus payer account number|9 numeric digits|\n|RFC|Mexico only.|12 alphanumeric characters for corporations and 13 alphanumeric characters for individuals|\n|RNC|Dominican Republic (DO). Registro Nacional de Contribuyentes (National Contributors Number)|DO + 9 digits|\n|RUC|Peru only.|11 numeric digits|\n|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|\n|SIN|Canadian social insurance number|9 numeric digits|\n|SSN|US social security number (US only)|9 numeric digits|\n|TC|Vietnam tax code|10 or 13 numeric digits|\n|UEN|Singapore only|9 or 10 alphanumeric characters|\n|USCI|China united social credit code|18 alphanumeric characters|\n|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|","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"]}}}} ``` ## The businessIdentificationValue object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"businessIdentificationValue":{"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."}}}} ``` ## The acquirerId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"acquirerId":{"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}}}} ``` ## The acquirerIdMastercard object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"acquirerIdMastercard":{"type":"string","pattern":"^([0-9a-zA-Z]*$)","description":"Acquiring institution identification code","minLength":1,"maxLength":11}}}} ``` ## The locale object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"locale":{"type":"string","description":"Locale identifier following BCP 47 (e.g., en-US, es-MX)","minLength":1,"maxLength":10}}}} ``` ## The acquirerMerchantId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"acquirerMerchantId":{"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}}}} ``` ## The firstAuthenticationFactor object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"firstAuthenticationFactor":{"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"]}}}} ``` ## The secondAuthenticationFactor object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"secondAuthenticationFactor":{"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"]}}}} ``` ## The authenticationTransaction object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"authenticationTransaction":{"type":"object","description":"Required only for Visa DAF.","required":["firstFactor"],"properties":{"firstFactor":{"$ref":"#/components/schemas/firstAuthenticationFactor"},"secondFactor":{"$ref":"#/components/schemas/secondAuthenticationFactor"}}},"firstAuthenticationFactor":{"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"]},"secondAuthenticationFactor":{"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"]}}}} ``` ## The creationTimestamp object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"creationTimestamp":{"type":"string","maxLength":64,"description":"Token creation timestamp compliant with ISO 8601."}}}} ``` ## The lastUpdateTimestamp object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"lastUpdateTimestamp":{"type":"string","maxLength":64,"description":"Token last update timestamp compliant with ISO 8601. Provided only in case the token was updated after its creation."}}}} ``` ## The timestamp object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"timestamp":{"type":"string","minLength":1,"maxLength":64,"description":"A timestamp compliant with ISO 8601."}}}} ``` ## The supportedCardBrands object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"supportedCardBrands":{"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"]}}}}} ``` ## The confirmationTimestamp object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"confirmationTimestamp":{"type":"string","minLength":1,"maxLength":64,"description":"Merchant confirmation timestamp when the transaction was completed, compliant with ISO 8601."}}}} ``` ## The errorDetails object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"errorDetails":{"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."}}}} ``` ## The schemeCorrelationId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"schemeCorrelationId":{"type":"string","maxLength":128,"description":"Identifier used by the schemes for additional support."}}}} ``` ## The mcServiceId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"mcServiceId":{"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."}}}} ``` ## The merchantCategory object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"merchantCategory":{"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'. "}}}} ``` ## The transactionTypeV2 object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"transactionTypeV2":{"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"]}}}} ``` ## The isRecurring object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"isRecurring":{"type":"boolean","description":"Indicate if the payment is recurring (like a monthly subscription)"}}}} ``` ## The bindingType object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"bindingType":{"type":"string","maxLength":64,"description":"The request content depends on the binding type.","enum":["MASTERCARD_TAF_FIDO_IAAV"]}}}} ``` ## The mcCertifiedSolutionId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"mcCertifiedSolutionId":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of the Mastercard TAF certified MFA method."}}}} ``` ## The credentialId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"credentialId":{"type":"string","minLength":1,"maxLength":128,"description":"UUID identifying the FIDO authenticator."}}}} ``` ## The fidoRelyingParty object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"fidoRelyingParty":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO relying party."}}}} ``` ## The fidoUserId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"fidoUserId":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO user identifier."}}}} ``` ## The isSpcEnabled object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"isSpcEnabled":{"type":"boolean","description":"Indicates if Secure Payment Confirmation is enabled."}}}} ``` ## The fidoAuthenticationResponse object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"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}
    "}}}} ``` ## The fidoRegistrationResponse object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"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}
    "}}}} ``` ## The fidoPublicKeyCredential object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"fidoPublicKeyCredential":{"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}
    "}}}} ``` ## The mcTransactionAssertion object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"mcTransactionAssertion":{"type":"string","minLength":1,"maxLength":8196,"description":"The transaction assertion JWT as per Mastercard specifications."}}}} ``` ## The mcBindingAssertion object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"mcBindingAssertion":{"type":"string","minLength":1,"maxLength":8196,"description":"The binding assertion JWT as per Mastercard specifications."}}}} ``` ## The merchantCategoryCode object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"merchantCategoryCode":{"type":"string","minLength":1,"maxLength":4,"description":"The merchant category code."}}}} ``` ## The mcIaav object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"mcIaav":{"type":"string","minLength":1,"maxLength":8196,"description":"The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64."}}}} ``` ## The mcIaavTransactionId object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"mcIaavTransactionId":{"type":"string","minLength":1,"maxLength":128,"description":"The transaction identifier as present in the issuer IAAV."}}}} ``` ## The EMV\_TOKEN object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"EMV_TOKEN":{"type":"object","description":"List the parameters that are accepted to get a cryptogram for a transaction with the token.","required":["isRecurring"],"properties":{"isRecurring":{"$ref":"#/components/schemas/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+)?)$"},"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."}}},"isRecurring":{"type":"boolean","description":"Indicate if the payment is recurring (like a monthly subscription)"}}}} ``` ## The VISA\_DAF object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"VISA_DAF":{"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":{"$ref":"#/components/schemas/firstAuthenticationFactor"},"secondFactor":{"$ref":"#/components/schemas/secondAuthenticationFactor"},"visaSignedPayload":{"$ref":"#/components/schemas/visaSignedPayloadTrxV2"},"amount":{"$ref":"#/components/schemas/amount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"ipAddress":{"$ref":"#/components/schemas/ipAddressSimpleDesc"},"location":{"$ref":"#/components/schemas/location"},"email":{"$ref":"#/components/schemas/cardholderEmail"},"billingAddress":{"$ref":"#/components/schemas/cardholderAddress"}}},"firstAuthenticationFactor":{"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"]},"secondAuthenticationFactor":{"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"]},"visaSignedPayloadTrxV2":{"type":"string","description":"Set with the signature (JWT) generated by Thales ETP SDK.","minLength":1,"maxLength":4096},"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+)?)$"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters."},"ipAddressSimpleDesc":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4."},"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'"},"cardholderEmail":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address."},"cardholderAddress":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"$ref":"#/components/schemas/cardholderLine1"},"line2":{"$ref":"#/components/schemas/cardholderLine2"},"city":{"$ref":"#/components/schemas/cardholderCity"},"postalCode":{"$ref":"#/components/schemas/cardholderPostalCode"},"country":{"$ref":"#/components/schemas/country"},"subdivision":{"$ref":"#/components/schemas/cardholderSubdivision"}}},"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."},"cardholderLine2":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 2."},"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"},"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."}}}} ``` ## The MASTERCARD\_TAF\_FIDO object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"MASTERCARD_TAF_FIDO":{"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":{"$ref":"#/components/schemas/amount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"deviceId":{"$ref":"#/components/schemas/deviceIdMdes"},"ipAddress":{"$ref":"#/components/schemas/ipAddressSimpleDesc"},"location":{"$ref":"#/components/schemas/location"},"mcCertifiedSolutionId":{"$ref":"#/components/schemas/mcCertifiedSolutionId"},"credentialId":{"$ref":"#/components/schemas/credentialId"},"fidoRelyingParty":{"$ref":"#/components/schemas/fidoRelyingParty"},"fidoUserId":{"$ref":"#/components/schemas/fidoUserId"},"isSpcEnabled":{"$ref":"#/components/schemas/isSpcEnabled"},"fidoAuthenticationResponse":{"$ref":"#/components/schemas/fidoPublicKeyCredential"},"mcTransactionAssertion":{"$ref":"#/components/schemas/mcTransactionAssertion"},"email":{"$ref":"#/components/schemas/cardholderEmail"},"billingAddress":{"$ref":"#/components/schemas/cardholderAddressTAF"},"shippingAddress":{"$ref":"#/components/schemas/cardholderAddressTAF"},"merchantCategoryCode":{"$ref":"#/components/schemas/merchantCategoryCode"},"merchantCountry":{"$ref":"#/components/schemas/merchantCountry"}}},"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+)?)$"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters."},"deviceIdMdes":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":36},"ipAddressSimpleDesc":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4."},"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'"},"mcCertifiedSolutionId":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of the Mastercard TAF certified MFA method."},"credentialId":{"type":"string","minLength":1,"maxLength":128,"description":"UUID identifying the FIDO authenticator."},"fidoRelyingParty":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO relying party."},"fidoUserId":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO user identifier."},"isSpcEnabled":{"type":"boolean","description":"Indicates if Secure Payment Confirmation is enabled."},"fidoPublicKeyCredential":{"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}
    "},"mcTransactionAssertion":{"type":"string","minLength":1,"maxLength":8196,"description":"The transaction assertion JWT as per Mastercard specifications."},"cardholderEmail":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address."},"cardholderAddressTAF":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"$ref":"#/components/schemas/cardholderLine1"},"city":{"$ref":"#/components/schemas/cardholderCity"},"postalCode":{"$ref":"#/components/schemas/cardholderPostalCode"},"country":{"$ref":"#/components/schemas/country"},"subdivision":{"$ref":"#/components/schemas/cardholderSubdivision"}}},"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."},"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"},"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."},"merchantCategoryCode":{"type":"string","minLength":1,"maxLength":4,"description":"The merchant category code."},"merchantCountry":{"type":"string","minLength":2,"maxLength":2,"description":"Merchant country in ISO-3166-1 alpha-2 two-letter country code."}}}} ``` ## The MASTERCARD\_TAF\_IAAV object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"MASTERCARD_TAF_IAAV":{"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":{"$ref":"#/components/schemas/amount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"ipAddress":{"$ref":"#/components/schemas/ipAddressSimpleDesc"},"location":{"$ref":"#/components/schemas/location"},"mcIaav":{"$ref":"#/components/schemas/mcIaav"},"mcIaavTransactionId":{"$ref":"#/components/schemas/mcIaavTransactionId"},"verificationTimestamp":{"$ref":"#/components/schemas/timestamp"},"email":{"$ref":"#/components/schemas/cardholderEmail"},"billingAddress":{"$ref":"#/components/schemas/cardholderAddressTAF"},"shippingAddress":{"$ref":"#/components/schemas/cardholderAddressTAF"},"merchantCategoryCode":{"$ref":"#/components/schemas/merchantCategoryCode"},"merchantCountry":{"$ref":"#/components/schemas/merchantCountry"}}},"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+)?)$"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters."},"ipAddressSimpleDesc":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4."},"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'"},"mcIaav":{"type":"string","minLength":1,"maxLength":8196,"description":"The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64."},"mcIaavTransactionId":{"type":"string","minLength":1,"maxLength":128,"description":"The transaction identifier as present in the issuer IAAV."},"timestamp":{"type":"string","minLength":1,"maxLength":64,"description":"A timestamp compliant with ISO 8601."},"cardholderEmail":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address."},"cardholderAddressTAF":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"$ref":"#/components/schemas/cardholderLine1"},"city":{"$ref":"#/components/schemas/cardholderCity"},"postalCode":{"$ref":"#/components/schemas/cardholderPostalCode"},"country":{"$ref":"#/components/schemas/country"},"subdivision":{"$ref":"#/components/schemas/cardholderSubdivision"}}},"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."},"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"},"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."},"merchantCategoryCode":{"type":"string","minLength":1,"maxLength":4,"description":"The merchant category code."},"merchantCountry":{"type":"string","minLength":2,"maxLength":2,"description":"Merchant country in ISO-3166-1 alpha-2 two-letter country code."}}}} ``` ## The BINDING\_MASTERCARD\_TAF\_FIDO\_IAAV object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"BINDING_MASTERCARD_TAF_FIDO_IAAV":{"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":{"$ref":"#/components/schemas/mcCertifiedSolutionId"},"credentialId":{"$ref":"#/components/schemas/credentialId"},"deviceId":{"$ref":"#/components/schemas/deviceIdMdes"},"fidoRelyingParty":{"$ref":"#/components/schemas/fidoRelyingParty"},"fidoUserId":{"$ref":"#/components/schemas/fidoUserId"},"isSpcEnabled":{"$ref":"#/components/schemas/isSpcEnabled"},"fidoAuthenticationResponse":{"$ref":"#/components/schemas/fidoAuthenticationResponse"},"fidoRegistrationResponse":{"$ref":"#/components/schemas/fidoRegistrationResponse"},"mcIaav":{"$ref":"#/components/schemas/mcIaav"},"verificationTimestamp":{"$ref":"#/components/schemas/timestamp"},"mcBindingAssertion":{"$ref":"#/components/schemas/mcBindingAssertion"}}},"mcCertifiedSolutionId":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of the Mastercard TAF certified MFA method."},"credentialId":{"type":"string","minLength":1,"maxLength":128,"description":"UUID identifying the FIDO authenticator."},"deviceIdMdes":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":36},"fidoRelyingParty":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO relying party."},"fidoUserId":{"type":"string","minLength":1,"maxLength":128,"description":"The FIDO user identifier."},"isSpcEnabled":{"type":"boolean","description":"Indicates if Secure Payment Confirmation is enabled."},"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}
    "},"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}
    "},"mcIaav":{"type":"string","minLength":1,"maxLength":8196,"description":"The issuer IAAV as per Mastercard specifications, so JSON encoded in Base64."},"timestamp":{"type":"string","minLength":1,"maxLength":64,"description":"A timestamp compliant with ISO 8601."},"mcBindingAssertion":{"type":"string","minLength":1,"maxLength":8196,"description":"The binding assertion JWT as per Mastercard specifications."}}}} ``` ## The MASTERCARD\_THALES\_AUTHENTICATOR object ```json {"openapi":"3.1.1","info":{"title":"Thales ETP Server API","version":"1.78"},"components":{"schemas":{"MASTERCARD_THALES_AUTHENTICATOR":{"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":{"$ref":"#/components/schemas/amount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"deviceId":{"$ref":"#/components/schemas/deviceIdMdes"},"tafAssertionPayload":{"type":"string","minLength":1,"maxLength":10000,"description":"JSON assertion payload Base64 encoded, generated by Thales ETP SDK."},"merchantCategoryCode":{"$ref":"#/components/schemas/merchantCategoryCode"},"merchantCountry":{"$ref":"#/components/schemas/merchantCountry"},"email":{"$ref":"#/components/schemas/cardholderEmail"},"location":{"$ref":"#/components/schemas/location"},"ipAddress":{"$ref":"#/components/schemas/ipAddressSimpleDesc"},"billingAddress":{"$ref":"#/components/schemas/cardholderAddressTAF"},"shippingAddress":{"$ref":"#/components/schemas/cardholderAddressTAF"}}},"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+)?)$"},"currencyCode":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code on 3 characters."},"deviceIdMdes":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":36},"merchantCategoryCode":{"type":"string","minLength":1,"maxLength":4,"description":"The merchant category code."},"merchantCountry":{"type":"string","minLength":2,"maxLength":2,"description":"Merchant country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderEmail":{"type":"string","minLength":1,"maxLength":128,"description":"Card holder email address."},"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'"},"ipAddressSimpleDesc":{"type":"string","minLength":1,"maxLength":64,"description":"The card holder's device IP address in format IPv4."},"cardholderAddressTAF":{"type":"object","description":"Card holder billing address.","required":["line1","city","postalCode","country"],"properties":{"line1":{"$ref":"#/components/schemas/cardholderLine1"},"city":{"$ref":"#/components/schemas/cardholderCity"},"postalCode":{"$ref":"#/components/schemas/cardholderPostalCode"},"country":{"$ref":"#/components/schemas/country"},"subdivision":{"$ref":"#/components/schemas/cardholderSubdivision"}}},"cardholderLine1":{"type":"string","minLength":1,"maxLength":140,"description":"Card holder address line 1."},"cardholderCity":{"type":"string","minLength":1,"maxLength":100,"description":"Card holder city.","pattern":"^[A-Za-z0-9-_. ]+$"},"cardholderPostalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Card holder postal code or zip code.","pattern":"^[A-Za-z0-9]+$"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder country in ISO-3166-1 alpha-2 two-letter country code."},"cardholderSubdivision":{"type":"string","minLength":2,"maxLength":2,"description":"Card holder state or province code in ISO-3166-1 alpha-2 two-letter format."}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.payments.thalescloud.io/merchant-tokenization/ja/bakkuendo/apis/server-api/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.