v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

ThreeDS

Search & list ThreeDS entities

Fetch a list of ThreeDS entities.

get/payment/threeds

Query parameters

includeInstrumentboolean

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

includeAdditionalFieldsboolean

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

filter[instrumentId]string

Filter for a list of threeds by instrument ID.

filter[instrumentBin]string

Filter for a list of threeds by instrument BIN.

filter[instrumentSuffix]string

Filter for a list of threeds by instrument suffix.

filter[instrumentNetwork]string

Filter for a list of threeds by card network.

filter[instrumentIssuer]string

Filter for a list of threeds by instrument issuer.

filter[instrumentIssuerCountry]string

Filter for a list of threeds by instrument issuer country.

filter[instrumentFutureUsage]string

Filter for a list of threeds by instrument future usage.

filter[workflowExecutionId]string

Filter for a list of threeds by workflow execution id.

filter[merchantReference]string

Filter for a list of threeds by merchant reference.

filter[providerReference]string

Filter for a list of threeds by provider reference.

filter[threeDSServerTransId]string

Filter for a list of threeds by serverTransId.

filter[status]string

Filter for a list of threeds by threeds status.

filter[providerId]string

Filter for a list of threeds by provider ID.

filter[providerConfigId]string

Filter for a list of threeds by provider config ID.

filter[workspaceId]string

Filter by Workspace ID.

filter[createdAt]string

Example:[2026-04-01T00:00:00Z,2026-05-01T00:00:00Z)

Filter by createdAt field using interval notation.

1973-02-03T04:32:11.596Z - exact date value

(1973-02-03T04:32:11.596Z - after the date excluding it

[1973-02-03T04:32:11.596Z - after the date including it

1973-02-03T04:32:11.596Z) - before the date excluding it

1973-02-03T04:32:11.596Z] - before the date including it

(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z) - between two dates excluding both

(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z] - between two dates excluding on the left

[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z) - between two dates excluding on the right

[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z] - between two dates including both.

page[cursor]string

Cursor for paging results.

Search collection items from that cursor.

page[after]string

Cursor for paging results.

Search collection items after that cursor.

page[before]string

Cursor for paging results.

Search collection items before that cursor.

page[size]integer

Length of the collection to search.

Response

Success.

Example response

{
  "results": [
    {
      "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"
        }
      }
    }
  ]
}