spec release

Adyen · Dec 12, 2024 · 7a609f5 · 7a609f5
1 parent 0f5c774
commit 7a609f5
Show file tree

Hide file tree

Showing 6 changed files with 178 additions and 13 deletions.
diff --git a/json/ManagementNotificationService-v3.json b/json/ManagementNotificationService-v3.json
@@ -251,6 +251,46 @@
             }
          }
       },
+      "terminalAssignment.completed" : {
+         "post" : {
+            "tags" : [
+               "Terminal management"
+            ],
+            "summary" : "Terminal assignment completed",
+            "description" : "A request to [reassign a terminal](https://docs.adyen.com/api-explorer/Management/3/post/terminals/(terminalId)/reassign) was completed.",
+            "x-addedInVersion" : "3",
+            "operationId" : "post-terminalAssignment.completed",
+            "x-sortIndex" : 3,
+            "x-methodName" : "terminalAssignmentCompleted",
+            "security" : [
+               {
+                  "BasicAuth" : [
+                     ]
+               }
+            ],
+            "requestBody" : {
+               "content" : {
+                  "application/json" : {
+                     "schema" : {
+                        "$ref" : "#/components/schemas/TerminalAssignmentNotificationRequest"
+                     }
+                  }
+               }
+            },
+            "responses" : {
+               "200" : {
+                  "content" : {
+                     "application/json" : {
+                        "schema" : {
+                           "$ref" : "#/components/schemas/TerminalAssignmentNotificationResponse"
+                        }
+                     }
+                  },
+                  "description" : "OK - the request has succeeded."
+               }
+            }
+         }
+      },
       "terminalBoarding.triggered" : {
          "post" : {
             "tags" : [
@@ -776,6 +816,48 @@
             },
             "type" : "object"
          },
+         "TerminalAssignmentNotificationRequest" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "assignedToAccount" : {
+                  "description" : "The unique identifier of the merchant/company account to which the terminal is assigned.",
+                  "type" : "string"
+               },
+               "assignedToStore" : {
+                  "description" : "The unique identifier of the store to which the terminal is assigned.",
+                  "type" : "string"
+               },
+               "eventDate" : {
+                  "description" : "The date and time when an event has been completed.",
+                  "type" : "string"
+               },
+               "pspReference" : {
+                  "description" : "The PSP reference of the request from which the notification originates.",
+                  "type" : "string"
+               },
+               "uniqueTerminalId" : {
+                  "description" : "The unique identifier of the terminal.",
+                  "type" : "string"
+               }
+            },
+            "required" : [
+               "uniqueTerminalId",
+               "pspReference",
+               "eventDate",
+               "assignedToAccount"
+            ],
+            "type" : "object"
+         },
+         "TerminalAssignmentNotificationResponse" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "notificationResponse" : {
+                  "description" : "Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
+                  "type" : "string"
+               }
+            },
+            "type" : "object"
+         },
          "TerminalBoardingData" : {
             "additionalProperties" : false,
             "properties" : {

diff --git a/json/ManagementService-v1.json b/json/ManagementService-v1.json
@@ -15270,13 +15270,13 @@
             "additionalProperties" : false,
             "properties" : {
                "currency" : {
-                  "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
+                  "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).",
                   "maxLength" : 3,
                   "minLength" : 3,
                   "type" : "string"
                },
                "value" : {
-                  "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+                  "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).",
                   "format" : "int64",
                   "type" : "integer"
                }

diff --git a/json/ManagementService-v3.json b/json/ManagementService-v3.json
@@ -15667,13 +15667,13 @@
             "additionalProperties" : false,
             "properties" : {
                "currency" : {
-                  "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
+                  "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).",
                   "maxLength" : 3,
                   "minLength" : 3,
                   "type" : "string"
                },
                "value" : {
-                  "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+                  "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).",
                   "format" : "int64",
                   "type" : "integer"
                }
@@ -20330,11 +20330,15 @@
             "additionalProperties" : false,
             "properties" : {
                "iccid" : {
-                  "description" : "The integrated circuit card identifier (ICCID) of the SIM card in the terminal.",
+                  "description" : "The integrated circuit card identifier (ICCID) of the primary SIM card in the terminal.",
+                  "type" : "string"
+               },
+               "iccid2" : {
+                  "description" : "The integrated circuit card identifier (ICCID) of the secondary SIM card in the terminal, typically used for a [third-party SIM card](https://docs.adyen.com/point-of-sale/design-your-integration/network-and-connectivity/cellular-failover/#using-a-third-party-sim-card).",
                   "type" : "string"
                },
                "status" : {
-                  "description" : "On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal.",
+                  "description" : "On a terminal that supports 3G or 4G connectivity, indicates the status of the primary SIM card in the terminal.",
                   "enum" : [
                      "activated",
                      "deactivated",
@@ -21341,7 +21345,15 @@
                   "description" : "STAR details.",
                   "$ref" : "#/components/schemas/StarInfo"
                },
+               "storeId" : {
+                  "x-addedInVersion" : "3",
+                  "description" : "The store for this payment method",
+                  "type" : "string"
+               },
                "storeIds" : {
+                  "deprecated" : true,
+                  "x-deprecatedInVersion" : "3",
+                  "x-deprecatedMessage" : "Use `storeId` instead. Only one store per payment method is allowed.",
                   "description" : "The list of stores for this payment method",
                   "items" : {
                      "type" : "string"

diff --git a/yaml/ManagementNotificationService-v3.yaml b/yaml/ManagementNotificationService-v3.yaml
@@ -167,6 +167,31 @@ webhooks:
               schema:
                 $ref: '#/components/schemas/PaymentMethodNotificationResponse'
           description: OK - the request has succeeded.
+  terminalAssignment.completed:
+    post:
+      tags:
+      - Terminal management
+      summary: Terminal assignment completed
+      description: A request to [reassign a terminal](https://docs.adyen.com/api-explorer/Management/3/post/terminals/(terminalId)/reassign)
+        was completed.
+      x-addedInVersion: '3'
+      operationId: post-terminalAssignment.completed
+      x-sortIndex: 3
+      x-methodName: terminalAssignmentCompleted
+      security:
+      - BasicAuth: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/TerminalAssignmentNotificationRequest'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TerminalAssignmentNotificationResponse'
+          description: OK - the request has succeeded.
   terminalBoarding.triggered:
     post:
       tags:
@@ -675,6 +700,40 @@ components:
           description: A description of how you can resolve the verification error.
           type: string
       type: object
+    TerminalAssignmentNotificationRequest:
+      additionalProperties: false
+      properties:
+        assignedToAccount:
+          description: The unique identifier of the merchant/company account to which
+            the terminal is assigned.
+          type: string
+        assignedToStore:
+          description: The unique identifier of the store to which the terminal is
+            assigned.
+          type: string
+        eventDate:
+          description: The date and time when an event has been completed.
+          type: string
+        pspReference:
+          description: The PSP reference of the request from which the notification
+            originates.
+          type: string
+        uniqueTerminalId:
+          description: The unique identifier of the terminal.
+          type: string
+      required:
+      - uniqueTerminalId
+      - pspReference
+      - eventDate
+      - assignedToAccount
+      type: object
+    TerminalAssignmentNotificationResponse:
+      additionalProperties: false
+      properties:
+        notificationResponse:
+          description: Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
+          type: string
+      type: object
     TerminalBoardingData:
       additionalProperties: false
       properties:

diff --git a/yaml/ManagementService-v1.yaml b/yaml/ManagementService-v1.yaml
@@ -10101,12 +10101,12 @@ components:
       additionalProperties: false
       properties:
         currency:
-          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).
           maxLength: 3
           minLength: 3
           type: string
         value:
-          description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+          description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
           format: int64
           type: integer
       required:

diff --git a/yaml/ManagementService-v3.yaml b/yaml/ManagementService-v3.yaml
@@ -10359,12 +10359,12 @@ components:
       additionalProperties: false
       properties:
         currency:
-          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).
           maxLength: 3
           minLength: 3
           type: string
         value:
-          description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+          description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
           format: int64
           type: integer
       required:
@@ -14782,12 +14782,16 @@ components:
       additionalProperties: false
       properties:
         iccid:
-          description: The integrated circuit card identifier (ICCID) of the SIM card
-            in the terminal.
+          description: The integrated circuit card identifier (ICCID) of the primary
+            SIM card in the terminal.
+          type: string
+        iccid2:
+          description: The integrated circuit card identifier (ICCID) of the secondary
+            SIM card in the terminal, typically used for a [third-party SIM card](https://docs.adyen.com/point-of-sale/design-your-integration/network-and-connectivity/cellular-failover/#using-a-third-party-sim-card).
           type: string
         status:
           description: On a terminal that supports 3G or 4G connectivity, indicates
-            the status of the SIM card in the terminal.
+            the status of the primary SIM card in the terminal.
           enum:
           - activated
           - deactivated
@@ -15768,7 +15772,15 @@ components:
         star:
           description: STAR details.
           $ref: '#/components/schemas/StarInfo'
+        storeId:
+          x-addedInVersion: '3'
+          description: The store for this payment method
+          type: string
         storeIds:
+          deprecated: true
+          x-deprecatedInVersion: '3'
+          x-deprecatedMessage: Use `storeId` instead. Only one store per payment method
+            is allowed.
           description: The list of stores for this payment method
           items:
             type: string