{"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    \"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    \"4-0\": \"`dsTransactionId`\",\n    \"5-0\": \"`threeDSecureVersion`\",\n    \"4-1\": \"*string*\",\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    \"0-0\": \"`threeDSecureReferenceId`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Optional\",\n    \"0-3\": \"The ID of the initial transaction. Links the current transaction to the existing, initial transaction.\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\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\\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":48,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60fed21a76106200102eaeab","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.39 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60fed21a76106200102eae0a","60fed21a76106200102eae0b","60fed21a76106200102eae0c","60fed21a76106200102eae0d","60fed21a76106200102eae0e","60fed21a76106200102eae0f","60fed21a76106200102eae10","60fed21a76106200102eae11","60fed21a76106200102eae12","60fed21a76106200102eae13","60fed21a76106200102eae14","60fed21a76106200102eae15","60fed21a76106200102eae16","60fed21a76106200102eae17","60fed21a76106200102eae18","60fed21a76106200102eae19","60fed21a76106200102eae1a","60fed21a76106200102eae1b","60fed21a76106200102eae1c","613a2bc99ca316007473ee77"],"_id":"60fed21a76106200102eaec3","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"60a40b18fa93ca00237af576","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":"60fed21a76106200102eae15","version":"60fed21a76106200102eaec3","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-09-04T16:13:43.935Z","__v":0,"parentDoc":null}

threeDSecure

Contains 3D Secure details for this transaction

Request

Property Name
Type
Required
Description

threeDSecureReferenceId

string

Optional

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

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.

dsTransactionId

string

Optional

Transaction ID value from the 3DS server.

UUID of 36 characters.

threeDSecureVersion

string

Optional

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

  • 1.0.2
  • 2.1.0
  • 2.2.0

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.