pokepay_partner_ruby_sdk 0.3.2 → 0.3.6

data/partner.yaml

@@ -7,8 +7,9 @@ openapi: '3.0.1'
 info:
   description: >-
     Partner APIs
+
   title:  Partner APIs
-  version: 0.0.0
+  version: 24.3.26
 
 tags:
   - name: Transaction
@@ -34,6 +35,7 @@ tags:
   - name: Customer
   - name: Organization
   - name: Shop
+  - name: User
   - name: Account
   - name: Private Money
   - name: Bulk
@@ -45,6 +47,17 @@ tags:
       WebHookにはURLとタスク名、有効化されているかを設定することが出来ます。
       通知はタスク完了時、事前に設定したURLにPOSTリクエストを行います。
   - name: Coupon
+    description: |
+      Couponは支払い時に指定し、支払い処理の前にCouponに指定の方法で値引き処理を行います。
+      Couponは特定店舗で利用できるものや利用可能期間、配信条件などを設定できます。
+  - name: UserDevice
+    description: |
+      UserDeviceはユーザー毎のデバイスを管理します。
+      あるユーザーが使っている端末を区別する必要がある場合に用いられます。
+      これが必要な理由はBank Payを用いたチャージを行う場合は端末を区別できることが要件としてあるためです。
+  - name: BankPay
+    description: |
+      BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。
 
 components:
   schemas:
@@ -52,6 +65,7 @@ components:
       x-pokepay-schema-type: "response"
       properties:
         pong:
+          x-pokepay-csharp-property-name: "Value"
           type: string
           pattern: '^ok$'
     Echo:
@@ -284,6 +298,10 @@ components:
           type: string
           format: date-time
           title: チャージQRコード自体の失効日時
+        last_used_at:
+          type: string
+          format: date-time
+          nullable: true
         private_money:
           $ref: '#/components/schemas/PrivateMoney'
           title: 対象マネー情報
@@ -309,11 +327,24 @@ components:
         token:
           type: string
           title: チャージQRコードを解析したときに出てくるURL
+    PaginatedChecks:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/Check'
+        count:
+          type: integer
+          minimum: 0
+        pagination:
+          $ref: '#/components/schemas/Pagination'
     CpmToken:
       x-pokepay-schema-type: "response"
       type: object
       properties:
         cpm_token:
+          x-pokepay-csharp-property-name: "Token"
           type: string
           minLength: 22
           maxLength: 22
@@ -581,9 +612,11 @@ components:
           description: |
             取引のポイント額です。
             キャンペーンによるポイント付与額を含まない、元々の取引で支払われたポイント額を表します。
+          nullable: true
         campaign_point_amount:
           type: number
           title: 'キャンペーンによるポイント付与額'
+          nullable: true
         done_at:
           type: string
           format: date-time
@@ -948,6 +981,96 @@ components:
         description:
           type: string
           title: 取引説明文
+    ExternalTransactionDetail:
+      x-pokepay-schema-type: "response"
+      properties:
+        id:
+          type: string
+          format: uuid
+          title: ポケペイ外部取引ID
+        is_modified:
+          type: boolean
+          title: 返金された取引かどうか
+        sender:
+          $ref: '#/components/schemas/User'
+          title: 送金者情報
+        sender_account:
+          $ref: '#/components/schemas/Account'
+          title: 送金ウォレット情報
+        receiver:
+          $ref: '#/components/schemas/User'
+          title: 受取者情報
+        receiver_account:
+          $ref: '#/components/schemas/Account'
+          title: 受取ウォレット情報
+        amount:
+          type: number
+          title: 決済額
+        done_at:
+          type: string
+          format: date-time
+          title: 取引日時
+        description:
+          type: string
+          title: 取引説明文
+        transaction:
+          $ref: '#/components/schemas/TransactionDetail'
+          nullable: true
+          title: 関連ポケペイ取引詳細
+          description: |
+            ポケペイ外取引と連動して作られたポケペイ取引の取引詳細です。
+            例えば、キャンペーンによるポイント付与取引やキャンセル状況などの情報が含まれます。
+            ポケペイ取引が存在しない場合はnullが設定されます。
+
+    Products:
+      type: array
+      items:
+        type: object
+        properties:
+          jan_code:
+            type: string
+            maxLength: 64
+          classification_code:
+            type: string
+            maxLength: 64
+          name:
+            type: string
+            maxLength: 256
+          unit_price:
+            type: number
+            minimum: 0
+          price:
+            type: number
+            minimum: 0
+          quantity:
+            type: integer
+            minimum: 1
+          is_discounted:
+            type: boolean
+          other:
+            type: string
+            format: json
+        example: |-
+          {"jan_code":"abc",
+           "name":"name1",
+           "unit_price":100,
+           "price": 100,
+           "quantity": 1,
+           "is_discounted": false,
+           "other":"{}"}
+      title: '商品情報データ'
+      description:  |-
+        一つの取引に含まれる商品情報データです。
+        以下の内容からなるJSONオブジェクトの配列で指定します。
+
+        - `jan_code`: JANコード。64字以下の文字列
+        - `name`: 商品名。256字以下の文字列
+        - `unit_price`: 商品単価。0以上の数値
+        - `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
+        - `quantity`: 商品の個数。この値が指定された場合、priceから算出される個数よりも優先されます。
+        - `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
+        - `other`: その他商品に関する情報。JSONオブジェクトで指定します。
+
     Product:
       x-pokepay-schema-type: "response"
       properties:
@@ -963,6 +1086,10 @@ components:
         price:
           type: number
           minimum: 0
+        quantity:
+          type: integer
+          minimum: 1
+          nullable: true
         is_discounted:
           type: boolean
         other:
@@ -984,6 +1111,14 @@ components:
           type: number
           format: decimal
           minimum: 0
+        raw_point_amount:
+          type: number
+          format: decimal
+          minimum: 0
+        campaign_point_amount:
+          type: number
+          format: decimal
+          minimum: 0
         point_count:
           type: integer
     PrivateMoneyOrganizationSummary:
@@ -1027,6 +1162,12 @@ components:
         added_point_amount:
           type: number
           format: decimal
+        topup_point_amount:
+          type: number
+          format: decimal
+        campaign_point_amount:
+          type: number
+          format: decimal
         refunded_added_point_amount:
           type: number
           format: decimal
@@ -1078,6 +1219,67 @@ components:
           type: string
           format: date-time
 
+    UserDevice:
+      x-pokepay-schema-type: "response"
+      properties:
+        id:
+          type: string
+          format: uuid
+          title: 'デバイスID'
+        user:
+          $ref: '#/components/schemas/User'
+          title: 'デバイスを使用するユーザ'
+        is_active:
+          type: boolean
+          title: 'デバイスが有効か'
+        metadata:
+          type: string
+          format: json
+          title: 'デバイスのメタデータ'
+
+    BankRegisteringInfo:
+      x-pokepay-schema-type: "response"
+      properties:
+        redirect_url:
+          type: string
+        paytree_customer_number:
+          type: string
+          nullable: true
+
+    Bank:
+      x-pokepay-schema-type: "response"
+      properties:
+        id:
+          type: string
+          format: uuid
+        private_money:
+          $ref: '#/components/schemas/PrivateMoney'
+        bank_name:
+          type: string
+        bank_code:
+          type: string
+        branch_number:
+          type: string
+        branch_name:
+          type: string
+        deposit_type:
+          type: string
+        masked_account_number:
+          type: string
+        account_name:
+          type: string
+
+    Banks:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/Bank'
+        count:
+          type: integer
+          minimum: 0
+
     PaginatedTransaction:
       x-pokepay-schema-type: "response"
       properties:
@@ -1312,6 +1514,20 @@ components:
           type: string
           enum: [enabled, disabled]
           title: 'キャンペーンの現在の状態'
+        budget_caps_amount:
+          title: 'キャンペーンの予算上限額'
+          type: integer
+          nullable: true
+        budget_current_amount:
+          title: 'キャンペーンの付与合計額'
+          type: integer
+          nullable: true
+        budget_current_time:
+          title: 'キャンペーンの付与集計日時'
+          type: string
+          format: date-time
+          nullable: true
+
     PaginatedCampaigns:
       x-pokepay-schema-type: "response"
       properties:
@@ -1546,6 +1762,18 @@ components:
           minimum: 0
         pagination:
           $ref: '#/components/schemas/Pagination'
+    PaginatedOrganizations:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/Organization'
+        count:
+          type: integer
+          minimum: 0
+        pagination:
+          $ref: '#/components/schemas/Pagination'
 
     BadRequest:
       x-pokepay-schema-type: "response"
@@ -1765,6 +1993,8 @@ paths:
           $ref: '#/components/responses/BadRequest'
   /user:
     get:
+      tags:
+        - User
       responses:
         '200':
           description: OK
@@ -2729,11 +2959,17 @@ paths:
                   minimum: 0
                   format: decimal
                   title: '付与マネー額'
+                  description: |
+                    チャージQRコードによって付与されるマネー額です。
+                    `money_amount`と`point_amount`の少なくともどちらかは指定する必要があります。
                 point_amount:
                   type: number
                   minimum: 0
                   format: decimal
                   title: '付与ポイント額'
+                  description: |
+                    チャージQRコードによって付与されるポイント額です。
+                    `money_amount`と`point_amount`の少なくともどちらかは指定する必要があります。
                 account_id:
                   type: string
                   format: uuid
@@ -2745,35 +2981,52 @@ paths:
                   example: 'test check'
                 is_onetime:
                   type: boolean
-                  title: 'ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)'
+                  title: 'ワンタイムかどうかのフラグ'
                   description: |
                     チャージQRコードが一度の読み取りで失効するときに`true`にします。デフォルト値は`true`です。
-                    `false`の場合、そのチャージQRコードは1ユーザについては1回きりですが、複数ユーザによって読み取り可能なQRコードになります。
+                    `false`の場合、複数ユーザによって読み取り可能なQRコードになります。
+                    ただし、その場合も1ユーザにつき1回のみしか読み取れません。
                 usage_limit:
                   type: integer
                   nullable: true
-                  title: 'ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数'
+                  title: 'ワンタイムでない場合の最大読み取り回数'
                   description: |
-                    複数ユーザによって読み取り可能なチャージQRコードの読み取り回数に制限をつけるために指定します。
-                    省略すると無制限に読み取り可能なチャージQRコードになります。
-                    チャージQRコードは管理画面からいつでも無効化(有効化)することができます。
+                    複数ユーザによって読み取り可能なチャージQRコードの最大読み取り回数を指定します。
+                    NULLに設定すると無制限に読み取り可能なチャージQRコードになります。
+                    デフォルト値はNULLです。
+                    ワンタイム指定(`is_onetime`)がされているときは、本パラメータはNULLである必要があります。
                 expires_at:
                   type: string
                   format: date-time
-                  title: 'チャージQR自体の失効日時'
+                  title: 'チャージQRコード自体の失効日時'
+                  description: |
+                    チャージQRコード自体の失効日時を指定します。この日時以降はチャージQRコードを読み取れなくなります。デフォルトでは作成日時から3ヶ月後になります。
+
+                    チャージQRコード自体の失効日時であって、チャージQRコードによって付与されるマネー残高の有効期限とは異なることに注意してください。マネー残高の有効期限はマネー設定で指定されているものになります。
                 point_expires_at:
                   type: string
                   format: date-time
-                  title: 'チャージQRによって付与されるポイントの失効日時'
+                  title: 'チャージQRコードによって付与されるポイント残高の有効期限'
+                  description: |
+                    チャージQRコードによって付与されるポイント残高の有効起源を指定します。デフォルトではマネー残高の有効期限と同じものが指定されます。
+
+                    チャージQRコードにより付与されるマネー残高の有効期限はQRコード毎には指定できませんが、ポイント残高の有効期限は本パラメータにより、QRコード毎に個別に指定することができます。
                 point_expires_in_days:
                   type: integer
                   minimum: 1
-                  title: 'チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)'
+                  title: 'チャージQRコードによって付与されるポイント残高の有効期限(相対日数指定)'
+                  description: |
+                    チャージQRコードによって付与されるポイント残高の有効期限を相対日数で指定します。
+                    1を指定すると、チャージQRコード作成日の当日中に失効します(翌日0時に失効)。
+                    `point_expires_at`と`point_expires_in_days`が両方指定されている場合は、チャージQRコードによるチャージ取引ができた時点からより近い方が採用されます。
                   example: 60
                 bear_point_account:
                   type: string
                   format: uuid
-                  title: 'ポイント額を負担する店舗アカウントのID'
+                  title: 'ポイント額を負担する店舗のウォレットID'
+                  description: |
+                    ポイントチャージをする場合、ポイント額を負担する店舗のウォレットIDを指定することができます。
+                    デフォルトではマネー発行体のデフォルト店舗(本店)がポイント負担先となります。
       responses:
         '200':
           description: OK
@@ -2784,59 +3037,313 @@ paths:
         '400':
           $ref: '#/components/responses/InvalidParameters'
         '403':
-          $ref: '#/components/responses/Forbidden'
+          $ref: '#/components/responses/UnpermittedAdminUser'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
-  /cpm/{cpm_token}:
     get:
       tags:
-        - Transaction
-      summary: 'CPMトークンの状態取得'
-      description: CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
-      x-pokepay-operator-name: "GetCpmToken"
+        - Check
+      summary: 'チャージQRコード一覧の取得'
+      x-pokepay-operator-name: "ListChecks"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                page:
+                  type: integer
+                  minimum: 1
+                  title: 'ページ番号'
+                per_page:
+                  type: integer
+                  minimum: 1
+                  title: '1ページの表示数'
+                  description: 1ページ当たり表示数です。デフォルト値は50です。
+                  example: 50
+                private_money_id:
+                  type: string
+                  format: uuid
+                  title: 'マネーID'
+                  description: |
+                    チャージQRコードのチャージ対象のマネーIDで結果をフィルターします。
+                organization_code:
+                  type: string
+                  maxLength: 32
+                  title: '組織コード'
+                  description: |-
+                    チャージQRコードの発行店舗の所属組織の組織コードで結果をフィルターします。
+                    デフォルトでは未指定です。
+                expires_from:
+                  type: string
+                  format: date-time
+                  title: '有効期限の期間によるフィルター(開始時点)'
+                  description: |
+                    有効期限の期間によるフィルターの開始時点のタイムスタンプです。
+                    デフォルトでは未指定です。
+                expires_to:
+                  type: string
+                  format: date-time
+                  title: '有効期限の期間によるフィルター(終了時点)'
+                  description: |
+                    有効期限の期間によるフィルターの終了時点のタイムスタンプです。
+                    デフォルトでは未指定です。
+                created_from:
+                  type: string
+                  format: date-time
+                  title: '作成日時の期間によるフィルター(開始時点)'
+                  description: |
+                    作成日時の期間によるフィルターの開始時点のタイムスタンプです。
+                    デフォルトでは未指定です。
+                created_to:
+                  type: string
+                  format: date-time
+                  title: '作成日時の期間によるフィルター(終了時点)'
+                  description: |
+                    作成日時の期間によるフィルターの終了時点のタイムスタンプです。
+                    デフォルトでは未指定です。
+                issuer_shop_id:
+                  type: string
+                  format: uuid
+                  title: '発行店舗ID'
+                  description: |
+                    チャージQRコードを発行した店舗IDによってフィルターします。
+                    デフォルトでは未指定です。
+                description:
+                  type: string
+                  title: 'チャージQRコードの説明文'
+                  description: |
+                    チャージQRコードの説明文(description)によってフィルターします。
+                    部分一致(前方一致)したものを表示します。
+                    デフォルトでは未指定です。
+                is_onetime:
+                  type: boolean
+                  title: 'ワンタイムのチャージQRコードかどうか'
+                  description: |
+                    チャージQRコードがワンタイムに設定されているかどうかでフィルターします。
+                    `true` の場合はワンタイムかどうかでフィルターし、`false`の場合はワンタイムでないものをフィルターします。
+                    未指定の場合はフィルターしません。
+                    デフォルトでは未指定です。
+                is_disabled:
+                  type: boolean
+                  title: '無効化されたチャージQRコードかどうか'
+                  description: |
+                    チャージQRコードが無効化されているかどうかでフィルターします。
+                    `true` の場合は無効なものをフィルターし、`false`の場合は有効なものをフィルターします。
+                    未指定の場合はフィルターしません。
+                    デフォルトでは未指定です。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedChecks'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+  /checks/{check_id}:
+    get:
+      tags:
+        - Check
+      summary: 'チャージQRコードの表示'
+      x-pokepay-operator-name: "GetCheck"
       x-pokepay-allow-server-side: true
       parameters:
         - in: path
-          name: cpm_token
+          name: check_id
           required: true
           schema:
             type: string
-            minLength: 22
-            maxLength: 22
-            title: CPMトークン
-          description: CPM取引時にエンドユーザーが店舗に提示するバーコードを解析して得られる22桁の文字列です。
+            format: uuid
+            title: 'チャージQRコードのID'
+          description: |-
+            表示対象のチャージQRコードのIDです。
       responses:
         '200':
           description: OK
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CpmToken'
+                $ref: '#/components/schemas/Check'
         '400':
-          $ref: '#/components/responses/BadRequest'
+          $ref: '#/components/responses/InvalidParameters'
         '403':
-          $ref: '#/components/responses/Forbidden'
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
-  /transactions:
-    get:
+    patch:
       tags:
-        - Transaction
-      summary: '【廃止】取引履歴を取得する'
-      description: 取引一覧を返します。
-      x-pokepay-operator-name: "ListTransactions"
+        - Check
+      summary: 'チャージQRコードの更新'
+      x-pokepay-operator-name: "UpdateCheck"
       x-pokepay-allow-server-side: true
+      parameters:
+        - in: path
+          name: check_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: 'チャージQRコードのID'
+          description: |-
+            更新対象のチャージQRコードのIDです。
       requestBody:
         required: true
         content:
           application/json:
             schema:
               properties:
-                from:
-                  type: string
-                  format: date-time
-                  title: '開始日時'
-                  description: |-
+                money_amount:
+                  type: number
+                  minimum: 0
+                  format: decimal
+                  title: '付与マネー額'
+                  description: |
+                    チャージQRコードによって付与されるマネー額です。
+                    `money_amount`と`point_amount`が両方0になるような更新リクエストはエラーになります。
+                point_amount:
+                  type: number
+                  minimum: 0
+                  format: decimal
+                  title: '付与ポイント額'
+                  description: |
+                    チャージQRコードによって付与されるポイント額です。
+                    `money_amount`と`point_amount`が両方0になるような更新リクエストはエラーになります。
+                description:
+                  type: string
+                  maxLength: 200
+                  title: 'チャージQRコードの説明文'
+                  description: |
+                    チャージQRコードの説明文です。
+                    チャージ取引後は、取引の説明文に転記され、取引履歴などに表示されます。
+                  example: 'test check'
+                is_onetime:
+                  type: boolean
+                  title: 'ワンタイムかどうかのフラグ'
+                  description: |
+                    チャージQRコードが一度の読み取りで失効するときに`true`にします。
+                    `false`の場合、複数ユーザによって読み取り可能なQRコードになります。
+                    ただし、その場合も1ユーザにつき1回のみしか読み取れません。
+                usage_limit:
+                  type: integer
+                  nullable: true
+                  title: 'ワンタイムでない場合の最大読み取り回数'
+                  description: |
+                    複数ユーザによって読み取り可能なチャージQRコードの最大読み取り回数を指定します。
+                    NULLに設定すると無制限に読み取り可能なチャージQRコードになります。
+                    ワンタイム指定(`is_onetime`)がされているときは、本パラメータはNULLである必要があります。
+                expires_at:
+                  type: string
+                  format: date-time
+                  title: 'チャージQRコード自体の失効日時'
+                  description: |
+                    チャージQRコード自体の失効日時を指定します。この日時以降はチャージQRコードを読み取れなくなります。
+
+                    チャージQRコード自体の失効日時であって、チャージQRコードによって付与されるマネー残高の有効期限とは異なることに注意してください。マネー残高の有効期限はマネー設定で指定されているものになります。
+                point_expires_at:
+                  type: string
+                  format: date-time
+                  nullable: true
+                  title: 'チャージQRコードによって付与されるポイント残高の有効期限'
+                  description: |
+                    チャージQRコードによって付与されるポイント残高の有効起源を指定します。
+
+                    チャージQRコードにより付与されるマネー残高の有効期限はQRコード毎には指定できませんが、ポイント残高の有効期限は本パラメータにより、QRコード毎に個別に指定することができます。
+                point_expires_in_days:
+                  type: integer
+                  minimum: 1
+                  nullable: true
+                  title: 'チャージQRコードによって付与されるポイント残高の有効期限(相対日数指定)'
+                  description: |
+                    チャージQRコードによって付与されるポイント残高の有効期限を相対日数で指定します。
+                    1を指定すると、チャージQRコード作成日の当日中に失効します(翌日0時に失効)。
+                    `point_expires_at`と`point_expires_in_days`が両方指定されている場合は、チャージQRコードによるチャージ取引ができた時点からより近い方が採用されます。
+                    `point_expires_at`と`point_expires_in_days`が両方NULLに設定されている場合は、マネーに設定されている残高の有効期限と同じになります。
+                  example: 60
+                bear_point_account:
+                  type: string
+                  format: uuid
+                  title: 'ポイント額を負担する店舗のウォレットID'
+                  description: |
+                    ポイントチャージをする場合、ポイント額を負担する店舗のウォレットIDを指定することができます。
+                is_disabled:
+                  type: boolean
+                  title: '無効化されているかどうかのフラグ'
+                  description: |
+                    チャージQRコードを無効化するときに`true`にします。
+                    `false`の場合は無効化されているチャージQRコードを再有効化します。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Check'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+        '404':
+          $ref: '#/components/responses/NotFound'
+  /cpm/{cpm_token}:
+    get:
+      tags:
+        - Transaction
+      summary: 'CPMトークンの状態取得'
+      description: CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
+      x-pokepay-operator-name: "GetCpmToken"
+      x-pokepay-allow-server-side: true
+      parameters:
+        - in: path
+          name: cpm_token
+          required: true
+          schema:
+            type: string
+            minLength: 22
+            maxLength: 22
+            title: CPMトークン
+          description: CPM取引時にエンドユーザーが店舗に提示するバーコードを解析して得られる22桁の文字列です。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CpmToken'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+  /transactions:
+    get:
+      tags:
+        - Transaction
+      summary: '【廃止】取引履歴を取得する'
+      description: 取引一覧を返します。
+      x-pokepay-operator-name: "ListTransactions"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                from:
+                  type: string
+                  format: date-time
+                  title: '開始日時'
+                  description: |-
                     抽出期間の開始日時です。
 
                     フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
@@ -3451,48 +3958,7 @@ paths:
                   example: |-
                     {"key":"value"}
                 products:
-                  type: array
-                  items:
-                    type: object
-                    properties:
-                      jan_code:
-                        type: string
-                        maxLength: 64
-                      classification_code:
-                        type: string
-                        maxLength: 64
-                      name:
-                        type: string
-                        maxLength: 256
-                      unit_price:
-                        type: number
-                        minimum: 0
-                      price:
-                        type: number
-                        minimum: 0
-                      is_discounted:
-                        type: boolean
-                      other:
-                        type: string
-                        format: json
-                    example: |-
-                      {"jan_code":"abc",
-                       "name":"name1",
-                       "unit_price":100,
-                       "price": 100,
-                       "is_discounted": false,
-                       "other":"{}"}
-                  title: '商品情報データ'
-                  description:  |-
-                    一つの取引に含まれる商品情報データです。
-                    以下の内容からなるJSONオブジェクトの配列で指定します。
-
-                    - `jan_code`: JANコード。64字以下の文字列
-                    - `name`: 商品名。256字以下の文字列
-                    - `unit_price`: 商品単価。0以上の数値
-                    - `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
-                    - `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
-                    - `other`: その他商品に関する情報。JSONオブジェクトで指定します。
+                  $ref: '#/components/schemas/Products'
                 request_id:
                   type: string
                   format: uuid
@@ -3504,6 +3970,19 @@ paths:
 
                     リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
                   example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
+                strategy:
+                  type: string
+                  enum: [point-preferred, money-only]
+                  title: '支払い時の残高消費方式'
+                  description: |-
+                    支払い時に残高がどのように消費されるかを指定します。
+                    デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+                    - point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+                    - money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+                    マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+                  example: 'point-preferred'
       responses:
         '200':
           description: OK
@@ -3578,48 +4057,7 @@ paths:
                   example: |-
                     {"key":"value"}
                 products:
-                  type: array
-                  items:
-                    type: object
-                    properties:
-                      jan_code:
-                        type: string
-                        maxLength: 64
-                      classification_code:
-                        type: string
-                        maxLength: 64
-                      name:
-                        type: string
-                        maxLength: 256
-                      unit_price:
-                        type: number
-                        minimum: 0
-                      price:
-                        type: number
-                        minimum: 0
-                      is_discounted:
-                        type: boolean
-                      other:
-                        type: string
-                        format: json
-                    example: |-
-                      {"jan_code":"abc",
-                       "name":"name1",
-                       "unit_price":100,
-                       "price": 100,
-                       "is_discounted": false,
-                       "other":"{}"}
-                  title: 商品情報データ
-                  description:  |-
-                    一つの取引に含まれる商品情報データです。
-                    以下の内容からなるJSONオブジェクトの配列で指定します。
-
-                    - `jan_code`: JANコード。64字以下の文字列
-                    - `name`: 商品名。256字以下の文字列
-                    - `unit_price`: 商品単価。0以上の数値
-                    - `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
-                    - `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
-                    - `other`: その他商品に関する情報。JSONオブジェクトで指定します。
+                  $ref: '#/components/schemas/Products'
                 request_id:
                   type: string
                   format: uuid
@@ -3631,6 +4069,19 @@ paths:
 
                     リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
                   example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
+                strategy:
+                  type: string
+                  enum: [point-preferred, money-only]
+                  title: '支払い時の残高消費方式'
+                  description: |-
+                    支払い時に残高がどのように消費されるかを指定します。
+                    デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+                    - point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+                    - money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+                    マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+                  example: 'point-preferred'
       responses:
         '200':
           description: OK
@@ -3701,6 +4152,87 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
+
+  /transactions/cashtray:
+    post:
+      tags:
+        - Check
+      summary: 'CashtrayQRコードを読み取ることで取引する'
+      description: |
+        エンドユーザーから受け取ったCashtray用QRコードのIDをエンドユーザーIDと共に渡すことで支払いあるいはチャージ取引が作られます。
+
+        通常CashtrayQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。
+        もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがCashtrayQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
+
+      x-pokepay-operator-name: "CreateTransactionWithCashtray"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["cashtray_id", "customer_id"]
+              properties:
+                cashtray_id:
+                  type: string
+                  format: uuid
+                  title: 'Cashtray用QRコードのID'
+                  description: |-
+                    Cashtray用QRコードのIDです。
+
+                    QRコード生成時に送金元店舗のウォレット情報や、金額などが登録されています。
+
+                customer_id:
+                  type: string
+                  format: uuid
+                  title: 'エンドユーザーのID'
+                  description: |-
+                    エンドユーザーIDです。
+
+                strategy:
+                  type: string
+                  enum: [point-preferred, money-only]
+                  default: 'point-preferred'
+                  title: '支払い時の残高消費方式'
+                  description: |-
+                    支払い時に残高がどのように消費されるかを指定します。
+                    チャージの場合は無効です。
+                    デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+                    - point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+                    - money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+                    マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+
+                request_id:
+                  type: string
+                  format: uuid
+                  title: 'リクエストID'
+                  description: |-
+                    取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+                    取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。
+                    指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+                    リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。
+                    もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+                  example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TransactionDetail'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+
   /transactions/transfer:
     post:
       tags:
@@ -3798,6 +4330,7 @@ paths:
       tags:
         - Transaction
       x-pokepay-allow-server-side: true
+      x-pokepay-operator-name: "CreateExchangeTransaction"
       requestBody:
         required: true
         content:
@@ -3815,7 +4348,7 @@ paths:
                   type: string
                   format: uuid
                 amount:
-                  type: number
+                  type: integer
                   minimum: 1
                 description:
                   type: string
@@ -4112,48 +4645,7 @@ paths:
                   example: |-
                     {"key":"value"}
                 products:
-                  type: array
-                  items:
-                    type: object
-                    properties:
-                      jan_code:
-                        type: string
-                        maxLength: 64
-                      classification_code:
-                        type: string
-                        maxLength: 64
-                      name:
-                        type: string
-                        maxLength: 256
-                      unit_price:
-                        type: number
-                        minimum: 0
-                      price:
-                        type: number
-                        minimum: 0
-                      is_discounted:
-                        type: boolean
-                      other:
-                        type: string
-                        format: json
-                    example: |-
-                      {"jan_code":"abc",
-                       "name":"name1",
-                       "unit_price":100,
-                       "price": 100,
-                       "is_discounted": false,
-                       "other":"{}"}
-                  title: '商品情報データ'
-                  description:  |-
-                    一つの取引に含まれる商品情報データです。
-                    以下の内容からなるJSONオブジェクトの配列で指定します。
-
-                    - `jan_code`: JANコード。64字以下の文字列
-                    - `name`: 商品名。256字以下の文字列
-                    - `unit_price`: 商品単価。0以上の数値
-                    - `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
-                    - `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
-                    - `other`: その他商品に関する情報。JSONオブジェクトで指定します。
+                  $ref: '#/components/schemas/Products'
                 request_id:
                   type: string
                   format: uuid
@@ -4165,13 +4657,21 @@ paths:
 
                     リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
                   example: 9dbfd997-b948-40d3-a3bf-6bc1a01368d2
+                done_at:
+                  type: string
+                  format: date-time
+                  title: 'ポケペイ外部取引の実施時間'
+                  description: |-
+                    ポケペイ外部取引が実際に起こった時間です。
+                    時間帯指定のポイント付与キャンペーンでの取引時間の計算に使われます。
+                    デフォルトではCreateExternalTransactionがリクエストされた時間になります。
       responses:
         '200':
           description: OK
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ExternalTransaction'
+                $ref: '#/components/schemas/ExternalTransactionDetail'
         '400':
           $ref: '#/components/responses/BadRequest'
         '403':
@@ -4217,30 +4717,61 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ExternalTransaction'
+                $ref: '#/components/schemas/ExternalTransactionDetail'
         '403':
           $ref: '#/components/responses/Forbidden'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
-  /transfers:
+  /external-transactions/requests/{request_id}:
     get:
       tags:
-        - Transfer
-      x-pokepay-operator-name: "ListTransfers"
+        - Event
+      summary: 'リクエストIDからポケペイ外部取引を取得する'
+      description: |-
+        リクエストIDを指定してポケペイ外部取引を取得します。
+
+        発行体の管理者は自組織発行のマネーに紐付くポケペイ外部取引を取得できます。
+
+      x-pokepay-operator-name: GetExternalTransactionByRequestId
       x-pokepay-allow-server-side: true
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              properties:
-                from:
-                  type: string
-                  format: date-time
-                to:
-                  type: string
-                  format: date-time
-                page:
+      parameters:
+        - in: path
+          name: request_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: 'リクエストID'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ExternalTransactionDetail'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+  /transfers:
+    get:
+      tags:
+        - Transfer
+      x-pokepay-operator-name: "ListTransfers"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                from:
+                  type: string
+                  format: date-time
+                to:
+                  type: string
+                  format: date-time
+                page:
                   type: integer
                   minimum: 1
                 per_page:
@@ -4521,6 +5052,66 @@ paths:
           $ref: '#/components/responses/UnprocessableEntity'
 
   /organizations:
+    get:
+      tags:
+        - Organization
+      summary: '加盟店組織の一覧を取得する'
+      x-pokepay-allow-server-side: true
+      x-pokepay-operator-name: "ListOrganizations"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id"]
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+                  title: 'マネーID'
+                  description: |-
+                    マネーIDです。
+                    このマネーに加盟している加盟組織がフィルターされます。
+                page:
+                  type: integer
+                  minimum: 1
+                  title: 'ページ番号'
+                  description: 取得したいページ番号です。
+                  example: 1
+                per_page:
+                  type: integer
+                  minimum: 1
+                  title: '1ページ分の取引数'
+                  description: 1ページ分の取引数です。
+                  example: 50
+                name:
+                  type: string
+                  title: '組織名'
+                code:
+                  type: string
+                  title: '組織コード'
+                #これらのパラメータは管理画面のユースケースに特化してそうなので一旦コメントアウトしておく
+                #with_issuer_org:
+                #  type: boolean
+                #with_details:
+                #  type: boolean
+                #with_disabled_member_orgs:
+                #  type: boolean
+                #with_all_members:
+                #  type: boolean
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedOrganizations'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
     post:
       tags:
         - Organization
@@ -5267,6 +5858,8 @@ paths:
           $ref: '#/components/responses/UnprocessableEntity'
   /bulk-transactions/{bulk_transaction_id}:
     get:
+      tags:
+        - Transaction
       summary: バルク取引ジョブの実行状況を取得する
       x-pokepay-operator-name: "GetBulkTransaction"
       x-pokepay-allow-server-side: true
@@ -5294,6 +5887,8 @@ paths:
           $ref: '#/components/responses/NotFound'
   /bulk-transactions/{bulk_transaction_id}/jobs:
     get:
+      tags:
+        - Transaction
       summary: バルク取引ジョブの詳細情報一覧を取得する
       x-pokepay-operator-name: "ListBulkTransactionJobs"
       x-pokepay-allow-server-side: true
@@ -5960,6 +6555,43 @@ paths:
                     ]
                     ```
 
+                blacklisted_product_rules:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      product_code:
+                        type: string
+                        maxLength: 64
+                        title: '対象の製品コード'
+                        description: |-
+                          対象の製品コード (JANコードやISBNコードなど) を指定します。(必須項目)
+
+                          SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (_ で任意の1文字にマッチし、 % で任意文字列にマッチします。 例: 978-% でISBNコード)
+                        items:
+                          type: string
+                      classification_code:
+                        type: string
+                        maxLength: 64
+                        title: '対象の商品分類コード'
+                        description: |-
+                          対象の商品分類コード (書籍のCコードなど) を指定します。(任意項目)
+
+                          SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (_ で任意の1文字にマッチし、 % で任意文字列にマッチします。 例: 978-% でISBNコード)
+                        items:
+                          type: string
+                    example: |-
+                      {
+                        "product_code": "4912345678904",
+                        "classification_code": "c123"
+                      }
+
+                  title: '商品情報ベースのキャンペーンで除外対象にする商品リスト'
+                  description:  |-
+                    商品情報をベースとしてポイント付与を行う際に、事前に除外対象とする商品リストを指定します。
+                    除外対象の商品コード、または分類コードのパターンの配列として指定します。
+                    取引時には、まずここで指定した除外対象商品が除かれ、残った商品に対して `product_based_point_rules` のルール群が適用されます。
+
                 applicable_days_of_week:
                   type: array
                   items:
@@ -5967,7 +6599,7 @@ paths:
                     minimum: 0
                     maximum: 6
                   title: 'キャンペーンを適用する曜日 (複数指定)'
-                  describe: |-
+                  description: |-
                     キャンペーンを適用する曜日を指定します (複数指定)。
                     曜日は整数で表します。月曜を 0 とし、日曜を 6 とします。
                     指定しなかった場合は全日を対象にします (曜日による適用条件なし)
@@ -5991,7 +6623,7 @@ paths:
                       }
 
                   title: 'キャンペーンを適用する時間帯 (複数指定)'
-                  describe: |-
+                  description: |-
                     キャンペーンを適用する時間帯を指定します (複数指定可)。
                     時間帯はfromとtoからなるオブジェクトで指定します。
                     fromとtoは両方必要です。
@@ -6001,9 +6633,31 @@ paths:
                     type: string
                     format: uuid
                   title: 'キャンペーン適用対象となる店舗IDのリスト'
-                  describe: |-
+                  description: |-
                     キャンペーンを適用する店舗IDを指定します (複数指定)。
                     指定しなかった場合は全店舗が対象になります。
+                blacklisted_shop_ids:
+                  type: array
+                  items:
+                    type: string
+                    format: uuid
+                  title: 'キャンペーン適用対象外となる店舗IDのリスト(ブラックリスト方式)'
+                  description: |-
+                    キャンペーンの適用対象外となる店舗IDをブラックリスト方式で指定します (複数指定可)。
+                    このパラメータが指定されている場合、blacklisted_shop_idsに含まれていない店舗全てがキャンペーンの適用対象になります。
+                    blacklisted_shop_idsとapplicable_shop_idsは同時には指定できません。ホワイトリスト方式を使うときはapplicable_shop_idsを指定してください。
+                minimum_number_of_products:
+                  type: integer
+                  minimum: 1
+                  title: 'キャンペーンを適用する1会計内の商品個数の下限'
+                  description: |-
+                    このパラメータを指定すると、取引時の1会計内のルールに適合する商品個数がminimum_number_of_productsを超えたときにのみキャンペーンが発火するようになります。
+                minimum_number_of_amount:
+                  type: integer
+                  minimum: 1
+                  title: 'キャンペーンを適用する1会計内の商品総額の下限'
+                  description: |-
+                    このパラメータを指定すると、取引時の1会計内のルールに適合する商品総額がminimum_number_of_amountを超えたときにのみキャンペーンが発火するようになります。
                 minimum_number_for_combination_purchase:
                   type: integer
                   minimum: 1
@@ -6194,6 +6848,7 @@ paths:
                     デフォルトではポイント付与先はキャンペーンを駆動するイベントのマネー(private_money_idで指定したマネー)になります。
 
                     別マネーに対するポイント付与は別のtransactionとなります。 RefundTransaction で元のイベントをキャンセルしたときはポイント付与のtransactionもキャンセルされ、逆にポイント付与のtransactionをキャンセルしたときは連動して元のイベントがキャンセルされます。
+
                 applicable_account_metadata:
                   description: |-
                     ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
@@ -6243,6 +6898,66 @@ paths:
                       "value": "male"
                     }
 
+                applicable_transaction_metadata:
+                  description: |-
+                    取引時に指定するメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
+                    メタデータの属性名 key とメタデータの値 value の組をオブジェクトとして指定します。
+                    取引のメタデータはCreatePaymentTransactionやCreateExternalTransactionで登録できます。
+
+                    オプショナルパラメータtestによって比較方法を指定することができます。
+                    デフォルトは equal で、その他に not-equalを指定可能です。
+
+                    例1: 取引のメタデータに会員ランクとしてbronzeが指定されているときのみ発火
+
+                    ```javascript
+                    {
+                      "key": "rank",
+                      "value": "bronze"
+                    }
+                    ```
+
+                    例2: 取引のメタデータに会員ランクとしてbronze以外が指定されているときのみ発火
+
+                    ```javascript
+                    {
+                      "key": "rank",
+                      "value": "bronze",
+                      "test": "not-equal"
+                    }
+                    ```
+
+                  type: object
+                  properties:
+                    key:
+                      type: string
+                      description: |-
+                        メタデータの属性名
+                    value:
+                      type: string
+                      description: |-
+                        メタデータの値
+                    test:
+                      type: string
+                      enum: [equal, not-equal]
+                      description: |-
+                        メタデータの値の比較方法。デフォルトはequal
+                  example: |-
+                    {
+                      "key": "rank",
+                      "value": "bronze"
+                    }
+
+                budget_caps_amount:
+                  title: 'キャンペーン予算上限'
+                  type: integer
+                  minimum: 1
+                  maximum: 10000000000
+                  description: |-
+                    キャンペーンの予算上限を指定します。デフォルトは未指定です。
+
+                    このパラメータが指定されている場合、このキャンペーンの適用により付与されたポイント全体を定期的に集計し、その合計が上限を越えていた場合にはキャンペーンを無効にします。
+                    一度この値を越えて無効となったキャンペーンを再度有効にすることは出来ません。
+
       responses:
         '200':
           description: OK
@@ -6731,6 +7446,43 @@ paths:
                     ]
                     ```
 
+                blacklisted_product_rules:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      product_code:
+                        type: string
+                        maxLength: 64
+                        title: '対象の製品コード'
+                        description: |-
+                          対象の製品コード (JANコードやISBNコードなど) を指定します。(必須項目)
+
+                          SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (_ で任意の1文字にマッチし、 % で任意文字列にマッチします。 例: 978-% でISBNコード)
+                        items:
+                          type: string
+                      classification_code:
+                        type: string
+                        maxLength: 64
+                        title: '対象の商品分類コード'
+                        description: |-
+                          対象の商品分類コード (書籍のCコードなど) を指定します。(任意項目)
+
+                          SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (_ で任意の1文字にマッチし、 % で任意文字列にマッチします。 例: 978-% でISBNコード)
+                        items:
+                          type: string
+                    example: |-
+                      {
+                        "product_code": "4912345678904",
+                        "classification_code": "c123"
+                      }
+
+                  title: '商品情報ベースのキャンペーンで除外対象にする商品リスト'
+                  description:  |-
+                    商品情報をベースとしてポイント付与を行う際に、事前に除外対象とする商品リストを指定します。
+                    除外対象の商品コード、または分類コードのパターンの配列として指定します。
+                    取引時には、まずここで指定した除外対象商品が除かれ、残った商品に対して `product_based_point_rules` のルール群が適用されます。
+
                 applicable_days_of_week:
                   type: array
                   items:
@@ -6739,7 +7491,7 @@ paths:
                     maximum: 6
                   nullable: true
                   title: 'キャンペーンを適用する曜日 (複数指定)'
-                  describe: |-
+                  description: |-
                     キャンペーンを適用する曜日を指定します (複数指定)。
                     曜日は整数で表します。月曜を 0 とし、日曜を 6 とします。
                     指定しなかった場合は全日を対象にします (曜日による適用条件なし)
@@ -6764,7 +7516,7 @@ paths:
 
                   nullable: true
                   title: 'キャンペーンを適用する時間帯 (複数指定)'
-                  describe: |-
+                  description: |-
                     キャンペーンを適用する時間帯を指定します (複数指定可)。
                     時間帯はfromとtoからなるオブジェクトで指定します。
                     fromとtoは両方必要です。
@@ -6775,9 +7527,34 @@ paths:
                     format: uuid
                   nullable: true
                   title: 'キャンペーン適用対象となる店舗IDのリスト'
-                  describe: |-
+                  description: |-
                     キャンペーンを適用する店舗IDを指定します (複数指定)。
                     指定しなかった場合は全店舗が対象になります。
+                blacklisted_shop_ids:
+                  type: array
+                  items:
+                    type: string
+                    format: uuid
+                  nullable: true
+                  title: 'キャンペーン適用対象外となる店舗IDのリスト(ブラックリスト方式)'
+                  description: |-
+                    キャンペーンの適用対象外となる店舗IDをブラックリスト方式で指定します (複数指定可)。
+                    このパラメータが指定されている場合、blacklisted_shop_idsに含まれていない店舗全てがキャンペーンの適用対象になります。
+                    blacklisted_shop_idsとapplicable_shop_idsは同時には指定できません。ホワイトリスト方式を使うときはapplicable_shop_idsを指定してください。
+                minimum_number_of_products:
+                  type: integer
+                  minimum: 1
+                  nullable: true
+                  title: 'キャンペーンを適用する1会計内の商品個数の下限'
+                  description: |-
+                    このパラメータを指定すると、取引時の1会計内のルールに適合する商品個数がminimum_number_of_productsを超えたときにのみキャンペーンが発火するようになります。
+                minimum_number_of_amount:
+                  type: integer
+                  minimum: 1
+                  nullable: true
+                  title: 'キャンペーンを適用する1会計内の商品総額の下限'
+                  description: |-
+                    このパラメータを指定すると、取引時の1会計内のルールに適合する商品総額がminimum_number_of_amountを超えたときにのみキャンペーンが発火するようになります。
                 minimum_number_for_combination_purchase:
                   type: integer
                   minimum: 1
@@ -6957,6 +7734,7 @@ paths:
 
                     このパラメータが指定されている場合、各ユーザに対してそのキャンペーンによって過去付与されたポイントの累積値が記録されるようになります。
                     累積ポイント数がmax_total_point_amountを超えない限りにおいてキャンペーンで算出されたポイントが付与されます。
+
                 applicable_account_metadata:
                   description: |-
                     ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
@@ -7007,35 +7785,99 @@ paths:
                       "value": "male"
                     }
 
-      responses:
-        '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Campaign'
-        '400':
-          $ref: '#/components/responses/BadRequest'
-        '403':
-          $ref: '#/components/responses/Forbidden'
-        '404':
-          $ref: '#/components/responses/NotFound'
-        '422':
-          $ref: '#/components/responses/UnprocessableEntity'
-  /user-stats:
-    post:
-      tags:
-        - Transaction
-      summary: '指定期間内の顧客が行った取引の統計情報をCSVでダウンロードする'
-      description: |-
-        期間を指定して、期間内に発行マネーの全顧客が行った取引の総額・回数などをCSVでダウンロードする機能です。
-        CSVの作成は非同期で行われるため完了まで少しの間待つ必要がありますが、完了時にダウンロードできるURLをレスポンスとして返します。
-        このURLの有効期限はリクエスト日時から7日間です。
+                applicable_transaction_metadata:
+                  description: |-
+                    取引時に指定するメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
+                    メタデータの属性名 key とメタデータの値 value の組をオブジェクトとして指定します。
+                    取引のメタデータはCreatePaymentTransactionやCreateExternalTransactionで登録できます。
 
-        ダウンロードできるCSVのデータは以下のものです。
+                    オプショナルパラメータtestによって比較方法を指定することができます。
+                    デフォルトは equal で、その他に not-equalを指定可能です。
 
-        * organization_code: 取引を行った組織コード
-        * private_money_id: 取引されたマネーのID
+                    例1: 取引のメタデータに会員ランクとしてbronzeが指定されているときのみ発火
+
+                    ```javascript
+                    {
+                      "key": "rank",
+                      "value": "bronze"
+                    }
+                    ```
+
+                    例2: 取引のメタデータに会員ランクとしてbronze以外が指定されているときのみ発火
+
+                    ```javascript
+                    {
+                      "key": "rank",
+                      "value": "bronze",
+                      "test": "not-equal"
+                    }
+                    ```
+
+                  type: object
+                  nullable: true
+                  properties:
+                    key:
+                      type: string
+                      description: |-
+                        メタデータの属性名
+                    value:
+                      type: string
+                      description: |-
+                        メタデータの値
+                    test:
+                      type: string
+                      enum: [equal, not-equal]
+                      description: |-
+                        メタデータの値の比較方法。デフォルトはequal
+                  example: |-
+                    {
+                      "key": "rank",
+                      "value": "bronze"
+                    }
+
+                budget_caps_amount:
+                  title: 'キャンペーン予算上限'
+                  type: integer
+                  minimum: 1
+                  maximum: 10000000000
+                  nullable: true
+                  description: |-
+                    キャンペーンの予算上限を指定します。
+
+                    キャンペーン予算上限が設定されておらずこのパラメータに数値が指定されている場合、このキャンペーンの適用により付与されたポイント全体を定期的に集計し、その合計が上限を越えていた場合にはキャンペーンを無効にします。
+                    一度この値を越えて無効となったキャンペーンを再度有効にすることは出来ません。
+                    キャンペーン予算上限が設定されておらずこのパラメータにnullが指定されている場合、何も発生しない。
+                    キャンペーン予算上限が設定されておりこのパラメータにnullが指定された場合、キャンペーン予算上限は止まります。
+
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Campaign'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+  /user-stats:
+    post:
+      tags:
+        - Transaction
+      summary: '指定期間内の顧客が行った取引の統計情報をCSVでダウンロードする'
+      description: |-
+        期間を指定して、期間内に発行マネーの全顧客が行った取引の総額・回数などをCSVでダウンロードする機能です。
+        CSVの作成は非同期で行われるため完了まで少しの間待つ必要がありますが、完了時にダウンロードできるURLをレスポンスとして返します。
+        このURLの有効期限はリクエスト日時から7日間です。
+
+        ダウンロードできるCSVのデータは以下のものです。
+
+        * organization_code: 取引を行った組織コード
+        * private_money_id: 取引されたマネーのID
         * private_money_name: 取引されたマネーの名前
         * user_id: 決済したユーザーID
         * user_external_id: 決済したユーザーの外部ID
@@ -7052,6 +7894,7 @@ paths:
           application/json:
             schema:
               required: ["from", "to"]
+              x-pokepay-conditional-parameters: {<: [from, to]}
               properties:
                 from:
                   title: '集計期間の開始時刻'
@@ -7060,6 +7903,7 @@ paths:
                   description: |-
                     集計する期間の開始時刻をISO8601形式で指定します。
                     時刻は現在時刻、及び `to` で指定する時刻以前である必要があります。
+                  example: '2022-05-20T17:56:49.000000+09:00'
                 to:
                   title: '集計期間の終了時刻'
                   type: string
@@ -7067,6 +7911,7 @@ paths:
                   description: |-
                     集計する期間の終了時刻をISO8601形式で指定します。
                     時刻は現在時刻、及び `from` で指定する時刻の間である必要があります。
+                  example: '2023-12-10T01:16:11.000000+09:00'
       responses:
         '200':
           description: OK
@@ -7080,6 +7925,7 @@ paths:
           $ref: '#/components/responses/UnpermittedAdminUser'
         '503':
           $ref: '#/components/responses/UserStatsOperationServiceUnavailable'
+
   /webhooks:
     post:
       x-pokepay-operator-name: "CreateWebhook"
@@ -7212,6 +8058,308 @@ paths:
         '409':
           $ref: '#/components/responses/Conflict'
 
+    delete:
+      x-pokepay-operator-name: "DeleteWebhook"
+      x-pokepay-allow-server-side: true
+      tags:
+        - Webhook
+      summary: Webhookの削除
+      description: 指定したWebhookを削除します
+      parameters:
+        - in: path
+          name: webhook_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: 'Webhook ID'
+          description: |-
+            削除するWebhookのIDです。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OrganizationWorkerTaskWebhook'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+
+  /user-devices:
+    post:
+      x-pokepay-operator-name: "CreateUserDevice"
+      x-pokepay-allow-server-side: true
+      tags:
+        - UserDevice
+      summary: ユーザーのデバイス登録
+      description: ユーザーのデバイスを新規に登録します
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: [user_id]
+              properties:
+                user_id:
+                  type: string
+                  format: uuid
+                  title: 'ユーザーID'
+                metadata:
+                  type: string
+                  format: json
+                  title: ユーザーデバイスのメタデータ
+                  description: |
+                    ユーザーのデバイス用の情報をメタデータを保持するために用います。
+                    例: 端末の固有情報やブラウザのUser-Agent
+                  example: '{"user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:120.0) Gecko/20100101 Firefox/120.0"}'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserDevice'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+
+  /user-devices/{user_device_id}:
+    get:
+      x-pokepay-operator-name: "GetUserDevice"
+      x-pokepay-allow-server-side: true
+      tags:
+        - UserDevice
+      summary: ユーザーのデバイスを取得
+      description: ユーザーのデバイスの情報を取得します
+      parameters:
+        - in: path
+          name: user_device_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: ユーザーデバイスID
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserDevice'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+
+  /user-devices/{user_device_id}/activate:
+    post:
+      x-pokepay-operator-name: "ActivateUserDevice"
+      x-pokepay-allow-server-side: true
+      tags:
+        - UserDevice
+      summary: デバイスの有効化
+      description: |
+        指定のデバイスを有効化し、それ以外の同一ユーザーのデバイスを無効化します。
+      parameters:
+        - in: path
+          name: user_device_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: "ユーザーデバイスID"
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserDevice'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+        '503':
+          $ref: '#/components/responses/UserStatsOperationServiceUnavailable'
+
+  /user-devices/{user_device_id}/banks:
+    post:
+      x-pokepay-operator-name: "CreateBank"
+      x-pokepay-allow-server-side: true
+      tags:
+        - BankPay
+      summary: 銀行口座の登録
+      description: |
+        銀行口座の登録を始めるAPIです。レスポンスに含まれるredirect_urlをユーザーの端末で開き銀行を登録します。
+
+        ユーザーが銀行口座の登録に成功すると、callback_urlにリクエストが行われます。
+        アプリの場合はDeep Linkを使うことを想定しています。
+      parameters:
+        - in: path
+          name: user_device_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: "デバイスID"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id", "callback_url", "kana"]
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+                  title: 'マネーID'
+                callback_url:
+                  type: string
+                  maxLength: 256
+                  example: '<Deep Link>'
+                  title: 'コールバックURL'
+                kana:
+                  type: string
+                  maxLength: 30
+                  example: 'ポケペイタロウ'
+                  title: 'ユーザーの氏名 (片仮名で指定)'
+                email:
+                  type: string
+                  format: email
+                  maxLength: 300
+                  title: 'ユーザーのメールアドレス'
+                birthdate:
+                  type: string
+                  maxLength: 8
+                  title: '生年月日'
+                  example: '19901142'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BankRegisteringInfo'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+        '503':
+          $ref: '#/components/responses/UserStatsOperationServiceUnavailable'
+    get:
+      x-pokepay-operator-name: "ListBanks"
+      x-pokepay-allow-server-side: true
+      tags:
+        - BankPay
+      summary: 登録した銀行の一覧
+      description: 登録した銀行を一覧します
+      parameters:
+        - in: path
+          name: user_device_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: "デバイスID"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Banks'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+
+  /user-devices/{user_device_id}/banks/topup:
+    post:
+      x-pokepay-operator-name: "CreateBankTopupTransaction"
+      x-pokepay-allow-server-side: true
+      tags:
+        - BankPay
+      summary: 銀行からのチャージ
+      description: 指定のマネーのアカウントにbank_idの口座を用いてチャージを行います。
+      parameters:
+        - in: path
+          name: user_device_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: "デバイスID"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id", "amount", "bank_id", "request_id"]
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+                  title: 'マネーID'
+                amount:
+                  type: integer
+                  minimum: 1
+                  title: 'チャージ金額'
+                bank_id:
+                  type: string
+                  format: uuid
+                  title: '銀行ID'
+                request_id:
+                  type: string
+                  format: uuid
+                  title: 'リクエストID'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TransactionDetail'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+
   /coupons:
     get:
       x-pokepay-operator-name: "ListCoupons"
@@ -7294,7 +8442,112 @@ paths:
           $ref: '#/components/responses/UnpermittedAdminUser'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
-  /coupons/{coupon-id}:
+    post:
+      x-pokepay-operator-name: "CreateCoupon"
+      x-pokepay-allow-server-side: true
+      tags:
+        - Coupon
+      summary: クーポンの登録
+      description: 新しいクーポンを登録します
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id", "name", "starts_at", "ends_at", "issued_shop_id"]
+              x-pokepay-conditional-parameters:
+                xor: [discount_amount, discount_percentage]
+                xnor: [is_shop_specified, available_shop_ids]
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+                name:
+                  type: string
+                  maxLength: 128
+                description:
+                  type: string
+                  maxLength: 256
+                discount_amount:
+                  type: integer
+                  minimum: 0
+                discount_percentage:
+                  type: number
+                  minimum: 0
+                discount_upper_limit:
+                  type: integer
+                  minimum: 0
+                starts_at:
+                  type: string
+                  format: date-time
+                ends_at:
+                  type: string
+                  format: date-time
+                display_starts_at:
+                  type: string
+                  format: date-time
+                  title: 'クーポンの掲載期間(開始日時)'
+                display_ends_at:
+                  type: string
+                  format: date-time
+                  title: 'クーポンの掲載期間(終了日時)'
+                is_disabled:
+                  type: boolean
+                  title: '無効化フラグ'
+                is_hidden:
+                  type: boolean
+                  title: 'クーポン一覧に掲載されるかどうか'
+                  description: |
+                    アプリに表示されるクーポン一覧に掲載されるかどうか。
+                    主に一時的に掲載から外したいときに用いられる。そのためis_publicの設定よりも優先される。
+                is_public:
+                  type: boolean
+                  title: 'アプリ配信なしで受け取れるかどうか'
+                code:
+                  type: string
+                  title: 'クーポン受け取りコード'
+                usage_limit:
+                  type: integer
+                  title: 'ユーザごとの利用可能回数(NULLの場合は無制限)'
+                  default: 1
+                min_amount:
+                  type: integer
+                  title: 'クーポン適用可能な最小取引額'
+                issued_shop_id:
+                  type: string
+                  format: uuid
+                  title: '発行元の店舗ID'
+                is_shop_specified:
+                  type: boolean
+                  title: '特定店舗限定のクーポンかどうか'
+                available_shop_ids:
+                  type: array
+                  items:
+                    type: string
+                    format: uuid
+                  title: '利用可能店舗リスト'
+                storage_id:
+                  type: string
+                  format: uuid
+                  title: "ストレージID"
+                  description: "Storage APIでアップロードしたクーポン画像のStorage IDを指定します"
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CouponDetail'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+
+  /coupons/{coupon_id}:
     get:
       x-pokepay-operator-name: "GetCoupon"
       x-pokepay-allow-server-side: true
@@ -7304,7 +8557,7 @@ paths:
       description: 指定したIDを持つクーポンを取得します
       parameters:
         - in: path
-          name: coupon-id
+          name: coupon_id
           required: true
           schema:
             type: string
@@ -7327,3 +8580,112 @@ paths:
           $ref: '#/components/responses/UnpermittedAdminUser'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
+    patch:
+      x-pokepay-operator-name: "UpdateCoupon"
+      x-pokepay-allow-server-side: true
+      tags:
+        - Coupon
+      summary: クーポンの更新
+      description: 指定したクーポンを更新します
+      parameters:
+        - in: path
+          name: coupon_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: 'クーポンID'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              x-pokepay-conditional-parameters: {or: [discount_amount, discount_percentage]}
+              properties:
+                name:
+                  type: string
+                  maxLength: 128
+                description:
+                  type: string
+                  maxLength: 256
+                discount_amount:
+                  type: integer
+                  nullable: true
+                  minimum: 0
+                discount_percentage:
+                  type: number
+                  nullable: true
+                  minimum: 0
+                discount_upper_limit:
+                  type: integer
+                  nullable: true
+                  minimum: 0
+                starts_at:
+                  type: string
+                  format: date-time
+                ends_at:
+                  type: string
+                  format: date-time
+                display_starts_at:
+                  type: string
+                  format: date-time
+                  nullable: true
+                  title: 'クーポンの掲載期間(開始日時)'
+                display_ends_at:
+                  type: string
+                  format: date-time
+                  nullable: true
+                  title: 'クーポンの掲載期間(終了日時)'
+                is_disabled:
+                  type: boolean
+                  title: '無効化フラグ'
+                is_hidden:
+                  type: boolean
+                  title: 'クーポン一覧に掲載されるかどうか'
+                  description: |
+                    アプリに表示されるクーポン一覧に掲載されるかどうか。
+                    主に一時的に掲載から外したいときに用いられる。そのためis_publicの設定よりも優先される。
+                is_public:
+                  type: boolean
+                  title: 'アプリ配信なしで受け取れるかどうか'
+                code:
+                  type: string
+                  nullable: true
+                  title: 'クーポン受け取りコード'
+                usage_limit:
+                  type: integer
+                  nullable: true
+                  title: 'ユーザごとの利用可能回数(NULLの場合は無制限)'
+                min_amount:
+                  type: integer
+                  nullable: true
+                  title: 'クーポン適用可能な最小取引額'
+                is_shop_specified:
+                  type: boolean
+                  title: '特定店舗限定のクーポンかどうか'
+                available_shop_ids:
+                  type: array
+                  items:
+                    type: string
+                    format: uuid
+                  title: '利用可能店舗リスト'
+                storage_id:
+                  type: string
+                  format: uuid
+                  title: "ストレージID"
+                  description: "Storage APIでアップロードしたクーポン画像のStorage IDを指定します"
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CouponDetail'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/UnpermittedAdminUser'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'