Adyen · JSON Structure

Checkout Payment Details Request Structure

PaymentDetailsRequest schema from Adyen API

Type: object Properties: 4 Required: 1
PaymentsFinancial ServicesFintech

PaymentDetailsRequest is a JSON Structure definition published by Adyen, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

authenticationData details paymentData threeDSAuthenticationOnly

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/checkout-payment-details-request-structure.json",
  "description": "PaymentDetailsRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "authenticationData": {
      "x-addedInVersion": "69",
      "description": "Data for 3DS authentication.",
      "$ref": "#/components/schemas/DetailsRequestAuthenticationData"
    },
    "details": {
      "description": "Use this collection to submit the details that were returned as a result of the `/payments` call.",
      "$ref": "#/components/schemas/PaymentCompletionDetails"
    },
    "paymentData": {
      "description": "Encoded payment data. For [authorizing a payment after using 3D Secure 2 Authentication-only](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only/#authorise-the-payment-with-adyen):\n\nIf you received `resultCode`: **AuthenticationNotRequired** in the `/payments` response, use the `threeDSPaymentData` from the same response.\n\nIf you received `resultCode`: **AuthenticationFinished** in the `/payments` response, use the `action.paymentData` from the same response.",
      "maxLength": 200000,
      "type": "string"
    },
    "threeDSAuthenticationOnly": {
      "x-addedInVersion": "40",
      "deprecated": true,
      "x-deprecatedInVersion": "69",
      "x-deprecatedMessage": "Use `authenticationData.authenticationOnly` instead.",
      "description": "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.",
      "type": "boolean"
    }
  },
  "required": [
    "details"
  ],
  "name": "PaymentDetailsRequest"
}