spec release

Adyen · Oct 3, 2024 · ca7cde5 · ca7cde5
1 parent 0db5ba8
commit ca7cde5
Show file tree

Hide file tree

Showing 4 changed files with 130 additions and 8 deletions.
diff --git a/json/ManagementService-v1.json b/json/ManagementService-v1.json
@@ -16962,6 +16962,36 @@
                }
             }
          },
+         "JCBInfo" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "midNumber" : {
+                  "description" : "MID (Merchant ID) number. Format: 10 numeric characters.\n Must be provided for both `noContract` and `gatewayContract` service levels.",
+                  "type" : "string"
+               },
+               "reuseMidNumber" : {
+                  "default" : false,
+                  "description" : "Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. \nThis is applicable for both `noContract` and `gatewayContract` service levels. \nThe default value is `false`.",
+                  "type" : "boolean"
+               },
+               "serviceLevel" : {
+                  "description" : "Specifies the service level (settlement type) of this payment method. Possible values:\n* **noContract** — Adyen holds the contract with JCB.\n* **gatewayContract** — JCB receives the settlement and handles disputes. They then pay out to the merchant directly.",
+                  "enum" : [
+                     "noContract",
+                     "gatewayContract"
+                  ],
+                  "type" : "string"
+               },
+               "transactionDescription" : {
+                  "description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
+                  "$ref" : "#/components/schemas/TransactionDescriptionInfo"
+               }
+            },
+            "required" : [
+               "serviceLevel"
+            ],
+            "type" : "object"
+         },
          "JSONObject" : {
             "type" : "object"
          },
@@ -18025,7 +18055,7 @@
                },
                "jcb" : {
                   "description" : "JCB details.",
-                  "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+                  "$ref" : "#/components/schemas/JCBInfo"
                },
                "klarna" : {
                   "description" : "Klarna details.",
@@ -18338,7 +18368,7 @@
                },
                "jcb" : {
                   "description" : "JCB details.",
-                  "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+                  "$ref" : "#/components/schemas/JCBInfo"
                },
                "klarna" : {
                   "description" : "Klarna details.",

diff --git a/json/ManagementService-v3.json b/json/ManagementService-v3.json
@@ -17382,6 +17382,36 @@
             ],
             "type" : "object"
          },
+         "JCBInfo" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "midNumber" : {
+                  "description" : "MID (Merchant ID) number. Format: 10 numeric characters.\n Must be provided for both `noContract` and `gatewayContract` service levels.",
+                  "type" : "string"
+               },
+               "reuseMidNumber" : {
+                  "default" : false,
+                  "description" : "Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. \nThis is applicable for both `noContract` and `gatewayContract` service levels. \nThe default value is `false`.",
+                  "type" : "boolean"
+               },
+               "serviceLevel" : {
+                  "description" : "Specifies the service level (settlement type) of this payment method. Possible values:\n* **noContract** — Adyen holds the contract with JCB.\n* **gatewayContract** — JCB receives the settlement and handles disputes. They then pay out to the merchant directly.",
+                  "enum" : [
+                     "noContract",
+                     "gatewayContract"
+                  ],
+                  "type" : "string"
+               },
+               "transactionDescription" : {
+                  "description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
+                  "$ref" : "#/components/schemas/TransactionDescriptionInfo"
+               }
+            },
+            "required" : [
+               "serviceLevel"
+            ],
+            "type" : "object"
+         },
          "JSONObject" : {
             "type" : "object"
          },
@@ -18445,7 +18475,7 @@
                },
                "jcb" : {
                   "description" : "JCB details.",
-                  "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+                  "$ref" : "#/components/schemas/JCBInfo"
                },
                "klarna" : {
                   "description" : "Klarna details.",
@@ -18762,7 +18792,7 @@
                },
                "jcb" : {
                   "description" : "JCB details.",
-                  "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+                  "$ref" : "#/components/schemas/JCBInfo"
                },
                "klarna" : {
                   "description" : "Klarna details.",

diff --git a/yaml/ManagementService-v1.yaml b/yaml/ManagementService-v1.yaml
@@ -11660,6 +11660,37 @@ components:
       properties:
         InvalidField:
           $ref: '#/components/schemas/InvalidField'
+    JCBInfo:
+      additionalProperties: false
+      properties:
+        midNumber:
+          description: "MID (Merchant ID) number. Format: 10 numeric characters.\n\
+            \ Must be provided for both `noContract` and `gatewayContract` service\
+            \ levels."
+          type: string
+        reuseMidNumber:
+          default: false
+          description: "Indicates whether the JCB Merchant ID is reused from a previously\
+            \ setup JCB payment method. \nThis is applicable for both `noContract`\
+            \ and `gatewayContract` service levels. \nThe default value is `false`."
+          type: boolean
+        serviceLevel:
+          description: "Specifies the service level (settlement type) of this payment\
+            \ method. Possible values:\n* **noContract** \u2014 Adyen holds the contract\
+            \ with JCB.\n* **gatewayContract** \u2014 JCB receives the settlement\
+            \ and handles disputes. They then pay out to the merchant directly."
+          enum:
+          - noContract
+          - gatewayContract
+          type: string
+        transactionDescription:
+          description: 'Information regarding the transaction description.
+
+            > You cannot configure the transaction description in the test environment.'
+          $ref: '#/components/schemas/TransactionDescriptionInfo'
+      required:
+      - serviceLevel
+      type: object
     JSONObject:
       type: object
     Key:
@@ -12546,7 +12577,7 @@ components:
           $ref: '#/components/schemas/GenericPmWithTdiInfo'
         jcb:
           description: JCB details.
-          $ref: '#/components/schemas/GenericPmWithTdiInfo'
+          $ref: '#/components/schemas/JCBInfo'
         klarna:
           description: Klarna details.
           $ref: '#/components/schemas/KlarnaInfo'
@@ -12816,7 +12847,7 @@ components:
           $ref: '#/components/schemas/GenericPmWithTdiInfo'
         jcb:
           description: JCB details.
-          $ref: '#/components/schemas/GenericPmWithTdiInfo'
+          $ref: '#/components/schemas/JCBInfo'
         klarna:
           description: Klarna details.
           $ref: '#/components/schemas/KlarnaInfo'

diff --git a/yaml/ManagementService-v3.yaml b/yaml/ManagementService-v3.yaml
@@ -11935,6 +11935,37 @@ components:
       - value
       - message
       type: object
+    JCBInfo:
+      additionalProperties: false
+      properties:
+        midNumber:
+          description: "MID (Merchant ID) number. Format: 10 numeric characters.\n\
+            \ Must be provided for both `noContract` and `gatewayContract` service\
+            \ levels."
+          type: string
+        reuseMidNumber:
+          default: false
+          description: "Indicates whether the JCB Merchant ID is reused from a previously\
+            \ setup JCB payment method. \nThis is applicable for both `noContract`\
+            \ and `gatewayContract` service levels. \nThe default value is `false`."
+          type: boolean
+        serviceLevel:
+          description: "Specifies the service level (settlement type) of this payment\
+            \ method. Possible values:\n* **noContract** \u2014 Adyen holds the contract\
+            \ with JCB.\n* **gatewayContract** \u2014 JCB receives the settlement\
+            \ and handles disputes. They then pay out to the merchant directly."
+          enum:
+          - noContract
+          - gatewayContract
+          type: string
+        transactionDescription:
+          description: 'Information regarding the transaction description.
+
+            > You cannot configure the transaction description in the test environment.'
+          $ref: '#/components/schemas/TransactionDescriptionInfo'
+      required:
+      - serviceLevel
+      type: object
     JSONObject:
       type: object
     Key:
@@ -12821,7 +12852,7 @@ components:
           $ref: '#/components/schemas/GenericPmWithTdiInfo'
         jcb:
           description: JCB details.
-          $ref: '#/components/schemas/GenericPmWithTdiInfo'
+          $ref: '#/components/schemas/JCBInfo'
         klarna:
           description: Klarna details.
           $ref: '#/components/schemas/KlarnaInfo'
@@ -13094,7 +13125,7 @@ components:
           $ref: '#/components/schemas/GenericPmWithTdiInfo'
         jcb:
           description: JCB details.
-          $ref: '#/components/schemas/GenericPmWithTdiInfo'
+          $ref: '#/components/schemas/JCBInfo'
         klarna:
           description: Klarna details.
           $ref: '#/components/schemas/KlarnaInfo'