Skip to main content
GET
Get ThreeDS authentication by ID

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

threeDSId
string<uuid>
required

Identifier of the resource in Payrails.

Query Parameters

includeAdditionalFields
boolean
default:false

Boolean indicating if associated additional fields should be included in the response.

includeInstrument
boolean
default:false

Boolean indicating if the payment instrument should be included in the response.

Response

ThreeDS authentication found, and all details are included.

id
string<uuid>
required

Unique identifier of the ThreeDS authentication in Payrails.

createdAt
string<date-time>
required

Exact date and time when the ThreeDS authentication was created in Payrails. Possibly differs slightly from the date in the threeDS provider.

updatedAt
string<date-time>
required

Exact date and time when the ThreeDS authentication was last updated in Payrails. Possibly differs slightly from the date in the ThreeDS provider.

status
enum<string>
required

Current status of the ThreeDS authentication in Payrails.

Available options:
Created,
Versioned,
Failed,
AuthenticationStarted,
Challenged,
Authenticated
providerId
string<uuid>
required

Unique identifier of the Provider that was used to process the ThreeDS authentication.

providerConfigId
string<uuid>
required

Unique identifier of the merchant-specific Provider Configuration that was used to process the ThreeDS authentication. This can include the set of credentials used, the merchant account, etc.

workspaceId
string
required

Workspace ID that the ThreeDS authentication belongs to.

threeDSFlowType
enum<string>

The type of 3DS flow that was used for this authentication.

Available options:
Challenged,
Frictionless,
Unknown
merchantReference
string

Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.

Example:

"order_15415"

holderReference
string

Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.

holderId
string<uuid>

Unique identifier of the Holder in Payrails.

workflowExecutionId
string<uuid>

Merchant-specific identifier of the execution. This can be used for searching for the ThreeDS authentication later.

workflowExecutionActionId
string<uuid>

Identifier of the action in the Workflow that led to this ThreeDS authentication.

providerName
string

Name of the Provider that was used to process the ThreeDS authentication.

providerDisplayName
string

Display name of the Provider that was used to process the ThreeDS authentication.

providerReference
string

Unique identifier of the ThreeDS authentication in an external system, e.g. ThreeDS provider.

providerAccountDisplayName
string

Display name of the Provider Account/Configuration that was used to process the ThreeDS authentication.

instrument
object
instrumentId
string<uuid>

Unique identifier of the Instrument that was used for the Payment in Payrails.

instrumentTokenId
string<uuid>

Unique identifier of the specific Token inside the Instrument used for the Payment in Payrails.

threeDSServerTransID
string

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.

authenticationValue
string

Payment System-specific value provided as part of the ACS registration for each supported DS.

eci
string

Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder.

transStatus
string

Indicates whether a transaction qualifies as an authenticated transaction.

acquirerMerchantId
string

Acquirer-assigned merchant identifier.

acquirerBin
string

Acquiring institution identification code as assigned by the DS receiving the AReq message.

amount
object
meta
object

Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide. See Meta for every field.

additionalFields
object
Last modified on October 7, 2026