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": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$"
},
"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]*$)"
}
}
}
}
}
{ "type": "object", "required": [ "transactionReference", "challenge", "merchant" ], "properties": { "transactionReference": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$" }, "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",
"bypassed"
]
},
"authentication": {
"type": "object",
"properties": {
"version": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"eci": {
"type": "string",
"minLength": 1,
"maxLength": 2
},
"authenticationValue": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"transactionId": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
},
"transactionReference": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"_links": {
"type": "object",
"properties": {
"3ds:authenticate": {
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"minLength": 1,
"maxLength": 2048
}
}
},
"3ds:verify": {
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"minLength": 1,
"maxLength": 2048
}
}
},
"curies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"templated": {
"type": "boolean"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
},
"required": [
"href",
"templated",
"name"
]
}
}
},
"required": [
"curies"
]
},
"required": [
"outcome",
"transactionReference"
]
}
{ "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "authenticated", "authenticationFailed", "unavailable", "signatureFailed", "bypassed" ] }, "authentication": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1, "maxLength": 10 }, "eci": { "type": "string", "minLength": 1, "maxLength": 2 }, "authenticationValue": { "type": "string", "minLength": 1, "maxLength": 64 }, "transactionId": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "transactionReference": { "type": "string", "minLength": 1, "maxLength": 64 }, "_links": { "type": "object", "properties": { "3ds:authenticate": { "type": "object", "required": [ "href" ], "properties": { "href": { "type": "string", "minLength": 1, "maxLength": 2048 } } }, "3ds:verify": { "type": "object", "required": [ "href" ], "properties": { "href": { "type": "string", "minLength": 1, "maxLength": 2048 } } }, "curies": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "minLength": 1, "maxLength": 2048 }, "templated": { "type": "boolean" }, "name": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "required": [ "href", "templated", "name" ] } } }, "required": [ "curies" ] }, "required": [ "outcome", "transactionReference" ] }
Examples
An example of a 3DS Verification request
POSThttps://try.access.worldpay.com/verifications/customers/3ds/verification
Copied!
{
"Authorization": "Basic dXNlcjE6cGFzc3dvcmQ=",
"Content-Type": "application/vnd.worldpay.verifications.customers-v3.hal+json"
}
{ "Authorization": "Basic dXNlcjE6cGFzc3dvcmQ=", "Content-Type": "application/vnd.worldpay.verifications.customers-v3.hal+json" }
Copied!
{
"transactionReference": "sRMPWCQoQrEiVxehTnu0",
"merchant": {
"entity": "entity1"
},
"challenge": {
"reference": "uniqueChallengeRef12"
}
}
{ "transactionReference": "sRMPWCQoQrEiVxehTnu0", "merchant": { "entity": "entity1" }, "challenge": { "reference": "uniqueChallengeRef12" } }
200
Copied!
{
"Content-Type": "application/vnd.worldpay.verifications.customers-v3.hal+json"
}
{ "Content-Type": "application/vnd.worldpay.verifications.customers-v3.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"
}
}
}
{ "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" } } }