v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

ThreeDS

Get ThreeDS authentication by ID

Find a ThreeDS authentication from a given ID.

get/payment/threeds/{threeDSId}

Path parameters

threeDSIdstring uuid required

Identifier of the resource in Payrails.

Query parameters

includeAdditionalFieldsboolean

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

includeInstrumentboolean

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

Response

ThreeDS authentication found, and all details are included.

idstring uuid required

Unique identifier of the ThreeDS authentication in Payrails.

createdAtstring 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.

updatedAtstring 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.

Current status of the ThreeDS authentication in Payrails.

threeDSFlowType'Challenged' | 'Frictionless' | 'Unknown'

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

merchantReferencestring

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

holderReferencestring

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

holderIdstring uuid

Unique identifier of the Holder in Payrails.

workflowExecutionIdstring uuid

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

workflowExecutionActionIdstring uuid

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

providerIdstring uuid required

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

providerConfigIdstring 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.

providerNamestring

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

providerDisplayNamestring

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

providerReferencestring

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

providerAccountDisplayNamestring

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

instrumentIdstring uuid

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

instrumentTokenIdstring uuid

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

threeDSServerTransIDstring

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

authenticationValuestring

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

ecistring

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

transStatusstring

Indicates whether a transaction qualifies as an authenticated transaction.

acquirerMerchantIdstring

Acquirer-assigned merchant identifier.

acquirerBinstring

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

workspaceIdstring required

Workspace ID that the ThreeDS authentication belongs to.

Example response

{
  "merchantReference": "order_15415",
  "instrument": {
    "data": {
      "bin": "416598",
      "binLookup": {
        "bin": "416598"
      }
    }
  },
  "amount": {
    "value": "12.50",
    "currency": "EUR"
  },
  "meta": {
    "order": {
      "storeId": "store-123",
      "reference": "order_3573894940903",
      "placement": {
        "country": {
          "code": "DE"
        },
        "city": "Berlin"
      },
      "deliveryAddress": {
        "city": "Ankeborg",
        "country": {
          "code": "SE"
        },
        "doorNumber": "1",
        "street": "Stargatan",
        "postalCode": "12345",
        "name": "Peter",
        "lastName": "Parker",
        "email": "notbatman@gmail.com"
      },
      "billingAddress": {
        "city": "Ankeborg",
        "country": {
          "code": "SE"
        },
        "doorNumber": "1",
        "street": "Stargatan",
        "postalCode": "12345",
        "name": "Bruno",
        "lastName": "Diaz",
        "email": "iambatman@gmail.com"
      },
      "lines": [
        {
          "id": "123",
          "quantity": 1,
          "taxPercentage": {
            "value": "5"
          },
          "description": "Delicious Beer.",
          "name": "Beer 1",
          "total": {
            "value": "100",
            "currency": "SEK"
          },
          "links": {
            "productUrl": "https://www.amazingmerchant.com/products/1",
            "imageUrl": "https://www.amazingmerchant.com/products/1.jpeg"
          }
        }
      ]
    },
    "customer": {
      "reference": "1231905323475",
      "name": "FirstName",
      "lastName": "LastName",
      "email": "someone@email.com",
      "type": "VIP",
      "country": {
        "code": "SE"
      }
    },
    "clientContext": {
      "ipAddress": "217.110.239.132",
      "osType": "ios",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
      "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
      "language": "nl_NL",
      "colorDepth": 24,
      "screenHeight": 723,
      "screenWidth": 1536,
      "timeZoneOffset": 0,
      "javaEnabled": true,
      "javaScriptEnabled": true,
      "cookiesAccepted": true,
      "origin": "https://merchant.com/checkout",
      "host": "merchant.com"
    },
    "vendor": {
      "reference": "vendor-123",
      "name": "Cool Restaurant"
    },
    "risk": {
      "score": "80",
      "skipPaymentProviderRules": false,
      "force3DS": true,
      "threeDSMode": "Default",
      "allowNative3DS": true,
      "sessionId": "34567890123",
      "exemptionIndicator": "lowValue"
    },
    "subscription": {
      "chargeFrequency": "P2D",
      "expiration": "2000-09-01"
    },
    "tags": {
      "customKey": "customValue"
    }
  }
}