{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"threeDSecure","type":"basic","slug":"threedsecure","excerpt":"Contains 3D Secure details for this transaction","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`acsTransactionId`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Optional\",\n    \"0-3\": \"Transaction ID value from the 3DS server.\\n\\nUUID of 36 characters.\",\n    \"1-0\": \"`cavv`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"CAVV: Cardholder Authentication Verification Value\\n\\nBase64 encoded CAVV obtained from the external MPI.\\n\\nIf your authentication provider returns a CAVV, you must include it.\\n\\nCAVV is mandatory for  the following `eci` values:** 01, 02, 05, 06**\\n\\nAlso known as:\\n  * AVV: Authentication Verification Value\\n  * UCAF: Universal Cardholder Authentication Field \",\n    \"2-0\": \"`cavvAlgorithm`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Algorithm used to compute CAVV Value.\\n\\nOnly required for 1.0.2 Mastercard transactions.\\n\\n**Possible Values:**\\n  * `2`: CVV with ATN\\n  * `3 `: Mastercard SPA algorithm \",\n    \"3-0\": \"`challengeRequired`\",\n    \"3-1\": \"*boolean* \",\n    \"3-2\": \"Optional\",\n    \"4-0\": \"`dsTransactionId`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Transaction ID value from the 3DS server. \\n\\nUUID of 36 characters.\",\n    \"5-0\": \"`eci`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Optional\",\n    \"5-3\": \"ECI: Electronic Commerce Indicator\\n\\nApplicable if using external MPI. \\n\\n**Values for different types of transactions:**\\n  * Fully Authenticated Transaction: **02**,**05**\\n  * Attempted Authentication Transaction: **01,06**\\n  * Non 3-D Secure Transaction: **00,07**\\n\\n**Possible values for MasterCard:** **00**, **01**, **02**\\n\\n**Possible values for all other card types:** **05**, **06**, **07**\",\n    \"6-0\": \"`enrollmentStatus`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Optional\",\n    \"7-0\": \"`networkScore`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"Optional\",\n    \"8-0\": \"`reasonCode`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Optional\",\n    \"10-0\": \"`threeDSecureStatus`\",\n    \"9-0\": \"`threeDSecureReferenceId`\",\n    \"9-1\": \"*string*\",\n    \"9-2\": \"Optional\",\n    \"10-1\": \"*string* \",\n    \"10-2\": \"Optional\",\n    \"11-0\": \"`threeDSecureVersion`\",\n    \"11-1\": \"*string*\",\n    \"11-2\": \"Optional\",\n    \"11-3\": \"The version of 3-D Secure being used. Valid values: \\n* **1.0.2**\\n* **2.1.0**\\n* **2.2.0**\",\n    \"12-0\": \"`xid`\",\n    \"12-1\": \"*string*\",\n    \"12-2\": \"Optional\",\n    \"12-3\": \"Authentication transaction ID\\n\\nBase64 encoded XID obtained from the external MPI.\",\n    \"3-3\": \"**Possible Values:**\\n  * `true`: a challenge was required for this authenticaiton\\n  * `false`: frictionless transaction (no challenge)\",\n    \"7-3\": \"The global score calculated by the CB Scoring platform.\",\n    \"8-3\": \"The error code indicating a an issue with the transaction.\",\n    \"6-3\": \"Status of Authentication eligibility. \\n\\n**Possible Values:**\\n  * `Y` : Yes, Bank is participating in 3-D Secure protocol and will return the ACSUrl\\n  * `N`: No, Bank is not participating in 3-D Secure protocol\\n  * `U`: Unavailable, The DS or ACS is not available for authentication at the time of the request\\n  * `B`: Bypass, Merchant authentication rule is triggered to bypass authentication in this use case \",\n    \"10-3\": \"Payer Authentication Transaction status result identifier.\\n\\n**Possible Values:**\\n  * `Y`: Successful Authentication\\n  * `N`: Failed Authentication/ Account Not Verified/ Transaction Denied\\n  * `U`: Unable to Complete Authentication \\n  * `A`:Successful Attempts Transaction \\n  * `C`: Challenge Required for Authentication\\n  * `R`: Authentication Rejected\\n  * `D`: Challenge Required; Decoupled Authentication confirmed.\\n  * `I`: Informational Only \",\n    \"9-3\": \"The ID of the current 3DS Authentication. The current transaction is linked to the existing 3DS Authentication.\"\n  },\n  \"cols\": 4,\n  \"rows\": 13\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`authenticationResult`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"3-D Secure authentication result.\\n\\n**Possible values: **\\n  * `AUTHENTICATION_BYPASSED`\\n  * `AUTHENTICATION_SUCCEEDED`\\n  * `AUTHENTICATION_UNAVAILABLE`\\n  * `AUTHENTICATION_FAILED`\\n\\nFor more information, refer to [Authentication Results details](https://developers.bluesnap.com/docs/3-d-secure-for-api#section-authentication-results).\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","updates":[],"order":48,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"628531cd1258c8003f6dd25f","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.42 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["628531cd1258c8003f6dd1bf","628531cd1258c8003f6dd1c0","628531cd1258c8003f6dd1c1","628531cd1258c8003f6dd1c2","628531cd1258c8003f6dd1c3","628531cd1258c8003f6dd1c4","628531cd1258c8003f6dd1c5","628531cd1258c8003f6dd1c6","628531cd1258c8003f6dd1c7","628531cd1258c8003f6dd1c8","628531cd1258c8003f6dd1c9","628531cd1258c8003f6dd1ca","628531cd1258c8003f6dd1cb","628531cd1258c8003f6dd1cc","628531cd1258c8003f6dd1cd","628531cd1258c8003f6dd1ce","628531cd1258c8003f6dd1cf","628531cd1258c8003f6dd1d0","628531cd1258c8003f6dd1d1","628531cd1258c8003f6dd1d2"],"_id":"628531cd1258c8003f6dd27d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"622783372cd60c003782d77e","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"628531cd1258c8003f6dd1ca","version":"628531cd1258c8003f6dd27d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-09-04T16:13:43.935Z","__v":0,"parentDoc":null}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

iDEAL Transactions

Local Bank Transfer transactions

SEPA Direct Debit Transactions

Sofort Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

threeDSecure

Contains 3D Secure details for this transaction

Request

Property Name
Type
Required
Description

acsTransactionId

string

Optional

Transaction ID value from the 3DS server.

UUID of 36 characters.

cavv

string

Optional

CAVV: Cardholder Authentication Verification Value

Base64 encoded CAVV obtained from the external MPI.

If your authentication provider returns a CAVV, you must include it.

CAVV is mandatory for the following eci values: 01, 02, 05, 06

Also known as:

  • AVV: Authentication Verification Value
  • UCAF: Universal Cardholder Authentication Field

cavvAlgorithm

string

Optional

Algorithm used to compute CAVV Value.

Only required for 1.0.2 Mastercard transactions.

Possible Values:

  • 2: CVV with ATN
  • 3: Mastercard SPA algorithm

challengeRequired

boolean

Optional

Possible Values:

  • true: a challenge was required for this authenticaiton
  • false: frictionless transaction (no challenge)

dsTransactionId

string

Optional

Transaction ID value from the 3DS server.

UUID of 36 characters.

eci

string

Optional

ECI: Electronic Commerce Indicator

Applicable if using external MPI.

Values for different types of transactions:

  • Fully Authenticated Transaction: 02,05
  • Attempted Authentication Transaction: 01,06
  • Non 3-D Secure Transaction: 00,07

Possible values for MasterCard: 00, 01, 02

Possible values for all other card types: 05, 06, 07

enrollmentStatus

string

Optional

Status of Authentication eligibility.

Possible Values:

  • Y : Yes, Bank is participating in 3-D Secure protocol and will return the ACSUrl
  • N: No, Bank is not participating in 3-D Secure protocol
  • U: Unavailable, The DS or ACS is not available for authentication at the time of the request
  • B: Bypass, Merchant authentication rule is triggered to bypass authentication in this use case

networkScore

string

Optional

The global score calculated by the CB Scoring platform.

reasonCode

string

Optional

The error code indicating a an issue with the transaction.

threeDSecureReferenceId

string

Optional

The ID of the current 3DS Authentication. The current transaction is linked to the existing 3DS Authentication.

threeDSecureStatus

string

Optional

Payer Authentication Transaction status result identifier.

Possible Values:

  • Y: Successful Authentication
  • N: Failed Authentication/ Account Not Verified/ Transaction Denied
  • U: Unable to Complete Authentication
  • A:Successful Attempts Transaction
  • C: Challenge Required for Authentication
  • R: Authentication Rejected
  • D: Challenge Required; Decoupled Authentication confirmed.
  • I: Informational Only

threeDSecureVersion

string

Optional

The version of 3-D Secure being used. Valid values:

  • 1.0.2
  • 2.1.0
  • 2.2.0

xid

string

Optional

Authentication transaction ID

Base64 encoded XID obtained from the external MPI.

Response

Property Name
Type
Description

authenticationResult

string

3-D Secure authentication result.

Possible values:

  • AUTHENTICATION_BYPASSED
  • AUTHENTICATION_SUCCEEDED
  • AUTHENTICATION_UNAVAILABLE
  • AUTHENTICATION_FAILED

For more information, refer to Authentication Results details.