Verify the 3DS challenge response

Methods

POST

Verify the 3DS challenge response

Request

Copied!
{
 "type": "object",
 "required": [
  "transactionReference",
  "challenge",
  "merchant"
 ],
 "properties": {
  "transactionReference": {
   "type": "string",
   "minLength": 1,
   "maxLength": 64,
   "pattern": "[^\"' <>]*"
  },
  "merchant": {
   "type": "object",
   "required": [
    "entity"
   ],
   "properties": {
    "entity": {
     "type": "string",
     "minLength": 1,
     "maxLength": 64,
     "pattern": "^[A-Za-z0-9 ]*$"
    }
   }
  },
  "challenge": {
   "type": "object",
   "required": [
    "reference"
   ],
   "properties": {
    "reference": {
     "type": "string",
     "minLength": 20,
     "maxLength": 20,
     "pattern": "(^[A-Za-z0-9]*$)"
    }
   }
  }
 }
}

Responses

Response schema

Copied!
{
 "type": "object",
 "properties": {
  "outcome": {
   "type": "string",
   "enum": [
    "authenticated",
    "authenticationFailed",
    "unavailable",
    "signatureFailed"
   ]
  },
  "authentication": {
   "type": "object",
   "properties": {
    "authenticationValue": {
     "type": "string"
    },
    "version": {
     "type": "string"
    },
    "eci": {
     "type": "string"
    },
    "transactionId": {
     "type": "string"
    }
   }
  },
  "transactionReference": {
   "type": "string"
  },
  "_links": {
   "type": "object",
   "properties": {
    "3ds:authenticate": {
     "type": "object",
     "required": [
      "href"
     ],
     "properties": {
      "href": {
       "type": "string"
      }
     }
    },
    "3ds:verify": {
     "type": "object",
     "required": [
      "href"
     ],
     "properties": {
      "href": {
       "type": "string"
      }
     }
    },
    "curies": {
     "type": "array",
     "items": {
      "type": "object",
      "properties": {
       "href": {
        "type": "string"
       },
       "templated": {
        "type": "boolean"
       },
       "name": {
        "type": "string"
       }
      }
     },
     "required": [
      "href",
      "templated",
      "name"
     ]
    }
   }
  },
  "required": [
   "curies"
  ]
 },
 "required": [
  "outcome",
  "transactionReference"
 ]
}

Examples

POST
 An example of a 3DS Verification request
View
post
 An example of a 3DS Verification request 
POST https://try.access.worldpay.com/verifications/customers/3ds/verification
Copied!
{
  "Authorization": "Basic auth",
  "Content-Type": "application/vnd.worldpay.verifications.customers-v1.hal+json"
}
Copied!
{
  "transactionReference": "sRMPWCQoQrEiVxehTnu0",
  "merchant": {
    "entity": "entity1"
  },
  "challenge": {
    "reference": "uniqueChallengeRef12"
  }
}

200

Copied!
{
  "Content-Type": "application/vnd.worldpay.verifications.customers-v1.hal+json"
}
Copied!
{
  "outcome": "authenticated",
  "transactionReference": "sRMPWCQoQrEiVxehTnu0",
  "authentication": {
    "version": "1.0.2",
    "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAAA=",
    "eci": "05",
    "transactionId": "k4Vf36ijnJX54kwHQNqUr8"
  },
  "_links": {
    "curies": [
      {
        "href": "https://try.access.worldpay.com/rels/verifications/customers/3ds/{rel}",
        "templated": true,
        "name": "3ds"
      }
    ],
    "3ds:authenticate": {
      "href": "authenticate"
    },
    "3ds:verify": {
      "href": "authenticate/verify"
    }
  }
}