Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Feb 26, 2025
1 parent 872634a commit 126221d
Show file tree
Hide file tree
Showing 22 changed files with 771 additions and 495 deletions.
33 changes: 25 additions & 8 deletions json/PaymentService-v25.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down
33 changes: 25 additions & 8 deletions json/PaymentService-v30.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down
Loading

0 comments on commit 126221d

Please sign in to comment.