{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"three-d-secure","type":"basic","slug":"three-d-secure","excerpt":"Contains 3-D 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\": \"`three-d-secure-result-token`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Optional\",\n    \"0-3\": \"The 3-D Secure result token obtained from the Client-Side Encryption library. See [3-D Secure in Client-Side Encryption](/docs/3d-secure#section-3d-secure-in-client-side-encryption) for more details.\",\n    \"1-0\": \"`eci`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"ECI: Electronic Commerce Indicator\\n\\nApplicable if using external MPI. \\n\\nValues 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\\nPossible values for MasterCard: **00**, **01**, **02**\\n\\nPossible values for all other card types: **05**, **06**, **07**\",\n    \"2-0\": \"`cavv`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Optional\",\n    \"2-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:<ul><li>AVV: Authentication Verification Value</li>\\n<li>UCAF: Universal Cardholder Authentication Field</li></ul></li>\\n</ul>\",\n    \"3-0\": \"`xid`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Authentication transaction ID\\n\\nBase64 encoded XID obtained from the external MPI.\\n\\n3-D Secure 2.0: only required for Amex.\",\n    \"4-0\": \"`ds-transaction-id`\",\n    \"4-1\": \"*string*\",\n    \"5-0\": \"`three-d-secure-version`\",\n    \"5-1\": \"*string*\",\n    \"4-2\": \"Optional\",\n    \"5-2\": \"Optional\",\n    \"4-3\": \"Transaction ID value from the 3DS server. \\n\\nUUID of 36 characters.\",\n    \"5-3\": \"The version of 3-D Secure being used. Valid values: \\n* **1.0.2**\\n* **2.1.0**\\n* **2.2.0**\",\n    \"6-0\": \"`three-d-secure-reference-id`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Optional\",\n    \"6-3\": \"The ID of the initial transaction. Links the current transaction to the existing, initial transaction.\"\n  },\n  \"cols\": 4,\n  \"rows\": 7\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\": \"`authentication-result`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"3-D Secure authentication result.\\n\\nPossible values: \\n\\n <ul>\\n<li>**AUTHENTICATION_BYPASSED**</li>\\n<li>**AUTHENTICATION_SUCCEEDED**</li>\\n<li>**AUTHENTICATION_UNAVAILABLE**</li>\\n<li>**AUTHENTICATION_FAILED**</li>\\n</ul>\\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":113,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d6fe2146f818f002e8e548a","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"Main","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5c742637ad58c70033b9c699","5c742637ad58c70033b9c69a","5c742637ad58c70033b9c69b","5c742637ad58c70033b9c69c","5c742637ad58c70033b9c69d","5c742637ad58c70033b9c69e","5c742637ad58c70033b9c69f","5c742637ad58c70033b9c6a0","5c742637ad58c70033b9c6a1","5c742637ad58c70033b9c6a2","5c742637ad58c70033b9c6a3"],"_id":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedbcf19b49e8004462d199","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"5c742637ad58c70033b9c6a1","version":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-09-04T16:11:00.427Z","__v":0,"parentDoc":null}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

three-d-secure

Contains 3-D Secure details for this transaction

Request

Property Name
Type
Required
Description

three-d-secure-result-token

string

Optional

The 3-D Secure result token obtained from the Client-Side Encryption library. See 3-D Secure in Client-Side Encryption for more details.

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

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

xid

string

Optional

Authentication transaction ID

Base64 encoded XID obtained from the external MPI.

3-D Secure 2.0: only required for Amex.

ds-transaction-id

string

Optional

Transaction ID value from the 3DS server.

UUID of 36 characters.

three-d-secure-version

string

Optional

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

  • 1.0.2
  • 2.1.0
  • 2.2.0

three-d-secure-reference-id

string

Optional

The ID of the initial transaction. Links the current transaction to the existing, initial transaction.

Response

Property Name
Type
Description

authentication-result

string

3-D Secure authentication result.

Possible values:


  • AUTHENTICATION_BYPASSED

  • AUTHENTICATION_SUCCEEDED

  • AUTHENTICATION_UNAVAILABLE

  • AUTHENTICATION_FAILED

For more information, refer to Authentication Results details.