3.1 3D Secure Authentication

3.1.1 Request Body

3D Secure Authentication. The resulting Authentication Response (ARes) can either be the final message due to a frictionless flow or lead to a challenge flow

Base link for the endpoint is https://api.sekuritance.com/{{endpoint}}.

EventRequest TypeEndpoint
3D Secure AuthenticationPOST /v2/cards/auth

3.1.2 For Request and Response body JSON Sample

To check the the request and response of the body please check the URL: https://sekuritance.readme.io/reference

3.1.3 Request Body Parameters Description

This is a detailed description of each parameter in the request body.

Body ParamaterData TypeDescription
accountIdStringAdditional information about the account. Required for VISA cards
accountTypestringValid Values: "NOT_APPLICABLE""CREDIT""DEBIT""USABLE_BY_CARD_SCHEMES"
Indicates the type of account. Required for VISA cards.
acquirerBINinteger Required
Acquirer BIN assigned by the Directory Server
acquirerMerchantIdinteger Required
Acquirer-assigned Merchant identifier
addressesMatchbooleanIndicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same.
authenticationRequestTypestringRequired
Valid Values:
"PAYMENT_TX""RECURRING_TX""INSTALMENT_TX""ADD_CARD""MAINTAIN_CARD""CARDHOLDER_VERIFICATION""RESERVED_FOR_DS_USE"
Indicates the type of Authentication request
billingAddressObjectBilling Address. Required for Mastercard
addressLine1stringAddress Line 1
addressLine2stringAddress Line 2
addressLine3stringAddress Line 3
citystringAddress City
countryObjectAddress Country
countrystring
displayCountrystring
displayLanguagestring
displayNamestring
displayScriptstring
displayVariantstring
extensionKeysObject: Array of strings
iso3Countrystring
iso3Languagestring
languagestring
scriptstring
unicodeLocaleAttributesObject: Array of strings
unicodeLocaleKeysObject: Array of strings
postalCodestringAddress Line 3
statestringAddress State
browserAcceptHeaderbooleanRequired
Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder’s browser
browserColorDepthinteger Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property. In case the actual value does not exist in the allowed values, use the closest lower value
browserJSEnabledbooleanRequired
Boolean that represents the ability of the cardholder browser to execute Javascript
browserLanguagestringRequired
Value representing the browser language as defined in IETF BCP47
browserScreenHeightstringRequired
Total height of the Cardholder’s screen in pixels
browserScreenWidthstringRequired
Total width of the cardholder’s screen in pixels
browserTimezonestringRequired
Cardholder browser local timezone example: UTC+2
browserUserAgentstringRequired
Exact content of the HTTP user-agent header
cardExpiryDatestringCard Expiry Date
cardNumberstringRequired
Card Number that will be used in the authorisation request for payment transactions
cardholderNamestringCardholder Name
challengeCallbackURLObjectRequired
Fully qualified URL of the system that receives the CRes message or Error Message
authoritystring
contentObject
defaultPortinteger
deserializedFieldsURLStreamHandler (object)
filestring
hoststring
pathstring
portinteger
protocolstring
querystring
refstring
serializedHashCodeinteger
userInfostring
emailAddressstringEmail Address
ipAddressstringIP address the browser is connecting from
mccstringRequired
DS-specific code describing the Merchant's type of business, product or service
merchantCountryCodeObjectRequired
Merchant Country Code
countrystring
displayLanguagestring
displayLanguagestring
displayNamestring
displayScriptstring
displayVariantstring
extensionKeysObject: Array of strings
iso3Countrystring
iso3Languagestring
languagestring
scriptstring
unicodeLocaleAttributesObject: Array of strings
unicodeLocaleKeysObject: Array of strings
variantstring
merchantNamestringRequired
Merchant name
messageCategorystringRequired
Valid Values:
"PAYMENT""NON_PAYMENT""THREED_RESERVED"
Merchant name
mobileNumberObjectMobile number. Required for VISA and Mastercard
countryCodestring
numberstring
payTokenIndstringValid Values:
Required if payTokenInd is true. This data element will be populated by the system residing in the 3-D Secure domain where the de-tokenisation occurs
phoneNumberObjectPhone number. Required for VISA and Mastercard
countryCodestring
numberstring
purchaseAmountObjectRequired
Purchase amount
amountnumberTransaction amount
currencystringThree letter currency code ISO 4217
purchaseDatestring Required
Purchase Date & Time
purchaseInstalmentDatainteger Indicates the maximum number of authorisations permitted for instalment payments (from 2 to 999). Required if authenticationRequest is INSTALMENT_TX
recurringExpirystring Date after which no further authorisations shall be performed. This is a required field for recurring transactions, we suggest setting it at a reasonably high value if you don't have a defined expiry date. Required if authenticationRequest is INSTALMENT_TX or RECURRING_TX
recurringFrequencyinteger Indicates the minimum number of days between authorisations. Required if authenticationRequest is INSTALMENT_TX or RECURRING_TX
requestorURLObjectRequired
Fully qualified URL of the Merchant website or customer care site. This data element provides additional information to the receiving 3-D Secure system if a problem arises and should provide contact information.
authoritystring
contentObject
defaultPortinteger
deserializedFieldsURLStreamHandler (object)
filestring
hoststring
pathstring
portinteger
protocolstring
querystring
refstring
serializedHashCodeinteger
userInfostring
shippingObjectShipping Address. Required for Mastercard
addressLine1string
addressLine2string
addressLine3string
citystring
countryObjectAddress Country
countrystring
displayCountrystring
displayLanguagestring
displayNamestring
displayScriptstring
displayVariantstring
extensionKeysObject: Array of strings
iso3Countrystring
iso3Languagestring
languagestring
scriptstring
unicodeLocaleAttributesObject: Array of strings
unicodeLocaleKeysObject: Array of strings
variantstringAddress Line 3
postalCodestring
statestringAddress State
threeDSCompletedIndicatorstringRequired
Valid Values:
"COMPLETED""FAILED""UNAVAILABLE"
Indicates whether the 3DS Method successfully completed
threeDSServerTransactionIDstringRequired
Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
transactionReferencestringRequired
Merchant unique transaction identifier
transactionTypestringValid Values:
"GOODS""CHECK_ACCEPTANCE""ACCOUNT_FUNDING""QUASI_CASH""PREPAID_ACTIVATION_AND_LOAD"
Identifies the type of transaction being authenticated. Required for VISA