diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index 077fc30..ca50b2a 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -894,7 +894,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -2554,7 +2554,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -2701,7 +2701,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -2811,7 +2811,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -2939,7 +2939,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -3545,12 +3545,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -3701,7 +3718,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -3720,7 +3737,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index 3133da1..e23bd21 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -1130,7 +1130,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -2904,7 +2904,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -3061,7 +3061,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -3171,7 +3171,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -3309,7 +3309,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -3920,12 +3920,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -4170,7 +4187,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -4189,7 +4206,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index 8f53bec..b0f1b47 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -1596,7 +1596,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3650,7 +3650,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -3812,7 +3812,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -3950,7 +3950,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4093,7 +4093,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4231,7 +4231,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4366,7 +4366,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5042,12 +5042,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -5556,7 +5573,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -5575,7 +5592,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index 91396a9..3f3d5e0 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -1596,7 +1596,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3670,7 +3670,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -3832,7 +3832,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -3970,7 +3970,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4113,7 +4113,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4251,7 +4251,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4386,7 +4386,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5067,12 +5067,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -5594,7 +5611,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -5613,7 +5630,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index a8a189f..7441223 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -1596,7 +1596,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3670,7 +3670,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -3832,7 +3832,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -3970,7 +3970,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4113,7 +4113,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4251,7 +4251,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4386,7 +4386,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5067,12 +5067,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -5629,7 +5646,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -5648,7 +5665,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index 3926641..188e007 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -1606,7 +1606,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3680,7 +3680,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -3842,7 +3842,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -3986,7 +3986,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4129,7 +4129,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4273,7 +4273,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4408,7 +4408,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5095,12 +5095,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -5677,7 +5694,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -5696,7 +5713,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index 82e441e..079acf3 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -1720,7 +1720,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3826,7 +3826,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -3994,7 +3994,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4138,7 +4138,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4287,7 +4287,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4431,7 +4431,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4572,7 +4572,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5259,12 +5259,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -5871,7 +5888,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -5890,7 +5907,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index e9fec09..3bdb11a 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -1720,7 +1720,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3826,7 +3826,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4003,7 +4003,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4147,7 +4147,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4296,7 +4296,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4440,7 +4440,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4581,7 +4581,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5268,12 +5268,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -5880,7 +5897,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -5899,7 +5916,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index 6b63dc5..3a5738d 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -1720,7 +1720,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3559,7 +3559,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "subMerchant" : { @@ -3917,7 +3917,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4104,7 +4104,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4248,7 +4248,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4397,7 +4397,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4541,7 +4541,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4682,7 +4682,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5369,12 +5369,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -6007,7 +6024,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -6026,7 +6043,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v67.json b/json/PaymentService-v67.json index aef0400..9200708 100644 --- a/json/PaymentService-v67.json +++ b/json/PaymentService-v67.json @@ -1720,7 +1720,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3559,7 +3559,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "subMerchant" : { @@ -3917,7 +3917,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4098,7 +4098,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4242,7 +4242,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4385,7 +4385,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4529,7 +4529,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4664,7 +4664,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5343,12 +5343,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -6011,7 +6028,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -6044,7 +6061,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/json/PaymentService-v68.json b/json/PaymentService-v68.json index a5de2c9..006b198 100644 --- a/json/PaymentService-v68.json +++ b/json/PaymentService-v68.json @@ -1856,7 +1856,7 @@ "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", + "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* **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.\n* If you the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } }, @@ -3725,7 +3725,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "subMerchant" : { @@ -4125,7 +4125,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4324,7 +4324,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4468,7 +4468,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4619,7 +4619,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -4763,7 +4763,7 @@ "$ref" : "#/components/schemas/Address" }, "browserInfo" : { - "description" : "The shopper's browser information.\n> 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.", + "description" : "The shopper's browser information.\n> 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 2 redirect.", "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { @@ -4906,7 +4906,7 @@ "$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.", + "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.\n> Your reference must not include personally identifiable information (PII) such as name or email address.", "type" : "string" }, "shopperStatement" : { @@ -5633,12 +5633,29 @@ "description" : "The 3D Secure 2 version.", "type" : "string" }, + "tokenization.shopperReference" : { + "description" : "The provided reference of the shopper.", + "type" : "string" + }, + "tokenization.store.operationType" : { + "description" : "The store operation performed on the token.", + "enum" : [ + "created", + "updated", + "alreadyStored" + ], + "type" : "string" + }, + "tokenization.storedPaymentMethodId" : { + "description" : "The reference that uniquely identifies tokenized payment details.", + "type" : "string" + }, "visaTransactionId" : { "description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type" : "string" }, "xid" : { - "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", + "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } }, @@ -6540,7 +6557,7 @@ "additionalProperties" : false, "properties" : { "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", + "description" : "In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.\n\n", "enum" : [ "Y", "N", @@ -6573,7 +6590,7 @@ "type" : "string" }, "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", + "description" : "In 3D Secure 2, this is the `transStatus` from the `ARes`.\n\n", "enum" : [ "A", "C", diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index aff3a4b..cefe324 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -667,15 +667,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -2882,7 +2880,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -3094,9 +3092,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -3192,7 +3191,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -3387,9 +3386,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4227,6 +4227,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -4235,13 +4248,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -4389,12 +4398,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -4410,11 +4418,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 5803123..c383d83 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -829,15 +829,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3131,7 +3129,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -3361,9 +3359,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -3459,7 +3458,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -3672,9 +3671,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4516,6 +4516,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -4524,13 +4537,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -4741,12 +4750,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -4762,11 +4770,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index 1ae89f9..72cfd57 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -1208,15 +1208,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3815,7 +3813,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4052,9 +4050,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4181,7 +4180,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4401,9 +4400,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4530,7 +4530,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4743,9 +4743,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5647,6 +5648,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -5655,13 +5669,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -6178,12 +6188,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -6199,11 +6208,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index 2469154..53ea30e 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -1208,15 +1208,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3835,7 +3833,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4072,9 +4070,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4201,7 +4200,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4421,9 +4420,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4550,7 +4550,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4763,9 +4763,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5672,6 +5673,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -5680,13 +5694,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -6216,12 +6226,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -6237,11 +6246,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index cf617b7..b193e09 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -1208,15 +1208,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3835,7 +3833,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4072,9 +4070,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4201,7 +4200,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4421,9 +4420,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4550,7 +4550,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4763,9 +4763,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5672,6 +5673,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -5680,13 +5694,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -6260,12 +6270,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -6281,11 +6290,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index 716c673..e89c363 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -1225,15 +1225,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3852,7 +3850,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4089,9 +4087,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4224,7 +4223,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4444,9 +4443,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4579,7 +4579,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4792,9 +4792,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5707,6 +5708,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -5715,13 +5729,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -6313,12 +6323,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -6334,11 +6343,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index 4918bb5..026e5aa 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -1293,15 +1293,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3944,7 +3942,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4187,9 +4185,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4322,7 +4321,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4548,9 +4547,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4683,7 +4683,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4902,9 +4902,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5817,6 +5818,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -5825,13 +5839,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -6446,12 +6456,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -6467,11 +6476,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index 27b59df..0e0b1a5 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -1293,15 +1293,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3944,7 +3942,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4196,9 +4194,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4331,7 +4330,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4557,9 +4556,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4692,7 +4692,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4911,9 +4911,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5826,6 +5827,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -5834,13 +5848,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -6455,12 +6465,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -6476,11 +6485,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index 87d313a..b10d228 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -1293,15 +1293,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3677,9 +3675,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string subMerchant: description: 'Required for Back-to-Back/ purchase driven load in Wallet @@ -4036,7 +4035,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4296,9 +4295,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4431,7 +4431,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4657,9 +4657,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4792,7 +4793,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -5011,9 +5012,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5926,6 +5928,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -5934,13 +5949,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -6591,12 +6602,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -6612,11 +6622,10 @@ components: description: The CAVV algorithm used. Include this only for 3D Secure 1. type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v67.yaml b/yaml/PaymentService-v67.yaml index 129b69b..c4e4d7b 100644 --- a/yaml/PaymentService-v67.yaml +++ b/yaml/PaymentService-v67.yaml @@ -1293,15 +1293,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3677,9 +3675,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string subMerchant: description: 'Required for Back-to-Back/ purchase driven load in Wallet @@ -4036,7 +4035,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4290,9 +4289,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4425,7 +4425,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4645,9 +4645,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4780,7 +4781,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4993,9 +4994,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5901,6 +5903,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -5909,13 +5924,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -6607,12 +6618,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -6642,11 +6652,10 @@ components: - '07' type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C diff --git a/yaml/PaymentService-v68.yaml b/yaml/PaymentService-v68.yaml index 7b56e8f..247d28c 100644 --- a/yaml/PaymentService-v68.yaml +++ b/yaml/PaymentService-v68.yaml @@ -1442,15 +1442,13 @@ components: 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" + \ knowledge of 3D Secure.\n\nPossible values:\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.\n* If you the BIN is not enrolled, you will\ + \ receive an error.\n\n" type: string type: object AdditionalDataAirline: @@ -3850,9 +3848,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string subMerchant: description: 'Required for Back-to-Back/ purchase driven load in Wallet @@ -4255,7 +4254,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4529,9 +4528,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -4664,7 +4664,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -4896,9 +4896,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -5031,7 +5032,7 @@ components: > 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.' + is routed to 3D Secure 2 redirect.' $ref: '#/components/schemas/BrowserInfo' captureDelayHours: x-addedInVersion: '2' @@ -5256,9 +5257,10 @@ components: $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." + \ identify this shopper, for example user ID or account ID. The value\ + \ is case-sensitive and must be at least three characters.\n> Your reference\ + \ must not include personally identifiable information (PII) such as name\ + \ or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We\ @@ -6211,6 +6213,19 @@ components: threeDSVersion: description: The 3D Secure 2 version. type: string + tokenization.shopperReference: + description: The provided reference of the shopper. + type: string + tokenization.store.operationType: + description: The store operation performed on the token. + enum: + - created + - updated + - alreadyStored + type: string + tokenization.storedPaymentMethodId: + description: The reference that uniquely identifies tokenized payment details. + type: string visaTransactionId: description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. @@ -6219,13 +6234,9 @@ components: > Contact Support Team to enable this field.' type: string xid: - description: 'The 3DS transaction ID of the 3DS session sent in notifications. - The value is Base64-encoded and is returned for transactions with directoryResponse - ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, - use the `mpiData.xid`, field. - - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + description: "The 3DS transaction ID of the 3DS session sent in notifications.\ + \ The value is Base64-encoded and is returned for transactions with directoryResponse\ + \ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" type: string type: object ResponseAdditionalDataDomesticError: @@ -7165,12 +7176,11 @@ components: additionalProperties: false properties: authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. + description: 'In 3D Secure 2, this is the `transStatus` from the challenge + result. If the transaction was frictionless, omit this parameter. - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' + ' enum: - Y - N @@ -7200,11 +7210,10 @@ components: - '07' type: string directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. + description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. - In 3D Secure 2, this is the `transStatus` from the `ARes`.' + ' enum: - A - C