PortOne Platform API

openapi: 3.0.3
info:
  title: PortOne B2b Platform API
  version: 1.16.0
servers:
- url: https://api.portone.io
  description: 운영환경 서버
tags:
- name: Platform
paths:
  /platform/account-transfers:
    get:
      summary: 이체 내역 다건 조회
      description: '이체 내역 다건 조회


        여러 이체 내역을 조회합니다.'
      operationId: getPlatformAccountTransfers
      parameters:
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      - name: requestBody
        in: query
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountTransfersBody1'
      responses:
        '200':
          description: 성공 응답으로 조회된 이체 내역과 페이지 정보를 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAccountTransfersResponse'
          x-portone-description: 성공 응답으로 조회된 이체 내역과 페이지 정보를 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAccountTransfersError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAccountTransfersError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAccountTransfersError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: platform.accountTransfer
      x-portone-title: 이체 내역 다건 조회
      x-portone-description: 여러 이체 내역을 조회합니다.
      x-portone-error:
        $ref: '#/components/schemas/GetPlatformAccountTransfersError'
      x-portone-unstable: true
      tags:
      - Platform
  /platform/additional-fee-policies/{id}/archive:
    post:
      summary: 추가 수수료 정책 보관
      description: '추가 수수료 정책 보관


        주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.'
      operationId: archivePlatformAdditionalFeePolicy
      parameters:
      - name: id
        in: path
        description: 추가 수수료 정책 아이디
        required: true
        schema:
          type: string
        x-portone-title: 추가 수수료 정책 아이디
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      responses:
        '200':
          description: 성공 응답으로 보관된 추가 수수료 정책 객체를 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchivePlatformAdditionalFeePolicyResponse'
          x-portone-description: 성공 응답으로 보관된 추가 수수료 정책 객체를 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchivePlatformAdditionalFeePolicyError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchivePlatformAdditionalFeePolicyError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchivePlatformAdditionalFeePolicyError'
        '404':
          description: '* `PlatformAdditionalFeePolicyNotFoundError`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchivePlatformAdditionalFeePolicyError'
        '409':
          description: '* `PlatformCannotArchiveScheduledAdditionalFeePolicyError`: 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchivePlatformAdditionalFeePolicyError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: platform.policy
      x-portone-title: 추가 수수료 정책 보관
      x-portone-description: 주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.
      x-portone-error:
        $ref: '#/components/schemas/ArchivePlatformAdditionalFeePolicyError'
      tags:
      - Platform
  /platform/additional-fee-policies/{id}/recover:
    post:
      summary: 추가 수수료 정책 복원
      description: '추가 수수료 정책 복원


        주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.'
      operationId: recoverPlatformAdditionalFeePolicy
      parameters:
      - name: id
        in: path
        description: 추가 수수료 정책 아이디
        required: true
        schema:
          type: string
        x-portone-title: 추가 수수료 정책 아이디
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      responses:
        '200':
          description: 성공 응답으로 복원된 추가 수수료 정책 객체를 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoverPlatformAdditionalFeePolicyResponse'
          x-portone-description: 성공 응답으로 복원된 추가 수수료 정책 객체를 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoverPlatformAdditionalFeePolicyError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoverPlatformAdditionalFeePolicyError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoverPlatformAdditionalFeePolicyError'
        '404':
          description: '* `PlatformAdditionalFeePolicyNotFoundError`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoverPlatformAdditionalFeePolicyError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: platform.policy
      x-portone-title: 추가 수수료 정책 복원
      x-portone-description: 주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.
      x-portone-error:
        $ref: '#/components/schemas/RecoverPlatformAdditionalFeePolicyError'
      tags:
      - Platform
  /platform/additional-fee-policies/{id}/schedule:
    get:
      description: 주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 조회합니다.
      operationId: getPlatformAdditionalFeePolicySchedule
      parameters:
      - name: id
        in: path
        description: 추가 수수료 정책 아이디
        required: true
        schema:
          type: string
        x-portone-title: 추가 수수료 정책 아이디
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      responses:
        '200':
          description: 성공 응답으로 예약된 추가 수수료 정책을 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformAdditionalFeePolicy'
          x-portone-description: 성공 응답으로 예약된 추가 수수료 정책을 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyScheduleError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyScheduleError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyScheduleError'
        '404':
          description: '* `PlatformAdditionalFeePolicyNotFoundError`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyScheduleError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-description: 주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 조회합니다.
      x-portone-error:
        $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyScheduleError'
      x-portone-unstable: true
      tags:
      - Platform
    put:
      operationId: rescheduleAdditionalFeePolicy
      parameters:
      - name: id
        in: path
        description: 추가 수수료 정책 아이디
        required: true
        schema:
          type: string
        x-portone-title: 추가 수수료 정책 아이디
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReschedulePlatformAdditionalFeePolicyBody'
        required: true
      responses:
        '200':
          description: 성공 응답으로 예약된 추가 수수료 정책이 반환됩니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReschedulePlatformAdditionalFeePolicyResponse'
          x-portone-description: 성공 응답으로 예약된 추가 수수료 정책이 반환됩니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RescheduleAdditionalFeePolicyError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RescheduleAdditionalFeePolicyError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RescheduleAdditionalFeePolicyError'
        '404':
          description: '* `PlatformAdditionalFeePolicyNotFoundError`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RescheduleAdditionalFeePolicyError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-error:
        $ref: '#/components/schemas/RescheduleAdditionalFeePolicyError'
      x-portone-unstable: true
      tags:
      - Platform
    post:
      description: 주어진 아이디에 대응되는 추가 수수료 정책에 업데이트를 예약합니다.
      operationId: scheduleAdditionalFeePolicy
      parameters:
      - name: id
        in: path
        description: 추가 수수료 정책 아이디
        required: true
        schema:
          type: string
        x-portone-title: 추가 수수료 정책 아이디
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchedulePlatformAdditionalFeePolicyBody'
        required: true
      responses:
        '200':
          description: 성공 응답으로 예약된 추가 수수료 정책을 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchedulePlatformAdditionalFeePolicyResponse'
          x-portone-description: 성공 응답으로 예약된 추가 수수료 정책을 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleAdditionalFeePolicyError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleAdditionalFeePolicyError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleAdditionalFeePolicyError'
        '404':
          description: '* `PlatformAdditionalFeePolicyNotFoundError`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleAdditionalFeePolicyError'
        '409':
          description: '* `PlatformAdditionalFeePolicyScheduleAlreadyExistsError`

            * `PlatformArchivedAdditionalFeePolicyError`: 보관된 추가 수수료 정책을 업데이트하려고 하는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleAdditionalFeePolicyError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-description: 주어진 아이디에 대응되는 추가 수수료 정책에 업데이트를 예약합니다.
      x-portone-error:
        $ref: '#/components/schemas/ScheduleAdditionalFeePolicyError'
      x-portone-unstable: true
      tags:
      - Platform
    delete:
      description: 주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 취소합니다.
      operationId: cancelPlatformAdditionalFeePolicySchedule
      parameters:
      - name: id
        in: path
        description: 추가 수수료 정책 아이디
        required: true
        schema:
          type: string
        x-portone-title: 추가 수수료 정책 아이디
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPlatformAdditionalFeePolicyScheduleResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPlatformAdditionalFeePolicyScheduleError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPlatformAdditionalFeePolicyScheduleError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPlatformAdditionalFeePolicyScheduleError'
        '404':
          description: '* `PlatformAdditionalFeePolicyNotFoundError`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPlatformAdditionalFeePolicyScheduleError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-description: 주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 취소합니다.
      x-portone-error:
        $ref: '#/components/schemas/CancelPlatformAdditionalFeePolicyScheduleError'
      x-portone-unstable: true
      tags:
      - Platform
  /platform/additional-fee-policies/{id}:
    get:
      summary: 추가 수수료 정책 조회
      description: '추가 수수료 정책 조회


        주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.'
      operationId: getPlatformAdditionalFeePolicy
      parameters:
      - name: id
        in: path
        description: 조회할 추가 수수료 정책 아이디
        required: true
        schema:
          type: string
        x-portone-title: 조회할 추가 수수료 정책 아이디
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      responses:
        '200':
          description: 성공 응답으로 추가 수수료 정책을 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformAdditionalFeePolicy'
          x-portone-description: 성공 응답으로 추가 수수료 정책을 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyError'
        '404':
          description: '* `PlatformAdditionalFeePolicyNotFoundError`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: platform.policy
      x-portone-title: 추가 수수료 정책 조회
      x-portone-description: 주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.
      x-portone-error:
        $ref: '#/components/schemas/GetPlatformAdditionalFeePolicyError'
      tags:
      - Platform
    patch:
      summary: 추가 수수료 정책 수정
      description: '추가 수수료 정책 수정


        주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다.'
      operationId: updatePlatformAdditionalFeePolicy
      parameters:
      - name: id
        in: path
        description: 업데이트할 추가 수수료 정책 아이디
        required: true
        schema:
          type: string
        x-portone-title: 업데이트할 추가 수수료 정책 아이디
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyBody'
        required: true
      responses:
        '200':
          description: 성공 응답으로 업데이트된 추가 수수료 정책이 반환됩니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyResponse'
          x-portone-description: 성공 응답으로 업데이트된 추가 수수료 정책이 반환됩니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyError'
        '403':
          description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

            * `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyError'
        '404':
          description: '* `PlatformAdditionalFeePolicyNotFoundError`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyError'
        '409':
          description: '* `PlatformArchivedAdditionalFeePolicyError`: 보관된 추가 수수료 정책을 업데이트하려고 하는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: platform.policy
      x-portone-title: 추가 수수료 정책 수정
      x-portone-description: 주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다.
      x-portone-error:
        $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyError'
      tags:
      - Platform
  /platform/additional-fee-policies:
    get:
      summary: 추가 수수료 정책 다건 조회
      description: '추가 수수료 정책 다건 조회


        여러 추가 수수료 정책을 조회합니다.'
      operationId: getPlatformAdditionalFeePolicies
      parameters:
      - name: test
        in: query
        description: '테스트 모드 여부


          테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.'
        required: false
        schema:
          type: boolean
        x-portone-title: 테스트 모드 여부
        x-portone-description: 테스트 모드 여부를 결정합니다. true �

# --- truncated at 32 KB (577 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/portone/refs/heads/main/openapi/portone-platform-api-openapi.yml