Skip to content
APIs/Payments/3DS actions

3DS actions

If 3DS is enabled additional actions are required

Operations

Supply 3DS device data

Request

Gather additional device data

Security
BasicAuth
Path
linkDatastringrequired
Headers
WP-Api-Versionstringrequired

The API version

Value:"2024-06-01"
Example:2024-06-01
Bodyapplication/json
collectionReferencestring

Add the sessionId provided in the postMessage for the Device Data Collection (DDC) form (web) or for native (iOS/Android), returned as consumerSessionId as part of SDK initialization.

Note: If DDC fails you can attempt the payment without this value, but you will see an increased number of challenged and even authenticationFailed outcomes, if this happens for a lot of requests.

{
  "collectionReference": "string"
}

Responses

Created

Bodyapplication/json
outcomestring
Enum:"authorized""refused""3dsChallenged""3dsAuthenticationFailed""3dsUnavailable"
Discriminator
paymentIdstring^[A-Za-z0-9_-]+$

Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.

commandIdstring^[A-Za-z0-9_-]+$

Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.

transactionReferencestring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`/+]*$

A unique reference generated by you that is used to identify a payment throughout its lifecycle.

paymentInstrumentobject

Details of the paymentInstrument used.

updatedPaymentInstrumentobject
issuerobject
riskFactorsArray of objects

Any risk factors which have been identified for the authorization. This section will not appear if no risks are identified.

fraudobject

Details of the outcome of the Fraud assessment

threeDSobject
exemptionobject

An object containing information about the exemption.

schemeReferencestring

An object containing information returned by the scheme.

tokenobject

An object including the token details you have asked us to create.

merchantobject
amountsobject

An object containing transaction amounts. Returned for partial authorizations.

_actionsobject
Response

As an additional fraud measure the issuer requests a 3DS challenge to be performed

{
  "outcome": "3dsChallenged",
  "transactionReference": "Memory265-13/08/1876",
  "authentication": {
    "version": "2.1.0"
  },
  "challenge": {
    "reference": "706hovL8DK1tIGGzQUV1",
    "url": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp",
    "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJPcmdVbml0SWQiOiI2NjAzMDA3YWJlMjMxZTM1ZTNmNTRjODkiLCJPYmplY3RpZnlQYXlsb2FkIjpmYWxzZSwiaXNzIjoiNjYwMzAwN2ExNmRkOWE3ZTZhMDMzNDA3IiwiUmV0dXJuVXJsIjoiaHR0cDovL3BheW1lbnQuZXhhbXBsZS5jb20iLCJQYXlsb2FkIjoie1wiUGF5bG9hZFwiOlwiZXlKdFpYTnpZV2RsVkhsd1pTSTZJa05TWlhFaUxDSnRaWE56WVdkbFZtVnljMmx2YmlJNklqSXVNUzR3SWl3aWRHaHlaV1ZFVTFObGNuWmxjbFJ5WVc1elNVUWlPaUppTkRKbE5UWmpaaTAyWkRrMkxUUXpNek10T0dJMk5DMWlNbVU0TldZMFpURTFaVGtpTENKaFkzTlVjbUZ1YzBsRUlqb2laV1ZqWldZeE1ETXRNRE13TVMwMFpUbGtMVGsxTmpFdE56ZGlNbVkzTlRFMk5HUmhJaXdpWTJoaGJHeGxibWRsVjJsdVpHOTNVMmw2WlNJNklqQTBJbjBcIixcIkFDU1VybFwiOlwiaHR0cHM6XFwvXFwvMW1lcmNoYW50YWNzc3RhZy5jYXJkaW5hbGNvbW1lcmNlLmNvbVxcL01lcmNoYW50QUNTV2ViXFwvY3JlcS5qc3BcIixcIlRyYW5zYWN0aW9uSWRcIjpcIjcwNmhvdkw4REsxdElHR3pRVVYxXCJ9IiwiZXhwIjoxNzEyMzA2MDk0LCJpYXQiOjE3MTIzMDU0OTQsImp0aSI6IjE4YTIwYzNkLTZhZmMtNDA5My04NGEwLTQ2OGEyYTY5MTE0OCJ9.YEpOuTxnqrXRiHan-givWBd6FfTDJOfNg-h2dF2yA6A",
    "payload": "eyJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMS4wIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiJiNDJlNTZjZi02ZDk2LTQzMzMtOGI2NC1iMmU4NWY0ZTE1ZTkiLCJhY3NUcmFuc0lEIjoiZWVjZWYxMDMtMDMwMS00ZTlkLTk1NjEtNzdiMmY3NTE2NGRhIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA0In0"
  },
  "_actions": {
    "complete3dsChallenge": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiZXlOaXNtU0lzQnVLTm5BQkt1WjEyMVFxeXg2bUZtb2hEcEpFeDdyYXZ3SDE3NFBpUTBsWUpwekptbW9hR3VVSyJ9/3dsChallenges",
      "method": "POST"
    }
  }
}