Adyen Authorise3ds2 API

The Authorise3ds2 API from Adyen — 1 operation(s) for authorise3ds2.

Operations 1

POST /authorise3ds2 Adyen Complete a 3DS2 Authorisation #

Documentation

📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/configure-notifications/
📖
Documentation
https://docs.adyen.com/api-explorer/Account/6/overview
📖
Documentation
https://docs.adyen.com/development-resources/webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/BalanceControl/1/overview
📖
Documentation
https://docs.adyen.com/api-explorer/BinLookup/52/overview
📖
Documentation
https://docs.adyen.com/api-explorer/Checkout/71/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform/2/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/development-resources/data-protection-api/
📖
Documentation
https://docs.adyen.com/risk-management/disputes-api
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/fund-transfer/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/legal-entity-management-api/
📖
Documentation
https://docs.adyen.com/api-explorer/Management/3/overview
📖
Documentation
https://docs.adyen.com/api-explorer/management-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/notifications
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/notifications/
📖
Documentation
https://docs.adyen.com/online-payments/
📖
Documentation
https://docs.adyen.com/online-payments/online-payouts
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/
📖
Documentation
https://docs.adyen.com/online-payments/tokenization
📖
Documentation
https://docs.adyen.com/api-explorer/report-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/payment-methods/gift-cards/stored-value-api/
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/terminal-api-reference/
📖
Documentation
https://docs.adyen.com/development-resources/testing/create-test-cards
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/business-accounts/transactions/transaction-webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/transfer-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/on-demand-payouts
📖
Documentation
https://docs.adyen.com/development-resources/webhooks

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/adyen-authorise3ds2-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adyen-authorise3ds2-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '68'
  x-publicVersion: true
  title: Adyen Payment Authorise3ds2 API
  description: "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v68/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**."
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://pal-test.adyen.com/pal/servlet/Payment/v68
tags:
- name: Authorise3ds2
paths:
  /authorise3ds2:
    post:
      tags:
      - Authorise3ds2
      summary: Adyen Complete a 3DS2 Authorisation
      description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.


        > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.'
      x-addedInVersion: '37'
      operationId: post-authorise3ds2
      x-sortIndex: 3
      x-methodName: authorise3ds2
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              authorise3ds2:
                $ref: '#/components/examples/post-authorise3ds2-authorise3ds2'
            schema:
              $ref: '#/components/schemas/PaymentRequest3ds2'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResult'
              examples:
                post-authorise3ds2200Example:
                  summary: Default post-authorise3ds2 200 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    authCode: CODE123
                    dccAmount: 1000
                    dccSignature: example_value
                    fraudResult: example_value
                    issuerUrl: https://example.com/resource
                    md: example_value
                    paRequest: example_value
                    pspReference: REF-001
                    refusalReason: REF-001
                    resultCode: AuthenticationFinished
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-authorise3ds2403Example:
                  summary: Default post-authorise3ds2 403 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-authorise3ds2422Example:
                  summary: Default post-authorise3ds2 422 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  examples:
    post-authorise3ds2-authorise3ds2:
      summary: Submit 3D Secure 2 authentication data to the issuer
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        amount:
          currency: EUR
          value: 1000
        reference: YOUR_ORDER_NUMBER
        threeDS2RequestData:
          deviceChannel: app
          threeDSCompInd: Y
        threeDS2Token: — - BINARY DATA - -
    generic-401:
      summary: Response code 401. Unauthorized.
      value:
        status: 401
        errorCode: '000'
        message: HTTP Status Response - Unauthorized
        errorType: security
    generic-500:
      summary: Response code 500. Internal server error.
      value:
        status: 500
        errorCode: '905'
        message: Payment details are not supported
        errorType: configuration
        pspReference: '8516091485743033'
    generic-400:
      summary: Response code 400. Bad request.
      value:
        status: 400
        errorCode: '702'
        message: 'Unexpected input: ", expected: }'
        errorType: validation
  schemas:
    AdditionalData3DSecure:
      properties:
        allow3DS2:
          description: "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\nor send the `executeThreeD` parameter.\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n"
          type: string
        challengeWindowSize:
          description: "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          type: string
        executeThreeD:
          description: "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive  or other, national regulations. \n"
          type: string
        mpiImplementationType:
          description: In case of Secure+, this field must be set to **CUPSecurePlus**.
          type: string
        scaExemption:
          description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** "
          type: string
        threeDSVersion:
          description: "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n"
          type: string
      type: object
    MerchantDevice:
      properties:
        os:
          description: Operating system running on the merchant device.
          type: string
        osVersion:
          description: Version of the operating system on the merchant device.
          type: string
        reference:
          description: Merchant device reference.
          type: string
      type: object
    ResponseAdditionalDataSepa:
      properties:
        sepadirectdebit.dateOfSignature:
          description: 'The transaction signature date.


            Format: yyyy-MM-dd'
          type: string
        sepadirectdebit.mandateId:
          description: Its value corresponds to the pspReference value of the transaction.
          type: string
        sepadirectdebit.sequenceType:
          description: 'This field can take one of the following values:

            * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.


            * First: (FRST) Initial/first collection in a series of direct debit instructions.

            * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.

            * Final: (FNAL) Last/final collection in a series of direct debit instructions.


            Example: OOFF'
          type: string
      type: object
    PaymentRequest3ds2:
      properties:
        accountInfo:
          x-addedInVersion: '40'
          description: 'Shopper account information for 3D Secure 2.

            > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.'
          $ref: '#/components/schemas/AccountInfo'
        additionalAmount:
          description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while the amount must be still set to 0 to trigger BIN or card verification).

            Required to be in the same currency as the `amount`. '
          $ref: '#/components/schemas/Amount'
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/AdditionalData3DSecure'
          - $ref: '#/components/schemas/AdditionalDataAirline'
          - $ref: '#/components/schemas/AdditionalDataCarRental'
          - $ref: '#/components/schemas/AdditionalDataCommon'
          - $ref: '#/components/schemas/AdditionalDataLevel23'
          - $ref: '#/components/schemas/AdditionalDataLodging'
          - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
          - $ref: '#/components/schemas/AdditionalDataOpi'
          - $ref: '#/components/schemas/AdditionalDataRatepay'
          - $ref: '#/components/schemas/AdditionalDataRetry'
          - $ref: '#/components/schemas/AdditionalDataRisk'
          - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
          - $ref: '#/components/schemas/AdditionalDataSubMerchant'
          - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
          - $ref: '#/components/schemas/AdditionalDataWallets'
          description: 'This field contains additional data, which may be required for a particular payment request.


            The `additionalData` object consists of entries, each of which includes the key and value.'
          type: object
        amount:
          description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          x-addedInVersion: '40'
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        billingAddress:
          x-addedInVersion: '4'
          description: 'The address where to send the invoice.

            > The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.

            >* For 3D Secure 2 transactions in all browser-based and mobile implementations.

            >* For cross-border payouts to and from Canada.'
          $ref: '#/components/schemas/Address'
        browserInfo:
          description: 'The shopper''s browser information.

            > For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate  that your integration can support a redirect in case a payment is routed to 3D Secure 1.'
          $ref: '#/components/schemas/BrowserInfo'
        captureDelayHours:
          x-addedInVersion: '2'
          description: The delay between the authorisation and scheduled auto-capture, specified in hours.
          format: int32
          type: integer
        dateOfBirth:
          x-addedInVersion: '7'
          description: 'The shopper''s date of birth.


            Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
          format: date
          type: string
        dccQuote:
          description: The forex quote as returned in the response of the forex service.
          $ref: '#/components/schemas/ForexQuote'
        deliveryAddress:
          description: The address where the purchased goods should be delivered.
          $ref: '#/components/schemas/Address'
        deliveryDate:
          x-addedInVersion: '8'
          description: 'The date and time the purchased goods should be delivered.


            Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD


            Example: 2017-07-17T13:42:40.428+01:00'
          format: date-time
          type: string
        deviceFingerprint:
          x-addedInVersion: '2'
          description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
          maxLength: 5000
          type: string
        fraudOffset:
          description: An integer value that is added to the normal fraud score. The value can be either positive or negative.
          format: int32
          type: integer
        installments:
          x-addedInVersion: '4'
          description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
          $ref: '#/components/schemas/Installments'
        localizedShopperStatement:
          x-addedInVersion: '68'
          additionalProperties:
            type: string
          description: "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters."
          type: object
        mcc:
          x-addedInVersion: '12'
          description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
          type: string
        merchantAccount:
          description: The merchant account identifier, with which you want to process the transaction.
          type: string
        merchantOrderReference:
          x-addedInVersion: '9'
          description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.

            The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.

            > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
          type: string
        merchantRiskIndicator:
          x-addedInVersion: '40'
          description: 'Additional risk fields for 3D Secure 2.

            > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.'
          $ref: '#/components/schemas/MerchantRiskIndicator'
        metadata:
          x-addedInVersion: '17'
          additionalProperties:
            type: string
          description: 'Metadata consists of entries, each of which includes a key and a value.

            Limits:

            * Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".

            * Maximum 20 characters per key.

            * Maximum 80 characters per value. '
          type: object
        orderReference:
          description: When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.
          type: string
        recurring:
          description: The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).
          $ref: '#/components/schemas/Recurring'
        recurringProcessingModel:
          x-addedInVersion: '30'
          description: 'Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.

            Allowed values:

            * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.

            * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.

            * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder''s balance drops below a certain amount.

            '
          enum:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: string
        reference:
          description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.

            If you need to provide multiple references for a transaction, separate them with hyphens ("-").

            Maximum length: 80 characters.'
          type: string
        selectedBrand:
          description: 'Some payment methods require defining a value for this field to specify how to process the transaction.


            For the Bancontact payment method, it can be set to:

            * `maestro` (default), to be processed like a Maestro card, or

            * `bcmc`, to be processed like a Bancontact card.'
          type: string
        selectedRecurringDetailReference:
          description: The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
          type: string
        sessionId:
          description: A session ID used to identify a payment session.
          type: string
        shopperEmail:
          description: 'The shopper''s email address. We recommend that you provide this data, as it is used in velocity fraud checks.

            > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.'
          type: string
        shopperIP:
          description: 'The shopper''s IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).

            > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.

            This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
          type: string
        shopperInteraction:
          description: 'Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.

            For the web service API, Adyen assumes Ecommerce shopper interaction by default.


            This field has the following possible values:

            * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.

            * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).

            * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.

            * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.'
          enum:
          - Ecommerce
          - ContAuth
          - Moto
          - POS
          type: string
        shopperLocale:
          x-addedInVersion: '7'
          description: The combination of a language code and a country code to specify the language to be used in the payment.
          type: string
        shopperName:
          x-addedInVersion: '7'
          description: The shopper's full name.
          $ref: '#/components/schemas/Name'
        shopperReference:
          description: "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address."
          type: string
        shopperStatement:
          description: "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**."
          type: string
        socialSecurityNumber:
          x-addedInVersion: '4'
          description: The shopper's social security number.
          type: string
        splits:
          x-addedInVersion: '37'
          description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        store:
          x-addedInVersion: '23'
          description: 'The ecommerce or point-of-sale store that is processing the payment. Used in:


            * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).

            * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).'
          maxLength: 16
          minLength: 1
          type: string
        telephoneNumber:
          x-addedInVersion: '7'
          description: The shopper's telephone number.
          type: string
        threeDS2RequestData:
          x-addedInVersion: '40'
          description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
          $ref: '#/components/schemas/ThreeDS2RequestData'
        threeDS2Result:
          description: Thre ThreeDS2Result that was returned in the final CRes.
          $ref: '#/components/schemas/ThreeDS2Result'
        threeDS2Token:
          description: The ThreeDS2Token that was returned in the /authorise call.
          type: string
        threeDSAuthenticationOnly:
          x-addedInVersion: '50'
          default: false
          description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
          type: boolean
        totalsGroup:
          x-addedInVersion: '23'
          description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
          maxLength: 16
          minLength: 1
          type: string
        trustedShopper:
          x-addedInVersion: '37'
          description: Set to true if the payment should be routed to a trusted MID.
          type: boolean
      required:
      - merchantAccount
      - reference
      - amount
      type: object
    Installments:
      properties:
        plan:
          x-addedInVersion: '64'
          description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values:

            * **regular**

            * **revolving**

            '
          enum:
          - regular
          - revolving
          type: string
        value:
          description: 'Defines the number of installments. Its value needs to be greater than zero.


            Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.'
          format: int32
          type: integer
      required:
      - value
      type: object
    AdditionalDataRiskStandalone:
      properties:
        PayPal.CountryCode:
          description: Shopper's country of residence in the form of ISO standard 3166 2-character country codes.
          type: string
        PayPal.EmailId:
          description: Shopper's email.
          type: string
        PayPal.FirstName:
          description: Shopper's first name.
          type: string
        PayPal.LastName:
          description: Shopper's last name.
          type: string
        PayPal.PayerId:
          description: 'Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.'
          type: string
        PayPal.Phone:
          description: Shopper's phone number.
          type: string
        PayPal.ProtectionEligibility:
          description: 'Allowed values:

            * **Eligible** — Merchant is protected by PayPal''s Seller Protection Policy for Unauthorized Payments and Item Not Received.


            * **PartiallyEligible** — Merchant is protected by PayPal''s Seller Protection Policy for Item Not Received.


            * **Ineligible** — Merchant is not protected under the Seller Protection Policy.'
          type: string
        PayPal.TransactionId:
          description: Unique transaction ID of the payment.
          type: string
        avsResultRaw:
          description: 'Raw AVS result received from the acquirer, where available. Example: D'
          type: string
        bin:
          description: The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).
          type: string
        cvcResultRaw:
          description: 'Raw CVC result received from the acquirer, where available. Example: 1'
          type: string
        riskToken:
          description: Unique identifier or token for the shopper's card details.
          type: string
        threeDAuthenticated:
          description: 'A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true'
          type: string
        threeDOffered:
          description: 'A Boolean value indicating whether 3DS was offered for this payment. Example: true'
          type: string
        tokenDataType:
          description: 'Required for PayPal pa

# --- truncated at 32 KB (154 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-authorise3ds2-api-openapi.yml