Skip to content
APIs/3DS/Internal

Internal

These actions will be filtered out of the merchant facing API reference using this redocly decorator. Added but disabled on this branch.

decorators:
  remove-x-internal: on

For use internally by the service hosting the 3ds page

Operations

Device Data Initialization
internal

Request

Details required for device data collection

Security
BasicAuth
Path
keystringrequired

Unique short lived value generated by us and used as part of the redirect url path.

Headers
WP-Api-Versionstringrequired

The API version.

Value:"2026-10-01"
Example:2026-10-01
curl -i -X POST \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/3ds/deviceData/{key}/initialization' \
  -H 'WP-Api-Version: 2026-10-01'

Responses

The challenge was successful - obtain the authentication data for onward use.

Bodyapplication/json
providerstringrequired

The outcome of the authentication request.

Enum:"cardinal""ravelin"
Discriminator
jwtstring, [ 1 .. 2048 ] characters

A digitally signed token that contains additional details required for DDC.

urlstring, [ 1 .. 2048 ] characters

A POST action on the DDC form. Used to redirect to the issuers DDC page.

binstring

First six digits of the card number (Bank Identification Number), used as part of DDC. Returned if a token resource, network payment token or card number is included in the request.

Response

Cardinal device data collection

{
  "provider": "cardinal",
  "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJPcmdVbml0SWQiOiI2NjAzMDA3YWJlMjMxZTM1ZTNmNTRjODkiLCJpc3MiOiI2NjAzMDA3YTE2ZGQ5YTdlNmEwMzM0MDciLCJleHAiOjE3Mjk2ODA1NzksImlhdCI6MTcyOTY3OTk3OSwianRpIjoiNWMyZDk3NDctOGVhOC00MDg3LTg0MDgtZGIxYTFlOWE2MjQ1In0._82c7r-EkZpbwzxBhQK-KuF277iYg54TCYPxIp0G0uk",
  "url": "https://{new-visa-data-centre-url}.com/V2/Cruise/Collect",
  "bin": "400000"
}