spec release

Adyen · Feb 8, 2024 · a12cfd4 · a12cfd4
1 parent 5e794ff
commit a12cfd4
Show file tree

Hide file tree

Showing 4 changed files with 172 additions and 24 deletions.
diff --git a/json/ManagementService-v1.json b/json/ManagementService-v1.json
@@ -17412,17 +17412,37 @@
                   "type" : "array"
                },
                "notification" : {
-                  "description" : "Configures the event notification button on the terminal screen, for example used for pay-at-table.",
+                  "description" : "Configures sending event notifications by pressing a button on a terminal, for example used for pay-at-table.",
                   "$ref" : "#/components/schemas/Notification"
                }
             },
             "type" : "object"
          },
          "Notification" : {
             "properties" : {
+               "category" : {
+                  "description" : "The type of event notification sent when you select the notification button.",
+                  "enum" : [
+                     "SaleWakeUp",
+                     "KeyPressed"
+                  ],
+                  "type" : "string"
+               },
+               "details" : {
+                  "description" : "The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.",
+                  "type" : "string"
+               },
+               "enabled" : {
+                  "description" : "Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.",
+                  "type" : "boolean"
+               },
                "showButton" : {
-                  "description" : "Shows or hides the event notification button on the terminal screen.",
+                  "description" : "Shows or hides the event notification button on the screen of terminal models that have a keypad.",
                   "type" : "boolean"
+               },
+               "title" : {
+                  "description" : "The name of the notification button on the terminal screen.",
+                  "type" : "string"
                }
             },
             "type" : "object"
@@ -18901,7 +18921,7 @@
                   "type" : "string"
                },
                "externalReferenceId" : {
-                  "description" : "When using the Zip payment method: The location ID that Zip has assigned to your store.",
+                  "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
                   "type" : "string"
                },
                "id" : {
@@ -20017,6 +20037,13 @@
                   },
                   "type" : "array"
                },
+               "customRoutingFlags" : {
+                  "description" : "Custom routing flags for acquirer routing.",
+                  "items" : {
+                     "type" : "string"
+                  },
+                  "type" : "array"
+               },
                "diners" : {
                   "description" : "Diners details.",
                   "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -20255,7 +20282,7 @@
                   "type" : "string"
                },
                "externalReferenceId" : {
-                  "description" : "When using the Zip payment method: The location ID that Zip has assigned to your store.",
+                  "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
                   "type" : "string"
                },
                "phoneNumber" : {

diff --git a/json/ManagementService-v3.json b/json/ManagementService-v3.json
@@ -17599,17 +17599,37 @@
                   "type" : "array"
                },
                "notification" : {
-                  "description" : "Configures the event notification button on the terminal screen, for example used for pay-at-table.",
+                  "description" : "Configures sending event notifications by pressing a button on a terminal, for example used for pay-at-table.",
                   "$ref" : "#/components/schemas/Notification"
                }
             },
             "type" : "object"
          },
          "Notification" : {
             "properties" : {
+               "category" : {
+                  "description" : "The type of event notification sent when you select the notification button.",
+                  "enum" : [
+                     "SaleWakeUp",
+                     "KeyPressed"
+                  ],
+                  "type" : "string"
+               },
+               "details" : {
+                  "description" : "The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.",
+                  "type" : "string"
+               },
+               "enabled" : {
+                  "description" : "Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.",
+                  "type" : "boolean"
+               },
                "showButton" : {
-                  "description" : "Shows or hides the event notification button on the terminal screen.",
+                  "description" : "Shows or hides the event notification button on the screen of terminal models that have a keypad.",
                   "type" : "boolean"
+               },
+               "title" : {
+                  "description" : "The name of the notification button on the terminal screen.",
+                  "type" : "string"
                }
             },
             "type" : "object"
@@ -19079,7 +19099,7 @@
                   "type" : "string"
                },
                "externalReferenceId" : {
-                  "description" : "When using the Zip payment method: The location ID that Zip has assigned to your store.",
+                  "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
                   "type" : "string"
                },
                "id" : {
@@ -20291,6 +20311,13 @@
                   },
                   "type" : "array"
                },
+               "customRoutingFlags" : {
+                  "description" : "Custom routing flags for acquirer routing.",
+                  "items" : {
+                     "type" : "string"
+                  },
+                  "type" : "array"
+               },
                "diners" : {
                   "description" : "Diners details.",
                   "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -20529,7 +20556,7 @@
                   "type" : "string"
                },
                "externalReferenceId" : {
-                  "description" : "When using the Zip payment method: The location ID that Zip has assigned to your store.",
+                  "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
                   "type" : "string"
                },
                "phoneNumber" : {

diff --git a/yaml/ManagementService-v1.yaml b/yaml/ManagementService-v1.yaml
@@ -12004,16 +12004,36 @@ components:
             type: string
           type: array
         notification:
-          description: Configures the event notification button on the terminal screen,
-            for example used for pay-at-table.
+          description: Configures sending event notifications by pressing a button
+            on a terminal, for example used for pay-at-table.
           $ref: '#/components/schemas/Notification'
       type: object
     Notification:
       properties:
+        category:
+          description: The type of event notification sent when you select the notification
+            button.
+          enum:
+          - SaleWakeUp
+          - KeyPressed
+          type: string
+        details:
+          description: The text shown in the prompt which opens when you select the
+            notification button. For example, the description of the input box for
+            pay-at-table.
+          type: string
+        enabled:
+          description: Enables sending event notifications either by pressing the
+            Confirm key on terminals with a keypad or by tapping the event notification
+            button on the terminal screen.
+          type: boolean
         showButton:
-          description: Shows or hides the event notification button on the terminal
-            screen.
+          description: Shows or hides the event notification button on the screen
+            of terminal models that have a keypad.
           type: boolean
+        title:
+          description: The name of the notification button on the terminal screen.
+          type: string
       type: object
     NotificationUrl:
       properties:
@@ -13368,8 +13388,19 @@ components:
           description: The description of the store.
           type: string
         externalReferenceId:
-          description: 'When using the Zip payment method: The location ID that Zip
-            has assigned to your store.'
+          description: 'The unique identifier of the store, used by certain payment
+            methods and tax authorities. Accepts up to 14 digits.
+
+
+            Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated
+            by dots, slashes, hyphens, or without separators.
+
+
+            Optional for Zip in Australia and SIRET in France, required except for
+            nonprofit organizations and incorporated associations.
+
+
+            '
           type: string
         id:
           description: The unique identifier of the store. This value is generated
@@ -14469,6 +14500,11 @@ components:
           items:
             type: string
           type: array
+        customRoutingFlags:
+          description: Custom routing flags for acquirer routing.
+          items:
+            type: string
+          type: array
         diners:
           description: Diners details.
           $ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -14734,8 +14770,19 @@ components:
           description: The description of the store.
           type: string
         externalReferenceId:
-          description: 'When using the Zip payment method: The location ID that Zip
-            has assigned to your store.'
+          description: 'The unique identifier of the store, used by certain payment
+            methods and tax authorities. Accepts up to 14 digits.
+
+
+            Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated
+            by dots, slashes, hyphens, or without separators.
+
+
+            Optional for Zip in Australia and SIRET in France, required except for
+            nonprofit organizations and incorporated associations.
+
+
+            '
           type: string
         phoneNumber:
           description: The phone number of the store, including '+' and country code.

diff --git a/yaml/ManagementService-v3.yaml b/yaml/ManagementService-v3.yaml
@@ -12126,16 +12126,36 @@ components:
             type: string
           type: array
         notification:
-          description: Configures the event notification button on the terminal screen,
-            for example used for pay-at-table.
+          description: Configures sending event notifications by pressing a button
+            on a terminal, for example used for pay-at-table.
           $ref: '#/components/schemas/Notification'
       type: object
     Notification:
       properties:
+        category:
+          description: The type of event notification sent when you select the notification
+            button.
+          enum:
+          - SaleWakeUp
+          - KeyPressed
+          type: string
+        details:
+          description: The text shown in the prompt which opens when you select the
+            notification button. For example, the description of the input box for
+            pay-at-table.
+          type: string
+        enabled:
+          description: Enables sending event notifications either by pressing the
+            Confirm key on terminals with a keypad or by tapping the event notification
+            button on the terminal screen.
+          type: boolean
         showButton:
-          description: Shows or hides the event notification button on the terminal
-            screen.
+          description: Shows or hides the event notification button on the screen
+            of terminal models that have a keypad.
           type: boolean
+        title:
+          description: The name of the notification button on the terminal screen.
+          type: string
       type: object
     NotificationUrl:
       properties:
@@ -13483,8 +13503,19 @@ components:
           description: The description of the store.
           type: string
         externalReferenceId:
-          description: 'When using the Zip payment method: The location ID that Zip
-            has assigned to your store.'
+          description: 'The unique identifier of the store, used by certain payment
+            methods and tax authorities. Accepts up to 14 digits.
+
+
+            Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated
+            by dots, slashes, hyphens, or without separators.
+
+
+            Optional for Zip in Australia and SIRET in France, required except for
+            nonprofit organizations and incorporated associations.
+
+
+            '
           type: string
         id:
           description: The unique identifier of the store. This value is generated
@@ -14680,6 +14711,11 @@ components:
           items:
             type: string
           type: array
+        customRoutingFlags:
+          description: Custom routing flags for acquirer routing.
+          items:
+            type: string
+          type: array
         diners:
           description: Diners details.
           $ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -14945,8 +14981,19 @@ components:
           description: The description of the store.
           type: string
         externalReferenceId:
-          description: 'When using the Zip payment method: The location ID that Zip
-            has assigned to your store.'
+          description: 'The unique identifier of the store, used by certain payment
+            methods and tax authorities. Accepts up to 14 digits.
+
+
+            Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated
+            by dots, slashes, hyphens, or without separators.
+
+
+            Optional for Zip in Australia and SIRET in France, required except for
+            nonprofit organizations and incorporated associations.
+
+
+            '
           type: string
         phoneNumber:
           description: 'The phone number of the store, including ''+'' and country