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 이면 테스트 모드로 실행됩니다. 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/GetPlatformAdditionalFeePoliciesBody' responses: '200': description: 성공 응답으로 조회된 추가 수수료 정책 리스트와 페이지 정보를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/GetPlatformAdditionalFeePoliciesResponse' x-portone-description: 성공 응답으로 조회된 추가 수수료 정책 리스트와 페이지 정보를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformAdditionalFeePoliciesError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformAdditionalFeePoliciesError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformAdditionalFeePoliciesError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 추가 수수료 정책 다건 조회 x-portone-description: 여러 추가 수수료 정책을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformAdditionalFeePoliciesError' tags: - Platform post: summary: 추가 수수료 정책 생성 description: '추가 수수료 정책 생성 새로운 추가 수수료 정책을 생성합니다.' operationId: createPlatformAdditionalFeePolicy 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformAdditionalFeePolicyBody' required: true responses: '200': description: 성공 응답 content: application/json: schema: $ref: '#/components/schemas/CreatePlatformAdditionalFeePolicyResponse' x-portone-title: 성공 응답 '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformAdditionalFeePolicyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformAdditionalFeePolicyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformAdditionalFeePolicyError' '409': description: '* `PlatformAdditionalFeePolicyAlreadyExistsError`' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformAdditionalFeePolicyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 추가 수수료 정책 생성 x-portone-description: 새로운 추가 수수료 정책을 생성합니다. x-portone-error: $ref: '#/components/schemas/CreatePlatformAdditionalFeePolicyError' tags: - Platform /platform/bank-accounts/{bank}/{accountNumber}/holder: get: summary: 예금주 조회 description: '예금주 조회 계좌의 예금주를 조회합니다.' operationId: getPlatformAccountHolder parameters: - name: bank in: path description: 은행 required: true schema: $ref: '#/components/schemas/Bank' x-portone-title: 은행 - name: accountNumber 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로 적용됩니다. - name: birthdate in: query description: '생년월일 실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.' required: false schema: type: string x-portone-title: 생년월일 x-portone-description: 실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다. - name: businessRegistrationNumber in: query description: '사업자등록번호 실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.' required: false schema: type: string x-portone-title: 사업자등록번호 x-portone-description: 실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다. responses: '200': description: 성공 응답으로 조회된 예금주 명이 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/PlatformAccountHolder' x-portone-description: 성공 응답으로 조회된 예금주 명이 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformNotSupportedBankError`: 지원하지 않는 은행인 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformAccountHolderError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformAccountHolderError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformAccountHolderError' '503': description: '* `PlatformExternalApiTemporarilyFailedError`: 외부 api의 일시적인 오류 * `PlatformExternalApiFailedError`: 외부 api 오류' content: application/json: schema: $ref: '#/components/schemas/GetPlatformAccountHolderError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.account x-portone-title: 예금주 조회 x-portone-description: 계좌의 예금주를 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformAccountHolderError' tags: - Platform /platform/bulk-account-transfers: get: summary: 일괄 이체 내역 다건 조회 description: '일괄 이체 내역 다건 조회 성공 응답으로 조회된 일괄 이체 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다.' operationId: getPlatformBulkAccountTransfers 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/GetPlatformBulkAccountTransfersBody' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetPlatformBulkAccountTransfersResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformBulkAccountTransfersError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformBulkAccountTransfersError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformBulkAccountTransfersError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.bulkAccountTransfer x-portone-title: 일괄 이체 내역 다건 조회 x-portone-description: 성공 응답으로 조회된 일괄 이체 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformBulkAccountTransfersError' tags: - Platform /platform/bulk-payouts: get: summary: 일괄 지급 내역 다건 조회 description: '일괄 지급 내역 다건 조회 성공 응답으로 조회된 일괄 지급 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다.' operationId: getPlatformBulkPayouts 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/GetPlatformBulkPayoutsBody' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetPlatformBulkPayoutsResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformBulkPayoutsError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformBulkPayoutsError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformBulkPayoutsError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.bulkPayout x-portone-title: 일괄 지급 내역 다건 조회 x-portone-description: 성공 응답으로 조회된 일괄 지급 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformBulkPayoutsError' tags: - Platform /platform/companies/{businessRegistrationNumber}/state: get: summary: 사업자 조회 description: '사업자 조회 사업자 정보를 조회합니다. 포트원 서비스에 연동 및 등록되지 않은 사업자도 조회 가능합니다.' operationId: getPlatformCompanyState parameters: - name: businessRegistrationNumber 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/GetPlatformCompanyStatePayload' x-portone-description: 성공 응답으로 조회된 사업자 상태가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformCompanyStateError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformCompanyStateError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformCompanyStateError' '404': description: '* `PlatformCompanyNotFoundError`: 사업자 정보를 찾을 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformCompanyStateError' '503': description: '* `PlatformExternalApiFailedError`: 외부 api 오류' content: application/json: schema: $ref: '#/components/schemas/GetPlatformCompanyStateError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.company x-portone-title: 사업자 조회 x-portone-description: 사업자 정보를 조회합니다. 포트원 서비스에 연동 및 등록되지 않은 사업자도 조회 가능합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformCompanyStateError' tags: - Platform /platform/contracts/{id}/archive: post: summary: 계약 보관 description: '계약 보관 주어진 아이디에 대응되는 계약을 보관합니다.' operationId: archivePlatformContract 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/ArchivePlatformContractResponse' x-portone-description: 성공 응답으로 보관된 계약 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformContractError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformContractError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformContractError' '404': description: '* `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformContractError' '409': description: '* `PlatformCannotArchiveScheduledContractError`: 예약된 업데이트가 있는 계약을 보관하려고 하는 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformContractError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 계약 보관 x-portone-description: 주어진 아이디에 대응되는 계약을 보관합니다. x-portone-error: $ref: '#/components/schemas/ArchivePlatformContractError' tags: - Platform /platform/contracts/{id}/recover: post: summary: 계약 복원 description: '계약 복원 주어진 아이디에 대응되는 계약을 복원합니다.' operationId: recoverPlatformContract 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/RecoverPlatformContractResponse' x-portone-description: 성공 응답으로 복원된 계약 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformContractError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformContractError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformContractError' '404': description: '* `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformContractError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 계약 복원 x-portone-description: 주어진 아이디에 대응되는 계약을 복원합니다. x-portone-error: $ref: '#/components/schemas/RecoverPlatformContractError' tags: - Platform /platform/contracts/{id}/schedule: get: description: 주어진 아이디에 대응되는 계약의 예약 업데이트를 조회합니다. operationId: getPlatformContractSchedule 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/PlatformContract' x-portone-description: 성공 응답으로 예약된 계약 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractScheduleError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractScheduleError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractScheduleError' '404': description: '* `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractScheduleError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 계약의 예약 업데이트를 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformContractScheduleError' x-portone-unstable: true tags: - Platform put: description: 주어진 아이디에 대응되는 계약에 예약 업데이트를 재설정합니다. operationId: rescheduleContract 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/ReschedulePlatformContractBody' required: true responses: '200': description: 성공 응답으로 예약된 계약 객체를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/ReschedulePlatformContractResponse' x-portone-description: 성공 응답으로 예약된 계약 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RescheduleContractError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RescheduleContractError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/RescheduleContractError' '404': description: '* `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/RescheduleContractError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 계약에 예약 업데이트를 재설정합니다. x-portone-error: $ref: '#/components/schemas/RescheduleContractError' x-portone-unstable: true tags: - Platform post: description: 주어진 아이디에 대응되는 계약에 업데이트를 예약합니다. operationId: scheduleContract 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/SchedulePlatformContractBody' required: true responses: '200': description: 성공 응답으로 예약된 계약 객체를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformContractResponse' x-portone-description: 성공 응답으로 예약된 계약 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ScheduleContractError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ScheduleContractError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/ScheduleContractError' '404': description: '* `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/ScheduleContractError' '409': description: '* `PlatformContractScheduleAlreadyExistsError` * `PlatformArchivedContractError`: 보관된 계약을 업데이트하려고 하는 경우' content: application/json: schema: $ref: '#/components/schemas/ScheduleContractError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 계약에 업데이트를 예약합니다. x-portone-error: $ref: '#/components/schemas/ScheduleContractError' x-portone-unstable: true tags: - Platform delete: description: 주어진 아이디에 대응되는 계약의 예약 업데이트를 취소합니다. operationId: cancelPlatformContractSchedule 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/CancelPlatformContractScheduleResponse' x-portone-title: 성공 응답 '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformContractScheduleError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformContractScheduleError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformContractScheduleError' '404': description: '* `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformContractScheduleError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 계약의 예약 업데이트를 취소합니다. x-portone-error: $ref: '#/components/schemas/CancelPlatformContractScheduleError' x-portone-unstable: true tags: - Platform /platform/contracts/{id}: get: summary: 계약 조회 description: '계약 조회 주어진 아이디에 대응되는 계약을 조회합니다.' operationId: getPlatformContract 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/PlatformContract' x-portone-description: 성공 응답으로 계약 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractError' '404': description: '* `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 계약 조회 x-portone-description: 주어진 아이디에 대응되는 계약을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformContractError' tags: - Platform patch: summary: 계약 수정 description: '계약 수정 주어진 아이디에 대응되는 계약을 업데이트합니다.' operationId: updatePlatformContract 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/UpdatePlatformContractBody' required: true responses: '200': description: 성공 응답으로 업데이트된 계약 객체가 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformContractResponse' x-portone-description: 성공 응답으로 업데이트된 계약 객체가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformContractError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformContractError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformContractError' '404': description: '* `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformContractError' '409': description: '* `PlatformArchivedContractError`: 보관된 계약을 업데이트하려고 하는 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformContractError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 계약 수정 x-portone-description: 주어진 아이디에 대응되는 계약을 업데이트합니다. x-portone-error: $ref: '#/components/schemas/UpdatePlatformContractError' tags: - Platform /platform/contracts: get: summary: 계약 다건 조회 description: '계약 다건 조회 여러 계약을 조회합니다.' operationId: getPlatformContracts 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/GetPlatformContractsBody' responses: '200': description: 성공 응답으로 조회된 계약 리스트와 페이지 정보를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractsResponse' x-portone-description: 성공 응답으로 조회된 계약 리스트와 페이지 정보를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractsError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractsError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformContractsError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 계약 다건 조회 x-portone-description: 여러 계약을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformContractsError' tags: - Platform post: summary: 계약 생성 description: '계약 생성 새로운 계약을 생성합니다.' operationId: createPlatformContract 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformContractBody' required: true responses: '200': description: 성공 응답으로 생성된 계약 객체가 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/CreatePlatformContractResponse' x-portone-description: 성공 응답으로 생성된 계약 객체가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformContractError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformContractError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformContractError' '409': description: '* `PlatformContractAlreadyExistsError`' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformContractError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 계약 생성 x-portone-description: 새로운 계약을 생성합니다. x-portone-error: $ref: '#/components/schemas/CreatePlatformContractError' tags: - Platform /platform/discount-share-policies/{id}/archive: post: summary: 할인 분담 정책 보관 description: '할인 분담 정책 보관 주어진 아이디에 대응되는 할인 분담을 보관합니다.' operationId: archivePlatformDiscountSharePolicy 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/ArchivePlatformDiscountSharePolicyResponse' x-portone-description: 성공 응답으로 보관된 할인 분담 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformDiscountSharePolicyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformDiscountSharePolicyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformDiscountSharePolicyError' '404': description: '* `PlatformDiscountSharePolicyNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformDiscountSharePolicyError' '409': description: '* `PlatformCannotArchiveScheduledDiscountSharePolicyError`: 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformDiscountSharePolicyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 할인 분담 정책 보관 x-portone-description: 주어진 아이디에 대응되는 할인 분담을 보관합니다. x-portone-error: $ref: '#/components/schemas/ArchivePlatformDiscountSharePolicyError' tags: - Platform /platform/discount-share-policies/{id}/recover: post: summary: 할인 분담 정책 복원 description: '할인 분담 정책 복원 주어진 아이디에 대응되는 할인 분담을 복원합니다.' operationId: recoverPlatformDiscountSharePolicy 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/RecoverPlatformDiscountSharePolicyResponse' x-portone-description: 성공 응답으로 복원된 할인 분담 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformDiscountSharePolicyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformDiscountSharePolicyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformDiscountSharePolicyError' '404': description: '* `PlatformDiscountSharePolicyNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformDiscountSharePolicyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 할인 분담 정책 복원 x-portone-description: 주어진 아이디에 대응되는 할인 분담을 복원합니다. x-portone-error: $ref: '#/components/schemas/RecoverPlatformDiscountSharePolicyError' tags: - Platform /platform/discount-share-policies/{id}/schedule: get: description: 주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 조회합니다. operationId: getPlatformDiscountSharePolicySchedule 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/PlatformDiscountSharePolicy' x-portone-description: 성공 응답으로 예약된 할인 분담 정책을 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyScheduleError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyScheduleError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyScheduleError' '404': description: '* `PlatformDiscountSharePolicyNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyScheduleError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyScheduleError' x-portone-unstable: true tags: - Platform put: description: 주어진 아이디에 대응되는 할인 분담에 예약 업데이트를 재설정합니다. operationId: rescheduleDiscountSharePolicy 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/ReschedulePlatformDiscountSharePolicyBody' required: true responses: '200': description: 성공 응답으로 예약된 할인 분담 정책을 반환합니다. content: application/json: schema: $ref: '#/components/schemas/ReschedulePlatformDiscountSharePolicyResponse' x-portone-description: 성공 응답으로 예약된 할인 분담 정책을 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RescheduleDiscountSharePolicyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RescheduleDiscountSharePolicyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/RescheduleDiscountSharePolicyError' '404': description: '* `PlatformDiscountSharePolicyNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/RescheduleDiscountSharePolicyError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 할인 분담에 예약 업데이트를 재설정합니다. x-portone-error: $ref: '#/components/schemas/RescheduleDiscountSharePolicyError' x-portone-unstable: true tags: - Platform post: description: 주어진 아이디에 대응되는 할인 분담에 업데이트를 예약합니다. operationId: scheduleDiscountSharePolicy 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/SchedulePlatformDiscountSharePolicyBody' required: true responses: '200': description: 성공 응답으로 예약된 할인 분담 정책이 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformDiscountSharePolicyResponse' x-portone-description: 성공 응답으로 예약된 할인 분담 정책이 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ScheduleDiscountSharePolicyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ScheduleDiscountSharePolicyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/ScheduleDiscountSharePolicyError' '404': description: '* `PlatformDiscountSharePolicyNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/ScheduleDiscountSharePolicyError' '409': description: '* `PlatformDiscountSharePolicyScheduleAlreadyExistsError` * `PlatformArchivedDiscountSharePolicyError`: 보관된 할인 분담 정책을 업데이트하려고 하는 경우' content: application/json: schema: $ref: '#/components/schemas/ScheduleDiscountSharePolicyError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 할인 분담에 업데이트를 예약합니다. x-portone-error: $ref: '#/components/schemas/ScheduleDiscountSharePolicyError' x-portone-unstable: true tags: - Platform delete: description: 주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 취소합니다. operationId: cancelPlatformDiscountSharePolicySchedule 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/CancelPlatformDiscountSharePolicyScheduleResponse' x-portone-title: 성공 응답 '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformDiscountSharePolicyScheduleError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformDiscountSharePolicyScheduleError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformDiscountSharePolicyScheduleError' '404': description: '* `PlatformDiscountSharePolicyNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformDiscountSharePolicyScheduleError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 취소합니다. x-portone-error: $ref: '#/components/schemas/CancelPlatformDiscountSharePolicyScheduleError' x-portone-unstable: true tags: - Platform /platform/discount-share-policies/{id}: get: summary: 할인 분담 정책 조회 description: '할인 분담 정책 조회 주어진 아이디에 대응되는 할인 분담을 조회합니다.' operationId: getPlatformDiscountSharePolicy 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/PlatformDiscountSharePolicy' x-portone-description: 성공 응답으로 할인 분담 정책을 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyError' '404': description: '* `PlatformDiscountSharePolicyNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 할인 분담 정책 조회 x-portone-description: 주어진 아이디에 대응되는 할인 분담을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyError' tags: - Platform patch: summary: 할인 분담 정책 수정 description: '할인 분담 정책 수정 주어진 아이디에 대응되는 할인 분담을 업데이트합니다.' operationId: updatePlatformDiscountSharePolicy 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/UpdatePlatformDiscountSharePolicyBody' required: true responses: '200': description: 성공 응답으로 업데이트된 할인 분담 정책을 반환합니다. content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyResponse' x-portone-description: 성공 응답으로 업데이트된 할인 분담 정책을 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyError' '404': description: '* `PlatformDiscountSharePolicyNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyError' '409': description: '* `PlatformArchivedDiscountSharePolicyError`: 보관된 할인 분담 정책을 업데이트하려고 하는 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 할인 분담 정책 수정 x-portone-description: 주어진 아이디에 대응되는 할인 분담을 업데이트합니다. x-portone-error: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyError' tags: - Platform /platform/discount-share-policies: get: summary: 할인 분담 정책 다건 조회 description: '할인 분담 정책 다건 조회 여러 할인 분담을 조회합니다.' operationId: getPlatformDiscountSharePolicies 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/GetPlatformDiscountSharePoliciesBody' responses: '200': description: 성공 응답으로 조회된 할인 분담 정책 리스트와 페이지 정보가 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePoliciesResponse' x-portone-description: 성공 응답으로 조회된 할인 분담 정책 리스트와 페이지 정보가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePoliciesError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePoliciesError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePoliciesError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 할인 분담 정책 다건 조회 x-portone-description: 여러 할인 분담을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformDiscountSharePoliciesError' tags: - Platform post: summary: 할인 분담 정책 생성 description: '할인 분담 정책 생성 새로운 할인 분담을 생성합니다.' operationId: createPlatformDiscountSharePolicy 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformDiscountSharePolicyBody' required: true responses: '200': description: 성공 응답으로 생성된 할인 분담 정책이 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/CreatePlatformDiscountSharePolicyResponse' x-portone-description: 성공 응답으로 생성된 할인 분담 정책이 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformDiscountSharePolicyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformDiscountSharePolicyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformDiscountSharePolicyError' '409': description: '* `PlatformDiscountSharePolicyAlreadyExistsError`' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformDiscountSharePolicyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.policy x-portone-title: 할인 분담 정책 생성 x-portone-description: 새로운 할인 분담을 생성합니다. x-portone-error: $ref: '#/components/schemas/CreatePlatformDiscountSharePolicyError' tags: - Platform /platform/discount-share-policy-filter-options: get: description: 할인 분담 정책 다건 조회 시 필요한 필터 옵션을 조회합니다. operationId: getPlatformDiscountSharePolicyFilterOptions 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: isArchived in: query description: '보관 조회 여부 true 이면 보관된 할인 분담의 필터 옵션을 조회하고, false 이면 보관되지 않은 할인 분담의 필터 옵션을 조회합니다. 기본값은 false 입니다.' required: false schema: type: boolean x-portone-title: 보관 조회 여부 x-portone-description: true 이면 보관된 할인 분담의 필터 옵션을 조회하고, false 이면 보관되지 않은 할인 분담의 필터 옵션을 조회합니다. 기본값은 false 입니다. responses: '200': description: 성공 응답으로 조회된 할인 분담 정책 필터 옵션을 반환합니다. content: application/json: schema: $ref: '#/components/schemas/PlatformDiscountSharePolicyFilterOptions' x-portone-description: 성공 응답으로 조회된 할인 분담 정책 필터 옵션을 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyFilterOptionsError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyFilterOptionsError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyFilterOptionsError' security: - bearerJwt: [] - portOne: [] x-portone-description: 할인 분담 정책 다건 조회 시 필요한 필터 옵션을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformDiscountSharePolicyFilterOptionsError' x-portone-unstable: true tags: - Platform /platform/partner-filter-options: get: description: 파트너 다건 조회 시 필요한 필터 옵션을 조회합니다. operationId: getPlatformPartnerFilterOptions 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: isArchived in: query description: '보관 조회 여부 true 이면 보관된 파트너의 필터 옵션을 조회하고, false 이면 보관되지 않은 파트너의 필터 옵션을 조회합니다. 기본값은 false 입니다.' required: false schema: type: boolean x-portone-title: 보관 조회 여부 x-portone-description: true 이면 보관된 파트너의 필터 옵션을 조회하고, false 이면 보관되지 않은 파트너의 필터 옵션을 조회합니다. 기본값은 false 입니다. responses: '200': description: 성공 응답으로 조회된 파트너 필터 옵션을 반환합니다. content: application/json: schema: $ref: '#/components/schemas/PlatformPartnerFilterOptions' x-portone-description: 성공 응답으로 조회된 파트너 필터 옵션을 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerFilterOptionsError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerFilterOptionsError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerFilterOptionsError' security: - bearerJwt: [] - portOne: [] x-portone-description: 파트너 다건 조회 시 필요한 필터 옵션을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformPartnerFilterOptionsError' x-portone-unstable: true tags: - Platform /platform/partner-settlements/complete-payout: post: summary: 일괄 지급 완료 처리 description: '일괄 지급 완료 처리 선택한 정산내역 아이디들로 일괄 지급을 완료 처리 합니다.' operationId: completePlatformPayoutByPartnerSettlementIds 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CompletePlatformPayoutByPartnerSettlementIdsBody' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CompletePlatformPayoutByPartnerSettlementIdsResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformNoSelectedPartnerSettlementsError`: 선택된 정산건이 없는 경우 * `PlatformDuplicatedPartnerSettlementIdsError`: 선택된 정산건 아이디에 중복이 있는 경우 * `PlatformNonPayablePartnerSettlementsError`: 지급할 수 없는 정산건이 포함된 경우 * `PlatformNegativePayoutAmountPartnersError`: 지급 금액의 총합이 음수인 파트너가 존재하는 경우' content: application/json: schema: $ref: '#/components/schemas/CompletePlatformPayoutByPartnerSettlementIdsError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CompletePlatformPayoutByPartnerSettlementIdsError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CompletePlatformPayoutByPartnerSettlementIdsError' '404': description: '* `PlatformPartnerSettlementsNotFoundError`: 요청한 정산건 목록을 찾을 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/CompletePlatformPayoutByPartnerSettlementIdsError' '409': description: '* `PlatformBulkPayoutIdAlreadyExistsError`: 일괄 지급 아이디가 이미 존재하는 경우' content: application/json: schema: $ref: '#/components/schemas/CompletePlatformPayoutByPartnerSettlementIdsError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.payout x-portone-title: 일괄 지급 완료 처리 x-portone-description: 선택한 정산내역 아이디들로 일괄 지급을 완료 처리 합니다. x-portone-error: $ref: '#/components/schemas/CompletePlatformPayoutByPartnerSettlementIdsError' x-portone-unstable: true tags: - Platform /platform/partner-settlements/delete: post: summary: 정산내역 삭제 description: '정산내역 삭제 선택한 정산내역들을 삭제합니다.' operationId: deletePlatformPartnerSettlements 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/DeletePlatformPartnerSettlementsBody' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformPartnerSettlementsResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformNonDeletablePartnerSettlementsError`: 삭제할 수 없는 정산건이 포함된 경우 * `PlatformReferencedCancelOrderTransfersExistError`: 취소 정산건이 참조 중인 정산건이 포함된 경우' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformPartnerSettlementsError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformPartnerSettlementsError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformPartnerSettlementsError' '404': description: '* `PlatformPartnerSettlementsNotFoundError`: 요청한 정산건 목록을 찾을 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformPartnerSettlementsError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partnerSettlement x-portone-title: 정산내역 삭제 x-portone-description: 선택한 정산내역들을 삭제합니다. x-portone-error: $ref: '#/components/schemas/DeletePlatformPartnerSettlementsError' x-portone-unstable: true tags: - Platform /platform/partner-settlements: get: summary: 정산 내역 다건 조회 description: '정산 내역 다건 조회 여러 정산 내역을 조회합니다.' operationId: getPlatformPartnerSettlements 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/GetPlatformPartnerSettlementsBody' responses: '200': description: 성공 응답으로 조회된 정산 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerSettlementsResponse' x-portone-description: 성공 응답으로 조회된 정산 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerSettlementsError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerSettlementsError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerSettlementsError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partnerSettlement x-portone-title: 정산 내역 다건 조회 x-portone-description: 여러 정산 내역을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformPartnerSettlementsError' tags: - Platform /platform/partners/batch: post: summary: 파트너 다건 생성 description: '파트너 다건 생성 새로운 파트너를 다건 생성합니다.' operationId: createPlatformPartners 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnersBody' required: true responses: '200': description: 성공 응답 content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnersResponse' x-portone-title: 성공 응답 '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformPartnerIdsDuplicatedError` * `PlatformCurrencyNotSupportedError`: 지원 되지 않는 통화를 선택한 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnersError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnersError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnersError' '404': description: '* `PlatformContractsNotFoundError` * `PlatformUserDefinedPropertyNotFoundError`: 사용자 정의 속성이 존재 하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnersError' '409': description: '* `PlatformPartnerIdsAlreadyExistError`' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnersError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 다건 생성 x-portone-description: 새로운 파트너를 다건 생성합니다. x-portone-error: $ref: '#/components/schemas/CreatePlatformPartnersError' tags: - Platform /platform/partners/counterparty-connect/{id}: post: summary: 파트너 거래처 연동 description: '파트너 거래처 연동 파트너를 거래처에 연동합니다.' operationId: connectPartnerCounterparty 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/ConnectPartnerCounterpartyResponse' x-portone-description: 성공 응답으로 파트너 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformPartnerTypeIsNotBusinessError`: 파트너 유형이 사업자가 아닌 경우 * `PlatformPartnerTaxationTypeIsSimpleError`: 파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우 * `PlatformCounterpartyNotConnectableStatusError`: 파트너 거래처 연동 상태가 연동 가능한 상태가 아닌 경우' content: application/json: schema: $ref: '#/components/schemas/ConnectPartnerCounterpartyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ConnectPartnerCounterpartyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우 * `PlatformBtxNotEnabledError`: BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/ConnectPartnerCounterpartyError' '404': description: '* `PlatformPartnerNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/ConnectPartnerCounterpartyError' '409': description: '* `PlatformPartnerScheduleExistsError`: 파트너 수정 예약 건이 존재하는 경우 * `PlatformArchivedPartnerError`: 보관된 파트너를 업데이트하려고 하는 경우 * `PlatformArchivedPartnerNtsNotAllowedError`: 보관된 파트너는 국세청 연동/연동해제를 할 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/ConnectPartnerCounterpartyError' '503': description: '* `PlatformExternalApiFailedError`: 외부 api 오류' content: application/json: schema: $ref: '#/components/schemas/ConnectPartnerCounterpartyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 거래처 연동 x-portone-description: 파트너를 거래처에 연동합니다. x-portone-error: $ref: '#/components/schemas/ConnectPartnerCounterpartyError' tags: - Platform /platform/partners/counterparty-connect: post: summary: 파트너 일괄 거래처 연동 description: '파트너 일괄 거래처 연동 파트너들을 일괄 거래처 연동합니다.' operationId: connectBulkPartnerCounterparty 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectBulkPartnerCounterpartyBody' required: true responses: '200': description: 성공 응답으로 일괄 작업 객체를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/ConnectBulkPartnerCounterpartyResponse' x-portone-description: 성공 응답으로 일괄 작업 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ConnectBulkPartnerCounterpartyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ConnectBulkPartnerCounterpartyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우 * `PlatformBtxNotEnabledError`: BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/ConnectBulkPartnerCounterpartyError' '404': description: '* `PlatformPartnerNotFoundError` * `PlatformTargetPartnerNotFoundError`: 처리 대상 파트너가 존재하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/ConnectBulkPartnerCounterpartyError' '503': description: '* `PlatformExternalApiFailedError`: 외부 api 오류' content: application/json: schema: $ref: '#/components/schemas/ConnectBulkPartnerCounterpartyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 일괄 거래처 연동 x-portone-description: 파트너들을 일괄 거래처 연동합니다. x-portone-error: $ref: '#/components/schemas/ConnectBulkPartnerCounterpartyError' tags: - Platform /platform/partners/counterparty-disconnect/{id}: post: summary: 파트너 거래처 연동 해제 description: '파트너 거래처 연동 해제 파트너를 거래처 연동 해제합니다.' operationId: disconnectPartnerCounterparty 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/DisconnectPartnerCounterpartyResponse' x-portone-description: 성공 응답으로 파트너 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformPartnerTypeIsNotBusinessError`: 파트너 유형이 사업자가 아닌 경우 * `PlatformPartnerTaxationTypeIsSimpleError`: 파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우 * `PlatformCounterpartyNotConnectedError`: 파트너가 거래처로 연동 되어있지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/DisconnectPartnerCounterpartyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/DisconnectPartnerCounterpartyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우 * `PlatformBtxNotEnabledError`: BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/DisconnectPartnerCounterpartyError' '404': description: '* `PlatformPartnerNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/DisconnectPartnerCounterpartyError' '409': description: '* `PlatformOngoingTaxInvoiceExistsError`: 진행 중인 세금계산서가 존재하는 경우 * `PlatformArchivedPartnerNtsNotAllowedError`: 보관된 파트너는 국세청 연동/연동해제를 할 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/DisconnectPartnerCounterpartyError' '503': description: '* `PlatformExternalApiFailedError`: 외부 api 오류' content: application/json: schema: $ref: '#/components/schemas/DisconnectPartnerCounterpartyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 거래처 연동 해제 x-portone-description: 파트너를 거래처 연동 해제합니다. x-portone-error: $ref: '#/components/schemas/DisconnectPartnerCounterpartyError' tags: - Platform /platform/partners/counterparty-disconnect: post: summary: 파트너 일괄 거래처 연동 해제 description: '파트너 일괄 거래처 연동 해제 파트너들을 일괄 거래처 연동 해제합니다.' operationId: disconnectBulkPartnerCounterparty 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/DisconnectBulkPartnerCounterpartyBody' required: true responses: '200': description: 성공 응답으로 일괄 작업 객체를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/DisconnectBulkPartnerCounterpartyResponse' x-portone-description: 성공 응답으로 일괄 작업 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/DisconnectBulkPartnerCounterpartyError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/DisconnectBulkPartnerCounterpartyError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우 * `PlatformBtxNotEnabledError`: BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우' content: application/json: schema: $ref: '#/components/schemas/DisconnectBulkPartnerCounterpartyError' '404': description: '* `PlatformPartnerNotFoundError` * `PlatformTargetPartnerNotFoundError`: 처리 대상 파트너가 존재하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/DisconnectBulkPartnerCounterpartyError' '503': description: '* `PlatformExternalApiFailedError`: 외부 api 오류' content: application/json: schema: $ref: '#/components/schemas/DisconnectBulkPartnerCounterpartyError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 일괄 거래처 연동 해제 x-portone-description: 파트너들을 일괄 거래처 연동 해제합니다. x-portone-error: $ref: '#/components/schemas/DisconnectBulkPartnerCounterpartyError' tags: - Platform /platform/partners/schedule: post: operationId: schedulePlatformPartners 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformPartnersBody' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformPartnersResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformPartnersError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformPartnersError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformPartnersError' '404': description: '* `PlatformContractNotFoundError` * `PlatformUserDefinedPropertyNotFoundError`: 사용자 정의 속성이 존재 하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformPartnersError' '409': description: '* `PlatformPartnerSchedulesAlreadyExistError` * `PlatformArchivedPartnersCannotBeScheduledError`: 보관된 파트너들을 예약 업데이트하려고 하는 경우 * `PlatformMemberCompanyConnectedPartnersCannotBeScheduledError`: 연동 사업자로 연동된 파트너들을 예약 수정하려고 시도한 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformPartnersError' security: - bearerJwt: [] - portOne: [] x-portone-error: $ref: '#/components/schemas/SchedulePlatformPartnersError' x-portone-unstable: true tags: - Platform /platform/partners/{id}/archive: post: summary: 파트너 보관 description: '파트너 보관 주어진 아이디에 대응되는 파트너를 보관합니다.' operationId: archivePlatformPartner 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/ArchivePlatformPartnerResponse' x-portone-description: 성공 응답으로 보관된 파트너 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformPartnerError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformPartnerError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformPartnerError' '404': description: '* `PlatformPartnerNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformPartnerError' '409': description: '* `PlatformCannotArchiveScheduledPartnerError`: 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우 * `PlatformCounterpartyOngoingTaxInvoiceExistsError`: 연동된 거래처에 진행 중인 세금계산서가 있는 경우 * `PlatformPartnerPendingNtsOperationError`: 파트너의 국세청 연동/해제가 진행 중인 경우' content: application/json: schema: $ref: '#/components/schemas/ArchivePlatformPartnerError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 보관 x-portone-description: 주어진 아이디에 대응되는 파트너를 보관합니다. x-portone-error: $ref: '#/components/schemas/ArchivePlatformPartnerError' tags: - Platform /platform/partners/{id}/recover: post: summary: 파트너 복원 description: '파트너 복원 주어진 아이디에 대응되는 파트너를 복원합니다.' operationId: recoverPlatformPartner 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/RecoverPlatformPartnerResponse' x-portone-description: 성공 응답으로 복원된 파트너 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformPartnerError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformPartnerError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformPartnerError' '404': description: '* `PlatformPartnerNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformPartnerError' '409': description: '* `PlatformPartnerPendingNtsOperationError`: 파트너의 국세청 연동/해제가 진행 중인 경우' content: application/json: schema: $ref: '#/components/schemas/RecoverPlatformPartnerError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 복원 x-portone-description: 주어진 아이디에 대응되는 파트너를 복원합니다. x-portone-error: $ref: '#/components/schemas/RecoverPlatformPartnerError' tags: - Platform /platform/partners/{id}/schedule: get: description: 주어진 아이디에 대응되는 파트너의 예약 업데이트를 조회합니다. operationId: getPlatformPartnerSchedule 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/PlatformPartner' x-portone-description: 성공 응답으로 예약된 파트너 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerScheduleError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerScheduleError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerScheduleError' '404': description: '* `PlatformPartnerNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerScheduleError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 파트너의 예약 업데이트를 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformPartnerScheduleError' x-portone-unstable: true tags: - Platform put: description: 주어진 아이디에 대응되는 파트너에 예약 업데이트를 재설정합니다. operationId: reschedulePartner 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/ReschedulePlatformPartnerBody' required: true responses: '200': description: 성공 응답으로 예약된 파트너 객체를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/ReschedulePlatformPartnerResponse' x-portone-description: 성공 응답으로 예약된 파트너 객체를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ReschedulePartnerError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ReschedulePartnerError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/ReschedulePartnerError' '404': description: '* `PlatformPartnerNotFoundError` * `PlatformContractNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/ReschedulePartnerError' '409': description: '* `PlatformMemberCompanyConnectedPartnerCannotBeScheduledError`: 연동 사업자로 연동된 파트너를 예약 수정하려고 시도한 경우' content: application/json: schema: $ref: '#/components/schemas/ReschedulePartnerError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 파트너에 예약 업데이트를 재설정합니다. x-portone-error: $ref: '#/components/schemas/ReschedulePartnerError' x-portone-unstable: true tags: - Platform post: description: 주어진 아이디에 대응되는 파트너에 업데이트를 예약합니다. operationId: schedulePartner 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/SchedulePlatformPartnerBody' required: true responses: '200': description: 성공 응답으로 예약된 파트너 객체가 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/SchedulePlatformPartnerResponse' x-portone-description: 성공 응답으로 예약된 파트너 객체가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformAccountVerificationFailedError`: 파트너 계좌 인증이 실패한 경우 * `PlatformInsufficientDataToChangePartnerTypeError`: 파트너 타입 수정에 필요한 데이터가 부족한 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePartnerError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePartnerError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePartnerError' '404': description: '* `PlatformPartnerNotFoundError` * `PlatformContractNotFoundError` * `PlatformAccountVerificationNotFoundError`: 파트너 계좌 검증 아이디를 찾을 수 없는 경우 * `PlatformUserDefinedPropertyNotFoundError`: 사용자 정의 속성이 존재 하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePartnerError' '409': description: '* `PlatformPartnerScheduleAlreadyExistsError` * `PlatformArchivedPartnerError`: 보관된 파트너를 업데이트하려고 하는 경우 * `PlatformAccountVerificationAlreadyUsedError`: 파트너 계좌 검증 아이디를 이미 사용한 경우 * `PlatformMemberCompanyConnectedPartnerBrnUnchangeableError`: 연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우 * `PlatformMemberCompanyConnectedPartnerTypeUnchangeableError`: 연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우 * `PlatformCompanyVerificationAlreadyUsedError`: 파트너 사업자 검증 아이디를 이미 사용한 경우 * `PlatformMemberCompanyConnectedPartnerCannotBeScheduledError`: 연동 사업자로 연동된 파트너를 예약 수정하려고 시도한 경우' content: application/json: schema: $ref: '#/components/schemas/SchedulePartnerError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 파트너에 업데이트를 예약합니다. x-portone-error: $ref: '#/components/schemas/SchedulePartnerError' x-portone-unstable: true tags: - Platform delete: description: 주어진 아이디에 대응되는 파트너의 예약 업데이트를 취소합니다. operationId: cancelPlatformPartnerSchedule 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/CancelPlatformPartnerScheduleResponse' x-portone-title: 성공 응답 '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformPartnerScheduleError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformPartnerScheduleError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformPartnerScheduleError' '404': description: '* `PlatformPartnerNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/CancelPlatformPartnerScheduleError' security: - bearerJwt: [] - portOne: [] x-portone-description: 주어진 아이디에 대응되는 파트너의 예약 업데이트를 취소합니다. x-portone-error: $ref: '#/components/schemas/CancelPlatformPartnerScheduleError' x-portone-unstable: true tags: - Platform /platform/partners/{id}: get: summary: 파트너 조회 description: '파트너 조회 파트너 객체를 조회합니다.' operationId: getPlatformPartner 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/PlatformPartner' x-portone-description: 성공 응답으로 파트너 객체가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerError' '404': description: '* `PlatformPartnerNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnerError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 조회 x-portone-description: 파트너 객체를 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformPartnerError' tags: - Platform patch: summary: 파트너 수정 description: '파트너 수정 주어진 아이디에 대응되는 파트너 정보를 업데이트합니다.' operationId: updatePlatformPartner 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/UpdatePlatformPartnerBody' required: true responses: '200': description: 성공 응답으로 업데이트된 파트너 객체가 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformPartnerResponse' x-portone-description: 성공 응답으로 업데이트된 파트너 객체가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformAccountVerificationFailedError`: 파트너 계좌 인증이 실패한 경우 * `PlatformInsufficientDataToChangePartnerTypeError`: 파트너 타입 수정에 필요한 데이터가 부족한 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformPartnerError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformPartnerError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformPartnerError' '404': description: '* `PlatformPartnerNotFoundError` * `PlatformContractNotFoundError` * `PlatformAccountVerificationNotFoundError`: 파트너 계좌 검증 아이디를 찾을 수 없는 경우 * `PlatformUserDefinedPropertyNotFoundError`: 사용자 정의 속성이 존재 하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformPartnerError' '409': description: '* `PlatformArchivedPartnerError`: 보관된 파트너를 업데이트하려고 하는 경우 * `PlatformAccountVerificationAlreadyUsedError`: 파트너 계좌 검증 아이디를 이미 사용한 경우 * `PlatformMemberCompanyConnectedPartnerBrnUnchangeableError`: 연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우 * `PlatformCompanyVerificationAlreadyUsedError`: 파트너 사업자 검증 아이디를 이미 사용한 경우 * `PlatformMemberCompanyConnectedPartnerTypeUnchangeableError`: 연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformPartnerError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 수정 x-portone-description: 주어진 아이디에 대응되는 파트너 정보를 업데이트합니다. x-portone-error: $ref: '#/components/schemas/UpdatePlatformPartnerError' tags: - Platform /platform/partners: get: summary: 파트너 다건 조회 description: '파트너 다건 조회 여러 파트너를 조회합니다.' operationId: getPlatformPartners 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/GetPlatformPartnersBody' responses: '200': description: 성공 응답으로 조회된 파트너 리스트와 페이지 정보가 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnersResponse' x-portone-description: 성공 응답으로 조회된 파트너 리스트와 페이지 정보가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnersError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnersError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPartnersError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 다건 조회 x-portone-description: 여러 파트너를 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformPartnersError' tags: - Platform post: summary: 파트너 생성 description: '파트너 생성 새로운 파트너를 생성합니다.' operationId: createPlatformPartner 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnerBody' required: true responses: '200': description: 성공 응답으로 생성된 파트너 객체가 반환됩니다. content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnerResponse' x-portone-description: 성공 응답으로 생성된 파트너 객체가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformAccountVerificationFailedError`: 파트너 계좌 인증이 실패한 경우 * `PlatformCurrencyNotSupportedError`: 지원 되지 않는 통화를 선택한 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnerError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnerError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnerError' '404': description: '* `PlatformContractNotFoundError` * `PlatformAccountVerificationNotFoundError`: 파트너 계좌 검증 아이디를 찾을 수 없는 경우 * `PlatformUserDefinedPropertyNotFoundError`: 사용자 정의 속성이 존재 하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnerError' '409': description: '* `PlatformPartnerIdAlreadyExistsError` * `PlatformAccountVerificationAlreadyUsedError`: 파트너 계좌 검증 아이디를 이미 사용한 경우 * `PlatformCompanyVerificationAlreadyUsedError`: 파트너 사업자 검증 아이디를 이미 사용한 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformPartnerError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.partner x-portone-title: 파트너 생성 x-portone-description: 새로운 파트너를 생성합니다. x-portone-error: $ref: '#/components/schemas/CreatePlatformPartnerError' tags: - Platform /platform/payouts: get: summary: 지급 내역 다건 조회 description: '지급 내역 다건 조회 여러 지급 내역을 조회합니다.' operationId: getPlatformPayouts 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/GetPlatformPayoutsBody' responses: '200': description: 성공 응답으로 조회된 지급 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/GetPlatformPayoutsResponse' x-portone-description: 성공 응답으로 조회된 지급 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPayoutsError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPayoutsError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformPayoutsError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.payout x-portone-title: 지급 내역 다건 조회 x-portone-description: 여러 지급 내역을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformPayoutsError' tags: - Platform /platform/setting: get: summary: 플랫폼 설정 조회 description: '플랫폼 설정 조회 설정 정보를 조회합니다.' operationId: getPlatformSetting 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로 적용됩니다. responses: '200': description: 성공 응답으로 플랫폼 설정 정보를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/PlatformSetting' x-portone-description: 성공 응답으로 플랫폼 설정 정보를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformSettingError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformSettingError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformSettingError' security: - bearerJwt: [] - portOne: [] x-portone-title: 플랫폼 설정 조회 x-portone-description: 설정 정보를 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformSettingError' tags: - Platform patch: summary: 플랫폼 설정 업데이트 description: '플랫폼 설정 업데이트 설정 정보를 업데이트합니다.' operationId: updatePlatformSetting 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformSettingBody' required: true responses: '200': description: 성공 응답으로 플랫폼 설정 정보를 반환합니다. content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformSettingResponse' x-portone-description: 성공 응답으로 플랫폼 설정 정보를 반환합니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformSettingError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformSettingError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformSettingError' security: - bearerJwt: [] - portOne: [] x-portone-title: 플랫폼 설정 업데이트 x-portone-description: 설정 정보를 업데이트합니다. x-portone-error: $ref: '#/components/schemas/UpdatePlatformSettingError' tags: - Platform /platform/transfer-summaries/sheet-file: get: summary: 정산 상세 내역 다운로드 description: '정산 상세 내역 다운로드 정산 상세 내역을 csv 파일로 다운로드 합니다.' operationId: downloadPlatformTransferSheet 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: true content: application/json: schema: $ref: '#/components/schemas/DownloadPlatformTransferSheetBody' responses: '200': description: '' content: text/csv: schema: type: string format: binary '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/DownloadPlatformTransferSheetError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/DownloadPlatformTransferSheetError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.transfer x-portone-title: 정산 상세 내역 다운로드 x-portone-description: 정산 상세 내역을 csv 파일로 다운로드 합니다. x-portone-error: $ref: '#/components/schemas/DownloadPlatformTransferSheetError' tags: - Platform /platform/transfer-summaries: get: summary: 정산건 다건 조회 description: '정산건 다건 조회 성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다.' operationId: getPlatformTransferSummaries 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/GetPlatformTransferSummariesBody' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetPlatformTransferSummariesResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformTransferSummariesError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformTransferSummariesError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformTransferSummariesError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.transfer x-portone-title: 정산건 다건 조회 x-portone-description: 성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다. x-portone-error: $ref: '#/components/schemas/GetPlatformTransferSummariesError' tags: - Platform /platform/transfers/manual: post: summary: 수기 정산건 생성 description: '수기 정산건 생성 성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.' operationId: createPlatformManualTransfer 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformManualTransferBody' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CreateManualTransferResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformCurrencyNotSupportedError`: 지원 되지 않는 통화를 선택한 경우 * `PlatformNegativeAmountNotAllowedError`: 정산 건별 옵션이 켜진 플랫폼에서 음수 금액 수기 정산 생성을 시도한 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformManualTransferError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformManualTransferError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformManualTransferError' '404': description: '* `PlatformPartnerNotFoundError` * `PlatformUserDefinedPropertyNotFoundError`: 사용자 정의 속성이 존재 하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformManualTransferError' '409': description: '* `PlatformTransferIdAlreadyUsedError`' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformManualTransferError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.transfer x-portone-title: 수기 정산건 생성 x-portone-description: 성공 응답으로 생성된 수기 정산건 객체가 반환됩니다. x-portone-error: $ref: '#/components/schemas/CreatePlatformManualTransferError' tags: - Platform /platform/transfers/order-cancel: post: summary: 주문 취소 정산건 생성 description: '주문 취소 정산건 생성 성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.' operationId: createPlatformOrderCancelTransfer 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferBody' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CreateOrderCancelTransferResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformOrderDetailMismatchedError` * `PlatformDiscountSharePolicyIdDuplicatedError` * `PlatformCancellableAmountExceededError`: 취소 가능한 금액이 초과한 경우 * `PlatformCancellableDiscountAmountExceededError` * `PlatformCancellableDiscountTaxFreeAmountExceededError` * `PlatformProductIdDuplicatedError` * `PlatformCancellableProductQuantityExceededError` * `PlatformOrderTransferAlreadyCancelledError` * `PlatformSettlementAmountExceededError`: 정산 가능한 금액을 초과한 경우 * `PlatformCancellationAndPaymentTypeMismatchedError` * `PlatformSettlementCancelAmountExceededPortOneCancelError`: 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우 * `PlatformCannotSpecifyTransferError`: 정산 건 식별에 실패한 경우 * `PlatformSettlementDateEarlierThanSettlementStartDateError`: 정산일이 정산 시작일보다 빠른 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferError' '404': description: '* `PlatformTransferNotFoundError` * `PlatformCancellationNotFoundError` * `PlatformPaymentNotFoundError` * `PlatformProductIdNotFoundError` * `PlatformTransferDiscountSharePolicyNotFoundError` * `PlatformUserDefinedPropertyNotFoundError`: 사용자 정의 속성이 존재 하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferError' '409': description: '* `PlatformTransferAlreadyExistsError` * `PlatformTransferIdAlreadyUsedError`' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.transfer x-portone-title: 주문 취소 정산건 생성 x-portone-description: 성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다. x-portone-error: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferError' tags: - Platform /platform/transfers/order: post: summary: 주문 정산건 생성 description: '주문 정산건 생성 성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.' operationId: createPlatformOrderTransfer 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로 적용됩니다. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderTransferBody' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CreateOrderTransferResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformProductIdDuplicatedError` * `PlatformSettlementPaymentAmountExceededPortOnePaymentError`: 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우 * `PlatformSettlementTaxFreeAmountExceededPortOnePaymentError`: 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우 * `PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError`: 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우 * `PlatformSettlementAmountExceededError`: 정산 가능한 금액을 초과한 경우 * `PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError` * `PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError` * `PlatformCurrencyNotSupportedError`: 지원 되지 않는 통화를 선택한 경우 * `PlatformSettlementDateEarlierThanSettlementStartDateError`: 정산일이 정산 시작일보다 빠른 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderTransferError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderTransferError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderTransferError' '404': description: '* `PlatformPartnerNotFoundError` * `PlatformContractNotFoundError` * `PlatformAdditionalFeePoliciesNotFoundError` * `PlatformDiscountSharePoliciesNotFoundError` * `PlatformPaymentNotFoundError` * `PlatformUserDefinedPropertyNotFoundError`: 사용자 정의 속성이 존재 하지 않는 경우 * `PlatformSettlementParameterNotFoundError`: 정산 파라미터가 존재하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderTransferError' '409': description: '* `PlatformTransferAlreadyExistsError` * `PlatformTransferIdAlreadyUsedError`' content: application/json: schema: $ref: '#/components/schemas/CreatePlatformOrderTransferError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.transfer x-portone-title: 주문 정산건 생성 x-portone-description: 성공 응답으로 생성된 주문 정산건 객체가 반환됩니다. x-portone-error: $ref: '#/components/schemas/CreatePlatformOrderTransferError' tags: - Platform /platform/transfers/{id}: get: summary: 정산건 조회 description: '정산건 조회 정산건을 조회합니다.' operationId: getPlatformTransfer 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/PlatformTransfer' x-portone-description: 성공 응답으로 정산건 객체가 반환됩니다. '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformTransferError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformTransferError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/GetPlatformTransferError' '404': description: '* `PlatformTransferNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/GetPlatformTransferError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.transfer x-portone-title: 정산건 조회 x-portone-description: 정산건을 조회합니다. x-portone-error: $ref: '#/components/schemas/GetPlatformTransferError' tags: - Platform delete: summary: 정산건 삭제 description: '정산건 삭제 scheduled, in_process 상태의 정산건만 삭제가능합니다.' operationId: deletePlatformTransfer 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/DeletePlatformTransferResponse' '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우 * `PlatformCancelOrderTransfersExistsError` * `PlatformTransferNonDeletableStatusError`' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformTransferError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformTransferError' '403': description: '* `PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 * `ForbiddenError`: 요청이 거절된 경우' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformTransferError' '404': description: '* `PlatformTransferNotFoundError`' content: application/json: schema: $ref: '#/components/schemas/DeletePlatformTransferError' security: - bearerJwt: [] - portOne: [] x-portone-category: platform.transfer x-portone-title: 정산건 삭제 x-portone-description: scheduled, in_process 상태의 정산건만 삭제가능합니다. x-portone-error: $ref: '#/components/schemas/DeletePlatformTransferError' tags: - Platform components: schemas: DeletePlatformPartnerSettlementsError: title: DeletePlatformPartnerSettlementsError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNonDeletablePartnerSettlementsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerSettlementsNotFoundError' - $ref: '#/components/schemas/PlatformReferencedCancelOrderTransfersExistError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NON_DELETABLE_PARTNER_SETTLEMENTS: '#/components/schemas/PlatformNonDeletablePartnerSettlementsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_SETTLEMENTS_NOT_FOUND: '#/components/schemas/PlatformPartnerSettlementsNotFoundError' PLATFORM_REFERENCED_CANCEL_ORDER_TRANSFERS_EXIST: '#/components/schemas/PlatformReferencedCancelOrderTransfersExistError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' UpdatePlatformContractResponse: title: 계약 객체 업데이트 성공 응답 description: 계약 객체 업데이트 성공 응답 type: object required: - contract properties: contract: $ref: '#/components/schemas/PlatformContract' title: 업데이트된 계약 객체 x-portone-title: 계약 객체 업데이트 성공 응답 CancelPlatformAdditionalFeePolicyScheduleResponse: title: 추가 수수료 정책 예약 업데이트 취소 성공 응답 description: 추가 수수료 정책 예약 업데이트 취소 성공 응답 type: object x-portone-title: 추가 수수료 정책 예약 업데이트 취소 성공 응답 PlatformCancellableDiscountAmountExceededError: title: PlatformCancellableDiscountAmountExceededError type: object required: - type - discountSharePolicyId - discountSharePolicyGraphqlId - cancellableAmount - requestAmount properties: type: type: string discountSharePolicyId: type: string discountSharePolicyGraphqlId: type: string cancellableAmount: type: integer format: int64 requestAmount: type: integer format: int64 productId: type: string message: type: string x-portone-status-code: 400 PlatformAdditionalFeePolicyNotFoundError: title: PlatformAdditionalFeePolicyNotFoundError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 404 PlatformBulkPayoutIdAlreadyExistsError: title: 일괄 지급 아이디가 이미 존재하는 경우 description: 일괄 지급 아이디가 이미 존재하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 일괄 지급 아이디가 이미 존재하는 경우 x-portone-status-code: 409 PlatformCounterpartyNotConnectableStatusError: title: 파트너 거래처 연동 상태가 연동 가능한 상태가 아닌 경우 description: 파트너 거래처 연동 상태가 연동 가능한 상태가 아닌 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너 거래처 연동 상태가 연동 가능한 상태가 아닌 경우 x-portone-status-code: 400 CreatePlatformPartnersError: title: CreatePlatformPartnersError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformContractsNotFoundError' - $ref: '#/components/schemas/PlatformCurrencyNotSupportedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerIdsAlreadyExistError' - $ref: '#/components/schemas/PlatformPartnerIdsDuplicatedError' - $ref: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CONTRACTS_NOT_FOUND: '#/components/schemas/PlatformContractsNotFoundError' PLATFORM_CURRENCY_NOT_SUPPORTED: '#/components/schemas/PlatformCurrencyNotSupportedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_IDS_ALREADY_EXISTS: '#/components/schemas/PlatformPartnerIdsAlreadyExistError' PLATFORM_PARTNER_IDS_DUPLICATED: '#/components/schemas/PlatformPartnerIdsDuplicatedError' PLATFORM_USER_DEFINED_PROPERTY_NOT_FOUND: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformDiscountSharePolicy: title: 할인 분담 정책 description: '할인 분담 정책 할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.' type: object required: - id - graphqlId - name - partnerShareRate - isArchived - appliedAt - isForTest properties: id: type: string graphqlId: type: string name: type: string title: 할인 분담 정책 이름 partnerShareRate: type: integer format: int32 title: 할인 분담율 description: 파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 `할인금액 * partnerShareRate * 10^5` 로 책정합니다. memo: type: string title: 해당 할인 분담에 대한 메모 isArchived: type: boolean title: 보관 여부 appliedAt: type: string format: date-time title: 변경 적용 시점 isForTest: type: boolean x-portone-title: 할인 분담 정책 x-portone-description: '할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.' PlatformCannotArchiveScheduledDiscountSharePolicyError: title: 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우 description: 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우 x-portone-status-code: 409 PlatformPaymentMethodTransferInput: title: PlatformPaymentMethodTransferInput type: object ConnectBulkPartnerCounterpartyResponse: title: 파트너 일괄 거래처 연동 응답 description: 파트너 일괄 거래처 연동 응답 type: object required: - bulkTask properties: bulkTask: $ref: '#/components/schemas/PlatformBulkTask' x-portone-title: 파트너 일괄 거래처 연동 응답 CreatePlatformPartnerBodyType: title: 파트너 생성을 위한 유형별 추가 정보 description: 파트너 생성을 위한 유형별 추가 정보 type: object properties: business: $ref: '#/components/schemas/CreatePlatformPartnerBodyTypeBusiness' title: 사업자 추가 정보 whtPayer: $ref: '#/components/schemas/CreatePlatformPartnerBodyTypeWhtPayer' title: 원천징수 대상자 추가 정보 nonWhtPayer: $ref: '#/components/schemas/CreatePlatformPartnerBodyTypeNonWhtPayer' title: 원천징수 비대상자 추가 정보 x-portone-title: 파트너 생성을 위한 유형별 추가 정보 PlatformPartnerSettlement: title: PlatformPartnerSettlement oneOf: - $ref: '#/components/schemas/PlatformPartnerManualSettlement' - $ref: '#/components/schemas/PlatformPartnerOrderCancelSettlement' - $ref: '#/components/schemas/PlatformPartnerOrderSettlement' discriminator: propertyName: type mapping: MANUAL: '#/components/schemas/PlatformPartnerManualSettlement' ORDER: '#/components/schemas/PlatformPartnerOrderSettlement' ORDER_CANCEL: '#/components/schemas/PlatformPartnerOrderCancelSettlement' x-portone-discriminator: ORDER: {} ORDER_CANCEL: {} MANUAL: {} PlatformPayoutFilterInput: title: 지급 내역 필터 입력 정보 description: 지급 내역 필터 입력 정보 type: object required: - criteria properties: statuses: type: array items: $ref: '#/components/schemas/PlatformPayoutStatus' title: 지급 상태 description: 값이 존재하는 경우 해당 리스트에 포함되는 지급 상태를 가진 지급 내역을 조회합니다. partnerIds: type: array items: type: string title: 파트너 아이디 description: 값이 존재하는 경우 해당 리스트에 포함되는 파트너 아이디를 가진 지급 내역을 조회합니다. criteria: $ref: '#/components/schemas/PlatformPayoutFilterInputCriteria' title: 조회 기준 payoutAccountBanks: title: 지급 계좌 은행 type: array items: $ref: '#/components/schemas/Bank' description: 값이 존재하는 경우 해당 리스트에 포함되는 지급 계좌 은행을 가진 지급 내역을 조회합니다. partnerTags: type: array items: type: string title: 파트너 태그 description: 값이 존재하는 경우 해당 리스트에 포함되는 파트너 태그를 하나 이상 가진 지급 내역을 조회합니다. payoutCurrencies: title: 지급 통화 type: array items: $ref: '#/components/schemas/Currency' description: 값이 존재하는 경우 해당 리스트에 포함되는 지급 통화를 가진 지급 내역을 조회합니다. payoutIds: type: array items: type: string title: 지급 아이디 description: 값이 존재하는 경우 해당 리스트에 포함되는 지급 아이디를 가진 지급 내역을 조회합니다. taxInvoiceStatuses: type: array items: $ref: '#/components/schemas/PlatformPayoutTaxInvoiceStatus' title: 세금계산서 상태 description: 값이 존재하는 경우 해당 리스트에 포함되는 세금계산서 상태를 가진 지급 내역을 조회합니다. partnerTypes: title: 파트너 유형 type: array items: $ref: '#/components/schemas/PlatformPartnerTypeName' description: 값이 존재하는 경우 해당 리스트에 포함되는 파트너 유형을 가진 지급 내역을 조회합니다. partnerTaxationTypes: title: 파트너 과세 유형 type: array items: $ref: '#/components/schemas/PlatformPartnerTaxationType' description: 값이 존재하는 경우 해당 리스트에 포함되는 파트너 과세 유형을 가진 지급 내역을 조회합니다. settlementStatementStatuses: title: 정산 내역서 상태 type: array items: $ref: '#/components/schemas/PlatformPayoutSettlementStatementStatus' description: 값이 존재하는 경우 해당 리스트에 포함되는 정산 내역서 상태를 가진 지급 내역을 조회합니다. x-portone-title: 지급 내역 필터 입력 정보 PlatformPartnerSettlementStatusStats: title: PlatformPartnerSettlementStatusStats type: object required: - payoutScheduled - payoutPrepared - payoutWithheld - payoutExcluded - payoutFailed - payoutCancelled - payoutConfirmed - inPayout - paidOut properties: payoutScheduled: type: integer format: int64 payoutPrepared: type: integer format: int64 payoutWithheld: type: integer format: int64 payoutExcluded: type: integer format: int64 payoutFailed: type: integer format: int64 payoutCancelled: type: integer format: int64 payoutConfirmed: type: integer format: int64 inPayout: type: integer format: int64 paidOut: type: integer format: int64 GetPlatformPayoutsBody: title: GetPlatformPayoutsBody type: object properties: isForTest: type: boolean description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' page: $ref: '#/components/schemas/PageInput' filter: $ref: '#/components/schemas/PlatformPayoutFilterInput' GetPlatformPartnerScheduleError: title: GetPlatformPartnerScheduleError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' ReschedulePlatformContractResponse: title: 계약 예약 업데이트 재설정 성공 응답 description: 계약 예약 업데이트 재설정 성공 응답 type: object required: - scheduledContract properties: scheduledContract: $ref: '#/components/schemas/PlatformContract' title: 예약된 계약 정보 x-portone-title: 계약 예약 업데이트 재설정 성공 응답 PlatformPartnerMemberCompanyConnectionStatus: title: 플랫폼 파트너 연동 사업자 연결 상태 description: 플랫폼 파트너 연동 사업자 연결 상태 type: string enum: - NOT_CONNECTED - CONNECT_PENDING - CONNECTED - CONNECT_FAILED - DISCONNECT_PENDING x-portone-title: 플랫폼 파트너 연동 사업자 연결 상태 x-portone-enum: CONNECT_PENDING: title: 연결 대기 DISCONNECT_PENDING: title: 연결 해제 대기 CONNECT_FAILED: title: 연결 실패 CONNECTED: title: 연결됨 NOT_CONNECTED: title: 연결되지 않음 GetPlatformAdditionalFeePolicyScheduleError: title: GetPlatformAdditionalFeePolicyScheduleError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformAccountTransferStatus: title: 계좌 이체 상태 description: 계좌 이체 상태 type: string enum: - PREPARED - SCHEDULED - CANCELLED - STOPPED - PROCESSING - ASYNC_PROCESSING - SUCCEEDED - FAILED x-portone-title: 계좌 이체 상태 x-portone-enum: STOPPED: title: 중단 PREPARED: title: 대기 CANCELLED: title: 취소 SUCCEEDED: title: 성공 SCHEDULED: title: 예약 PROCESSING: title: 처리 중 ASYNC_PROCESSING: title: 비동기 처리 중 FAILED: title: 실패 RecoverPlatformContractResponse: title: 계약 복원 성공 응답 description: 계약 복원 성공 응답 type: object required: - contract properties: contract: $ref: '#/components/schemas/PlatformContract' title: 복원된 계약 x-portone-title: 계약 복원 성공 응답 PlatformOrderCancelTransfer: title: 주문 취소 정산건 description: 주문 취소 정산건 type: object required: - type - id - graphqlId - partner - status - settlementDate - settlementCurrency - isForTest - userDefinedProperties - amount - contract - payment - settlementStartDate - orderLines - additionalFees - discounts - cancellation - parameters properties: type: type: string id: type: string title: 정산건 아이디 graphqlId: type: string partner: $ref: '#/components/schemas/PlatformPartner' title: 파트너 status: $ref: '#/components/schemas/PlatformTransferStatus' title: 정산 상태 memo: type: string title: 메모 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 일 settlementCurrency: $ref: '#/components/schemas/Currency' title: 정산 통화 payoutId: type: string description: 더 이상 사용되지 않는 값입니다. payoutGraphqlId: type: string isForTest: type: boolean title: 테스트 모드 여부 userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' amount: $ref: '#/components/schemas/PlatformOrderSettlementAmount' title: 정산 금액 정보 contract: $ref: '#/components/schemas/PlatformContract' title: 계약 payment: $ref: '#/components/schemas/PlatformPayment' title: 결제 정보 settlementStartDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 시작일 orderLines: title: 주문 항목 리스트 type: array items: $ref: '#/components/schemas/PlatformOrderTransferOrderLine' additionalFees: title: 정산 금액 계산 시 사용된 추가 수수료 정보 type: array items: $ref: '#/components/schemas/PlatformOrderTransferAdditionalFee' discounts: title: 정산 금액 계산 시 사용된 할인 정보 type: array items: $ref: '#/components/schemas/PlatformOrderTransferDiscount' cancellation: $ref: '#/components/schemas/PlatformOrderTransferCancellation' title: 주문 취소 정보 parameters: $ref: '#/components/schemas/TransferParameters' title: 정산 파라미터 (실험기능) x-portone-title: 주문 취소 정산건 PlatformArchivedPartnerError: title: 보관된 파트너를 업데이트하려고 하는 경우 description: 보관된 파트너를 업데이트하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 보관된 파트너를 업데이트하려고 하는 경우 x-portone-status-code: 409 PlatformPaymentMethodGiftCertificate: title: 상품권 description: 상품권 type: object required: - type properties: type: type: string x-portone-title: 상품권 SchedulePlatformPartnersBody: title: SchedulePlatformPartnersBody type: object required: - update - appliedAt properties: filter: $ref: '#/components/schemas/PlatformPartnerFilterInput' update: $ref: '#/components/schemas/SchedulePlatformPartnersBodyUpdate' appliedAt: type: string format: date-time PlatformFeeInput: title: 수수료 계산 방식을 특정하기 위한 입력 정보 description: '수수료 계산 방식을 특정하기 위한 입력 정보 정률 수수료를 설정하고 싶은 경우 `fixedRate` 필드에, 정액 수수료를 설정하고 싶은 경우 `fixedAmount` 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.' type: object properties: fixedRate: type: integer format: int32 title: 정률 수수료 fixedAmount: type: integer format: int64 title: 정액 수수료 x-portone-title: 수수료 계산 방식을 특정하기 위한 입력 정보 x-portone-description: '정률 수수료를 설정하고 싶은 경우 `fixedRate` 필드에, 정액 수수료를 설정하고 싶은 경우 `fixedAmount` 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.' RecoverPlatformAdditionalFeePolicyError: title: RecoverPlatformAdditionalFeePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformBulkAccountTransfersBody: title: GetPlatformBulkAccountTransfersBody type: object properties: isForTest: type: boolean description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' page: $ref: '#/components/schemas/PageInput' filter: $ref: '#/components/schemas/PlatformBulkAccountTransferFilterInput' PlatformAccount: title: 플랫폼 정산 계좌 description: '플랫폼 정산 계좌 `currency` 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.' type: object required: - bank - currency - number - holder - status properties: bank: $ref: '#/components/schemas/Bank' title: 은행 currency: $ref: '#/components/schemas/Currency' title: 정산에 사용할 통화 number: type: string title: 계좌번호 holder: type: string title: 예금주명 status: $ref: '#/components/schemas/PlatformAccountStatus' title: 계좌 상태 x-portone-title: 플랫폼 정산 계좌 x-portone-description: '`currency` 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.' CreateOrderTransferResponse: title: CreateOrderTransferResponse type: object required: - transfer properties: transfer: $ref: '#/components/schemas/PlatformOrderTransfer' ReschedulePlatformAdditionalFeePolicyBody: title: 추가 수수료 정책 예약 업데이트 재설정을 위한 입력 정보 description: 추가 수수료 정책 예약 업데이트 재설정을 위한 입력 정보 type: object required: - update - appliedAt properties: update: $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyBody' title: 반영할 업데이트 내용 appliedAt: type: string format: date-time title: 업데이트 적용 시점 x-portone-title: 추가 수수료 정책 예약 업데이트 재설정을 위한 입력 정보 PlatformFee: title: 플랫폼 중개수수료 정보 description: 플랫폼 중개수수료 정보 oneOf: - $ref: '#/components/schemas/PlatformFixedAmountFee' - $ref: '#/components/schemas/PlatformFixedRateFee' discriminator: propertyName: type mapping: FIXED_AMOUNT: '#/components/schemas/PlatformFixedAmountFee' FIXED_RATE: '#/components/schemas/PlatformFixedRateFee' x-portone-title: 플랫폼 중개수수료 정보 x-portone-discriminator: FIXED_RATE: title: 정률 수수료 FIXED_AMOUNT: title: 정액 수수료 PlatformAmountExceededType: title: PlatformAmountExceededType type: string enum: - DISCOUNT_THAN_ORDER - DISCOUNT_TAX_FREE_THAN_DISCOUNT - DISCOUNT_TAX_FREE_THAN_ORDER_TAX_FREE - PAYMENT_TAX_FREE_THAN_PAYMENT x-portone-enum: DISCOUNT_THAN_ORDER: title: 할인금액이 주문금액을 초과 DISCOUNT_TAX_FREE_THAN_DISCOUNT: title: 면세 할인금액이 할인금액을 초과 DISCOUNT_TAX_FREE_THAN_ORDER_TAX_FREE: title: 면세 할인금액이 면세 주문금액을 초과 PAYMENT_TAX_FREE_THAN_PAYMENT: title: 면세 결제금액이 결제금액을 초과 PlatformMemberCompanyConnectedPartnerTypeUnchangeableError: title: 연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우 description: 연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우 x-portone-status-code: 409 CreatePlatformPartnerBodyAccount: title: 파트너 계좌 등록을 위한 정보 description: 파트너 계좌 등록을 위한 정보 type: object required: - bank - currency - number - holder properties: bank: $ref: '#/components/schemas/Bank' title: 은행 currency: $ref: '#/components/schemas/Currency' title: 정산에 사용할 통화 number: type: string title: 계좌번호 holder: type: string title: 예금주명 accountVerificationId: type: string title: 계좌 검증 아이디 x-portone-title: 파트너 계좌 등록을 위한 정보 ArchivePlatformPartnerResponse: title: 파트너 보관 성공 응답 description: 파트너 보관 성공 응답 type: object required: - partner properties: partner: $ref: '#/components/schemas/PlatformPartner' title: 보관된 파트너 x-portone-title: 파트너 보관 성공 응답 PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError: title: PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError type: object required: - type - id - graphqlId - feeCurrency - settlementCurrency properties: type: type: string id: type: string graphqlId: type: string feeCurrency: $ref: '#/components/schemas/Currency' settlementCurrency: $ref: '#/components/schemas/Currency' message: type: string x-portone-status-code: 400 GetPlatformContractsBody: title: 계약 다건 조회를 위한 입력 정보 description: 계약 다건 조회를 위한 입력 정보 type: object properties: page: $ref: '#/components/schemas/PageInput' title: 요청할 페이지 정보 filter: $ref: '#/components/schemas/PlatformContractFilterInput' title: 조회할 계약 조건 필터 x-portone-title: 계약 다건 조회를 위한 입력 정보 ArchivePlatformPartnerError: title: ArchivePlatformPartnerError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformCannotArchiveScheduledPartnerError' - $ref: '#/components/schemas/PlatformCounterpartyOngoingTaxInvoiceExistsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformPartnerPendingNtsOperationError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CANNOT_ARCHIVE_SCHEDULED_PARTNER: '#/components/schemas/PlatformCannotArchiveScheduledPartnerError' PLATFORM_COUNTERPARTY_ONGOING_TAX_INVOICE_EXISTS: '#/components/schemas/PlatformCounterpartyOngoingTaxInvoiceExistsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_PARTNER_PENDING_NTS_OPERATION: '#/components/schemas/PlatformPartnerPendingNtsOperationError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformSettlementCycleType: title: 플랫폼 정산 주기 계산 방식 description: 플랫폼 정산 주기 계산 방식 type: string enum: - DAILY - WEEKLY - MONTHLY - MANUAL_DATES x-portone-title: 플랫폼 정산 주기 계산 방식 x-portone-enum: DAILY: title: 매일 정산 WEEKLY: title: 매주 정해진 요일에 정산 MONTHLY: title: 매월 정해진 날(일)에 정산 MANUAL_DATES: title: 정해진 날짜(월, 일)에 정산 PlatformPartnerManualSettlement: title: PlatformPartnerManualSettlement type: object required: - type - id - graphqlId - partner - settlementDate - settlementCurrency - status - amount - taxFreeAmount - isForTest properties: type: type: string id: type: string title: 정산내역 아이디 graphqlId: type: string partner: $ref: '#/components/schemas/PlatformPartner' title: 파트너 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 일 settlementCurrency: $ref: '#/components/schemas/Currency' title: 정산 통화 status: $ref: '#/components/schemas/PlatformPartnerSettlementStatus' title: 정산 상태 statusUpdatedAt: type: string format: date-time title: 상태 업데이트 일시 memo: type: string title: 메모 amount: type: integer format: int64 title: 정산 금액 taxFreeAmount: type: integer format: int64 title: 정산 면세 금액 isForTest: type: boolean title: 테스트 모드 여부 CreatePlatformContractResponse: title: 계약 객체 생성 성공 응답 description: 계약 객체 생성 성공 응답 type: object required: - contract properties: contract: $ref: '#/components/schemas/PlatformContract' title: 생성된 계약 객체 x-portone-title: 계약 객체 생성 성공 응답 DisconnectBulkPartnerCounterpartyResponse: title: 파트너 일괄 거래처 연동 해제 응답 description: 파트너 일괄 거래처 연동 해제 응답 type: object required: - bulkTask properties: bulkTask: $ref: '#/components/schemas/PlatformBulkTask' x-portone-title: 파트너 일괄 거래처 연동 해제 응답 PlatformPartnerPendingNtsOperationError: title: 파트너의 국세청 연동/해제가 진행 중인 경우 description: 파트너의 국세청 연동/해제가 진행 중인 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너의 국세청 연동/해제가 진행 중인 경우 x-portone-status-code: 409 PlatformOrderSettlementAmount: title: 정산 금액 정보 description: '정산 금액 정보 정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.' type: object required: - settlement - settlementTaxFree - payment - paymentVat - paymentVatBurden - paymentTaxFree - paymentSupply - order - orderTaxFree - platformFee - platformFeeVat - additionalFee - additionalFeeVat - discount - discountTaxFree - discountShare - discountShareTaxFree - userDefinedFormulas properties: settlement: type: integer format: int64 title: 정산 금액 settlementTaxFree: type: integer format: int64 title: 정산 면세 금액 payment: type: integer format: int64 title: 결제 금액 paymentVat: type: integer format: int64 title: 결제 금액 부가세 paymentVatBurden: type: integer format: int64 title: 결제 금액 부가세 부담금액 description: 참조된 계약의 결제 금액 부가세 감액 여부에 따라 false인 경우 0원, true인 경우 결제 금액 부가세입니다. paymentTaxFree: type: integer format: int64 title: 결제 면세 금액 paymentSupply: type: integer format: int64 title: 결제 공급가액 order: type: integer format: int64 title: 주문 금액 orderTaxFree: type: integer format: int64 title: 면세 주문 금액 platformFee: type: integer format: int64 title: 중개 수수료 platformFeeVat: type: integer format: int64 title: 중개 수수료 부가세 additionalFee: type: integer format: int64 title: 추가 수수료 additionalFeeVat: type: integer format: int64 title: 추가 수수료 부가세 discount: type: integer format: int64 title: 할인 금액 discountTaxFree: type: integer format: int64 title: 면세 할인 금액 discountShare: type: integer format: int64 title: 할인 분담 금액 discountShareTaxFree: type: integer format: int64 title: 면세 할인 분담 금액 userDefinedFormulas: $ref: '#/components/schemas/PlatformUserDefinedFormulaResults' title: 사용자 정의 수식 결과 x-portone-title: 정산 금액 정보 x-portone-description: 정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다. SchedulePlatformPartnersError: title: SchedulePlatformPartnersError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformArchivedPartnersCannotBeScheduledError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformMemberCompanyConnectedPartnersCannotBeScheduledError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerSchedulesAlreadyExistError' - $ref: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ARCHIVED_PARTNERS_CANNOT_BE_SCHEDULED: '#/components/schemas/PlatformArchivedPartnersCannotBeScheduledError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_MEMBER_COMPANY_CONNECTED_PARTNERS_CANNOT_BE_SCHEDULED: '#/components/schemas/PlatformMemberCompanyConnectedPartnersCannotBeScheduledError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_SCHEDULES_ALREADY_EXIST: '#/components/schemas/PlatformPartnerSchedulesAlreadyExistError' PLATFORM_USER_DEFINED_PROPERTY_NOT_FOUND: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PageInfo: title: 반환된 페이지 결과 정보 description: 반환된 페이지 결과 정보 type: object required: - number - size - totalCount properties: number: type: integer format: int32 title: 요청된 페이지 번호 size: type: integer format: int32 title: 요청된 페이지 당 객체 수 totalCount: type: integer format: int32 title: 실제 반환된 객체 수 x-portone-title: 반환된 페이지 결과 정보 PlatformSettlementDateEarlierThanSettlementStartDateError: title: 정산일이 정산 시작일보다 빠른 경우 description: 정산일이 정산 시작일보다 빠른 경우 type: object required: - type - settlementStartDate - settlementDate properties: type: type: string message: type: string settlementStartDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. x-portone-title: 정산일이 정산 시작일보다 빠른 경우 x-portone-status-code: 400 PlatformPaymentMethodVirtualAccount: title: 가상계좌 description: 가상계좌 type: object required: - type properties: type: type: string x-portone-title: 가상계좌 PlatformPartnerStatus: title: 플랫폼 파트너 상태 description: 플랫폼 파트너 상태 type: string enum: - PENDING - APPROVED - REJECTED x-portone-title: 플랫폼 파트너 상태 x-portone-enum: PENDING: title: 승인 대기 중 APPROVED: title: 승인 완료 REJECTED: title: 승인 거절 SchedulePlatformPartnerBody: title: 파트너 업데이트 예약을 위한 입력 정보 description: 파트너 업데이트 예약을 위한 입력 정보 type: object required: - update - appliedAt properties: update: $ref: '#/components/schemas/UpdatePlatformPartnerBody' title: 반영할 업데이트 내용 appliedAt: type: string format: date-time title: 업데이트 적용 시점 x-portone-title: 파트너 업데이트 예약을 위한 입력 정보 Currency: title: 통화 description: 통화 type: string enum: - KRW - USD - JPY - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - KES - KGS - KHR - KMF - KPW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL x-portone-title: 통화 x-portone-enum: OMR: title: Rial Omani CUC: title: Peso Convertible BBD: title: Barbados Dollar PLN: title: Zloty SVC: title: El Salvador Colon BMD: title: Bermudian Dollar TJS: title: Somoni TND: title: Tunisian Dinar GNF: title: Guinean Franc SDG: title: Sudanese Pound MRU: title: Ouguiya XBB: title: Bond Markets Unit European Monetary Unit (E.M.U.-6) PKR: title: Pakistan Rupee FKP: title: Falkland Islands Pound MUR: title: Mauritius Rupee XAF: title: CFA Franc BEAC SAR: title: Saudi Riyal CAD: title: Canadian Dollar HKD: title: Hong Kong Dollar PYG: title: Guarani MGA: title: Malagasy Ariary UYI: title: Uruguay Peso en Unidades Indexadas (UI) AUD: title: Australian Dollar AMD: title: Armenian Dram YER: title: Yemeni Rial CHE: title: WIR Euro MMK: title: Kyat SEK: title: Swedish Krona TRY: title: Turkish Lira XBC: title: Bond Markets Unit European Unit of Account 9 (E.U.A.-9) KES: title: Kenyan Shilling GEL: title: Lari GTQ: title: Quetzal TZS: title: Tanzanian Shilling CUP: title: Cuban Peso ALL: title: Lek ERN: title: Nakfa BRL: title: Brazilian Real UGX: title: Uganda Shilling XUA: title: ADB Unit of Account GIP: title: Gibraltar Pound MZN: title: Mozambique Metical KRW: title: 대한민국 원화 JOD: title: Jordanian Dinar IQD: title: Iraqi Dinar VUV: title: Vatu XXX: title: The codes assigned for transactions where no currency is involved UZS: title: Uzbekistan Sum BOV: title: Mvdol UAH: title: Hryvnia PEN: title: Sol KMF: title: 'Comorian Franc ' DOP: title: Dominican Peso BDT: title: Taka LKR: title: Sri Lanka Rupee FJD: title: Fiji Dollar LSL: title: Loti BSD: title: Bahamian Dollar SRD: title: Surinam Dollar XTS: title: Codes specifically reserved for testing purposes SHP: title: Saint Helena Pound LRD: title: Liberian Dollar QAR: title: Qatari Rial BND: title: Brunei Dollar CDF: title: Congolese Franc SLE: title: Leone USN: title: US Dollar (Next day) VES: title: Bolívar Soberano TMT: title: Turkmenistan New Manat CHW: title: WIR Franc BGN: title: Bulgarian Lev JMD: title: Jamaican Dollar SZL: title: Lilangeni CZK: title: Czech Koruna ZMW: title: Zambian Kwacha UYU: title: Peso Uruguayo NPR: title: Nepalese Rupee EGP: title: Egyptian Pound AZN: title: Azerbaijan Manat CLP: title: Chilean Peso MOP: title: Pataca SCR: title: Seychelles Rupee HTG: title: Gourde VND: title: Dong LAK: title: Lao Kip BTN: title: Ngultrum GBP: title: Pound Sterling SSP: title: South Sudanese Pound XPD: title: Palladium TWD: title: New Taiwan Dollar DZD: title: Algerian Dinar MXN: title: Mexican Peso XDR: title: SDR (Special Drawing Right) ZWL: title: Zimbabwe Dollar AWG: title: Aruban Florin THB: title: Baht ISK: title: Iceland Krona LBP: title: Lebanese Pound SGD: title: Singapore Dollar MWK: title: Malawi Kwacha KZT: title: Tenge CRC: title: Costa Rican Colon WST: title: Tala DJF: title: Djibouti Franc LYD: title: Libyan Dinar NGN: title: Naira BIF: title: Burundi Franc AED: title: UAE Dirham CHF: title: Swiss Franc RWF: title: Rwanda Franc XBD: title: Bond Markets Unit European Unit of Account 17 (E.U.A.-17) INR: title: Indian Rupee CLF: title: Unidad de Fomento XOF: title: CFA Franc BCEAO COU: title: Unidad de Valor Real MXV: title: Mexican Unidad de Inversion (UDI) PGK: title: Kina CNY: title: Yuan Renminbi SYP: title: Syrian Pound VED: title: Bolívar Soberano RON: title: Romanian Leu AFN: title: Afghani PHP: title: Philippine Peso MDL: title: Moldovan Leu KHR: title: Riel XPT: title: Platinum COP: title: Colombian Peso DKK: title: Danish Krone KYD: title: Cayman Islands Dollar XPF: title: CFP Franc GMD: title: Dalasi MVR: title: Rufiyaa STN: title: Dobra TTD: title: Trinidad and Tobago Dollar PAB: title: Balboa XAU: title: Gold XAG: title: Silver JPY: title: 일본 엔화 TOP: title: Pa’anga BWP: title: Pula MKD: title: Denar ARS: title: Argentine Peso HUF: title: Forint MYR: title: Malaysian Ringgit USD: title: 미국 달러 SLL: title: Leone MAD: title: Moroccan Dirham RUB: title: Russian Ruble MNT: title: Tugrik BOB: title: Boliviano GYD: title: Guyana Dollar SBD: title: Solomon Islands Dollar XBA: title: Bond Markets Unit European Composite Unit (EURCO) BHD: title: Bahraini Dinar HNL: title: Lempira UYW: title: Unidad Previsional NZD: title: New Zealand Dollar XCD: title: East Caribbean Dollar XSU: title: Sucre KGS: title: Som AOA: title: Kwanza BZD: title: Belize Dollar IDR: title: Rupiah SOS: title: Somali Shilling NIO: title: Cordoba Oro GHS: title: Ghana Cedi ANG: title: Netherlands Antillean Guilder RSD: title: Serbian Dinar ILS: title: New Israeli Sheqel NOK: title: Norwegian Krone KWD: title: Kuwaiti Dinar NAD: title: Namibia Dollar ETB: title: Ethiopian Birr BYN: title: Belarusian Ruble KPW: title: North Korean Won EUR: title: Euro CVE: title: Cabo Verde Escudo ZAR: title: Rand IRR: title: Iranian Rial HRK: title: Kuna (Replaced by EUR) BAM: title: Convertible Mark DeletePlatformTransferResponse: title: DeletePlatformTransferResponse type: object CreatePlatformOrderTransferBodyOrderLine: title: 주문 항목 description: 주문 항목 type: object required: - product - quantity - discounts - additionalFees properties: product: $ref: '#/components/schemas/CreatePlatformOrderTransferBodyProduct' title: 상품 quantity: type: integer format: int32 title: 상품 수량 discounts: title: 상품 할인 정보 type: array items: $ref: '#/components/schemas/CreatePlatformOrderTransferBodyDiscount' additionalFees: title: 상품 추가 수수료 정보 type: array items: $ref: '#/components/schemas/CreatePlatformOrderTransferBodyAdditionalFee' x-portone-title: 주문 항목 PlatformTransferSummaryExternalPayment: title: PlatformTransferSummaryExternalPayment type: object required: - type - id - currency properties: type: type: string id: type: string orderName: type: string currency: $ref: '#/components/schemas/Currency' methodType: $ref: '#/components/schemas/PaymentMethodType' SchedulePlatformPartnersResponse: title: SchedulePlatformPartnersResponse type: object CreatePlatformPartnerBody: title: 파트너 생성을 위한 입력 정보 description: 파트너 생성을 위한 입력 정보 type: object required: - name - contact - account - defaultContractId - tags - type properties: id: type: string title: 파트너에 부여할 고유 아이디 description: 고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다. name: type: string title: 파트너 법인명 혹은 이름 contact: $ref: '#/components/schemas/CreatePlatformPartnerBodyContact' title: 파트너 담당자 연락 정보 account: $ref: '#/components/schemas/CreatePlatformPartnerBodyAccount' title: 정산 계좌 description: 파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다. defaultContractId: type: string title: 기본 계약 아이디 description: 이미 존재하는 계약 아이디를 등록해야 합니다. memo: type: string title: 파트너에 대한 메모 description: 총 256자까지 입력할 수 있습니다. tags: type: array items: type: string title: 파트너에 부여할 태그 리스트 description: 최대 10개까지 입력할 수 있습니다. type: $ref: '#/components/schemas/CreatePlatformPartnerBodyType' title: 파트너 유형별 추가 정보 description: 사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다. userDefinedProperties: $ref: '#/components/schemas/PlatformProperties' title: 사용자 정의 속성 x-portone-title: 파트너 생성을 위한 입력 정보 PlatformArchivedDiscountSharePolicyError: title: 보관된 할인 분담 정책을 업데이트하려고 하는 경우 description: 보관된 할인 분담 정책을 업데이트하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 보관된 할인 분담 정책을 업데이트하려고 하는 경우 x-portone-status-code: 409 PlatformPayoutMethod: title: PlatformPayoutMethod type: string enum: - DIRECT - AGENCY x-portone-enum: DIRECT: {} AGENCY: {} ScheduleAdditionalFeePolicyError: title: ScheduleAdditionalFeePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyScheduleAlreadyExistsError' - $ref: '#/components/schemas/PlatformArchivedAdditionalFeePolicyError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' PLATFORM_ADDITIONAL_FEE_POLICY_SCHEDULE_ALREADY_EXISTS: '#/components/schemas/PlatformAdditionalFeePolicyScheduleAlreadyExistsError' PLATFORM_ARCHIVED_ADDITIONAL_FEE_POLICY: '#/components/schemas/PlatformArchivedAdditionalFeePolicyError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' CreatePlatformOrderCancelTransferBodyExternalCancellationDetail: title: 외부 결제 상세 정보 description: 외부 결제 상세 정보 type: object properties: cancelledAt: type: string format: date-time title: 취소 일시 x-portone-title: 외부 결제 상세 정보 PlatformBusinessStatus: title: 플랫폼 사업자 상태 description: 플랫폼 사업자 상태 type: string enum: - IN_BUSINESS - CLOSED - SUSPENDED x-portone-title: 플랫폼 사업자 상태 x-portone-enum: IN_BUSINESS: title: 사업 중 CLOSED: title: 폐업 SUSPENDED: title: 휴업 PlatformAccountVerificationAlreadyUsedError: title: 파트너 계좌 검증 아이디를 이미 사용한 경우 description: 파트너 계좌 검증 아이디를 이미 사용한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너 계좌 검증 아이디를 이미 사용한 경우 x-portone-status-code: 409 PlatformPaymentNotFoundError: title: PlatformPaymentNotFoundError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 404 PlatformAccountVerificationFailedError: title: 파트너 계좌 인증이 실패한 경우 description: 파트너 계좌 인증이 실패한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너 계좌 인증이 실패한 경우 x-portone-status-code: 400 PlatformPortOnePaymentCancelAmountType: title: 금액 타입 description: 금액 타입 type: string enum: - SUPPLY_WITH_VAT - TAX_FREE x-portone-title: 금액 타입 x-portone-enum: SUPPLY_WITH_VAT: title: 공급대가 description: 공급가액과 부가세를 더한 금액입니다. TAX_FREE: title: 면세 금액 PlatformPaymentMethodMobile: title: 모바일 description: 모바일 type: object required: - type properties: type: type: string x-portone-title: 모바일 GetPlatformBulkPayoutsError: title: GetPlatformBulkPayoutsError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' SchedulePlatformPartnersBodyUpdate: title: SchedulePlatformPartnersBodyUpdate type: object properties: name: type: string contact: $ref: '#/components/schemas/SchedulePlatformPartnersBodyUpdateContact' type: $ref: '#/components/schemas/SchedulePlatformPartnersBodyUpdateType' account: $ref: '#/components/schemas/SchedulePlatformPartnersBodyUpdateAccount' defaultContractId: type: string memo: type: string tags: type: array items: type: string userDefinedProperties: $ref: '#/components/schemas/PlatformProperties' PlatformBulkAccountTransferStatusStats: title: PlatformBulkAccountTransferStatusStats type: object required: - prepared - scheduled - ongoing - completed properties: prepared: type: integer format: int64 scheduled: type: integer format: int64 ongoing: type: integer format: int64 completed: type: integer format: int64 ReschedulePartnerError: title: ReschedulePartnerError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformMemberCompanyConnectedPartnerCannotBeScheduledError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_MEMBER_COMPANY_CONNECTED_PARTNER_CANNOT_BE_SCHEDULED: '#/components/schemas/PlatformMemberCompanyConnectedPartnerCannotBeScheduledError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' CreatePlatformPartnerError: title: CreatePlatformPartnerError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAccountVerificationAlreadyUsedError' - $ref: '#/components/schemas/PlatformAccountVerificationFailedError' - $ref: '#/components/schemas/PlatformAccountVerificationNotFoundError' - $ref: '#/components/schemas/PlatformCompanyVerificationAlreadyUsedError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformCurrencyNotSupportedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerIdAlreadyExistsError' - $ref: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ACCOUNT_VERIFICATION_ALREADY_USED: '#/components/schemas/PlatformAccountVerificationAlreadyUsedError' PLATFORM_ACCOUNT_VERIFICATION_FAILED: '#/components/schemas/PlatformAccountVerificationFailedError' PLATFORM_ACCOUNT_VERIFICATION_NOT_FOUND: '#/components/schemas/PlatformAccountVerificationNotFoundError' PLATFORM_COMPANY_VERIFICATION_ALREADY_USED: '#/components/schemas/PlatformCompanyVerificationAlreadyUsedError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_CURRENCY_NOT_SUPPORTED: '#/components/schemas/PlatformCurrencyNotSupportedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_ID_ALREADY_EXISTS: '#/components/schemas/PlatformPartnerIdAlreadyExistsError' PLATFORM_USER_DEFINED_PROPERTY_NOT_FOUND: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' ConnectBulkPartnerCounterpartyError: title: ConnectBulkPartnerCounterpartyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformBtxNotEnabledError' - $ref: '#/components/schemas/PlatformExternalApiFailedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformTargetPartnerNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_BTX_NOT_ENABLED: '#/components/schemas/PlatformBtxNotEnabledError' PLATFORM_EXTERNAL_API_FAILED: '#/components/schemas/PlatformExternalApiFailedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_TARGET_PARTNER_NOT_FOUND: '#/components/schemas/PlatformTargetPartnerNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPaymentMethodVirtualAccountInput: title: PlatformPaymentMethodVirtualAccountInput type: object PlatformSettlementCycleMethodDaily: title: 매일 정산 description: 매일 정산 type: object required: - type properties: type: type: string x-portone-title: 매일 정산 PlatformOngoingTaxInvoiceExistsError: title: 진행 중인 세금계산서가 존재하는 경우 description: 진행 중인 세금계산서가 존재하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 진행 중인 세금계산서가 존재하는 경우 x-portone-status-code: 409 PlatformReferencedCancelOrderTransfersExistError: title: 취소 정산건이 참조 중인 정산건이 포함된 경우 description: 취소 정산건이 참조 중인 정산건이 포함된 경우 type: object required: - type - ids properties: type: type: string ids: type: array items: type: string message: type: string x-portone-title: 취소 정산건이 참조 중인 정산건이 포함된 경우 x-portone-status-code: 400 PlatformCompanyNotFoundError: title: 사업자 정보를 찾을 수 없는 경우 description: 사업자 정보를 찾을 수 없는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 사업자 정보를 찾을 수 없는 경우 x-portone-status-code: 404 CreatePlatformOrderTransferBodyProduct: title: 상품 description: 상품 type: object required: - id - name - amount properties: id: type: string title: 상품 아이디 name: type: string title: 상품 이름 amount: type: integer format: int64 title: 상품 금액 taxFreeAmount: type: integer format: int64 title: 상품 면세 금액 tag: type: string title: 태그 x-portone-title: 상품 CreatePlatformPartnersResponse: title: 파트너 다건 생성 성공 응답 description: 파트너 다건 생성 성공 응답 type: object required: - partners properties: partners: title: 생성된 파트너 리스트 type: array items: $ref: '#/components/schemas/PlatformPartner' x-portone-title: 파트너 다건 생성 성공 응답 PlatformAccountStatus: title: 플랫폼 계좌 상태 description: 플랫폼 계좌 상태 type: string enum: - VERIFIED - VERIFY_FAILED - VERIFY_ERROR - NOT_VERIFIED - UNKNOWN x-portone-title: 플랫폼 계좌 상태 x-portone-enum: NOT_VERIFIED: title: 계좌 인증 안됨 VERIFY_FAILED: title: 계좌주 불일치 VERIFIED: title: 계좌 인증 완료됨 VERIFY_ERROR: title: 계좌 인증 오류 UNKNOWN: title: 알 수 없는 상태 PlatformArchivedAdditionalFeePolicyError: title: 보관된 추가 수수료 정책을 업데이트하려고 하는 경우 description: 보관된 추가 수수료 정책을 업데이트하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 보관된 추가 수수료 정책을 업데이트하려고 하는 경우 x-portone-status-code: 409 PlatformAdditionalFeePolicyScheduleAlreadyExistsError: title: PlatformAdditionalFeePolicyScheduleAlreadyExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 PlatformFixedRateFee: title: 정률 수수료 description: '정률 수수료 총 금액에 정해진 비율을 곱한 만큼의 수수료를 책정합니다.' type: object required: - type - rate properties: type: type: string rate: type: integer format: int32 title: 수수료율 description: 총 금액 대비 수수료 비율을 의미하며, 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수입니다. `총 금액 * rate * 10^5` (`rate * 10^3 %`) 만큼 수수료를 책정합니다. x-portone-title: 정률 수수료 x-portone-description: 총 금액에 정해진 비율을 곱한 만큼의 수수료를 책정합니다. PlatformAdditionalFeePolicyAlreadyExistsError: title: PlatformAdditionalFeePolicyAlreadyExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 UnauthorizedError: title: 인증 정보가 올바르지 않은 경우 description: 인증 정보가 올바르지 않은 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 인증 정보가 올바르지 않은 경우 x-portone-status-code: 401 ArchivePlatformDiscountSharePolicyError: title: ArchivePlatformDiscountSharePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformCannotArchiveScheduledDiscountSharePolicyError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CANNOT_ARCHIVE_SCHEDULED_DISCOUNT_SHARE_POLICY: '#/components/schemas/PlatformCannotArchiveScheduledDiscountSharePolicyError' PLATFORM_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' SchedulePlatformAdditionalFeePolicyResponse: title: 추가 수수료 정책 업데이트 예약 성공 응답 description: 추가 수수료 정책 업데이트 예약 성공 응답 type: object required: - scheduledAdditionalFeePolicy properties: scheduledAdditionalFeePolicy: $ref: '#/components/schemas/PlatformAdditionalFeePolicy' title: 예약된 추가 수수료 정책 x-portone-title: 추가 수수료 정책 업데이트 예약 성공 응답 PlatformDiscountSharePoliciesNotFoundError: title: PlatformDiscountSharePoliciesNotFoundError type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-status-code: 404 PlatformSettlementAmountExceededError: title: 정산 가능한 금액을 초과한 경우 description: 정산 가능한 금액을 초과한 경우 type: object required: - type - requestedAmount - allowedAmount - type properties: type: $ref: '#/components/schemas/PlatformAmountExceededType' message: type: string productId: type: string title: 상품 아이디 description: 주문 항목의 상품 아이디입니다. requestedAmount: type: integer format: int64 title: 요청 받은 금액 allowedAmount: type: integer format: int64 title: 초과한 금액 x-portone-title: 정산 가능한 금액을 초과한 경우 x-portone-status-code: 400 PlatformDiscountSharePolicyIdDuplicatedError: title: PlatformDiscountSharePolicyIdDuplicatedError type: object required: - type - id - graphqlId properties: type: type: string id: type: string graphqlId: type: string message: type: string x-portone-status-code: 400 PlatformTransfer: title: 정산건 description: '정산건 정산건은 파트너에 정산해줄 정산 금액과 정산 방식 등이 포함되어 있는 정산 정보입니다. 정산 방식은은 주문 정산, 주문 취소 정산, 수기 정산이 있습니다.' oneOf: - $ref: '#/components/schemas/PlatformManualTransfer' - $ref: '#/components/schemas/PlatformOrderCancelTransfer' - $ref: '#/components/schemas/PlatformOrderTransfer' discriminator: propertyName: type mapping: MANUAL: '#/components/schemas/PlatformManualTransfer' ORDER: '#/components/schemas/PlatformOrderTransfer' ORDER_CANCEL: '#/components/schemas/PlatformOrderCancelTransfer' x-portone-title: 정산건 x-portone-description: '정산건은 파트너에 정산해줄 정산 금액과 정산 방식 등이 포함되어 있는 정산 정보입니다. 정산 방식은은 주문 정산, 주문 취소 정산, 수기 정산이 있습니다.' x-portone-discriminator: MANUAL: title: 수기 정산건 ORDER: title: 주문 정산건 ORDER_CANCEL: title: 주문 취소 정산건 PlatformSettlementCycleMethodWeekly: title: 매주 정해진 요일에 정산 description: 매주 정해진 요일에 정산 type: object required: - type - daysOfWeek properties: type: type: string daysOfWeek: title: 요일 type: array items: $ref: '#/components/schemas/DayOfWeek' x-portone-title: 매주 정해진 요일에 정산 PlatformProductIdNotFoundError: title: PlatformProductIdNotFoundError type: object required: - type - id properties: type: type: string id: type: string message: type: string x-portone-status-code: 404 CreatePlatformOrderCancelTransferBodyDiscount: title: 할인 정보 description: 할인 정보 type: object required: - sharePolicyId - amount properties: sharePolicyId: type: string title: 할인 분담 정책 아이디 amount: type: integer format: int64 title: 할인 금액 taxFreeAmount: type: integer format: int64 title: 면세 할인 금액 x-portone-title: 할인 정보 PlatformBulkPayoutStatusStats: title: PlatformBulkPayoutStatusStats type: object required: - preparing - prepared - ongoing - postProcessPending - completed - cancelled properties: preparing: type: integer format: int64 prepared: type: integer format: int64 ongoing: type: integer format: int64 postProcessPending: type: integer format: int64 completed: type: integer format: int64 cancelled: type: integer format: int64 PlatformOrderTransferDiscount: title: 할인 정보 description: 할인 정보 type: object required: - sharePolicy - amount - taxFreeAmount - shareAmount - shareTaxFreeAmount properties: sharePolicy: $ref: '#/components/schemas/PlatformDiscountSharePolicy' title: 할인 분담 정책 amount: type: integer format: int64 title: 할인 금액 taxFreeAmount: type: integer format: int64 title: 면세 할인 금액 shareAmount: type: integer format: int64 title: 할인 분담 금액 shareTaxFreeAmount: type: integer format: int64 title: 면세 할인 분담 금액 x-portone-title: 할인 정보 PlatformTransferNotFoundError: title: PlatformTransferNotFoundError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 404 PlatformPayoutStatusStats: title: PlatformPayoutStatusStats type: object required: - confirmed - prepared - cancelled - stopped - processing - succeeded - failed - scheduled properties: confirmed: type: integer format: int64 prepared: type: integer format: int64 cancelled: type: integer format: int64 stopped: type: integer format: int64 processing: type: integer format: int64 succeeded: type: integer format: int64 failed: type: integer format: int64 scheduled: type: integer format: int64 CreatePlatformOrderTransferBodyAdditionalFee: title: 추가 수수료 정보 description: 추가 수수료 정보 type: object required: - policyId properties: policyId: type: string title: 추가 수수료 정책 아이디 x-portone-title: 추가 수수료 정보 PlatformTransferDiscountSharePolicyNotFoundError: title: PlatformTransferDiscountSharePolicyNotFoundError type: object required: - type - discountSharePolicyId - discountSharePolicyGraphqlId properties: type: type: string discountSharePolicyId: type: string discountSharePolicyGraphqlId: type: string productId: type: string message: type: string x-portone-status-code: 404 PlatformPaymentMethod: title: 결제 수단 description: 결제 수단 oneOf: - $ref: '#/components/schemas/PlatformPaymentMethodCard' - $ref: '#/components/schemas/PlatformPaymentMethodEasyPay' - $ref: '#/components/schemas/PlatformPaymentMethodGiftCertificate' - $ref: '#/components/schemas/PlatformPaymentMethodMobile' - $ref: '#/components/schemas/PlatformPaymentMethodTransfer' - $ref: '#/components/schemas/PlatformPaymentMethodVirtualAccount' discriminator: propertyName: type mapping: CARD: '#/components/schemas/PlatformPaymentMethodCard' EASY_PAY: '#/components/schemas/PlatformPaymentMethodEasyPay' GIFT_CERTIFICATE: '#/components/schemas/PlatformPaymentMethodGiftCertificate' MOBILE: '#/components/schemas/PlatformPaymentMethodMobile' TRANSFER: '#/components/schemas/PlatformPaymentMethodTransfer' VIRTUAL_ACCOUNT: '#/components/schemas/PlatformPaymentMethodVirtualAccount' x-portone-title: 결제 수단 x-portone-discriminator: GIFT_CERTIFICATE: title: 상품권 VIRTUAL_ACCOUNT: title: 가상계좌 MOBILE: title: 모바일 CARD: title: 카드 TRANSFER: title: 계좌이체 EASY_PAY: title: 간편 결제 SchedulePlatformDiscountSharePolicyBody: title: 할인 분담 정책 업데이트 예약을 위한 입력 정보 description: 할인 분담 정책 업데이트 예약을 위한 입력 정보 type: object required: - update - appliedAt properties: update: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyBody' title: 반영할 업데이트 내용 appliedAt: type: string format: date-time title: 업데이트 적용 시점 x-portone-title: 할인 분담 정책 업데이트 예약을 위한 입력 정보 CreatePlatformPartnerBodyTypeBusiness: title: CreatePlatformPartnerBodyTypeBusiness type: object required: - companyName - businessRegistrationNumber - representativeName properties: companyName: type: string title: 상호명 taxationType: $ref: '#/components/schemas/PlatformPartnerTaxationType' title: 사업자 유형 description: 값을 입력하지 않으면 일반 과세로 설정됩니다. businessRegistrationNumber: type: string title: 사업자등록번호 representativeName: type: string title: 대표자 이름 companyAddress: type: string title: 사업장 주소 businessType: type: string title: 업태 businessClass: type: string title: 업종 companyVerificationId: type: string title: 사업자 조회 검증 아이디 PlatformBulkAccountTransfer: title: PlatformBulkAccountTransfer type: object required: - id - graphqlId - creatorId - bankAccountId - bankAccountGraphqlId - totalAmount - status - stats - statusUpdatedAt - createdAt - updatedAt properties: id: type: string title: 일괄 이체 고유 아이디 graphqlId: type: string creatorId: type: string bankAccountId: type: string title: 출금 계좌 아이디 bankAccountGraphqlId: type: string totalAmount: type: integer format: int64 status: $ref: '#/components/schemas/PlatformBulkAccountTransferStatus' stats: $ref: '#/components/schemas/PlatformBulkAccountTransferStats' statusUpdatedAt: type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time scheduledAt: type: string format: date-time PlatformContractAlreadyExistsError: title: PlatformContractAlreadyExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 PlatformCannotArchiveScheduledAdditionalFeePolicyError: title: 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우 description: 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우 x-portone-status-code: 409 ForbiddenError: title: 요청이 거절된 경우 description: 요청이 거절된 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 요청이 거절된 경우 x-portone-status-code: 403 DeletePlatformPartnerSettlementsBody: title: DeletePlatformPartnerSettlementsBody type: object required: - partnerSettlementIds properties: partnerSettlementIds: type: array items: type: string isForTest: type: boolean description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' PlatformPayoutFilterInputCriteria: title: 검색 기준 입력 정보 description: 검색 기준 입력 정보 type: object properties: timestampRange: $ref: '#/components/schemas/DateTimeRange' title: 생성 일시 범위 statusUpdatedTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 상태 업데이트 일시 범위 scheduledTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 지급 예정 일시 범위 settlementStatementIssuedTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 정산 내역서 발송 일시 범위 payoutId: type: string title: 지급 아이디 bulkPayoutId: type: string title: 일괄 지급 아이디 taxInvoiceId: type: string title: 세금계산서 아이디 settlementStatementId: type: string title: 정산 내역서 아이디 x-portone-title: 검색 기준 입력 정보 GetPlatformBulkPayoutsResponse: title: GetPlatformBulkPayoutsResponse type: object required: - items - page - counts properties: items: type: array items: $ref: '#/components/schemas/PlatformBulkPayout' page: $ref: '#/components/schemas/PageInfo' counts: $ref: '#/components/schemas/PlatformBulkPayoutStatusStats' GetPlatformBulkPayoutsBody: title: GetPlatformBulkPayoutsBody type: object properties: isForTest: type: boolean description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' page: $ref: '#/components/schemas/PageInput' filter: $ref: '#/components/schemas/PlatformBulkPayoutFilterInput' PlatformPayoutSettlementStatementSummary: title: 정산 내역서 요약 정보 description: 정산 내역서 요약 정보 type: object required: - status properties: status: $ref: '#/components/schemas/PlatformPayoutSettlementStatementStatus' title: 상태 id: type: string title: 아이디 issuedAt: type: string format: date-time title: 발송 일시 x-portone-title: 정산 내역서 요약 정보 MonthDay: title: 월 및 일자 정보 description: 월 및 일자 정보 type: object required: - month - day properties: month: type: integer format: int32 day: type: integer format: int32 x-portone-title: 월 및 일자 정보 PlatformOrderTransferAdditionalFee: title: 추가 수수료 정보 description: 추가 수수료 정보 type: object required: - policy - amount - vat properties: policy: $ref: '#/components/schemas/PlatformAdditionalFeePolicy' title: 추가 수수료 정책 amount: type: integer format: int64 title: 추가 수수료 금액 vat: type: integer format: int64 title: 추가 수수료 부가세 금액 x-portone-title: 추가 수수료 정보 PlatformDiscountSharePolicyFilterOptions: title: 할인 분담 정책 필터 옵션 조회 성공 응답 정보 description: 할인 분담 정책 필터 옵션 조회 성공 응답 정보 type: object required: - partnerShareRates properties: partnerShareRates: type: array items: type: integer format: int32 title: 조회된 파트너 분담율 리스트 x-portone-title: 할인 분담 정책 필터 옵션 조회 성공 응답 정보 GetPlatformDiscountSharePolicyScheduleError: title: GetPlatformDiscountSharePolicyScheduleError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformContractsNotFoundError: title: PlatformContractsNotFoundError type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-status-code: 404 PlatformArchivedPartnersCannotBeScheduledError: title: 보관된 파트너들을 예약 업데이트하려고 하는 경우 description: 보관된 파트너들을 예약 업데이트하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 보관된 파트너들을 예약 업데이트하려고 하는 경우 x-portone-status-code: 409 Type: title: Type type: string enum: - PARTNER_PAYOUT - REMIT x-portone-enum: PARTNER_PAYOUT: {} REMIT: {} SchedulePlatformContractBody: title: 계약 업데이트 예약을 위한 입력 정보 description: 계약 업데이트 예약을 위한 입력 정보 type: object required: - update - appliedAt properties: update: $ref: '#/components/schemas/UpdatePlatformContractBody' title: 반영할 업데이트 내용 appliedAt: type: string format: date-time title: 업데이트 적용 시점 x-portone-title: 계약 업데이트 예약을 위한 입력 정보 PlatformPayoutAccount: title: PlatformPayoutAccount type: object required: - bank - number - holder properties: bank: $ref: '#/components/schemas/Bank' number: type: string holder: type: string CreatePlatformPartnerResponse: title: 파트너 생성 성공 응답 description: 파트너 생성 성공 응답 type: object required: - partner properties: partner: $ref: '#/components/schemas/PlatformPartner' title: 생성된 파트너 x-portone-title: 파트너 생성 성공 응답 GetPlatformCompanyStateError: title: GetPlatformCompanyStateError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformCompanyNotFoundError' - $ref: '#/components/schemas/PlatformExternalApiFailedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_COMPANY_NOT_FOUND: '#/components/schemas/PlatformCompanyNotFoundError' PLATFORM_EXTERNAL_API_FAILED: '#/components/schemas/PlatformExternalApiFailedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformNoSelectedPartnerSettlementsError: title: 선택된 정산건이 없는 경우 description: 선택된 정산건이 없는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 선택된 정산건이 없는 경우 x-portone-status-code: 400 DisconnectBulkPartnerCounterpartyError: title: DisconnectBulkPartnerCounterpartyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformBtxNotEnabledError' - $ref: '#/components/schemas/PlatformExternalApiFailedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformTargetPartnerNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_BTX_NOT_ENABLED: '#/components/schemas/PlatformBtxNotEnabledError' PLATFORM_EXTERNAL_API_FAILED: '#/components/schemas/PlatformExternalApiFailedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_TARGET_PARTNER_NOT_FOUND: '#/components/schemas/PlatformTargetPartnerNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPartnerTypeName: title: 플랫폼 파트너 유형 이름 description: 플랫폼 파트너 유형 이름 type: string enum: - BUSINESS - WHT_PAYER - NON_WHT_PAYER x-portone-title: 플랫폼 파트너 유형 이름 x-portone-enum: BUSINESS: title: 사업자 WHT_PAYER: title: 원천징수 대상자 NON_WHT_PAYER: title: 원천징수 비대상자 ReschedulePlatformAdditionalFeePolicyResponse: title: 추가 수수료 정책 예약 업데이트 재설정 성공 응답 description: 추가 수수료 정책 예약 업데이트 재설정 성공 응답 type: object required: - scheduledAdditionalFeePolicy properties: scheduledAdditionalFeePolicy: $ref: '#/components/schemas/PlatformAdditionalFeePolicy' title: 예약된 추가 수수료 정책 x-portone-title: 추가 수수료 정책 예약 업데이트 재설정 성공 응답 PlatformDiscountSharePolicyAlreadyExistsError: title: PlatformDiscountSharePolicyAlreadyExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 ConnectPartnerCounterpartyError: title: ConnectPartnerCounterpartyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformArchivedPartnerError' - $ref: '#/components/schemas/PlatformArchivedPartnerNtsNotAllowedError' - $ref: '#/components/schemas/PlatformBtxNotEnabledError' - $ref: '#/components/schemas/PlatformCounterpartyNotConnectableStatusError' - $ref: '#/components/schemas/PlatformExternalApiFailedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformPartnerScheduleExistsError' - $ref: '#/components/schemas/PlatformPartnerTaxationTypeIsSimpleError' - $ref: '#/components/schemas/PlatformPartnerTypeIsNotBusinessError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ARCHIVED_PARTNER: '#/components/schemas/PlatformArchivedPartnerError' PLATFORM_ARCHIVED_PARTNER_NTS_NOT_ALLOWED: '#/components/schemas/PlatformArchivedPartnerNtsNotAllowedError' PLATFORM_BTX_NOT_ENABLED: '#/components/schemas/PlatformBtxNotEnabledError' PLATFORM_COUNTERPARTY_NOT_CONNECTABLE_STATUS: '#/components/schemas/PlatformCounterpartyNotConnectableStatusError' PLATFORM_EXTERNAL_API_FAILED: '#/components/schemas/PlatformExternalApiFailedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_PARTNER_SCHEDULE_EXISTS: '#/components/schemas/PlatformPartnerScheduleExistsError' PLATFORM_PARTNER_TAXATION_TYPE_IS_SIMPLE: '#/components/schemas/PlatformPartnerTaxationTypeIsSimpleError' PLATFORM_PARTNER_TYPE_IS_NOT_BUSINESS: '#/components/schemas/PlatformPartnerTypeIsNotBusinessError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPartnerSettlementsNotFoundError: title: 요청한 정산건 목록을 찾을 수 없는 경우 description: 요청한 정산건 목록을 찾을 수 없는 경우 type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-title: 요청한 정산건 목록을 찾을 수 없는 경우 x-portone-status-code: 404 UpdatePlatformDiscountSharePolicyResponse: title: 할인 분담 정책 업데이트 성공 응답 description: 할인 분담 정책 업데이트 성공 응답 type: object required: - discountSharePolicy properties: discountSharePolicy: $ref: '#/components/schemas/PlatformDiscountSharePolicy' title: 업데이트된 할인 분담 정책 x-portone-title: 할인 분담 정책 업데이트 성공 응답 CreatePlatformOrderCancelTransferBody: title: 주문 취소 정산 등록을 위한 입력 정보 description: '주문 취소 정산 등록을 위한 입력 정보 하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다. 하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다. transferId를 입력한 경우 (partnerId, paymentId)는 생략 가능합니다. id를 입력한 경우 생성될 취소 정산건 아이디로 사용됩니다.' type: object required: - cancellationId - discounts properties: partnerId: type: string title: 파트너 아이디 paymentId: type: string title: 결제 아이디 transferId: type: string title: 정산건 아이디 cancellationId: type: string title: 취소 내역 아이디 memo: type: string title: 메모 orderDetail: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferBodyOrderDetail' title: 주문 취소 정보 taxFreeAmount: type: integer format: int64 title: 주문 취소 면세 금액 description: 주문 취소 항목과 취소 면세 금액을 같이 전달하시면 최종 취소 면세 금액은 주문 취소 항목의 면세 금액이 아닌 전달해주신 취소 면세 금액으로 적용됩니다. discounts: title: 할인 정보 type: array items: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferBodyDiscount' settlementStartDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 시작일 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산일 externalCancellationDetail: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferBodyExternalCancellationDetail' title: 외부 결제 상세 정보 description: 해당 정보가 존재하는 경우 외부 결제 취소 정산건으로 등록되고, 존재하지않은 경우 포트원 결제 취소 정산건으로 등록됩니다. isForTest: type: boolean title: 테스트 모드 여부 description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' id: type: string title: 생성할 취소 정산건 아이디 description: 명시하지 않으면 id 가 임의로 생성됩니다. x-portone-title: 주문 취소 정산 등록을 위한 입력 정보 x-portone-description: '하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다. 하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다. transferId를 입력한 경우 (partnerId, paymentId)는 생략 가능합니다. id를 입력한 경우 생성될 취소 정산건 아이디로 사용됩니다.' PlatformTransferSummaryPayment: title: PlatformTransferSummaryPayment oneOf: - $ref: '#/components/schemas/PlatformTransferSummaryExternalPayment' - $ref: '#/components/schemas/PlatformTransferSummaryPortOnePayment' discriminator: propertyName: type mapping: EXTERNAL: '#/components/schemas/PlatformTransferSummaryExternalPayment' PORT_ONE: '#/components/schemas/PlatformTransferSummaryPortOnePayment' x-portone-discriminator: PORT_ONE: {} EXTERNAL: {} PlatformInsufficientDataToChangePartnerTypeError: title: 파트너 타입 수정에 필요한 데이터가 부족한 경우 description: 파트너 타입 수정에 필요한 데이터가 부족한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너 타입 수정에 필요한 데이터가 부족한 경우 x-portone-status-code: 400 PlatformSettlementCycleMethodManualDatesInput: title: PlatformSettlementCycleMethodManualDatesInput type: object required: - dates properties: dates: title: 월 및 일자 정보 type: array items: $ref: '#/components/schemas/MonthDay' PlatformPartnerFilterInputKeyword: title: 파트너 검색 키워드 입력 정보 description: '파트너 검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 파트너만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.' type: object properties: id: type: string description: 해당 값이 포함된 id 를 가진 파트너만 조회합니다. name: type: string description: 해당 값이 포함된 이름 을 가진 파트너만 조회합니다. email: type: string description: 해당 값이 포함된 이메일 주소를 가진 파트너만 조회합니다. businessRegistrationNumber: type: string description: 해당 값이 포함된 사업자등록번호를 가진 파트너만 조회합니다. defaultContractId: type: string description: 해당 값이 포함된 기본 계약 아이디를 가진 파트너만 조회합니다. memo: type: string description: 해당 값이 포함된 메모를 가진 파트너만 조회합니다. accountNumber: type: string description: 해당 값이 포함된 계좌번호를 가진 파트너만 조회합니다. accountHolder: type: string description: 해당 값이 포함된 계좌 예금주명을 가진 파트너만 조회합니다. x-portone-title: 파트너 검색 키워드 입력 정보 x-portone-description: 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 파트너만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다. SchedulePlatformContractResponse: title: 계약 업데이트 예약 성공 응답 description: 계약 업데이트 예약 성공 응답 type: object required: - scheduledContract properties: scheduledContract: $ref: '#/components/schemas/PlatformContract' title: 예약된 계약 정보 x-portone-title: 계약 업데이트 예약 성공 응답 PlatformContractScheduleAlreadyExistsError: title: PlatformContractScheduleAlreadyExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 PlatformCancellationNotFoundError: title: PlatformCancellationNotFoundError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 404 GetPlatformPayoutsResponse: title: GetPlatformPayoutsResponse type: object required: - items - page - counts properties: items: type: array items: $ref: '#/components/schemas/PlatformPayout' page: $ref: '#/components/schemas/PageInfo' counts: $ref: '#/components/schemas/PlatformPayoutStatusStats' PlatformProperties: title: PlatformProperties type: object additionalProperties: $ref: '#/components/schemas/PlatformUserDefinedPropertyValue' CreateOrderCancelTransferResponse: title: CreateOrderCancelTransferResponse type: object required: - transfer properties: transfer: $ref: '#/components/schemas/PlatformOrderCancelTransfer' DeletePlatformTransferError: title: DeletePlatformTransferError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformCancelOrderTransfersExistsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformTransferNonDeletableStatusError' - $ref: '#/components/schemas/PlatformTransferNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CANCEL_ORDER_TRANSFERS_EXISTS: '#/components/schemas/PlatformCancelOrderTransfersExistsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_TRANSFER_NON_DELETABLE_STATUS: '#/components/schemas/PlatformTransferNonDeletableStatusError' PLATFORM_TRANSFER_NOT_FOUND: '#/components/schemas/PlatformTransferNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformContractFilterInput: title: 계약 다건 조회를 위한 필터 조건 description: 계약 다건 조회를 위한 필터 조건 type: object properties: platformFeePayers: title: 금액 부담 주체 type: array items: $ref: '#/components/schemas/PlatformPayer' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 수수료 부담 주체를 가진 계약만 조회합니다. cycleTypes: title: 플랫폼 정산 주기 계산 방식 type: array items: $ref: '#/components/schemas/PlatformSettlementCycleType' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 주기 계산 방식을 가진 계약만 조회합니다. datePolicies: title: 플랫폼 정산 기준일 type: array items: $ref: '#/components/schemas/PlatformSettlementCycleDatePolicy' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 기준일을 가진 계약만 조회합니다. isArchived: type: boolean title: 보관 조회 여부 description: true 이면 보관된 계약을 조회하고, false 이면 보관되지 않은 계약을 조회합니다. 기본값은 false 입니다. keyword: $ref: '#/components/schemas/PlatformContractFilterInputKeyword' title: 검색 키워드 x-portone-title: 계약 다건 조회를 위한 필터 조건 GetPlatformDiscountSharePolicyFilterOptionsError: title: GetPlatformDiscountSharePolicyFilterOptionsError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPayoutSettlementStatementStatus: title: 정산 내역서 발송 상태 description: 정산 내역서 발송 상태 type: string enum: - UNSENT - SENT - SEND_FAILED - SEND_PREPARED x-portone-title: 정산 내역서 발송 상태 x-portone-enum: UNSENT: title: 미발송 SENT: title: 발송 성공 SEND_FAILED: title: 발송 실패 SEND_PREPARED: title: 발송 대기 CreatePlatformDiscountSharePolicyError: title: CreatePlatformDiscountSharePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyAlreadyExistsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_DISCOUNT_SHARE_POLICY_ALREADY_EXISTS: '#/components/schemas/PlatformDiscountSharePolicyAlreadyExistsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' RecoverPlatformPartnerResponse: title: 파트너 복원 성공 응답 description: 파트너 복원 성공 응답 type: object required: - partner properties: partner: $ref: '#/components/schemas/PlatformPartner' title: 복원된 파트너 x-portone-title: 파트너 복원 성공 응답 CreatePlatformOrderCancelTransferBodyOrderDetail: title: 주문 취소 정보 description: '주문 취소 정보 orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.' type: object properties: orderAmount: type: integer format: int64 title: 주문 취소 금액 orderLines: title: 주문 취소 항목 리스트 type: array items: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferBodyOrderLine' all: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferBodyOrderDetailAll' title: 전체 금액 취소 x-portone-title: 주문 취소 정보 x-portone-description: orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다. CreatePlatformOrderTransferBodyExternalPaymentDetail: title: 외부 결제 상세 정보 description: 외부 결제 상세 정보 type: object required: - currency properties: currency: $ref: '#/components/schemas/Currency' title: 통화 orderName: type: string title: 주문 명 paidAt: type: string format: date-time title: 결제 일시 method: $ref: '#/components/schemas/PlatformPaymentMethodInput' title: 결제 수단 x-portone-title: 외부 결제 상세 정보 PlatformBankAccountProvider: title: 제공자 description: 제공자 type: string enum: - HYPHEN_DATA - HYPHEN_FIRM - DOZN - MOCK x-portone-title: 제공자 x-portone-enum: HYPHEN_DATA: title: 하이픈 데이터 HYPHEN_FIRM: title: 하이픈 펌뱅킹 DOZN: title: 더즌 MOCK: title: 모의 GetPlatformContractError: title: GetPlatformContractError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' SettlementAmountType: title: SettlementAmountType type: string enum: - NET - GROSS x-portone-enum: NET: title: 순액(공급가액) GROSS: title: 총액(공급가액, 부가세) PlatformMemberCompanyConnectedPartnersCannotBeScheduledError: title: 연동 사업자로 연동된 파트너들을 예약 수정하려고 시도한 경우 description: 연동 사업자로 연동된 파트너들을 예약 수정하려고 시도한 경우 type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-title: 연동 사업자로 연동된 파트너들을 예약 수정하려고 시도한 경우 x-portone-status-code: 409 PlatformBulkTaskProgressStats: title: PlatformBulkTaskProgressStats type: object required: - preparedCount - processingCount - succeededCount - failedCount - canceledCount properties: preparedCount: type: integer format: int64 processingCount: type: integer format: int64 succeededCount: type: integer format: int64 failedCount: type: integer format: int64 canceledCount: type: integer format: int64 CreatePlatformAdditionalFeePolicyBody: title: 추가 수수료 정책 생성을 위한 입력 정보 description: 추가 수수료 정책 생성을 위한 입력 정보 type: object required: - name - fee - vatPayer properties: id: type: string title: 생성할 추가 수수료 정책 아이디 description: 명시하지 않으면 id 가 임의로 생성됩니다. name: type: string title: 이름 fee: $ref: '#/components/schemas/PlatformFeeInput' title: 수수료 정보 memo: type: string title: 메모 vatPayer: $ref: '#/components/schemas/PlatformPayer' title: 부가세 부담 주체 x-portone-title: 추가 수수료 정책 생성을 위한 입력 정보 SchedulePlatformPartnersBodyUpdateTypeNonWhtPayer: title: SchedulePlatformPartnersBodyUpdateTypeNonWhtPayer type: object properties: birthdate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 생년월일 GetPlatformAdditionalFeePoliciesError: title: GetPlatformAdditionalFeePoliciesError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformAdditionalFeePoliciesBody: title: 추가 수수료 정책 다건 조회를 위한 입력 정보 description: 추가 수수료 정책 다건 조회를 위한 입력 정보 type: object properties: page: $ref: '#/components/schemas/PageInput' title: 요청할 페이지 정보 filter: $ref: '#/components/schemas/PlatformAdditionalFeePolicyFilterInput' title: 조회할 추가 수수료 정책 조건 필터 x-portone-title: 추가 수수료 정책 다건 조회를 위한 입력 정보 CreatePlatformPartnerBodyTypeWhtPayer: title: CreatePlatformPartnerBodyTypeWhtPayer type: object properties: birthdate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 생년월일 PlatformNegativeAmountNotAllowedError: title: 정산 건별 옵션이 켜진 플랫폼에서 음수 금액 수기 정산 생성을 시도한 경우 description: 정산 건별 옵션이 켜진 플랫폼에서 음수 금액 수기 정산 생성을 시도한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 정산 건별 옵션이 켜진 플랫폼에서 음수 금액 수기 정산 생성을 시도한 경우 x-portone-status-code: 400 PlatformArchivedPartnerNtsNotAllowedError: title: 보관된 파트너는 국세청 연동/연동해제를 할 수 없는 경우 description: 보관된 파트너는 국세청 연동/연동해제를 할 수 없는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 보관된 파트너는 국세청 연동/연동해제를 할 수 없는 경우 x-portone-status-code: 409 SchedulePlatformPartnersBodyUpdateAccount: title: 파트너 계좌 업데이트를 위한 입력 정보 description: 파트너 계좌 업데이트를 위한 입력 정보 type: object required: - bank - currency - number - holder properties: bank: $ref: '#/components/schemas/Bank' title: 은행 currency: $ref: '#/components/schemas/Currency' title: 정산에 사용할 통화 number: type: string title: 계좌번호 holder: type: string title: 예금주명 accountVerificationId: type: string title: 계좌 검증 아이디 x-portone-title: 파트너 계좌 업데이트를 위한 입력 정보 GetPlatformPartnerSettlementsResponse: title: 정산내역 다건 조회 성공 응답 정보 description: 정산내역 다건 조회 성공 응답 정보 type: object required: - items - page - counts properties: items: type: array items: $ref: '#/components/schemas/PlatformPartnerSettlement' title: 조회된 정산내역 리스트 page: $ref: '#/components/schemas/PageInfo' title: 조회된 페이지 정보 counts: $ref: '#/components/schemas/PlatformPartnerSettlementStatusStats' title: 정산내역 상태 별 갯수 x-portone-title: 정산내역 다건 조회 성공 응답 정보 PlatformPaymentMethodEasyPay: title: 간편 결제 description: 간편 결제 type: object required: - type properties: type: type: string provider: $ref: '#/components/schemas/EasyPayProvider' title: 간편 결제사 methodType: $ref: '#/components/schemas/EasyPayMethodType' title: 간편 결제 수단 x-portone-title: 간편 결제 PlatformBulkAccountTransferFilterInputCriteria: title: PlatformBulkAccountTransferFilterInputCriteria type: object properties: timestampRange: $ref: '#/components/schemas/DateTimeRange' title: 생성 일시 범위 statusUpdatedTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 상태 업데이트 일시 범위 bulkAccountTransferId: type: string title: 일괄 이체 아이디 UpdatePlatformDiscountSharePolicyError: title: UpdatePlatformDiscountSharePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformArchivedDiscountSharePolicyError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ARCHIVED_DISCOUNT_SHARE_POLICY: '#/components/schemas/PlatformArchivedDiscountSharePolicyError' PLATFORM_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPayoutTaxInvoiceStatus: title: PlatformPayoutTaxInvoiceStatus type: string enum: - NONE - DRAFTED - DRAFT_PENDING - DRAFT_FAILED - REQUESTED - REQUEST_PENDING - REQUEST_FAILED - REQUEST_CANCELLED - REQUEST_REFUSED - ISSUED - ISSUE_PENDING - ISSUE_FAILED - ISSUANCE_CANCELLED - CANCEL_PENDING - BEFORE_SENDING - WAITING_SENDING - SENDING - SENDING_PENDING - SENDING_COMPLETED - SENDING_FAILED x-portone-enum: BEFORE_SENDING: {} DRAFTED: {} REQUEST_CANCELLED: {} ISSUE_PENDING: {} REQUEST_REFUSED: {} SENDING_PENDING: {} SENDING_COMPLETED: {} CANCEL_PENDING: {} DRAFT_PENDING: {} SENDING_FAILED: {} REQUEST_FAILED: {} SENDING: {} WAITING_SENDING: {} ISSUANCE_CANCELLED: {} ISSUE_FAILED: {} REQUESTED: {} ISSUED: {} NONE: {} DRAFT_FAILED: {} REQUEST_PENDING: {} CancelPlatformPartnerScheduleError: title: CancelPlatformPartnerScheduleError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' ArchivePlatformContractError: title: ArchivePlatformContractError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformCannotArchiveScheduledContractError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CANNOT_ARCHIVE_SCHEDULED_CONTRACT: '#/components/schemas/PlatformCannotArchiveScheduledContractError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPaymentMethodMobileInput: title: PlatformPaymentMethodMobileInput type: object PlatformTransferPropertyExactMatchInput: title: 사용자 정의 속성 key/value exact match description: 사용자 정의 속성 key/value exact match type: object required: - key - value properties: key: type: string title: 키 value: type: string title: 값 x-portone-title: 사용자 정의 속성 key/value exact match PlatformCompanyState: title: PlatformCompanyState type: object required: - taxationType - businessStatus properties: taxationType: $ref: '#/components/schemas/PlatformTaxationType' taxationTypeDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. businessStatus: $ref: '#/components/schemas/PlatformBusinessStatus' closedSuspendedDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. PlatformFixedAmountFee: title: 정액 수수료 description: '정액 수수료 총 금액에 무관하게 정해진 수수료 금액을 책정합니다.' type: object required: - type - amount properties: type: type: string amount: type: integer format: int64 title: 고정된 수수료 금액 x-portone-title: 정액 수수료 x-portone-description: 총 금액에 무관하게 정해진 수수료 금액을 책정합니다. PlatformContractNotFoundError: title: PlatformContractNotFoundError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 404 PlatformDiscountSharePolicyFilterInputKeyword: title: 검색 키워드 입력 정보 description: '검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 할인 분담 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.' type: object properties: id: type: string description: 해당 값이 포함된 id 를 가진 할인 분담 정책만 조회합니다. name: type: string description: 해당 값이 포함된 name 을 가진 할인 분담만 조회합니다. x-portone-title: 검색 키워드 입력 정보 x-portone-description: 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 할인 분담 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다. PlatformCompanyVerificationAlreadyUsedError: title: 파트너 사업자 검증 아이디를 이미 사용한 경우 description: 파트너 사업자 검증 아이디를 이미 사용한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너 사업자 검증 아이디를 이미 사용한 경우 x-portone-status-code: 409 DisconnectPartnerCounterpartyError: title: DisconnectPartnerCounterpartyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformArchivedPartnerNtsNotAllowedError' - $ref: '#/components/schemas/PlatformBtxNotEnabledError' - $ref: '#/components/schemas/PlatformCounterpartyNotConnectedError' - $ref: '#/components/schemas/PlatformExternalApiFailedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformOngoingTaxInvoiceExistsError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformPartnerTaxationTypeIsSimpleError' - $ref: '#/components/schemas/PlatformPartnerTypeIsNotBusinessError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ARCHIVED_PARTNER_NTS_NOT_ALLOWED: '#/components/schemas/PlatformArchivedPartnerNtsNotAllowedError' PLATFORM_BTX_NOT_ENABLED: '#/components/schemas/PlatformBtxNotEnabledError' PLATFORM_COUNTERPARTY_NOT_CONNECTED: '#/components/schemas/PlatformCounterpartyNotConnectedError' PLATFORM_EXTERNAL_API_FAILED: '#/components/schemas/PlatformExternalApiFailedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_ONGOING_TAX_INVOICE_EXISTS: '#/components/schemas/PlatformOngoingTaxInvoiceExistsError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_PARTNER_TAXATION_TYPE_IS_SIMPLE: '#/components/schemas/PlatformPartnerTaxationTypeIsSimpleError' PLATFORM_PARTNER_TYPE_IS_NOT_BUSINESS: '#/components/schemas/PlatformPartnerTypeIsNotBusinessError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformNotSupportedBankError: title: 지원하지 않는 은행인 경우 description: 지원하지 않는 은행인 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 지원하지 않는 은행인 경우 x-portone-status-code: 400 PlatformBulkPayoutFilterInputCriteria: title: PlatformBulkPayoutFilterInputCriteria type: object properties: timestampRange: $ref: '#/components/schemas/DateTimeRange' title: 생성 일시 범위 statusUpdatedTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 상태 업데이트 일시 범위 bulkPayoutId: type: string title: 일괄 지급 아이디 UpdatePlatformPartnerResponse: title: 파트너 업데이트 성공 응답 description: 파트너 업데이트 성공 응답 type: object required: - partner properties: partner: $ref: '#/components/schemas/PlatformPartner' title: 업데이트된 파트너 x-portone-title: 파트너 업데이트 성공 응답 PlatformContract: title: 계약 description: '계약 계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.' type: object required: - id - graphqlId - name - platformFee - settlementCycle - platformFeeVatPayer - subtractPaymentVatAmount - isArchived - appliedAt - isForTest properties: id: type: string title: 계약 고유 아이디 graphqlId: type: string name: type: string title: 계약 이름 memo: type: string title: 계약 내부 표기를 위한 메모 platformFee: $ref: '#/components/schemas/PlatformFee' title: 중개수수료 settlementCycle: $ref: '#/components/schemas/PlatformSettlementCycle' title: 정산 주기 platformFeeVatPayer: $ref: '#/components/schemas/PlatformPayer' title: 중개수수료에 대한 부가세 부담 주체 subtractPaymentVatAmount: type: boolean title: 정산 시 결제금액 부가세 감액 여부 description: false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다. isArchived: type: boolean title: 보관 여부 appliedAt: type: string format: date-time title: 변경 적용 시점 isForTest: type: boolean x-portone-title: 계약 x-portone-description: '계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.' PlatformAdditionalFeePolicy: title: 추가 수수료 정책 description: '추가 수수료 정책 추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.' type: object required: - id - graphqlId - name - fee - vatPayer - isArchived - appliedAt - isForTest properties: id: type: string title: 추가 수수료 정책 고유 아이디 graphqlId: type: string name: type: string title: 추가 수수료 정책 이름 fee: $ref: '#/components/schemas/PlatformFee' title: 책정 수수료 memo: type: string title: 해당 추가 수수료 정책에 대한 메모 vatPayer: $ref: '#/components/schemas/PlatformPayer' title: 부가세를 부담할 주체 isArchived: type: boolean title: 보관 여부 appliedAt: type: string format: date-time title: 변경 적용 시점 isForTest: type: boolean x-portone-title: 추가 수수료 정책 x-portone-description: 추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다. RescheduleContractError: title: RescheduleContractError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError: title: 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우 description: 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우 type: object required: - type - registeredSettlementSupplyWithVatAmount - requestSettlementSupplyWithVatAmount - portOneSupplyWithVatAmount properties: type: type: string registeredSettlementSupplyWithVatAmount: type: integer format: int64 requestSettlementSupplyWithVatAmount: type: integer format: int64 portOneSupplyWithVatAmount: type: integer format: int64 message: type: string x-portone-title: 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우 x-portone-status-code: 400 PlatformSettlementCycle: title: 정산 주기 description: '정산 주기 지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.' type: object required: - lagDays - datePolicy - method properties: lagDays: type: integer format: int32 title: 지체일 (d+n 의 n) description: 정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다. datePolicy: $ref: '#/components/schemas/PlatformSettlementCycleDatePolicy' title: 기준일로, 정산일 계산 시 공휴일을 고려하기 위한 정보입니다. method: $ref: '#/components/schemas/PlatformSettlementCycleMethod' title: 정산 주기 계산 방식 x-portone-title: 정산 주기 x-portone-description: 지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다. GetPlatformAccountHolderError: title: GetPlatformAccountHolderError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformExternalApiFailedError' - $ref: '#/components/schemas/PlatformExternalApiTemporarilyFailedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformNotSupportedBankError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_EXTERNAL_API_FAILED: '#/components/schemas/PlatformExternalApiFailedError' PLATFORM_EXTERNAL_API_TEMPORARILY_FAILED: '#/components/schemas/PlatformExternalApiTemporarilyFailedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_NOT_SUPPORTED_BANK: '#/components/schemas/PlatformNotSupportedBankError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformTransferStatus: title: 정산 상태 description: 정산 상태 type: string enum: - SCHEDULED - IN_PROCESS - SETTLED - IN_PAYOUT - PAID_OUT - PAYOUT_CONFIRMED x-portone-title: 정산 상태 x-portone-enum: SETTLED: title: 정산 완료 PAYOUT_CONFIRMED: title: 지급 확정 SCHEDULED: title: 정산 예약 PAID_OUT: title: 지급 완료 IN_PROCESS: title: 정산 중 IN_PAYOUT: title: 지급 중 PlatformBulkPayoutFilterInput: title: PlatformBulkPayoutFilterInput type: object properties: statuses: type: array items: $ref: '#/components/schemas/PlatformBulkPayoutStatus' methods: type: array items: $ref: '#/components/schemas/PlatformPayoutMethod' criteria: $ref: '#/components/schemas/PlatformBulkPayoutFilterInputCriteria' PlatformCannotArchiveScheduledContractError: title: 예약된 업데이트가 있는 계약을 보관하려고 하는 경우 description: 예약된 업데이트가 있는 계약을 보관하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 예약된 업데이트가 있는 계약을 보관하려고 하는 경우 x-portone-status-code: 409 UpdatePlatformPartnerBodyType: title: 파트너 업데이트를 위한 유형별 추가 정보 description: '파트너 업데이트를 위한 유형별 추가 정보 파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.' type: object properties: business: $ref: '#/components/schemas/UpdatePlatformPartnerBodyTypeBusiness' title: 사업자 추가 정보 whtPayer: $ref: '#/components/schemas/UpdatePlatformPartnerBodyTypeWhtPayer' title: 원천징수 대상자 추가 정보 nonWhtPayer: $ref: '#/components/schemas/UpdatePlatformPartnerBodyTypeNonWhtPayer' title: 원천징수 비대상자 추가 정보 x-portone-title: 파트너 업데이트를 위한 유형별 추가 정보 x-portone-description: '파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.' PlatformPartnerTaxationTypeIsSimpleError: title: 파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우 description: 파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우 x-portone-status-code: 400 CreatePlatformPartnerBodyContact: title: 파트너 담당자 정보 description: 파트너 담당자 정보 type: object required: - name - email properties: name: type: string title: 담당자 이름 phoneNumber: type: string title: 담당자 휴대폰 번호 email: type: string title: 담당자 이메일 x-portone-title: 파트너 담당자 정보 PlatformExternalApiFailedError: title: 외부 api 오류 description: 외부 api 오류 type: object required: - type properties: type: type: string message: type: string x-portone-title: 외부 api 오류 x-portone-status-code: 503 PlatformOrderCancelTransferSummary: title: PlatformOrderCancelTransferSummary type: object required: - type - id - graphqlId - storeId - partner - contract - status - settlementDate - settlementCurrency - isForTest - partnerUserDefinedProperties - userDefinedProperties - amount - payment - settlementStartDate properties: type: type: string id: type: string graphqlId: type: string storeId: type: string partner: $ref: '#/components/schemas/PlatformTransferSummaryPartner' contract: $ref: '#/components/schemas/PlatformContract' status: $ref: '#/components/schemas/PlatformTransferStatus' memo: type: string settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. settlementCurrency: $ref: '#/components/schemas/Currency' isForTest: type: boolean partnerUserDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' description: 5월 삭제 예정 필드입니다. partner.userDefinedProperties를 사용해주시길 바랍니다. userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' amount: $ref: '#/components/schemas/PlatformOrderSettlementAmount' payment: $ref: '#/components/schemas/PlatformTransferSummaryPayment' settlementStartDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. PlatformTransferIdAlreadyUsedError: title: PlatformTransferIdAlreadyUsedError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 UpdatePlatformPartnerBodyTypeWhtPayer: title: UpdatePlatformPartnerBodyTypeWhtPayer type: object properties: birthdate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 생년월일 ArchivePlatformDiscountSharePolicyResponse: title: 할인 분담 보관 성공 응답 description: 할인 분담 보관 성공 응답 type: object required: - discountSharePolicy properties: discountSharePolicy: $ref: '#/components/schemas/PlatformDiscountSharePolicy' title: 보관된 할인 분담 x-portone-title: 할인 분담 보관 성공 응답 SchedulePlatformAdditionalFeePolicyBody: title: 추가 수수료 정책 업데이트 예약을 위한 입력 정보 description: 추가 수수료 정책 업데이트 예약을 위한 입력 정보 type: object required: - update - appliedAt properties: update: $ref: '#/components/schemas/UpdatePlatformAdditionalFeePolicyBody' title: 반영할 업데이트 내용 appliedAt: type: string format: date-time title: 업데이트 적용 시점 x-portone-title: 추가 수수료 정책 업데이트 예약을 위한 입력 정보 GetPlatformPartnerSettlementsError: title: GetPlatformPartnerSettlementsError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPartnerSchedulesAlreadyExistError: title: PlatformPartnerSchedulesAlreadyExistError type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-status-code: 409 PlatformSettlementTaxFreeAmountExceededPortOnePaymentError: title: 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우 description: 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우 type: object required: - type - registeredSettlementTaxFreeAmount - requestSettlementTaxFreeAmount - portOneTaxFreeAmount properties: type: type: string registeredSettlementTaxFreeAmount: type: integer format: int64 requestSettlementTaxFreeAmount: type: integer format: int64 portOneTaxFreeAmount: type: integer format: int64 message: type: string x-portone-title: 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우 x-portone-status-code: 400 PlatformCannotArchiveScheduledPartnerError: title: 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우 description: 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우 x-portone-status-code: 409 CreatePlatformManualTransferError: title: CreatePlatformManualTransferError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformCurrencyNotSupportedError' - $ref: '#/components/schemas/PlatformNegativeAmountNotAllowedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformTransferIdAlreadyUsedError' - $ref: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CURRENCY_NOT_SUPPORTED: '#/components/schemas/PlatformCurrencyNotSupportedError' PLATFORM_NEGATIVE_AMOUNT_NOT_ALLOWED: '#/components/schemas/PlatformNegativeAmountNotAllowedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_TRANSFER_ID_ALREADY_USED: '#/components/schemas/PlatformTransferIdAlreadyUsedError' PLATFORM_USER_DEFINED_PROPERTY_NOT_FOUND: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformBulkPayout: title: PlatformBulkPayout type: object required: - id - graphqlId - name - creatorId - method - totalPayoutAmount - totalSettlementAmount - status - payoutStats - statusUpdatedAt - createdAt - updatedAt properties: id: type: string title: 일괄 지급 고유 아이디 graphqlId: type: string name: type: string title: 이름 creatorId: type: string title: 생성자 아이디 method: $ref: '#/components/schemas/PlatformPayoutMethod' title: 지급 유형 totalPayoutAmount: type: integer format: int64 title: 총 지급 금액 totalSettlementAmount: type: integer format: int64 title: 총 정산 금액 status: $ref: '#/components/schemas/PlatformBulkPayoutStatus' title: 상태 payoutStats: $ref: '#/components/schemas/PlatformBulkPayoutStats' title: 지급 통계 statusUpdatedAt: type: string format: date-time title: 상태 업데이트 일시 createdAt: type: string format: date-time title: 생성 일시 updatedAt: type: string format: date-time title: 업데이트 일시 PlatformUserDefinedPropertyKeyValue: title: 사용자 정의 속성 description: 사용자 정의 속성 type: object required: - key - value properties: key: type: string title: 사용자 정의 속성 키 value: $ref: '#/components/schemas/PlatformUserDefinedPropertyValue' title: 사용자 정의 속성 값 x-portone-title: 사용자 정의 속성 CreatePlatformDiscountSharePolicyResponse: title: 할인 분담 정책 생성 성공 응답 description: 할인 분담 정책 생성 성공 응답 type: object required: - discountSharePolicy properties: discountSharePolicy: $ref: '#/components/schemas/PlatformDiscountSharePolicy' title: 생성된 할인 분담 정책 x-portone-title: 할인 분담 정책 생성 성공 응답 GetPlatformPayoutsError: title: GetPlatformPayoutsError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformTaxationType: title: 플랫폼 과세 유형 description: 플랫폼 과세 유형 type: string enum: - NORMAL - SIMPLE_TAX_INVOICE_ISSUER - SIMPLE - TAX_FREE - ASSIGNED_ID_NUMBER - SPECIAL x-portone-title: 플랫폼 과세 유형 x-portone-enum: SIMPLE: title: 간이과세(세금계산서 미발행) ASSIGNED_ID_NUMBER: title: 고유 번호 부여 사업자 (비영리, 국가 등 납세 의무가 없는) TAX_FREE: title: 면세 SIMPLE_TAX_INVOICE_ISSUER: title: 간이과세(세금계산서 발행) SPECIAL: title: 과세 특례자 NORMAL: title: 일반 과세 PlatformCannotSpecifyTransferError: title: 정산 건 식별에 실패한 경우 description: 정산 건 식별에 실패한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 정산 건 식별에 실패한 경우 x-portone-status-code: 400 PlatformSettlementParameterNotFoundError: title: 정산 파라미터가 존재하지 않는 경우 description: 정산 파라미터가 존재하지 않는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 정산 파라미터가 존재하지 않는 경우 x-portone-status-code: 404 DayOfWeek: title: 요일 description: 요일 type: string enum: - SUN - MON - TUE - WED - THU - FRI - SAT x-portone-title: 요일 x-portone-enum: TUE: {} THU: {} SAT: {} MON: {} SUN: {} WED: {} FRI: {} PlatformSettlementCycleMethodMonthly: title: 매월 정해진 날(일)에 정산 description: 매월 정해진 날(일)에 정산 type: object required: - type - daysOfMonth properties: type: type: string daysOfMonth: type: array items: type: integer format: int32 x-portone-title: 매월 정해진 날(일)에 정산 CreatePlatformOrderCancelTransferBodyOrderDetailAll: title: 전체 금액 취소 description: 전체 금액 취소 type: object x-portone-title: 전체 금액 취소 GetPlatformTransferSummariesBody: title: 정산건 요약 다건 조회를 위한 입력 정보 description: 정산건 요약 다건 조회를 위한 입력 정보 type: object properties: page: $ref: '#/components/schemas/PageInput' title: 요청할 페이지 정보 filter: $ref: '#/components/schemas/PlatformTransferFilterInput' title: 조회할 정산건 조건 필터 x-portone-title: 정산건 요약 다건 조회를 위한 입력 정보 PlatformPartnerIdsAlreadyExistError: title: PlatformPartnerIdsAlreadyExistError type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-status-code: 409 CreatePlatformOrderCancelTransferError: title: CreatePlatformOrderCancelTransferError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformCancellableAmountExceededError' - $ref: '#/components/schemas/PlatformCancellableDiscountAmountExceededError' - $ref: '#/components/schemas/PlatformCancellableDiscountTaxFreeAmountExceededError' - $ref: '#/components/schemas/PlatformCancellableProductQuantityExceededError' - $ref: '#/components/schemas/PlatformCancellationAndPaymentTypeMismatchedError' - $ref: '#/components/schemas/PlatformCancellationNotFoundError' - $ref: '#/components/schemas/PlatformCannotSpecifyTransferError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyIdDuplicatedError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformOrderDetailMismatchedError' - $ref: '#/components/schemas/PlatformOrderTransferAlreadyCancelledError' - $ref: '#/components/schemas/PlatformPaymentNotFoundError' - $ref: '#/components/schemas/PlatformProductIdDuplicatedError' - $ref: '#/components/schemas/PlatformProductIdNotFoundError' - $ref: '#/components/schemas/PlatformSettlementAmountExceededError' - $ref: '#/components/schemas/PlatformSettlementCancelAmountExceededPortOneCancelError' - $ref: '#/components/schemas/PlatformSettlementDateEarlierThanSettlementStartDateError' - $ref: '#/components/schemas/PlatformTransferAlreadyExistsError' - $ref: '#/components/schemas/PlatformTransferDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformTransferIdAlreadyUsedError' - $ref: '#/components/schemas/PlatformTransferNotFoundError' - $ref: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CANCELLABLE_AMOUNT_EXCEEDED: '#/components/schemas/PlatformCancellableAmountExceededError' PLATFORM_CANCELLABLE_DISCOUNT_AMOUNT_EXCEEDED: '#/components/schemas/PlatformCancellableDiscountAmountExceededError' PLATFORM_CANCELLABLE_DISCOUNT_TAX_FREE_AMOUNT_EXCEEDED: '#/components/schemas/PlatformCancellableDiscountTaxFreeAmountExceededError' PLATFORM_CANCELLABLE_PRODUCT_QUANTITY_EXCEEDED: '#/components/schemas/PlatformCancellableProductQuantityExceededError' PLATFORM_CANCELLATION_AND_PAYMENT_TYPE_MISMATCHED: '#/components/schemas/PlatformCancellationAndPaymentTypeMismatchedError' PLATFORM_CANCELLATION_NOT_FOUND: '#/components/schemas/PlatformCancellationNotFoundError' PLATFORM_CANNOT_SPECIFY_TRANSFER: '#/components/schemas/PlatformCannotSpecifyTransferError' PLATFORM_DISCOUNT_SHARE_POLICY_ID_DUPLICATED: '#/components/schemas/PlatformDiscountSharePolicyIdDuplicatedError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_ORDER_DETAIL_MISMATCHED: '#/components/schemas/PlatformOrderDetailMismatchedError' PLATFORM_ORDER_TRANSFER_ALREADY_CANCELLED: '#/components/schemas/PlatformOrderTransferAlreadyCancelledError' PLATFORM_PAYMENT_NOT_FOUND: '#/components/schemas/PlatformPaymentNotFoundError' PLATFORM_PRODUCT_ID_DUPLICATED: '#/components/schemas/PlatformProductIdDuplicatedError' PLATFORM_PRODUCT_ID_NOT_FOUND: '#/components/schemas/PlatformProductIdNotFoundError' PLATFORM_SETTLEMENT_AMOUNT_EXCEEDED: '#/components/schemas/PlatformSettlementAmountExceededError' PLATFORM_SETTLEMENT_CANCEL_AMOUNT_EXCEEDED_PORT_ONE_CANCEL: '#/components/schemas/PlatformSettlementCancelAmountExceededPortOneCancelError' PLATFORM_SETTLEMENT_DATE_EARLIER_THAN_SETTLEMENT_START_DATE: '#/components/schemas/PlatformSettlementDateEarlierThanSettlementStartDateError' PLATFORM_TRANSFER_ALREADY_EXISTS: '#/components/schemas/PlatformTransferAlreadyExistsError' PLATFORM_TRANSFER_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformTransferDiscountSharePolicyNotFoundError' PLATFORM_TRANSFER_ID_ALREADY_USED: '#/components/schemas/PlatformTransferIdAlreadyUsedError' PLATFORM_TRANSFER_NOT_FOUND: '#/components/schemas/PlatformTransferNotFoundError' PLATFORM_USER_DEFINED_PROPERTY_NOT_FOUND: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' CreatePlatformAdditionalFeePolicyError: title: CreatePlatformAdditionalFeePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyAlreadyExistsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_ALREADY_EXISTS: '#/components/schemas/PlatformAdditionalFeePolicyAlreadyExistsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformAccountVerificationNotFoundError: title: 파트너 계좌 검증 아이디를 찾을 수 없는 경우 description: 파트너 계좌 검증 아이디를 찾을 수 없는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너 계좌 검증 아이디를 찾을 수 없는 경우 x-portone-status-code: 404 PlatformPartnerNotFoundError: title: PlatformPartnerNotFoundError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 404 PlatformBtxNotEnabledError: title: BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 description: BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 x-portone-status-code: 403 DownloadPlatformTransferSheetError: title: DownloadPlatformTransferSheetError oneOf: - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: INVALID_REQUEST: '#/components/schemas/InvalidRequestError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformContractsError: title: GetPlatformContractsError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformTransferNonDeletableStatusError: title: PlatformTransferNonDeletableStatusError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 400 PlatformPayout: title: PlatformPayout type: object required: - id - graphqlId - bulkPayoutId - bulkPayoutGraphqlId - method - status - statusUpdatedAt - partner - account - taxInvoiceStatus - currency - amount - supplyAmount - taxFreeAmount - vatAmount - settlementAmount - settlementTaxFreeAmount - incomeTaxAmount - localIncomeTaxAmount - createdAt - deductWht - settlementAmountType - settlementStatement properties: id: type: string title: 지급 고유 아이디 graphqlId: type: string bulkPayoutId: type: string bulkPayoutGraphqlId: type: string method: $ref: '#/components/schemas/PlatformPayoutMethod' status: $ref: '#/components/schemas/PlatformPayoutStatus' statusUpdatedAt: type: string format: date-time memo: type: string partner: $ref: '#/components/schemas/PlatformPartner' account: $ref: '#/components/schemas/PlatformPayoutAccount' taxInvoiceId: type: string title: 세금계산서 아이디 taxInvoiceStatus: $ref: '#/components/schemas/PlatformPayoutTaxInvoiceStatus' title: 세금계산서 상태 currency: $ref: '#/components/schemas/Currency' amount: type: integer format: int64 title: 지급금액 supplyAmount: type: integer format: int64 title: 공급가액 taxFreeAmount: type: integer format: int64 title: 면세 금액 vatAmount: type: integer format: int64 title: 부가세 settlementAmount: type: integer format: int64 title: 정산 금액 settlementTaxFreeAmount: type: integer format: int64 title: 정산 면세 금액 incomeTaxAmount: type: integer format: int64 title: 원천징수세액 (소득세) localIncomeTaxAmount: type: integer format: int64 title: 원천징수세액 (지방소득세) withdrawalMemo: type: string depositMemo: type: string createdAt: type: string format: date-time scheduledAt: type: string format: date-time failReason: type: string title: 실패 사유 deductWht: type: boolean title: 지급 금액에서 원천징수세 차감 여부 settlementAmountType: $ref: '#/components/schemas/SettlementAmountType' title: 정산 금액 취급 기준 settlementStatement: $ref: '#/components/schemas/PlatformPayoutSettlementStatementSummary' title: 정산 내역서 요약 정보 PlatformTransferSummaryPortOnePayment: title: PlatformTransferSummaryPortOnePayment type: object required: - type - id - orderName - currency properties: type: type: string id: type: string orderName: type: string currency: $ref: '#/components/schemas/Currency' methodType: $ref: '#/components/schemas/PaymentMethodType' CancelPlatformContractScheduleError: title: CancelPlatformContractScheduleError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformBulkPayoutStatus: title: PlatformBulkPayoutStatus type: string enum: - PREPARING - PREPARED - ONGOING - POST_PROCESS_PENDING - CANCELLED - COMPLETED x-portone-enum: PREPARED: {} CANCELLED: {} COMPLETED: {} PREPARING: {} POST_PROCESS_PENDING: {} ONGOING: {} DeletePlatformPartnerSettlementsResponse: title: 정산내역 삭제 결과 description: 정산내역 삭제 결과 type: object x-portone-title: 정산내역 삭제 결과 DisconnectBulkPartnerCounterpartyBody: title: 파트너 일괄 거래처 연동 해제 요청 정보 description: '파트너 일괄 거래처 연동 해제 요청 정보 파트너들을 일괄 거래처 연동 해제합니다.' type: object properties: filter: $ref: '#/components/schemas/PlatformPartnerFilterInput' title: 일괄 거래처 연동 해제할 파트너 조건 필터 x-portone-title: 파트너 일괄 거래처 연동 해제 요청 정보 x-portone-description: 파트너들을 일괄 거래처 연동 해제합니다. RescheduleAdditionalFeePolicyError: title: RescheduleAdditionalFeePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' RecoverPlatformDiscountSharePolicyResponse: title: 할인 분담 복원 성공 응답 description: 할인 분담 복원 성공 응답 type: object required: - discountSharePolicy properties: discountSharePolicy: $ref: '#/components/schemas/PlatformDiscountSharePolicy' title: 복원된 할인 분담 x-portone-title: 할인 분담 복원 성공 응답 RecoverPlatformDiscountSharePolicyError: title: RecoverPlatformDiscountSharePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformAccountTransferFilter: title: PlatformAccountTransferFilter type: object properties: tradeTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 이체 일시 범위 createdTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 생성 일시 범위 statusUpdatedTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 상태 업데이트 일시 범위 scheduledTimestampRange: $ref: '#/components/schemas/DateTimeRange' title: 이체 예정 일시 범위 accountTransferId: type: string title: 이체 아이디 bankAccountId: type: string title: 계좌 아이디 bulkAccountTransferId: type: string title: 일괄 이체 아이디 payoutId: type: string title: 지급 아이디 accountTransferIds: type: array items: type: string title: 이체 아이디 리스트 types: title: 구분 type: array items: $ref: '#/components/schemas/PlatformAccountTransferType' statuses: title: 상태 type: array items: $ref: '#/components/schemas/PlatformAccountTransferStatus' depositorName: type: string title: 입금자명 depositAccountHolder: type: string title: 예금주 depositMemo: type: string title: 받는 이 통장 메모 withdrawalMemo: type: string title: 보내는 이 통장 메모 DownloadPlatformTransferSheetBody: title: DownloadPlatformTransferSheetBody type: object properties: filter: $ref: '#/components/schemas/PlatformTransferFilterInput' title: 컬럼 키 목록 description: "- TRANSFER_MEMO: 메모 \n- TRANSFER_TYPE: 정산 유형\n- TRANSFER_STATUS: 상태 \n- TRANSFER_ID: 정산 아이디\n- TRANSFER_SETTLEMENT_DATE: 정산일 \n- TRANSFER_SETTLEMENT_AMOUNT: 정산 금액\n- TRANSFER_SETTLEMENT_TAX_FREE_AMOUNT: 정산 면세액\n- TRANSFER_SETTLEMENT_CURRENCY: 정산 통화\n- TRANSFER_SETTLEMENT_START_DATE: 정산 시작일\n- TRANSFER_ORDER_NAME: 주문명 \n- TRANSFER_ORDER_AMOUNT: 주문 금액\n- TRANSFER_ORDER_TAX_FREE_AMOUNT: 주문 면세액\n- TRANSFER_PAYMENT_ID: 주문 번호\n- TRANSFER_PAYMENT_METHOD: 결제 수단\n- TRANSFER_PAYMENT_AMOUNT: 결제 금액\n- TRANSFER_PAYMENT_SUPPLY_AMOUNT: 결제 공급가액\n- TRANSFER_PAYMENT_VAT_AMOUNT: 결제 부가세액\n- TRANSFER_PAYMENT_TAX_FREE_AMOUNT: 결제 면세액\n- TRANSFER_PAYMENT_VAT_BURDEN_AMOUNT: 결제 부가세 부담금\n- TRANSFER_PLATFORM_FEE: 중개수수료 \n- TRANSFER_PLATFORM_FEE_VAT: 중개수수료 부가세 부담금\n- TRANSFER_CONTRACT_ID: 계약 아이디\n- TRANSFER_CONTRACT_NAME: 계약 이름\n- TRANSFER_DISCOUNT_AMOUNT: 할인 금액\n- TRANSFER_DISCOUNT_TAX_FREE_AMOUNT: 할인 면세액\n- TRANSFER_DISCOUNT_SHARE_AMOUNT: 할인 분담금\n- TRANSFER_DISCOUNT_SHARE_TAX_FREE_AMOUNT: 할인 면세 분담금\n- TRANSFER_ADDITIONAL_FEE: 추가수수료 \n- TRANSFER_ADDITIONAL_FEE_VAT: 추가수수료 부가세 부담금\n- TRANSFER_{UserDefinedProperty.Key}\n- FORMULA_{UserDefinedFormula.Key}\n- PARTNER_* : 파트너 컬럼 키 사용 가능(w/o PARTNER_STATUS_UPDATED_AT)" fields: type: array items: type: string PlatformOrderTransferOrderLine: title: 주문 항목 description: 주문 항목 type: object required: - product - quantity - discounts - additionalFees - amount properties: product: $ref: '#/components/schemas/PlatformOrderTransferProduct' title: 상품 quantity: type: integer format: int32 title: 상품 수량 discounts: title: 상품 할인 정보 type: array items: $ref: '#/components/schemas/PlatformOrderTransferDiscount' additionalFees: title: 상품 추가 수수료 정보 type: array items: $ref: '#/components/schemas/PlatformOrderTransferAdditionalFee' amount: $ref: '#/components/schemas/PlatformOrderSettlementAmount' title: 상품 정산 금액 정보 x-portone-title: 주문 항목 CreatePlatformOrderTransferBodyOrderDetail: title: 주문 정보 description: '주문 정보 주문 금액 또는 주문 항목 하나만 입력 가능합니다.' type: object properties: orderAmount: type: integer format: int64 title: 주문 금액 orderLines: title: 주문 항목 리스트 type: array items: $ref: '#/components/schemas/CreatePlatformOrderTransferBodyOrderLine' x-portone-title: 주문 정보 x-portone-description: 주문 금액 또는 주문 항목 하나만 입력 가능합니다. PlatformCounterpartyNotConnectedError: title: 파트너가 거래처로 연동 되어있지 않은 경우 description: 파트너가 거래처로 연동 되어있지 않은 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너가 거래처로 연동 되어있지 않은 경우 x-portone-status-code: 400 PlatformManualTransfer: title: 수기 정산건 description: 수기 정산건 type: object required: - type - id - graphqlId - partner - status - settlementDate - settlementCurrency - isForTest - userDefinedProperties - settlementAmount - settlementTaxFreeAmount properties: type: type: string id: type: string title: 정산건 아이디 graphqlId: type: string partner: $ref: '#/components/schemas/PlatformPartner' title: 파트너 status: $ref: '#/components/schemas/PlatformTransferStatus' title: 정산 상태 memo: type: string title: 메모 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 일 settlementCurrency: $ref: '#/components/schemas/Currency' title: 정산 통화 payoutId: type: string description: 더 이상 사용되지 않는 값입니다. payoutGraphqlId: type: string isForTest: type: boolean title: 테스트 모드 여부 userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' settlementAmount: type: integer format: int64 title: 정산 금액 settlementTaxFreeAmount: type: integer format: int64 title: 정산 면세 금액 x-portone-title: 수기 정산건 PlatformOrderTransfer: title: 주문 정산건 description: 주문 정산건 type: object required: - type - id - graphqlId - partner - status - settlementDate - settlementCurrency - isForTest - userDefinedProperties - amount - contract - payment - settlementStartDate - orderLines - additionalFees - discounts - parameters properties: type: type: string id: type: string title: 정산건 아이디 graphqlId: type: string partner: $ref: '#/components/schemas/PlatformPartner' title: 파트너 status: $ref: '#/components/schemas/PlatformTransferStatus' title: 정산 상태 memo: type: string title: 메모 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 일 settlementCurrency: $ref: '#/components/schemas/Currency' title: 정산 통화 payoutId: type: string description: 더 이상 사용되지 않는 값입니다. payoutGraphqlId: type: string isForTest: type: boolean title: 테스트 모드 여부 userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' amount: $ref: '#/components/schemas/PlatformOrderSettlementAmount' title: 정산 금액 정보 contract: $ref: '#/components/schemas/PlatformContract' title: 계약 payment: $ref: '#/components/schemas/PlatformPayment' title: 결제 정보 settlementStartDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 시작일 orderLines: title: 주문 항목 리스트 type: array items: $ref: '#/components/schemas/PlatformOrderTransferOrderLine' additionalFees: title: 정산 금액 계산 시 사용된 추가 수수료 정보 type: array items: $ref: '#/components/schemas/PlatformOrderTransferAdditionalFee' discounts: title: 정산 금액 계산 시 사용된 할인 정보 type: array items: $ref: '#/components/schemas/PlatformOrderTransferDiscount' parameters: $ref: '#/components/schemas/TransferParameters' title: 정산 파라미터 (실험기능) x-portone-title: 주문 정산건 PlatformPartnerFilterInput: title: 파트너 필터 입력 정보 description: 파트너 필터 입력 정보 type: object properties: isArchived: type: boolean title: 보관 조회 여부 description: true 이면 보관된 파트너를 조회하고, false 이면 보관되지 않은 파트너를 조회합니다. 기본값은 false 입니다. tags: type: array items: type: string description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 태그를 하나 이상 가지는 파트너만 조회합니다. banks: title: 은행 type: array items: $ref: '#/components/schemas/Bank' description: 하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 계좌 은행을 가진 파트너만 조회합니다. accountCurrencies: title: 통화 type: array items: $ref: '#/components/schemas/Currency' description: 하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 계좌 통화를 가진 파트너만 조회합니다. ids: type: array items: type: string description: 하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 아이디를 가진 파트너만 조회합니다. contractIds: type: array items: type: string description: 하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 기본 계약 id를 가진 파트너만 조회합니다. accountStatuses: title: 플랫폼 계좌 상태 type: array items: $ref: '#/components/schemas/PlatformAccountStatus' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 계좌 상태를 가진 파트너만 조회합니다. businessStatuses: title: 플랫폼 파트너 사업자 상태 type: array items: $ref: '#/components/schemas/PlatformPartnerBusinessStatus' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 사업자 상태를 가진 파트너만 조회합니다. types: title: 플랫폼 파트너 유형 이름 type: array items: $ref: '#/components/schemas/PlatformPartnerTypeName' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 사업자 유형을 가진 파트너만 조회합니다. taxationTypes: title: 플랫폼 파트너 과세 유형 type: array items: $ref: '#/components/schemas/PlatformPartnerTaxationType' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 과세 유형을 가진 파트너만 조회합니다. memberCompanyConnectionStatuses: title: 플랫폼 파트너 연동 사업자 연결 상태 type: array items: $ref: '#/components/schemas/PlatformPartnerMemberCompanyConnectionStatus' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 연동 사업자 연결 상태를 가진 파트너만 조회합니다. keyword: $ref: '#/components/schemas/PlatformPartnerFilterInputKeyword' title: 검색 키워드 x-portone-title: 파트너 필터 입력 정보 PlatformPartnerTypeWhtPayer: title: 원천징수 대상자 파트너 정보 description: '원천징수 대상자 파트너 정보 비사업자 유형의 파트너 추가 정보 입니다.' type: object required: - type properties: type: type: string birthdate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 생년월일 x-portone-title: 원천징수 대상자 파트너 정보 x-portone-description: 비사업자 유형의 파트너 추가 정보 입니다. PlatformMemberCompanyConnectedPartnerCannotBeScheduledError: title: 연동 사업자로 연동된 파트너를 예약 수정하려고 시도한 경우 description: 연동 사업자로 연동된 파트너를 예약 수정하려고 시도한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 연동 사업자로 연동된 파트너를 예약 수정하려고 시도한 경우 x-portone-status-code: 409 PlatformAccountTransferStatusStats: title: PlatformAccountTransferStatusStats type: object required: - prepared - scheduled - cancelled - stopped - processing - asyncProcessing - succeeded - failed properties: prepared: type: integer format: int64 scheduled: type: integer format: int64 cancelled: type: integer format: int64 stopped: type: integer format: int64 processing: type: integer format: int64 asyncProcessing: type: integer format: int64 succeeded: type: integer format: int64 failed: type: integer format: int64 CancelPlatformContractScheduleResponse: title: 계약 예약 업데이트 취소 성공 응답 description: 계약 예약 업데이트 취소 성공 응답 type: object x-portone-title: 계약 예약 업데이트 취소 성공 응답 PlatformUserDefinedPropertyNotFoundError: title: 사용자 정의 속성이 존재 하지 않는 경우 description: 사용자 정의 속성이 존재 하지 않는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 사용자 정의 속성이 존재 하지 않는 경우 x-portone-status-code: 404 PlatformPartnerType: title: 파트너 유형별 추가 정보 description: 파트너 유형별 추가 정보 oneOf: - $ref: '#/components/schemas/PlatformPartnerTypeBusiness' - $ref: '#/components/schemas/PlatformPartnerTypeNonWhtPayer' - $ref: '#/components/schemas/PlatformPartnerTypeWhtPayer' discriminator: propertyName: type mapping: BUSINESS: '#/components/schemas/PlatformPartnerTypeBusiness' NON_WHT_PAYER: '#/components/schemas/PlatformPartnerTypeNonWhtPayer' WHT_PAYER: '#/components/schemas/PlatformPartnerTypeWhtPayer' x-portone-title: 파트너 유형별 추가 정보 x-portone-discriminator: BUSINESS: title: 사업자 파트너 정보 WHT_PAYER: title: 원천징수 대상자 파트너 정보 NON_WHT_PAYER: title: 원천징수 비대상자 파트너 정보 SchedulePlatformPartnerResponse: title: 파트너 업데이트 예약 성공 응답 description: 파트너 업데이트 예약 성공 응답 type: object required: - scheduledPartner properties: scheduledPartner: $ref: '#/components/schemas/PlatformPartner' title: 예약된 파트너 정보 x-portone-title: 파트너 업데이트 예약 성공 응답 UpdatePlatformPartnerBodyTypeBusiness: title: UpdatePlatformPartnerBodyTypeBusiness type: object properties: companyName: type: string title: 상호명 taxationType: $ref: '#/components/schemas/PlatformPartnerTaxationType' title: 사업자 유형 businessRegistrationNumber: type: string title: 사업자등록번호 representativeName: type: string title: 대표자 이름 companyAddress: type: string title: 사업장 주소 businessType: type: string title: 업태 businessClass: type: string title: 업종 companyVerificationId: type: string title: 사업자 조회 검증 아이디 PlatformNegativePayoutAmountPartnersError: title: 지급 금액의 총합이 음수인 파트너가 존재하는 경우 description: 지급 금액의 총합이 음수인 파트너가 존재하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 지급 금액의 총합이 음수인 파트너가 존재하는 경우 x-portone-status-code: 400 GetPlatformDiscountSharePoliciesBody: title: 할인 분담 정책 다건 조회를 위한 입력 정보 description: 할인 분담 정책 다건 조회를 위한 입력 정보 type: object properties: page: $ref: '#/components/schemas/PageInput' title: 요청할 페이지 정보 filter: $ref: '#/components/schemas/PlatformDiscountSharePolicyFilterInput' title: 조회할 할인 분담 정책 조건 필터 x-portone-title: 할인 분담 정책 다건 조회를 위한 입력 정보 PlatformDiscountSharePolicyFilterInput: title: 할인 분담 정책 다건 조회를 위한 필터 조건 description: 할인 분담 정책 다건 조회를 위한 필터 조건 type: object properties: isArchived: type: boolean title: 보관 조회 여부 description: true 이면 보관된 할인 분담 정책을 조회하고, false 이면 보관되지 않은 할인 분담 정책을 조회합니다. 기본값은 false 입니다. partnerShareRates: type: array items: type: integer format: int32 description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 파트너 분담율을 가진 할인 분담 정책만 조회합니다. keyword: $ref: '#/components/schemas/PlatformDiscountSharePolicyFilterInputKeyword' title: 검색 키워드 x-portone-title: 할인 분담 정책 다건 조회를 위한 필터 조건 PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError: title: PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError type: object required: - type - id - graphqlId - feeCurrency - settlementCurrency properties: type: type: string id: type: string graphqlId: type: string feeCurrency: $ref: '#/components/schemas/Currency' settlementCurrency: $ref: '#/components/schemas/Currency' message: type: string x-portone-status-code: 400 PlatformSettlementCycleMethodDailyInput: title: PlatformSettlementCycleMethodDailyInput type: object PlatformSettlementCancelAmountExceededPortOneCancelError: title: 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우 description: 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우 type: object required: - type - registeredSettlementCancelAmount - requestSettlementCancelAmount - portOneCancelAmount - amountType properties: type: type: string registeredSettlementCancelAmount: type: integer format: int64 requestSettlementCancelAmount: type: integer format: int64 portOneCancelAmount: type: integer format: int64 amountType: $ref: '#/components/schemas/PlatformPortOnePaymentCancelAmountType' message: type: string x-portone-title: 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우 x-portone-status-code: 400 CreatePlatformPartnersBody: title: 파트너 다건 생성을 위한 입력 정보 description: 파트너 다건 생성을 위한 입력 정보 type: object required: - partners properties: partners: title: 생성할 파트너 리스트 정보 type: array items: $ref: '#/components/schemas/CreatePlatformPartnerBody' x-portone-title: 파트너 다건 생성을 위한 입력 정보 PlatformCancellationAndPaymentTypeMismatchedError: title: PlatformCancellationAndPaymentTypeMismatchedError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 400 PlatformSettlementCycleMethod: title: 플랫폼 정산 주기 계산 방식 description: 플랫폼 정산 주기 계산 방식 oneOf: - $ref: '#/components/schemas/PlatformSettlementCycleMethodDaily' - $ref: '#/components/schemas/PlatformSettlementCycleMethodManualDates' - $ref: '#/components/schemas/PlatformSettlementCycleMethodMonthly' - $ref: '#/components/schemas/PlatformSettlementCycleMethodWeekly' discriminator: propertyName: type mapping: DAILY: '#/components/schemas/PlatformSettlementCycleMethodDaily' MANUAL_DATES: '#/components/schemas/PlatformSettlementCycleMethodManualDates' MONTHLY: '#/components/schemas/PlatformSettlementCycleMethodMonthly' WEEKLY: '#/components/schemas/PlatformSettlementCycleMethodWeekly' x-portone-title: 플랫폼 정산 주기 계산 방식 x-portone-discriminator: DAILY: title: 매일 정산 WEEKLY: title: 매주 정해진 요일에 정산 MONTHLY: title: 매월 정해진 날(일)에 정산 MANUAL_DATES: title: 정해진 날짜(월, 일)에 정산 UpdatePlatformSettingError: title: UpdatePlatformSettingError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' CreatePlatformDiscountSharePolicyBody: title: 할인 분담 정책 생성을 위한 입력 정보 description: 할인 분담 정책 생성을 위한 입력 정보 type: object required: - name - partnerShareRate properties: id: type: string title: 할인 분담에 부여할 고유 아이디 description: 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다. name: type: string title: 할인 분담에 부여할 이름 partnerShareRate: type: integer format: int32 title: 파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 `할인금액 * partnerShareRate * 10^5` 로 책정합니다. memo: type: string title: 해당 할인 분담에 대한 메모 ex) 파트너 브랜드 쿠폰 x-portone-title: 할인 분담 정책 생성을 위한 입력 정보 PlatformBulkAccountTransferFilterInput: title: PlatformBulkAccountTransferFilterInput type: object properties: statuses: type: array items: $ref: '#/components/schemas/PlatformBulkAccountTransferStatus' criteria: $ref: '#/components/schemas/PlatformBulkAccountTransferFilterInputCriteria' SchedulePlatformPartnersBodyUpdateContact: title: 파트너 업데이트를 위한 유형별 추가 정보 description: 파트너 업데이트를 위한 유형별 추가 정보 type: object properties: name: type: string title: 담당자 이름 phoneNumber: type: string title: 담당자 휴대폰 번호 email: type: string title: 담당자 이메일 x-portone-title: 파트너 업데이트를 위한 유형별 추가 정보 PlatformSettlementPaymentAmountExceededPortOnePaymentError: title: 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우 description: 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우 type: object required: - type - registeredSettlementPaymentAmount - requestSettlementPaymentAmount - portOnePaymentAmount properties: type: type: string registeredSettlementPaymentAmount: type: integer format: int64 requestSettlementPaymentAmount: type: integer format: int64 portOnePaymentAmount: type: integer format: int64 message: type: string x-portone-title: 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우 x-portone-status-code: 400 GetPlatformPartnerFilterOptionsError: title: GetPlatformPartnerFilterOptionsError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPartnerIdsDuplicatedError: title: PlatformPartnerIdsDuplicatedError type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-status-code: 400 PlatformCurrencyNotSupportedError: title: 지원 되지 않는 통화를 선택한 경우 description: 지원 되지 않는 통화를 선택한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 지원 되지 않는 통화를 선택한 경우 x-portone-status-code: 400 PlatformPartnerIdAlreadyExistsError: title: PlatformPartnerIdAlreadyExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 PlatformPaymentMethodCardInput: title: PlatformPaymentMethodCardInput type: object DateTimeRange: title: 시간 범위 description: 시간 범위 type: object required: - from - until properties: from: type: string format: date-time until: type: string format: date-time x-portone-title: 시간 범위 SchedulePlatformDiscountSharePolicyResponse: title: 할인 분담 정책 업데이트 예약 성공 응답 description: 할인 분담 정책 업데이트 예약 성공 응답 type: object required: - scheduledDiscountSharePolicy properties: scheduledDiscountSharePolicy: $ref: '#/components/schemas/PlatformDiscountSharePolicy' title: 예약된 할인 분담 정보 x-portone-title: 할인 분담 정책 업데이트 예약 성공 응답 EasyPayMethodType: title: 간편 결제 수단 description: 간편 결제 수단 type: string enum: - CARD - TRANSFER - CHARGE x-portone-title: 간편 결제 수단 x-portone-enum: CARD: {} TRANSFER: {} CHARGE: {} PlatformSettlementCycleMethodInput: title: 플랫폼 정산 주기 계산 방식 입력 정보 description: '플랫폼 정산 주기 계산 방식 입력 정보 하나의 하위 필드에만 값을 명시하여 요청합니다.' type: object properties: daily: $ref: '#/components/schemas/PlatformSettlementCycleMethodDailyInput' title: 매일 정산 weekly: $ref: '#/components/schemas/PlatformSettlementCycleMethodWeeklyInput' title: 매주 정해진 요일에 정산 monthly: $ref: '#/components/schemas/PlatformSettlementCycleMethodMonthlyInput' title: 매월 정해진 날(일)에 정산 manualDates: $ref: '#/components/schemas/PlatformSettlementCycleMethodManualDatesInput' title: 정해진 날짜(월, 일)에 정산 x-portone-title: 플랫폼 정산 주기 계산 방식 입력 정보 x-portone-description: 하나의 하위 필드에만 값을 명시하여 요청합니다. PlatformDepositAccountTransfer: title: PlatformDepositAccountTransfer type: object required: - type - id - bankAccountId - bankAccountGraphqlId - bankAccount - currency - amount - createdAt - updatedAt - depositorName - isForTest - statusUpdatedAt - status properties: type: type: string title: 계좌 이체 유형 id: type: string title: 계좌 이체 아이디 bankAccountId: type: string title: 입금 계좌 아이디 bankAccountGraphqlId: type: string bankAccount: $ref: '#/components/schemas/PlatformBankAccountDetail' title: 입금 계좌 정보 currency: $ref: '#/components/schemas/Currency' title: 통화 amount: type: integer format: int64 title: 금액 depositMemo: type: string title: 입금 계좌 적요 tradedAt: type: string format: date-time title: 이체 일시 createdAt: type: string format: date-time title: 생성 일시 updatedAt: type: string format: date-time title: 수정 일시 depositorName: type: string title: 입금자명 isForTest: type: boolean title: 테스트 모드 여부 statusUpdatedAt: type: string format: date-time title: 상태 업데이트 일시 status: $ref: '#/components/schemas/PlatformAccountTransferStatus' title: 상태 DisconnectPartnerCounterpartyResponse: title: 파트너 거래처 연동 해제 응답 description: 파트너 거래처 연동 해제 응답 type: object required: - partner properties: partner: $ref: '#/components/schemas/PlatformPartner' x-portone-title: 파트너 거래처 연동 해제 응답 UpdatePlatformAdditionalFeePolicyError: title: UpdatePlatformAdditionalFeePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' - $ref: '#/components/schemas/PlatformArchivedAdditionalFeePolicyError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' PLATFORM_ARCHIVED_ADDITIONAL_FEE_POLICY: '#/components/schemas/PlatformArchivedAdditionalFeePolicyError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformCancellableProductQuantityExceededError: title: PlatformCancellableProductQuantityExceededError type: object required: - type - productId - cancellableQuantity properties: type: type: string productId: type: string cancellableQuantity: type: integer format: int64 message: type: string x-portone-status-code: 400 PlatformSettlementParameterValue: title: 플랫폼 정산 파라미터 값 description: 플랫폼 정산 파라미터 값 type: object required: - decimal properties: decimal: type: integer format: int64 title: 크기가 조정되지 않은 숫자 decimalScale: type: integer format: int32 title: 소수 자리수 description: '정산 시 필요한 `decimalScale`이 지정되지 않은 경우 기본값으로 0을 사용합니다. 입력 가능한 법위는 0 ~ 5 입니다.' x-portone-title: 플랫폼 정산 파라미터 값 PlatformOrderTransferProduct: title: 상품 description: 상품 type: object required: - id - name - amount - taxFreeAmount properties: id: type: string title: 상품 아이디 name: type: string title: 상품 이름 amount: type: integer format: int64 title: 상품 금액 taxFreeAmount: type: integer format: int64 title: 상품 면세 금액 tag: type: string title: 태그 x-portone-title: 상품 UpdatePlatformAdditionalFeePolicyResponse: title: 추가 수수료 정책 업데이트 성공 응답 description: 추가 수수료 정책 업데이트 성공 응답 type: object required: - additionalFeePolicy properties: additionalFeePolicy: $ref: '#/components/schemas/PlatformAdditionalFeePolicy' title: 업데이트된 추가 수수료 정책 x-portone-title: 추가 수수료 정책 업데이트 성공 응답 ScheduleContractError: title: ScheduleContractError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformArchivedContractError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformContractScheduleAlreadyExistsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ARCHIVED_CONTRACT: '#/components/schemas/PlatformArchivedContractError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_CONTRACT_SCHEDULE_ALREADY_EXISTS: '#/components/schemas/PlatformContractScheduleAlreadyExistsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' UpdatePlatformPartnerBodyTypeNonWhtPayer: title: UpdatePlatformPartnerBodyTypeNonWhtPayer type: object properties: birthdate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 생년월일 PlatformCancelOrderTransfersExistsError: title: PlatformCancelOrderTransfersExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 400 PlatformProductIdDuplicatedError: title: PlatformProductIdDuplicatedError type: object required: - type - id properties: type: type: string id: type: string message: type: string x-portone-status-code: 400 PlatformNonPayablePartnerSettlementsError: title: 지급할 수 없는 정산건이 포함된 경우 description: 지급할 수 없는 정산건이 포함된 경우 type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-title: 지급할 수 없는 정산건이 포함된 경우 x-portone-status-code: 400 PlatformCancellableAmountType: title: 금액 타입 description: 금액 타입 type: string enum: - SUPPLY_WITH_VAT - TAX_FREE x-portone-title: 금액 타입 x-portone-enum: SUPPLY_WITH_VAT: title: 공급대가 description: 공급가액과 부가세를 더한 금액입니다. TAX_FREE: title: 면세 금액 SchedulePlatformPartnersBodyUpdateType: title: 파트너 유형별 정보 업데이트를 위한 입력 정보 description: '파트너 유형별 정보 업데이트를 위한 입력 정보 파트너 유형별 추가 정보를 수정합니다. 최초 생성된 유형 내에서 세부 정보만 수정할 수 있고 파트너의 유형 자체를 수정할 수는 없습니다.' type: object properties: business: $ref: '#/components/schemas/SchedulePlatformPartnersBodyUpdateTypeBusiness' title: 사업자 추가 정보 whtPayer: $ref: '#/components/schemas/SchedulePlatformPartnersBodyUpdateTypeWhtPayer' title: 원천징수 대상자 추가 정보 nonWhtPayer: $ref: '#/components/schemas/SchedulePlatformPartnersBodyUpdateTypeNonWhtPayer' title: 원천징수 비대상자 추가 정보 x-portone-title: 파트너 유형별 정보 업데이트를 위한 입력 정보 x-portone-description: '파트너 유형별 추가 정보를 수정합니다. 최초 생성된 유형 내에서 세부 정보만 수정할 수 있고 파트너의 유형 자체를 수정할 수는 없습니다.' ArchivePlatformAdditionalFeePolicyResponse: title: 추가 수수료 정책 보관 성공 응답 description: 추가 수수료 정책 보관 성공 응답 type: object required: - additionalFeePolicy properties: additionalFeePolicy: $ref: '#/components/schemas/PlatformAdditionalFeePolicy' title: 보관된 추가 수수료 정책 x-portone-title: 추가 수수료 정책 보관 성공 응답 UpdatePlatformContractBody: title: 계약 업데이트를 위한 입력 정보. 값이 명시되지 않은 필드는 업데이트되지 않습니다. description: '계약 업데이트를 위한 입력 정보. 값이 명시되지 않은 필드는 업데이트되지 않습니다. 값이 명시되지 않은 필드는 업데이트되지 않습니다.' type: object properties: name: type: string title: 계약 이름 memo: type: string title: 계약 내부 표기를 위한 메모 platformFee: $ref: '#/components/schemas/PlatformFeeInput' title: 중개수수료 settlementCycle: $ref: '#/components/schemas/PlatformSettlementCycleInput' title: 정산 주기 platformFeeVatPayer: $ref: '#/components/schemas/PlatformPayer' title: 중개수수료에 대한 부가세 부담 주체 subtractPaymentVatAmount: type: boolean title: 정산 시 결제금액 부가세 감액 여부 x-portone-title: 계약 업데이트를 위한 입력 정보. 값이 명시되지 않은 필드는 업데이트되지 않습니다. x-portone-description: 값이 명시되지 않은 필드는 업데이트되지 않습니다. PlatformWithdrawalAccountTransfer: title: PlatformWithdrawalAccountTransfer type: object required: - type - id - bankAccountId - bankAccountGraphqlId - bankAccount - currency - depositBank - depositAccountNumber - depositAccountHolder - amount - createdAt - updatedAt - isForTest - withdrawalType - statusUpdatedAt - status properties: type: type: string title: 계좌 이체 유형 id: type: string title: 계좌 이체 아이디 bankAccountId: type: string title: 출금 계좌 아이디 bankAccountGraphqlId: type: string bankAccount: $ref: '#/components/schemas/PlatformBankAccountDetail' title: 출금 계좌 정보 sequenceNumber: type: integer format: int32 title: 거래 일련번호 currency: $ref: '#/components/schemas/Currency' title: 통화 depositBank: $ref: '#/components/schemas/Bank' title: 이체 계좌 은행 depositAccountNumber: type: string title: 이체 계좌 번호 depositAccountHolder: type: string title: 예금주 amount: type: integer format: int64 title: 금액 withdrawalMemo: type: string title: 보내는 이 통장 메모 depositMemo: type: string title: 받는 이 통장 메모 balance: type: integer format: int64 title: 잔액 failReason: type: string title: 실패 사유 tradedAt: type: string format: date-time title: 이체 일시 createdAt: type: string format: date-time title: 생성 일시 updatedAt: type: string format: date-time title: 수정 일시 isForTest: type: boolean title: 테스트 모드 여부 withdrawalType: $ref: '#/components/schemas/Type' title: 출금 유형 partnerId: type: string title: 파트너 고유 아이디 partnerGraphqlId: type: string bulkPayoutId: type: string title: 일괄 지급 고유 아이디 bulkPayoutGraphqlId: type: string payoutId: type: string title: 지급 고유 아이디 payoutGraphqlId: type: string bulkAccountTransferId: type: string bulkAccountTransferGraphqlId: type: string documentId: type: string title: 전자서명 아이디 statusUpdatedAt: type: string format: date-time title: 상태 업데이트 일시 status: $ref: '#/components/schemas/PlatformAccountTransferStatus' title: 상태 scheduledAt: type: string format: date-time title: 예정 일시 PlatformUserDefinedFormulaResults: title: PlatformUserDefinedFormulaResults type: object additionalProperties: type: integer format: int64 RecoverPlatformAdditionalFeePolicyResponse: title: 추가 수수료 정책 복원 성공 응답 description: 추가 수수료 정책 복원 성공 응답 type: object required: - additionalFeePolicy properties: additionalFeePolicy: $ref: '#/components/schemas/PlatformAdditionalFeePolicy' title: 복원된 추가 수수료 정책 x-portone-title: 추가 수수료 정책 복원 성공 응답 GetAccountTransfersBody1: title: GetAccountTransfersBody type: object properties: isForTest: type: boolean description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' page: $ref: '#/components/schemas/PageInput' filter: $ref: '#/components/schemas/PlatformAccountTransferFilter' CreateManualTransferResponse: title: CreateManualTransferResponse type: object required: - transfer properties: transfer: $ref: '#/components/schemas/PlatformManualTransfer' TransferParameters: title: TransferParameters type: object additionalProperties: $ref: '#/components/schemas/PlatformSettlementParameterValue' GetPlatformPartnersResponse: title: 파트너 다건 조회 성공 응답 정보 description: 파트너 다건 조회 성공 응답 정보 type: object required: - items - page properties: items: title: 조회된 파트너 리스트 type: array items: $ref: '#/components/schemas/PlatformPartner' page: $ref: '#/components/schemas/PageInfo' title: 조회된 페이지 정보 x-portone-title: 파트너 다건 조회 성공 응답 정보 GetPlatformBulkAccountTransfersResponse: title: GetPlatformBulkAccountTransfersResponse type: object required: - items - page - counts properties: items: type: array items: $ref: '#/components/schemas/PlatformBulkAccountTransfer' page: $ref: '#/components/schemas/PageInfo' counts: $ref: '#/components/schemas/PlatformBulkAccountTransferStatusStats' GetPlatformPartnersBody: title: 파트너 다건 조회를 위한 입력 정보 description: 파트너 다건 조회를 위한 입력 정보 type: object properties: page: $ref: '#/components/schemas/PageInput' title: 요청할 페이지 정보 filter: $ref: '#/components/schemas/PlatformPartnerFilterInput' title: 조회할 파트너 조건 필터 x-portone-title: 파트너 다건 조회를 위한 입력 정보 CreatePlatformOrderCancelTransferBodyOrderLine: title: 주문 취소 항목 리스트 description: 주문 취소 항목 리스트 type: object required: - productId - quantity - discounts properties: productId: type: string title: 상품 아이디 quantity: type: integer format: int32 title: 상품 수량 discounts: title: 상품 할인 정보 type: array items: $ref: '#/components/schemas/CreatePlatformOrderCancelTransferBodyDiscount' x-portone-title: 주문 취소 항목 리스트 ReschedulePlatformDiscountSharePolicyResponse: title: 할인 분담 정책 예약 업데이트 재설정 성공 응답 description: 할인 분담 정책 예약 업데이트 재설정 성공 응답 type: object required: - scheduledDiscountSharePolicy properties: scheduledDiscountSharePolicy: $ref: '#/components/schemas/PlatformDiscountSharePolicy' title: 예약된 할인 분담 정보 x-portone-title: 할인 분담 정책 예약 업데이트 재설정 성공 응답 PlatformMemberCompanyConnectedPartnerBrnUnchangeableError: title: 연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우 description: 연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우 x-portone-status-code: 409 PlatformNonDeletablePartnerSettlementsError: title: 삭제할 수 없는 정산건이 포함된 경우 description: 삭제할 수 없는 정산건이 포함된 경우 type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-title: 삭제할 수 없는 정산건이 포함된 경우 x-portone-status-code: 400 PlatformUserDefinedPropertyValue: title: PlatformUserDefinedPropertyValue type: object required: - string properties: string: type: string ReschedulePlatformDiscountSharePolicyBody: title: 할인 분담 정책 예약 업데이트 재설정을 위한 입력 정보 description: 할인 분담 정책 예약 업데이트 재설정을 위한 입력 정보 type: object required: - update - appliedAt properties: update: $ref: '#/components/schemas/UpdatePlatformDiscountSharePolicyBody' title: 반영할 업데이트 내용 appliedAt: type: string format: date-time title: 업데이트 적용 시점 x-portone-title: 할인 분담 정책 예약 업데이트 재설정을 위한 입력 정보 PlatformTransferSummary: title: PlatformTransferSummary oneOf: - $ref: '#/components/schemas/PlatformManualTransferSummary' - $ref: '#/components/schemas/PlatformOrderCancelTransferSummary' - $ref: '#/components/schemas/PlatformOrderTransferSummary' discriminator: propertyName: type mapping: MANUAL: '#/components/schemas/PlatformManualTransferSummary' ORDER: '#/components/schemas/PlatformOrderTransferSummary' ORDER_CANCEL: '#/components/schemas/PlatformOrderCancelTransferSummary' x-portone-discriminator: MANUAL: {} ORDER: {} ORDER_CANCEL: {} ArchivePlatformContractResponse: title: 계약 보관 성공 응답 description: 계약 보관 성공 응답 type: object required: - contract properties: contract: $ref: '#/components/schemas/PlatformContract' title: 보관된 계약 x-portone-title: 계약 보관 성공 응답 CreatePlatformManualTransferBody: title: 수기 정산건 생성을 위한 입력 정보 description: 수기 정산건 생성을 위한 입력 정보 type: object required: - partnerId - settlementAmount - settlementDate properties: partnerId: type: string title: 파트너 아이디 memo: type: string title: 메모 settlementAmount: type: integer format: int64 title: 정산 금액 settlementTaxFreeAmount: type: integer format: int64 title: 정산 면세 금액 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 일 isForTest: type: boolean title: 테스트 모드 여부 description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' id: type: string title: 생성할 정산건 아이디 description: 명시하지 않으면 id 가 임의로 생성됩니다. settlementCurrency: $ref: '#/components/schemas/Currency' title: 정산 통화 x-portone-title: 수기 정산건 생성을 위한 입력 정보 PlatformTransferFilterInputKeyword: title: 정산건 검색 키워드 입력 정보 description: '정산건 검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.' type: object properties: all: type: string description: 해당 값이 포함된 정보를 가진 정산건만 조회합니다. paymentId: type: string description: 해당 값이랑 일치하는 paymentId 를 가진 정산건만 조회합니다. transferId: type: string description: 해당 값이랑 일치하는 transferId 를 가진 정산건만 조회합니다. transferMemo: type: string description: 해당 값이 포함된 transferMemo 를 가진 정산건만 조회합니다. productId: type: string description: 해당 값이랑 일치하는 productId 를 가진 정산건만 조회합니다. productName: type: string description: 해당 값이랑 일치하는 productName 을 가진 정산건만 조회합니다. partnerId: type: string description: 해당 값이랑 일치하는 partnerId 를 가진 정산건만 조회합니다. partnerName: type: string description: 해당 값이 포함된 partnerName 을 가진 정산건만 조회합니다. partnerMemo: type: string description: 해당 값이 포함된 partnerMemo 를 가진 정산건만 조회합니다. partnerSettlementId: type: string description: 해당 값이 포함된 partnerSettlementId 를 가진 정산건만 조회합니다. payoutId: type: string description: 해당 값과 일치하는 지급건에 연관된 정산건만 조회합니다. x-portone-title: 정산건 검색 키워드 입력 정보 x-portone-description: 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다. GetPlatformBulkAccountTransfersError: title: GetPlatformBulkAccountTransfersError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformAccountTransfersResponse: title: 이체내역 다건 조회 성공 응답 정보 description: 이체내역 다건 조회 성공 응답 정보 type: object required: - items - page - counts properties: items: title: 조회된 이체내역 리스트 type: array items: $ref: '#/components/schemas/PlatformAccountTransfer' page: $ref: '#/components/schemas/PageInfo' title: 조회된 페이지 정보 counts: $ref: '#/components/schemas/PlatformAccountTransferStatusStats' title: 이체 내역 상태별 건 수 x-portone-title: 이체내역 다건 조회 성공 응답 정보 GetPlatformDiscountSharePoliciesError: title: GetPlatformDiscountSharePoliciesError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformExternalApiTemporarilyFailedError: title: 외부 api의 일시적인 오류 description: 외부 api의 일시적인 오류 type: object required: - type properties: type: type: string message: type: string x-portone-title: 외부 api의 일시적인 오류 x-portone-status-code: 503 PlatformPartnerSettlementStatus: title: 정산 상태 description: 정산 상태 type: string enum: - PAYOUT_SCHEDULED - PAYOUT_PREPARED - PAYOUT_WITHHELD - PAYOUT_EXCLUDED - PAYOUT_FAILED - IN_PAYOUT - PAID_OUT - CANCELLED - CONFIRMED x-portone-title: 정산 상태 x-portone-enum: CONFIRMED: title: 지급 확정 PAYOUT_FAILED: title: 지급 실패 CANCELLED: title: 지급 취소 PAYOUT_SCHEDULED: title: 지급 예약 PAYOUT_WITHHELD: title: 지급 보류 PAYOUT_EXCLUDED: title: 지급 제외 PAID_OUT: title: 지급 완료 PAYOUT_PREPARED: title: 지급 예정 IN_PAYOUT: title: 지급 중 CreatePlatformContractError: title: CreatePlatformContractError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformContractAlreadyExistsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CONTRACT_ALREADY_EXISTS: '#/components/schemas/PlatformContractAlreadyExistsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformBulkPayoutStats: title: PlatformBulkPayoutStats type: object required: - amount - count properties: amount: $ref: '#/components/schemas/PlatformPayoutStatusStats' count: $ref: '#/components/schemas/PlatformPayoutStatusStats' CompletePlatformPayoutByPartnerSettlementIdsError: title: CompletePlatformPayoutByPartnerSettlementIdsError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformBulkPayoutIdAlreadyExistsError' - $ref: '#/components/schemas/PlatformDuplicatedPartnerSettlementIdsError' - $ref: '#/components/schemas/PlatformNegativePayoutAmountPartnersError' - $ref: '#/components/schemas/PlatformNoSelectedPartnerSettlementsError' - $ref: '#/components/schemas/PlatformNonPayablePartnerSettlementsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerSettlementsNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_BULK_PAYOUT_ID_ALREADY_EXISTS: '#/components/schemas/PlatformBulkPayoutIdAlreadyExistsError' PLATFORM_CURRENCY_NOT_SUPPORTED: '#/components/schemas/PlatformNegativePayoutAmountPartnersError' PLATFORM_DUPLICATED_PARTNER_SETTLEMENT_IDS: '#/components/schemas/PlatformDuplicatedPartnerSettlementIdsError' PLATFORM_NON_PAYABLE_PARTNER_SETTLEMENTS: '#/components/schemas/PlatformNonPayablePartnerSettlementsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_NO_SELECTED_PARTNER_SETTLEMENTS: '#/components/schemas/PlatformNoSelectedPartnerSettlementsError' PLATFORM_PARTNER_SETTLEMENTS_NOT_FOUND: '#/components/schemas/PlatformPartnerSettlementsNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformContractScheduleError: title: GetPlatformContractScheduleError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformTransferFilterInput: title: 정산건 필터 입력 정보 description: '정산건 필터 입력 정보 정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.' type: object properties: settlementStartDateRange: $ref: '#/components/schemas/DateRange' title: 정산 시작일 범위 settlementDateRange: $ref: '#/components/schemas/DateRange' title: 정산 일 범위 partnerTags: type: array items: type: string title: 파트너 태그 리스트 description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 태그를 하나 이상 가지는 파트너에 대한 정산건만 조회합니다. contractIds: type: array items: type: string title: 계약 아이디 리스트 description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 계약 아이디를 가지는 정산건만 조회합니다. discountSharePolicyIds: type: array items: type: string title: 할인 분담 정책 아이디 리스트 description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 할인 분담 정책 아이디를 하나 이상 가지는 정산건만 조회합니다. additionalFeePolicyIds: type: array items: type: string title: 추가 수수료 정책 아이디 리스트 description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 추가 수수료 아이디를 하나 이상 가지는 정산건만 조회합니다. paymentMethodTypes: type: array items: $ref: '#/components/schemas/PaymentMethodType' title: 결제 수단 리스트 description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 결제 수단을 가지는 파트너만 조회합니다. channelKeys: type: array items: type: string title: 채널 키 리스트 description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 채널 키를 가지는 정산건만 조회합니다. types: type: array items: $ref: '#/components/schemas/PlatformTransferType' title: 정산 방식 리스트 description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 방식의 정산건만 조회합니다. statuses: title: 정산 상태 리스트 type: array items: $ref: '#/components/schemas/PlatformTransferStatus' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 상태인 정산건만 조회합니다. userDefinedProperty: $ref: '#/components/schemas/PlatformTransferPropertyExactMatchInput' title: 사용자 정의 속성 exact match description: 사용자 정의 속성의 key와 value가 정확히 일치하는 정산건만 조회합니다. keyword: $ref: '#/components/schemas/PlatformTransferFilterInputKeyword' title: 검색 키워드 isForTest: type: boolean title: 테스트 모드 여부 description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Filter의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' x-portone-title: 정산건 필터 입력 정보 x-portone-description: 정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다. DateRange: title: DateRange type: object required: - from - until properties: from: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. until: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. PlatformPaymentMethodCard: title: 카드 description: 카드 type: object required: - type properties: type: type: string x-portone-title: 카드 PlatformPartnerFilterOptions: title: 파트너 필터 옵션 조회 성공 응답 정보 description: 파트너 필터 옵션 조회 성공 응답 정보 type: object required: - tags - contractSummary properties: tags: type: array items: type: string title: 조회된 태그 리스트 contractSummary: title: 조회된 파트너 계약 요약 정보 리스트 type: array items: $ref: '#/components/schemas/PlatformPartnerContractSummary' x-portone-title: 파트너 필터 옵션 조회 성공 응답 정보 PlatformDiscountSharePolicyScheduleAlreadyExistsError: title: PlatformDiscountSharePolicyScheduleAlreadyExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 PlatformBulkTaskType: title: PlatformBulkTaskType type: string enum: - CREATE_TRANSFERS - CREATE_PARTNERS - CONNECT_MEMBER_COMPANIES - DISCONNECT_MEMBER_COMPANIES - SEND_PAYOUT_SETTLEMENT_STATEMENTS x-portone-enum: CREATE_TRANSFERS: title: 정산건 일괄 등록 DISCONNECT_MEMBER_COMPANIES: title: 파트너 일괄 국세청 연동 해제 CONNECT_MEMBER_COMPANIES: title: 파트너 일괄 국세청 연동 SEND_PAYOUT_SETTLEMENT_STATEMENTS: title: 정산 내역서 일괄 발송 CREATE_PARTNERS: title: 파트너 일괄 등록 RecoverPlatformPartnerError: title: RecoverPlatformPartnerError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformPartnerPendingNtsOperationError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_PARTNER_PENDING_NTS_OPERATION: '#/components/schemas/PlatformPartnerPendingNtsOperationError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' CreatePlatformAdditionalFeePolicyResponse: title: 플랫폼 생성 성공 응답 정보 description: 플랫폼 생성 성공 응답 정보 type: object required: - additionalFeePolicy properties: additionalFeePolicy: $ref: '#/components/schemas/PlatformAdditionalFeePolicy' title: 생성된 추가 수수료 정책 x-portone-title: 플랫폼 생성 성공 응답 정보 SchedulePartnerError: title: SchedulePartnerError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAccountVerificationAlreadyUsedError' - $ref: '#/components/schemas/PlatformAccountVerificationFailedError' - $ref: '#/components/schemas/PlatformAccountVerificationNotFoundError' - $ref: '#/components/schemas/PlatformArchivedPartnerError' - $ref: '#/components/schemas/PlatformCompanyVerificationAlreadyUsedError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformInsufficientDataToChangePartnerTypeError' - $ref: '#/components/schemas/PlatformMemberCompanyConnectedPartnerBrnUnchangeableError' - $ref: '#/components/schemas/PlatformMemberCompanyConnectedPartnerCannotBeScheduledError' - $ref: '#/components/schemas/PlatformMemberCompanyConnectedPartnerTypeUnchangeableError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformPartnerScheduleAlreadyExistsError' - $ref: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ACCOUNT_VERIFICATION_ALREADY_USED: '#/components/schemas/PlatformAccountVerificationAlreadyUsedError' PLATFORM_ACCOUNT_VERIFICATION_FAILED: '#/components/schemas/PlatformAccountVerificationFailedError' PLATFORM_ACCOUNT_VERIFICATION_NOT_FOUND: '#/components/schemas/PlatformAccountVerificationNotFoundError' PLATFORM_ARCHIVED_PARTNER: '#/components/schemas/PlatformArchivedPartnerError' PLATFORM_COMPANY_VERIFICATION_ALREADY_USED: '#/components/schemas/PlatformCompanyVerificationAlreadyUsedError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_INSUFFICIENT_DATA_TO_CHANGE_PARTNER_TYPE: '#/components/schemas/PlatformInsufficientDataToChangePartnerTypeError' PLATFORM_MEMBER_COMPANY_CONNECTED_PARTNER_BRN_UNCHANGEABLE: '#/components/schemas/PlatformMemberCompanyConnectedPartnerBrnUnchangeableError' PLATFORM_MEMBER_COMPANY_CONNECTED_PARTNER_CANNOT_BE_SCHEDULED: '#/components/schemas/PlatformMemberCompanyConnectedPartnerCannotBeScheduledError' PLATFORM_MEMBER_COMPANY_CONNECTED_PARTNER_TYPE_UNCHANGEABLE: '#/components/schemas/PlatformMemberCompanyConnectedPartnerTypeUnchangeableError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_PARTNER_SCHEDULE_ALREADY_EXISTS: '#/components/schemas/PlatformPartnerScheduleAlreadyExistsError' PLATFORM_USER_DEFINED_PROPERTY_NOT_FOUND: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' RecoverPlatformContractError: title: RecoverPlatformContractError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformContact: title: 플랫폼 파트너 담당자 연락 정보 description: '플랫폼 파트너 담당자 연락 정보 파트너 담당자에게 연락하기 위한 정보들 입니다.' type: object required: - name - email properties: name: type: string title: 담당자 이름 phoneNumber: type: string title: 담당자 휴대폰 번호 email: type: string title: 담당자 이메일 x-portone-title: 플랫폼 파트너 담당자 연락 정보 x-portone-description: 파트너 담당자에게 연락하기 위한 정보들 입니다. PlatformManualTransferSummary: title: PlatformManualTransferSummary type: object required: - type - id - graphqlId - partner - status - settlementDate - settlementCurrency - isForTest - partnerUserDefinedProperties - userDefinedProperties - settlementAmount - settlementTaxFreeAmount properties: type: type: string id: type: string graphqlId: type: string partner: $ref: '#/components/schemas/PlatformTransferSummaryPartner' status: $ref: '#/components/schemas/PlatformTransferStatus' memo: type: string settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. settlementCurrency: $ref: '#/components/schemas/Currency' isForTest: type: boolean partnerUserDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' description: 5월 삭제 예정 필드입니다. partner.userDefinedProperties를 사용해주시길 바랍니다. userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' settlementAmount: type: integer format: int64 settlementTaxFreeAmount: type: integer format: int64 PlatformBulkAccountTransferStats: title: PlatformBulkAccountTransferStats type: object required: - amount - count properties: amount: $ref: '#/components/schemas/PlatformAccountTransferStatusStats' count: $ref: '#/components/schemas/PlatformAccountTransferStatusStats' PlatformPayoutStatus: title: PlatformPayoutStatus type: string enum: - CONFIRMED - PREPARED - CANCELLED - STOPPED - PROCESSING - SUCCEEDED - FAILED - SCHEDULED x-portone-enum: CONFIRMED: {} STOPPED: {} PREPARED: {} CANCELLED: {} SUCCEEDED: {} SCHEDULED: {} PROCESSING: {} FAILED: {} PlatformOrderDetailMismatchedError: title: PlatformOrderDetailMismatchedError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 400 CompletePlatformPayoutByPartnerSettlementIdsResponse: title: 일괄 지급 완료 처리 결과 description: 일괄 지급 완료 처리 결과 type: object required: - payoutCount - partnerSettlementCount properties: bulkPayoutId: type: string bulkPayoutGraphqlId: type: string payoutCount: type: integer format: int32 partnerSettlementCount: type: integer format: int32 x-portone-title: 일괄 지급 완료 처리 결과 PlatformCancellableDiscountTaxFreeAmountExceededError: title: PlatformCancellableDiscountTaxFreeAmountExceededError type: object required: - type - discountSharePolicyId - discountSharePolicyGraphqlId - cancellableAmount - requestAmount properties: type: type: string discountSharePolicyId: type: string discountSharePolicyGraphqlId: type: string cancellableAmount: type: integer format: int64 requestAmount: type: integer format: int64 productId: type: string message: type: string x-portone-status-code: 400 PlatformPaymentMethodEasyPayInput: title: 간편 결제 입력 정보 description: 간편 결제 입력 정보 type: object properties: provider: $ref: '#/components/schemas/EasyPayProvider' title: 간편 결제사 methodType: $ref: '#/components/schemas/EasyPayMethodType' title: 간편 결제 수단 x-portone-title: 간편 결제 입력 정보 PlatformOrderTransferCancellation: title: 주문 취소 정보 description: 주문 취소 정보 type: object required: - id - cancelledAt properties: id: type: string title: 주문 취소 아이디 cancelledAt: type: string format: date-time title: 취소 일시 x-portone-title: 주문 취소 정보 GetPlatformContractsResponse: title: 계약 다건 조회 성공 응답 description: 계약 다건 조회 성공 응답 type: object required: - items - page properties: items: title: 조회된 계약 리스트 type: array items: $ref: '#/components/schemas/PlatformContract' page: $ref: '#/components/schemas/PageInfo' title: 조회된 페이지 정보 x-portone-title: 계약 다건 조회 성공 응답 ReschedulePlatformPartnerBody: title: 파트너 예약 업데이트 재설정을 위한 입력 정보 description: 파트너 예약 업데이트 재설정을 위한 입력 정보 type: object required: - update - appliedAt properties: update: $ref: '#/components/schemas/UpdatePlatformPartnerBody' title: 반영할 업데이트 내용 appliedAt: type: string format: date-time title: 업데이트 적용 시점 x-portone-title: 파트너 예약 업데이트 재설정을 위한 입력 정보 PageInput: title: 다건 조회 API 에 사용되는 페이지 입력 정보 description: 다건 조회 API 에 사용되는 페이지 입력 정보 type: object properties: number: type: integer format: int32 title: 0부터 시작하는 페이지 번호 size: type: integer format: int32 title: 각 페이지 당 포함할 객체 수 x-portone-title: 다건 조회 API 에 사용되는 페이지 입력 정보 PlatformTransferSummaryPartnerType: title: 파트너 유형 description: 파트너 유형 type: string enum: - BUSINESS - WHT_PAYER - NON_WHT_PAYER x-portone-title: 파트너 유형 x-portone-enum: BUSINESS: title: 사업자 WHT_PAYER: title: 원천징수 대상자 NON_WHT_PAYER: title: 원천징수 비대상자 PlatformAccountHolder: title: 예금주 조회 성공 응답 정보 description: 예금주 조회 성공 응답 정보 type: object required: - holderName - accountVerificationId properties: holderName: type: string title: 계좌 예금주 이름 accountVerificationId: type: string title: 계좌 검증 아이디 x-portone-title: 예금주 조회 성공 응답 정보 GetPlatformAccountTransfersError: title: GetPlatformAccountTransfersError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformDiscountSharePoliciesResponse: title: 할인 분담 정책 다건 조회 성공 응답 정보 description: 할인 분담 정책 다건 조회 성공 응답 정보 type: object required: - items - page properties: items: title: 조회된 할인 분담 정책 리스트 type: array items: $ref: '#/components/schemas/PlatformDiscountSharePolicy' page: $ref: '#/components/schemas/PageInfo' title: 조회된 페이지 정보 x-portone-title: 할인 분담 정책 다건 조회 성공 응답 정보 PlatformSettlementCycleInput: title: 플랫폼 정산 주기 입력 정보 description: 플랫폼 정산 주기 입력 정보 type: object required: - lagDays - datePolicy - method properties: lagDays: type: integer format: int32 title: 지체일 (d+n 의 n) description: 정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다. datePolicy: $ref: '#/components/schemas/PlatformSettlementCycleDatePolicy' title: 기준일로, 정산일 계산 시 공휴일을 고려하기 위한 정보입니다. method: $ref: '#/components/schemas/PlatformSettlementCycleMethodInput' title: 정산 주기 계산 방식 x-portone-title: 플랫폼 정산 주기 입력 정보 PlatformBankAccountDetail: title: 계좌 상세 정보 description: 계좌 상세 정보 type: object required: - accountNumber - bank - provider properties: accountNumber: type: string title: 계좌번호 bank: $ref: '#/components/schemas/Bank' title: 은행 provider: $ref: '#/components/schemas/PlatformBankAccountProvider' title: 제공자 holder: type: string title: 예금주명 x-portone-title: 계좌 상세 정보 UpdatePlatformSettingResponse: title: 플랫폼 설정 업데이트 결과 description: 플랫폼 설정 업데이트 결과 type: object required: - setting properties: setting: $ref: '#/components/schemas/PlatformSetting' x-portone-title: 플랫폼 설정 업데이트 결과 PlatformPartnerTaxationType: title: 플랫폼 파트너 과세 유형 description: 플랫폼 파트너 과세 유형 type: string enum: - NORMAL - SIMPLE_TAX_INVOICE_ISSUER - SIMPLE - TAX_FREE x-portone-title: 플랫폼 파트너 과세 유형 x-portone-enum: NORMAL: title: 일반 과세 SIMPLE_TAX_INVOICE_ISSUER: title: 간이과세(세금계산서 발행) SIMPLE: title: 간이과세(세금계산서 미발행) TAX_FREE: title: 면세 PlatformAccountTransfer: title: 계좌 이체 description: '계좌 이체 송금 대행을 통해 일어난 정산 금액 지급, 인출 목적의 계좌 이체 결과 정보입니다.' oneOf: - $ref: '#/components/schemas/PlatformDepositAccountTransfer' - $ref: '#/components/schemas/PlatformWithdrawalAccountTransfer' discriminator: propertyName: type mapping: DEPOSIT: '#/components/schemas/PlatformDepositAccountTransfer' WITHDRAWAL: '#/components/schemas/PlatformWithdrawalAccountTransfer' x-portone-title: 계좌 이체 x-portone-description: 송금 대행을 통해 일어난 정산 금액 지급, 인출 목적의 계좌 이체 결과 정보입니다. x-portone-discriminator: DEPOSIT: {} WITHDRAWAL: {} GetPlatformCompanyStatePayload: title: 사업자 조회 성공 응답 정보 description: 사업자 조회 성공 응답 정보 type: object required: - companyState - companyVerificationId properties: companyState: $ref: '#/components/schemas/PlatformCompanyState' title: 사업자 정보 companyVerificationId: type: string title: 사업자 검증 아이디 x-portone-title: 사업자 조회 성공 응답 정보 CompletePlatformPayoutByPartnerSettlementIdsBody: title: CompletePlatformPayoutByPartnerSettlementIdsBody type: object required: - bulkPayoutId - partnerSettlementIds properties: bulkPayoutId: type: string name: type: string partnerSettlementIds: type: array items: type: string completedAt: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. isForTest: type: boolean description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' CreatePlatformContractBody: title: 계약 객체 생성을 위한 입력 정보 description: 계약 객체 생성을 위한 입력 정보 type: object required: - name - platformFee - settlementCycle - platformFeeVatPayer - subtractPaymentVatAmount properties: id: type: string title: 계약에 부여할 고유 아이디 description: 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다. name: type: string title: 계약 이름 memo: type: string title: 계약 내부 표기를 위한 메모 platformFee: $ref: '#/components/schemas/PlatformFeeInput' title: 중개수수료 settlementCycle: $ref: '#/components/schemas/PlatformSettlementCycleInput' title: 정산 주기 platformFeeVatPayer: $ref: '#/components/schemas/PlatformPayer' title: 중개수수료에 대한 부가세 부담 주체 subtractPaymentVatAmount: type: boolean title: 정산 시 결제금액 부가세 감액 여부 x-portone-title: 계약 객체 생성을 위한 입력 정보 PaymentMethodType: title: PaymentMethodType type: string enum: - CARD - TRANSFER - VIRTUAL_ACCOUNT - GIFT_CERTIFICATE - MOBILE - EASY_PAY - CONVENIENCE_STORE - CRYPTO x-portone-enum: CONVENIENCE_STORE: {} GIFT_CERTIFICATE: {} VIRTUAL_ACCOUNT: {} CRYPTO: {} MOBILE: {} CARD: {} TRANSFER: {} EASY_PAY: {} EasyPayProvider: title: 간편 결제사 description: 간편 결제사 type: string enum: - SAMSUNGPAY - KAKAOPAY - NAVERPAY - PAYCO - SSGPAY - CHAI - LPAY - KPAY - TOSSPAY - LGPAY - PINPAY - APPLEPAY - SKPAY - TOSS_BRANDPAY - KB_APP - ALIPAY - HYPHEN - TMONEY - PAYPAL - SMILEPAY - MIR - WECHAT - LINEPAY - KLARNA - GRABPAY - SHOPEEPAY - JKOPAY - PAYPAY - AMAZONPAY - RAKUTENPAY - DBARAI - AUPAY - MERPAY - MONEYTREE - KPLUS - TINABA - BILL_EASE - KREDIVO - RABBIT_LINE_PAY - ALIPAY_HK - AKULAKU_PAY_LATER - BOOST - BPI - DANA - G_CASH - HIPAY - MPAY - TOUCH_N_GO - TRUE_MONEY - DOKU_WALLET - JENIUS_PAY - OVO - MAYA - QRIS - THAI_QR - GOOGLE_PAY x-portone-title: 간편 결제사 x-portone-enum: ALIPAY_HK: {} MIR: {} QRIS: {} MONEYTREE: {} GRABPAY: {} TOSS_BRANDPAY: {} JKOPAY: {} SHOPEEPAY: {} BOOST: {} ALIPAY: {} LPAY: {} DBARAI: {} KB_APP: {} LINEPAY: {} PAYCO: {} HIPAY: {} BILL_EASE: {} DOKU_WALLET: {} SMILEPAY: {} TINABA: {} KLARNA: {} JENIUS_PAY: {} RABBIT_LINE_PAY: {} THAI_QR: {} NAVERPAY: {} GOOGLE_PAY: {} KREDIVO: {} CHAI: {} PINPAY: {} WECHAT: {} KPLUS: {} MAYA: {} TMONEY: {} TOSSPAY: {} SSGPAY: {} MERPAY: {} PAYPAL: {} OVO: {} G_CASH: {} LGPAY: {} APPLEPAY: {} HYPHEN: {} AUPAY: {} SAMSUNGPAY: {} DANA: {} TOUCH_N_GO: {} KPAY: {} AMAZONPAY: {} BPI: {} TRUE_MONEY: {} SKPAY: {} AKULAKU_PAY_LATER: {} RAKUTENPAY: {} PAYPAY: {} KAKAOPAY: {} MPAY: {} PlatformPaymentMethodTransfer: title: 계좌이체 description: 계좌이체 type: object required: - type properties: type: type: string x-portone-title: 계좌이체 PlatformBulkTaskStatus: title: PlatformBulkTaskStatus type: string enum: - PREPARED - PROCESSING - COMPLETED - CANCELED x-portone-enum: PREPARED: {} PROCESSING: {} COMPLETED: {} CANCELED: {} PlatformPayer: title: 금액 부담 주체 description: '금액 부담 주체 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.' type: string enum: - PARTNER - MERCHANT x-portone-title: 금액 부담 주체 x-portone-description: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다. x-portone-enum: PARTNER: title: 파트너가 부담하는 경우 MERCHANT: title: 고객사가 부담하는 경우 UpdatePlatformPartnerBodyContact: title: 파트너 담당자 업데이트를 위한 정보 description: 파트너 담당자 업데이트를 위한 정보 type: object properties: name: type: string title: 담당자 이름 phoneNumber: type: string title: 담당자 휴대폰 번호 email: type: string title: 담당자 이메일 x-portone-title: 파트너 담당자 업데이트를 위한 정보 PlatformTargetPartnerNotFoundError: title: 처리 대상 파트너가 존재하지 않는 경우 description: 처리 대상 파트너가 존재하지 않는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 처리 대상 파트너가 존재하지 않는 경우 x-portone-status-code: 404 PlatformContractFilterInputKeyword: title: 검색 키워드 입력 정보 description: '검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 계약만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.' type: object properties: id: type: string description: 해당 값이 포함된 id 를 가진 계약만 조회합니다. name: type: string description: 해당 값이 포함된 name 을 가진 계약만 조회합니다. x-portone-title: 검색 키워드 입력 정보 x-portone-description: 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 계약만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다. GetPlatformPartnersError: title: GetPlatformPartnersError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformPartnerError: title: GetPlatformPartnerError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' UpdatePlatformPartnerBody: title: 파트너 업데이트를 위한 입력 정보 description: '파트너 업데이트를 위한 입력 정보 값이 명시되지 않은 필드는 업데이트되지 않습니다.' type: object properties: name: type: string title: 파트너 법인명 혹은 이름 contact: $ref: '#/components/schemas/UpdatePlatformPartnerBodyContact' title: 파트너 담당자 연락 정보 account: $ref: '#/components/schemas/UpdatePlatformPartnerBodyAccount' title: 정산 계좌 defaultContractId: type: string title: 파트너에 설정된 기본 계약 아이디 memo: type: string title: 파트너에 대한 메모 tags: type: array items: type: string title: 파트너의 태그 리스트 type: $ref: '#/components/schemas/UpdatePlatformPartnerBodyType' title: 파트너 유형별 정보 userDefinedProperties: $ref: '#/components/schemas/PlatformProperties' title: 사용자 정의 속성 x-portone-title: 파트너 업데이트를 위한 입력 정보 x-portone-description: 값이 명시되지 않은 필드는 업데이트되지 않습니다. CancelPlatformDiscountSharePolicyScheduleResponse: title: 할인 분담 정책 예약 업데이트 취소 성공 응답 description: 할인 분담 정책 예약 업데이트 취소 성공 응답 type: object x-portone-title: 할인 분담 정책 예약 업데이트 취소 성공 응답 PlatformExternalPayment: title: 외부 결제 정보 description: 외부 결제 정보 type: object required: - type - id - currency properties: type: type: string id: type: string title: 결제 아이디 orderName: type: string title: 주문 명 currency: $ref: '#/components/schemas/Currency' title: 통화 method: $ref: '#/components/schemas/PlatformPaymentMethod' title: 결제 수단 paidAt: type: string format: date-time title: 결제 일시 x-portone-title: 외부 결제 정보 ConnectPartnerCounterpartyResponse: title: 파트너 거래처 연동 응답 description: 파트너 거래처 연동 응답 type: object required: - partner properties: partner: $ref: '#/components/schemas/PlatformPartner' x-portone-title: 파트너 거래처 연동 응답 PlatformSettlementCycleMethodManualDates: title: 정해진 날짜(월, 일)에 정산 description: 정해진 날짜(월, 일)에 정산 type: object required: - type - dates properties: type: type: string dates: title: 월 및 일자 정보 type: array items: $ref: '#/components/schemas/MonthDay' x-portone-title: 정해진 날짜(월, 일)에 정산 Bank: title: 은행 description: 은행 type: string enum: - BANK_OF_KOREA - KDB - IBK - KOOKMIN - SUHYUP - KEXIM - NONGHYUP - LOCAL_NONGHYUP - WOORI - STANDARD_CHARTERED - CITI - SUHYUP_FEDERATION - DAEGU - BUSAN - KWANGJU - JEJU - JEONBUK - KYONGNAM - KFCC - SHINHYUP - SAVINGS_BANK - MORGAN_STANLEY - HSBC - DEUTSCHE - JPMC - MIZUHO - MUFG - BANK_OF_AMERICA - BNP_PARIBAS - ICBC - BANK_OF_CHINA - NFCF - UOB - BOCOM - CCB - POST - KODIT - KIBO - HANA - SHINHAN - K_BANK - KAKAO - TOSS - MISC_FOREIGN - SGI - KCIS - YUANTA_SECURITIES - KB_SECURITIES - SANGSANGIN_SECURITIES - HANYANG_SECURITIES - LEADING_SECURITIES - BNK_SECURITIES - IBK_SECURITIES - DAOL_SECURITIES - MIRAE_ASSET_SECURITIES - SAMSUNG_SECURITIES - KOREA_SECURITIES - NH_SECURITIES - KYOBO_SECURITIES - HI_SECURITIES - HYUNDAI_MOTOR_SECURITIES - KIWOOM_SECURITIES - EBEST_SECURITIES - SK_SECURITIES - DAISHIN_SECURITIES - HANHWA_SECURITIES - HANA_SECURITIES - TOSS_SECURITIES - SHINHAN_SECURITIES - DB_SECURITIES - EUGENE_SECURITIES - MERITZ_SECURITIES - KAKAO_PAY_SECURITIES - BOOKOOK_SECURITIES - SHINYOUNG_SECURITIES - CAPE_SECURITIES - KOREA_SECURITIES_FINANCE - KOREA_FOSS_SECURITIES - WOORI_INVESTMENT_BANK x-portone-title: 은행 x-portone-enum: BANK_OF_CHINA: title: 중국은행 KDB: title: 산업은행 HANYANG_SECURITIES: title: 한양증권 SK_SECURITIES: title: SK증권 HANA_SECURITIES: title: 하나증권 KB_SECURITIES: title: KB증권 KYONGNAM: title: 경남은행 WOORI_INVESTMENT_BANK: title: 우리종합금융 CITI: title: 한국씨티은행 SHINYOUNG_SECURITIES: title: 신영증권 KOREA_SECURITIES: title: 한국투자증권 SHINHAN: title: 신한은행 LEADING_SECURITIES: title: 리딩투자증권 UOB: title: 대화은행 KOREA_FOSS_SECURITIES: title: 한국포스증권 MERITZ_SECURITIES: title: 메리츠증권 MIZUHO: title: 미즈호은행 EBEST_SECURITIES: title: LS증권 SANGSANGIN_SECURITIES: title: 상상인증권 IBK: title: 기업은행 DEUTSCHE: title: 도이치은행 KCIS: title: 한국신용정보원 KEXIM: title: 수출입은행 SHINHYUP: title: 신협 CCB: title: 중국건설은행 HANA: title: 하나은행 TOSS_SECURITIES: title: 토스증권 IBK_SECURITIES: title: IBK투자증권 SHINHAN_SECURITIES: title: 신한투자증권 HANHWA_SECURITIES: title: 한화투자증권 SUHYUP_FEDERATION: title: 수협중앙회 LOCAL_NONGHYUP: title: 지역농축협 WOORI: title: 우리은행 SAMSUNG_SECURITIES: title: 삼성증권 K_BANK: title: 케이뱅크 DB_SECURITIES: title: DB금융투자 SGI: title: 서울보증보험 JEJU: title: 제주은행 MIRAE_ASSET_SECURITIES: title: 미래에셋증권 SAVINGS_BANK: title: 저축은행 EUGENE_SECURITIES: title: 유진투자증권 DAEGU: title: 아이엠뱅크 BNK_SECURITIES: title: BNK투자증권 KAKAO_PAY_SECURITIES: title: 카카오페이증권 SUHYUP: title: 수협은행 CAPE_SECURITIES: title: 케이프투자증권 JEONBUK: title: 전북은행 BNP_PARIBAS: title: 비엔피파리바은행 KOREA_SECURITIES_FINANCE: title: 한국증권금융 KODIT: title: 신용보증기금 BOCOM: title: 교통은행 DAOL_SECURITIES: title: 다올투자증권 NFCF: title: 산림조합중앙회 HSBC: title: HSBC은행 STANDARD_CHARTERED: title: SC제일은행 KWANGJU: title: 광주은행 ICBC: title: 중국공상은행 TOSS: title: 토스뱅크 HYUNDAI_MOTOR_SECURITIES: title: 현대차증권 BANK_OF_AMERICA: title: BOA은행 BANK_OF_KOREA: title: 한국은행 NONGHYUP: title: NH농협은행 HI_SECURITIES: title: 하이투자증권 KIBO: title: 기술보증기금 KAKAO: title: 카카오뱅크 KIWOOM_SECURITIES: title: 키움증권 BUSAN: title: 부산은행 NH_SECURITIES: title: NH투자증권 MORGAN_STANLEY: title: 모간스탠리은행 KFCC: title: 새마을금고 BOOKOOK_SECURITIES: title: 부국증권 MISC_FOREIGN: title: 기타 외국계은행(중국 농업은행 등) YUANTA_SECURITIES: title: 유안타증권 POST: title: 우체국 DAISHIN_SECURITIES: title: 대신증권 KOOKMIN: title: 국민은행 MUFG: title: 엠유에프지은행 JPMC: title: 제이피모간체이스은행 KYOBO_SECURITIES: title: 교보증권 PlatformPartnerBusinessStatus: title: 플랫폼 파트너 사업자 상태 description: 플랫폼 파트너 사업자 상태 type: string enum: - NOT_VERIFIED - VERIFY_ERROR - NOT_FOUND - IN_BUSINESS - CLOSED - SUSPENDED x-portone-title: 플랫폼 파트너 사업자 상태 x-portone-enum: SUSPENDED: title: 휴업 NOT_VERIFIED: title: 조회 되지 않음 IN_BUSINESS: title: 사업 중 CLOSED: title: 폐업 NOT_FOUND: title: 대응되는 사업자 없음 VERIFY_ERROR: title: 조회 오류 PlatformTransferType: title: PlatformTransferType type: string enum: - ORDER - ORDER_CANCEL - MANUAL x-portone-enum: ORDER: {} ORDER_CANCEL: {} MANUAL: {} PlatformCounterpartyOngoingTaxInvoiceExistsError: title: 연동된 거래처에 진행 중인 세금계산서가 있는 경우 description: 연동된 거래처에 진행 중인 세금계산서가 있는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 연동된 거래처에 진행 중인 세금계산서가 있는 경우 x-portone-status-code: 409 SchedulePlatformPartnersBodyUpdateTypeWhtPayer: title: SchedulePlatformPartnersBodyUpdateTypeWhtPayer type: object properties: birthdate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 생년월일 PlatformPartnerContractSummary: title: 파트너 계약 요약 정보 description: 파트너 계약 요약 정보 type: object required: - id - name properties: id: type: string title: 계약 고유 아이디 name: type: string title: 계약 이름 x-portone-title: 파트너 계약 요약 정보 GetPlatformTransferSummariesResponse: title: GetPlatformTransferSummariesResponse type: object required: - transferSummaries - page properties: transferSummaries: type: array items: $ref: '#/components/schemas/PlatformTransferSummary' page: $ref: '#/components/schemas/PageInfo' CancelPlatformAdditionalFeePolicyScheduleError: title: CancelPlatformAdditionalFeePolicyScheduleError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformOrderTransferSummary: title: PlatformOrderTransferSummary type: object required: - type - id - graphqlId - storeId - partner - contract - status - settlementDate - settlementCurrency - isForTest - partnerUserDefinedProperties - userDefinedProperties - amount - payment - settlementStartDate properties: type: type: string id: type: string graphqlId: type: string storeId: type: string partner: $ref: '#/components/schemas/PlatformTransferSummaryPartner' contract: $ref: '#/components/schemas/PlatformContract' status: $ref: '#/components/schemas/PlatformTransferStatus' memo: type: string settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. settlementCurrency: $ref: '#/components/schemas/Currency' isForTest: type: boolean partnerUserDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' description: 5월 삭제 예정 필드입니다. partner.userDefinedProperties를 사용해주시길 바랍니다. userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' amount: $ref: '#/components/schemas/PlatformOrderSettlementAmount' payment: $ref: '#/components/schemas/PlatformTransferSummaryPayment' settlementStartDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. PlatformPartnerScheduleAlreadyExistsError: title: PlatformPartnerScheduleAlreadyExistsError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 409 PlatformPartnerTypeNonWhtPayer: title: 원천징수 비대상자 파트너 정보 description: '원천징수 비대상자 파트너 정보 비사업자 유형의 파트너 추가 정보 입니다.' type: object required: - type properties: type: type: string birthdate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 생년월일 x-portone-title: 원천징수 비대상자 파트너 정보 x-portone-description: 비사업자 유형의 파트너 추가 정보 입니다. PlatformPartnerSettlementFilterKeywordInput: title: PlatformPartnerSettlementFilterKeywordInput type: object properties: partnerSettlementId: type: string payoutId: type: string bulkPayoutId: type: string SchedulePlatformPartnersBodyUpdateTypeBusiness: title: SchedulePlatformPartnersBodyUpdateTypeBusiness type: object properties: companyName: type: string title: 상호명 taxationType: $ref: '#/components/schemas/PlatformPartnerTaxationType' title: 사업자 유형 businessRegistrationNumber: type: string title: 사업자등록번호 representativeName: type: string title: 대표자 이름 companyAddress: type: string title: 사업장 주소 businessType: type: string title: 업태 businessClass: type: string title: 업종 companyVerificationId: type: string title: 사업자 조회 검증 아이디 PlatformArchivedContractError: title: 보관된 계약을 업데이트하려고 하는 경우 description: 보관된 계약을 업데이트하려고 하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 보관된 계약을 업데이트하려고 하는 경우 x-portone-status-code: 409 PlatformTransferSummaryPartner: title: PlatformTransferSummaryPartner type: object required: - id - graphqlId - name - type - userDefinedProperties properties: id: type: string graphqlId: type: string name: type: string type: $ref: '#/components/schemas/PlatformTransferSummaryPartnerType' taxationType: $ref: '#/components/schemas/PlatformPartnerTaxationType' userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' PlatformCancellableAmountExceededError: title: 취소 가능한 금액이 초과한 경우 description: 취소 가능한 금액이 초과한 경우 type: object required: - type - cancellableAmount - requestAmount - amountType properties: type: type: string cancellableAmount: type: integer format: int64 requestAmount: type: integer format: int64 amountType: $ref: '#/components/schemas/PlatformCancellableAmountType' message: type: string x-portone-title: 취소 가능한 금액이 초과한 경우 x-portone-status-code: 400 PlatformAccountTransferType: title: 계좌 이체 유형 description: 계좌 이체 유형 type: string enum: - DEPOSIT - WITHDRAWAL x-portone-title: 계좌 이체 유형 x-portone-enum: DEPOSIT: title: 입금 WITHDRAWAL: title: 출금 PlatformPayment: title: 결제 정보 description: 결제 정보 oneOf: - $ref: '#/components/schemas/PlatformExternalPayment' - $ref: '#/components/schemas/PlatformPortOnePayment' discriminator: propertyName: type mapping: EXTERNAL: '#/components/schemas/PlatformExternalPayment' PORT_ONE: '#/components/schemas/PlatformPortOnePayment' x-portone-title: 결제 정보 x-portone-discriminator: PORT_ONE: title: 포트원 결제 정보 EXTERNAL: title: 외부 결제 정보 PlatformNotEnabledError: title: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 description: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 x-portone-status-code: 403 UpdatePlatformPartnerError: title: UpdatePlatformPartnerError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAccountVerificationAlreadyUsedError' - $ref: '#/components/schemas/PlatformAccountVerificationFailedError' - $ref: '#/components/schemas/PlatformAccountVerificationNotFoundError' - $ref: '#/components/schemas/PlatformArchivedPartnerError' - $ref: '#/components/schemas/PlatformCompanyVerificationAlreadyUsedError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformInsufficientDataToChangePartnerTypeError' - $ref: '#/components/schemas/PlatformMemberCompanyConnectedPartnerBrnUnchangeableError' - $ref: '#/components/schemas/PlatformMemberCompanyConnectedPartnerTypeUnchangeableError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ACCOUNT_VERIFICATION_ALREADY_USED: '#/components/schemas/PlatformAccountVerificationAlreadyUsedError' PLATFORM_ACCOUNT_VERIFICATION_FAILED: '#/components/schemas/PlatformAccountVerificationFailedError' PLATFORM_ACCOUNT_VERIFICATION_NOT_FOUND: '#/components/schemas/PlatformAccountVerificationNotFoundError' PLATFORM_ARCHIVED_PARTNER: '#/components/schemas/PlatformArchivedPartnerError' PLATFORM_COMPANY_VERIFICATION_ALREADY_USED: '#/components/schemas/PlatformCompanyVerificationAlreadyUsedError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_INSUFFICIENT_DATA_TO_CHANGE_PARTNER_TYPE: '#/components/schemas/PlatformInsufficientDataToChangePartnerTypeError' PLATFORM_MEMBER_COMPANY_CONNECTED_PARTNER_BRN_UNCHANGEABLE: '#/components/schemas/PlatformMemberCompanyConnectedPartnerBrnUnchangeableError' PLATFORM_MEMBER_COMPANY_CONNECTED_PARTNER_TYPE_UNCHANGEABLE: '#/components/schemas/PlatformMemberCompanyConnectedPartnerTypeUnchangeableError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_USER_DEFINED_PROPERTY_NOT_FOUND: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPaymentMethodInput: title: 결제 수단 입력 정보 description: 결제 수단 입력 정보 type: object properties: card: $ref: '#/components/schemas/PlatformPaymentMethodCardInput' title: 카드 transfer: $ref: '#/components/schemas/PlatformPaymentMethodTransferInput' title: 계좌이체 virtualAccount: $ref: '#/components/schemas/PlatformPaymentMethodVirtualAccountInput' title: 가상계좌 giftCertificate: $ref: '#/components/schemas/PlatformPaymentMethodGiftCertificateInput' title: 상품권 mobile: $ref: '#/components/schemas/PlatformPaymentMethodMobileInput' title: 모바일 easyPay: $ref: '#/components/schemas/PlatformPaymentMethodEasyPayInput' title: 간편 결제 x-portone-title: 결제 수단 입력 정보 PlatformBulkAccountTransferStatus: title: PlatformBulkAccountTransferStatus type: string enum: - PREPARED - SCHEDULED - ONGOING - COMPLETED x-portone-enum: PREPARED: {} SCHEDULED: {} ONGOING: {} COMPLETED: {} PlatformPaymentMethodGiftCertificateInput: title: PlatformPaymentMethodGiftCertificateInput type: object PlatformPartnerSettlementFilterInput: title: PlatformPartnerSettlementFilterInput type: object properties: settlementDates: type: array items: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. contractIds: type: array items: type: string partnerTags: type: array items: type: string settlementCurrencies: title: 통화 type: array items: $ref: '#/components/schemas/Currency' statuses: title: 정산 상태 type: array items: $ref: '#/components/schemas/PlatformPartnerSettlementStatus' partnerIds: type: array items: type: string settlementTypes: title: 정산 유형 type: array items: $ref: '#/components/schemas/PlatformPartnerSettlementType' keyword: $ref: '#/components/schemas/PlatformPartnerSettlementFilterKeywordInput' UpdatePlatformDiscountSharePolicyBody: title: 할인 분담 정책 업데이트를 위한 입력 정보 description: '할인 분담 정책 업데이트를 위한 입력 정보 값이 명시되지 않은 필드는 업데이트하지 않습니다.' type: object properties: name: type: string title: 할인 분담 정책 이름 partnerShareRate: type: integer format: int32 title: 할인 분담율 description: 파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 `할인금액 * partnerShareRate * 10^5` 로 책정합니다. memo: type: string title: 해당 할인 분담에 대한 메모 x-portone-title: 할인 분담 정책 업데이트를 위한 입력 정보 x-portone-description: 값이 명시되지 않은 필드는 업데이트하지 않습니다. UpdatePlatformContractError: title: UpdatePlatformContractError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformArchivedContractError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ARCHIVED_CONTRACT: '#/components/schemas/PlatformArchivedContractError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' RescheduleDiscountSharePolicyError: title: RescheduleDiscountSharePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformAdditionalFeePolicyFilterInputKeyword: title: 검색 키워드 입력 정보 description: '검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 추가 수수료 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.' type: object properties: name: type: string description: 해당 값이 포함된 name 을 가진 추가 수수료 정책만 조회합니다. id: type: string description: 해당 값이 포함된 id 를 가진 추가 수수료 정책만 조회합니다. fee: type: string description: 해당 값과 같은 수수료 를 가진 추가 수수료 정책만 조회합니다. x-portone-title: 검색 키워드 입력 정보 x-portone-description: 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 추가 수수료 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다. CancelPlatformPartnerScheduleResponse: title: 파트너 예약 업데이트 취소 성공 응답 description: 파트너 예약 업데이트 취소 성공 응답 type: object x-portone-title: 파트너 예약 업데이트 취소 성공 응답 PlatformPartnerTypeIsNotBusinessError: title: 파트너 유형이 사업자가 아닌 경우 description: 파트너 유형이 사업자가 아닌 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너 유형이 사업자가 아닌 경우 x-portone-status-code: 400 PlatformOrderTransferAlreadyCancelledError: title: PlatformOrderTransferAlreadyCancelledError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 400 PlatformDiscountSharePolicyNotFoundError: title: PlatformDiscountSharePolicyNotFoundError type: object required: - type properties: type: type: string message: type: string x-portone-status-code: 404 GetPlatformPartnerSettlementsBody: title: 정산내역 다건 조회를 위한 입력 정보 description: 정산내역 다건 조회를 위한 입력 정보 type: object required: - filter properties: page: $ref: '#/components/schemas/PageInput' title: 요청할 페이지 정보 filter: $ref: '#/components/schemas/PlatformPartnerSettlementFilterInput' title: 조회할 정산내역 조건 필터 isForTest: type: boolean title: 테스트 모드 여부 description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' x-portone-title: 정산내역 다건 조회를 위한 입력 정보 ConnectBulkPartnerCounterpartyBody: title: 파트너 일괄 거래처 연동 요청 정보 description: '파트너 일괄 거래처 연동 요청 정보 파트너들을 일괄 거래처 연동합니다.' type: object properties: filter: $ref: '#/components/schemas/PlatformPartnerFilterInput' title: 일괄 거래처 연동할 파트너 조건 필터 x-portone-title: 파트너 일괄 거래처 연동 요청 정보 x-portone-description: 파트너들을 일괄 거래처 연동합니다. ReschedulePlatformPartnerResponse: title: 파트너 예약 업데이트 재설정 성공 응답 description: 파트너 예약 업데이트 재설정 성공 응답 type: object required: - scheduledPartner properties: scheduledPartner: $ref: '#/components/schemas/PlatformPartner' title: 예약된 파트너 정보 x-portone-title: 파트너 예약 업데이트 재설정 성공 응답 UpdatePlatformPartnerBodyAccount: title: 파트너 계좌 업데이트를 위한 입력 정보 description: 파트너 계좌 업데이트를 위한 입력 정보 type: object required: - bank - currency - number - holder properties: bank: $ref: '#/components/schemas/Bank' title: 은행 currency: $ref: '#/components/schemas/Currency' title: 정산에 사용할 통화 number: type: string title: 계좌번호 holder: type: string title: 예금주명 accountVerificationId: type: string title: 계좌 검증 아이디 x-portone-title: 파트너 계좌 업데이트를 위한 입력 정보 PlatformPartnerScheduleExistsError: title: 파트너 수정 예약 건이 존재하는 경우 description: 파트너 수정 예약 건이 존재하는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 파트너 수정 예약 건이 존재하는 경우 x-portone-status-code: 409 ReschedulePlatformContractBody: title: 계약 예약 업데이트 재설정을 위한 입력 정보 description: 계약 예약 업데이트 재설정을 위한 입력 정보 type: object required: - update - appliedAt properties: update: $ref: '#/components/schemas/UpdatePlatformContractBody' title: 반영할 업데이트 내용 appliedAt: type: string format: date-time title: 업데이트 적용 시점 x-portone-title: 계약 예약 업데이트 재설정을 위한 입력 정보 CancelPlatformDiscountSharePolicyScheduleError: title: CancelPlatformDiscountSharePolicyScheduleError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformAdditionalFeePolicyError: title: GetPlatformAdditionalFeePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' GetPlatformSettingError: title: GetPlatformSettingError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformTransferAlreadyExistsError: title: PlatformTransferAlreadyExistsError type: object required: - type - transferId - transferGraphqlId properties: type: type: string transferId: type: string transferGraphqlId: type: string message: type: string x-portone-status-code: 409 PlatformPartner: title: 파트너 description: '파트너 파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.' type: object required: - id - graphqlId - name - contact - account - status - defaultContractId - tags - type - isArchived - appliedAt - userDefinedProperties - isForTest properties: id: type: string title: 파트너 고유 아이디 graphqlId: type: string name: type: string title: 파트너 법인명 혹은 이름 contact: $ref: '#/components/schemas/PlatformContact' title: 파트너 담당자 연락 정보 account: $ref: '#/components/schemas/PlatformAccount' title: 정산 계좌 status: $ref: '#/components/schemas/PlatformPartnerStatus' title: 파트너의 상태 defaultContractId: type: string title: 파트너에 설정된 기본 계약 아이디 memo: type: string title: 파트너에 대한 메모 tags: type: array items: type: string title: 파트너의 태그 리스트 type: $ref: '#/components/schemas/PlatformPartnerType' title: 파트너 유형별 정보 isArchived: type: boolean title: 보관 여부 appliedAt: type: string format: date-time title: 변경 적용 시점 userDefinedProperties: $ref: '#/components/schemas/PlatformProperties' title: 사용자 정의 속성 isForTest: type: boolean x-portone-title: 파트너 x-portone-description: '파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.' CreatePlatformOrderTransferError: title: CreatePlatformOrderTransferError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePoliciesNotFoundError' - $ref: '#/components/schemas/PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError' - $ref: '#/components/schemas/PlatformContractNotFoundError' - $ref: '#/components/schemas/PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError' - $ref: '#/components/schemas/PlatformCurrencyNotSupportedError' - $ref: '#/components/schemas/PlatformDiscountSharePoliciesNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformPartnerNotFoundError' - $ref: '#/components/schemas/PlatformPaymentNotFoundError' - $ref: '#/components/schemas/PlatformProductIdDuplicatedError' - $ref: '#/components/schemas/PlatformSettlementAmountExceededError' - $ref: '#/components/schemas/PlatformSettlementDateEarlierThanSettlementStartDateError' - $ref: '#/components/schemas/PlatformSettlementParameterNotFoundError' - $ref: '#/components/schemas/PlatformSettlementPaymentAmountExceededPortOnePaymentError' - $ref: '#/components/schemas/PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError' - $ref: '#/components/schemas/PlatformSettlementTaxFreeAmountExceededPortOnePaymentError' - $ref: '#/components/schemas/PlatformTransferAlreadyExistsError' - $ref: '#/components/schemas/PlatformTransferIdAlreadyUsedError' - $ref: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICIES_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePoliciesNotFoundError' PLATFORM_ADDITIONAL_FIXED_AMOUNT_FEE_CURRENCY_AND_SETTLEMENT_CURRENCY_MISMATCHED: '#/components/schemas/PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError' PLATFORM_CONTRACT_NOT_FOUND: '#/components/schemas/PlatformContractNotFoundError' PLATFORM_CONTRACT_PLATFORM_FIXED_AMOUNT_FEE_CURRENCY_AND_SETTLEMENT_CURRENCY_MISMATCHED: '#/components/schemas/PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError' PLATFORM_CURRENCY_NOT_SUPPORTED: '#/components/schemas/PlatformCurrencyNotSupportedError' PLATFORM_DISCOUNT_SHARE_POLICIES_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePoliciesNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_PARTNER_NOT_FOUND: '#/components/schemas/PlatformPartnerNotFoundError' PLATFORM_PAYMENT_NOT_FOUND: '#/components/schemas/PlatformPaymentNotFoundError' PLATFORM_PRODUCT_ID_DUPLICATED: '#/components/schemas/PlatformProductIdDuplicatedError' PLATFORM_SETTLEMENT_AMOUNT_EXCEEDED: '#/components/schemas/PlatformSettlementAmountExceededError' PLATFORM_SETTLEMENT_DATE_EARLIER_THAN_SETTLEMENT_START_DATE: '#/components/schemas/PlatformSettlementDateEarlierThanSettlementStartDateError' PLATFORM_SETTLEMENT_PARAMETER_NOT_FOUND: '#/components/schemas/PlatformSettlementParameterNotFoundError' PLATFORM_SETTLEMENT_PAYMENT_AMOUNT_EXCEEDED_PORT_ONE_PAYMENT: '#/components/schemas/PlatformSettlementPaymentAmountExceededPortOnePaymentError' PLATFORM_SETTLEMENT_SUPPLY_WITH_VAT_AMOUNT_EXCEEDED_PORT_ONE_PAYMENT: '#/components/schemas/PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError' PLATFORM_SETTLEMENT_TAX_FREE_AMOUNT_EXCEEDED_PORT_ONE_PAYMENT: '#/components/schemas/PlatformSettlementTaxFreeAmountExceededPortOnePaymentError' PLATFORM_TRANSFER_ALREADY_EXISTS: '#/components/schemas/PlatformTransferAlreadyExistsError' PLATFORM_TRANSFER_ID_ALREADY_USED: '#/components/schemas/PlatformTransferIdAlreadyUsedError' PLATFORM_USER_DEFINED_PROPERTY_NOT_FOUND: '#/components/schemas/PlatformUserDefinedPropertyNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformPartnerOrderCancelSettlement: title: PlatformPartnerOrderCancelSettlement type: object required: - type - id - graphqlId - partner - settlementDate - settlementCurrency - status - contract - settlementStartDateRange - amount - isForTest properties: type: type: string id: type: string title: 정산내역 아이디 graphqlId: type: string partner: $ref: '#/components/schemas/PlatformPartner' title: 파트너 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 일 settlementCurrency: $ref: '#/components/schemas/Currency' title: 정산 통화 status: $ref: '#/components/schemas/PlatformPartnerSettlementStatus' title: 정산 상태 statusUpdatedAt: type: string format: date-time title: 상태 업데이트 일시 memo: type: string title: 메모 contract: $ref: '#/components/schemas/PlatformContract' title: 계약 settlementStartDateRange: $ref: '#/components/schemas/DateRange' title: 정산 시작 일 범위 amount: $ref: '#/components/schemas/PlatformOrderSettlementAmount' title: 금액 정보 isForTest: type: boolean title: 테스트 모드 여부 GetPlatformTransferSummariesError: title: GetPlatformTransferSummariesError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformSettlementCycleDatePolicy: title: 플랫폼 정산 기준일 description: 플랫폼 정산 기준일 type: string enum: - HOLIDAY_BEFORE - HOLIDAY_AFTER - CALENDAR_DAY x-portone-title: 플랫폼 정산 기준일 x-portone-enum: HOLIDAY_BEFORE: title: 공휴일 전 영업일 HOLIDAY_AFTER: title: 공휴일 후 영업일 CALENDAR_DAY: title: 달력일 UpdatePlatformSettingBody: title: 플랫폼 설정 업데이트를 위한 입력 정보 description: 플랫폼 설정 업데이트를 위한 입력 정보 type: object properties: defaultWithdrawalMemo: type: string title: 기본 보내는 이 통장 메모 defaultDepositMemo: type: string title: 기본 받는 이 통장 메모 supportsMultipleOrderTransfersPerPartner: type: boolean title: paymentId, storeId, partnerId가 같은 주문 정산건에 대한 중복 정산 지원 여부 adjustSettlementDateAfterHolidayIfEarlier: type: boolean title: 정산일이 정산시작일보다 작거나 같을 경우 공휴일 후 영업일로 정산일 다시 계산 여부 deductWht: type: boolean title: 지급 금액에서 원천징수세 차감 여부 settlementAmountType: $ref: '#/components/schemas/SettlementAmountType' title: 정산 금액 취급 기준 manualSettlementPerTransfer: type: boolean title: 수기정산을 정산 건별로 정산내역/지급내역으로 생성 x-portone-title: 플랫폼 설정 업데이트를 위한 입력 정보 PlatformAdditionalFeePoliciesNotFoundError: title: PlatformAdditionalFeePoliciesNotFoundError type: object required: - type - ids - graphqlIds properties: type: type: string ids: type: array items: type: string graphqlIds: type: array items: type: string message: type: string x-portone-status-code: 404 CreatePlatformPartnerBodyTypeNonWhtPayer: title: CreatePlatformPartnerBodyTypeNonWhtPayer type: object properties: birthdate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 생년월일 PlatformPartnerSettlementType: title: 정산 유형 description: 정산 유형 type: string enum: - MANUAL - ORDER - ORDER_CANCEL x-portone-title: 정산 유형 x-portone-enum: MANUAL: title: 수동 정산 ORDER: title: 주문 정산 ORDER_CANCEL: title: 주문 취소 정산 PlatformPortOnePayment: title: 포트원 결제 정보 description: 포트원 결제 정보 type: object required: - type - id - storeId - channelKey - orderName - currency - paidAt properties: type: type: string id: type: string title: 결제 아이디 storeId: type: string title: 상점 아이디 channelKey: type: string title: 채널 키 orderName: type: string title: 주문 명 method: $ref: '#/components/schemas/PlatformPaymentMethod' title: 결제 수단 currency: $ref: '#/components/schemas/Currency' title: 통화 paidAt: type: string format: date-time title: 결제 일시 x-portone-title: 포트원 결제 정보 ArchivePlatformAdditionalFeePolicyError: title: ArchivePlatformAdditionalFeePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' - $ref: '#/components/schemas/PlatformCannotArchiveScheduledAdditionalFeePolicyError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ADDITIONAL_FEE_POLICY_NOT_FOUND: '#/components/schemas/PlatformAdditionalFeePolicyNotFoundError' PLATFORM_CANNOT_ARCHIVE_SCHEDULED_ADDITIONAL_FEE_POLICY: '#/components/schemas/PlatformCannotArchiveScheduledAdditionalFeePolicyError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformAdditionalFeePolicyFilterInput: title: 추가 수수료 정책 다건 조회를 위한 필터 조건 description: 추가 수수료 정책 다건 조회를 위한 필터 조건 type: object properties: isArchived: type: boolean title: 보관 조회 여부 description: true 이면 보관된 추가 수수료 정책의 필터 옵션을 조회하고, false 이면 보관되지 않은 추가 수수료 정책의 필터 옵션을 조회합니다. 기본값은 false 입니다. vatPayers: title: 금액 부담 주체 type: array items: $ref: '#/components/schemas/PlatformPayer' description: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 부가세 부담 주체에 해당하는 추가 수수료 정책만 조회합니다. keyword: $ref: '#/components/schemas/PlatformAdditionalFeePolicyFilterInputKeyword' title: 검색 키워드 x-portone-title: 추가 수수료 정책 다건 조회를 위한 필터 조건 PlatformPartnerTypeBusiness: title: 사업자 파트너 정보 description: '사업자 파트너 정보 사업자 유형의 파트너 추가 정보 입니다.' type: object required: - type - companyName - taxationType - businessStatus - businessRegistrationNumber - representativeName - memberCompanyConnectionStatus properties: type: type: string companyName: type: string title: 상호명 taxationType: $ref: '#/components/schemas/PlatformPartnerTaxationType' title: 과세 유형 businessStatus: $ref: '#/components/schemas/PlatformPartnerBusinessStatus' title: 사업자 상태 businessRegistrationNumber: type: string title: 사업자등록번호 representativeName: type: string title: 대표자 이름 companyAddress: type: string title: 사업장 주소 businessType: type: string title: 업태 businessClass: type: string title: 업종 memberCompanyConnectionStatus: $ref: '#/components/schemas/PlatformPartnerMemberCompanyConnectionStatus' title: 연동사업자 연동 상태 memberCompanyConnectionFailedReason: type: string title: 연동사업자 연동 실패 사유 x-portone-title: 사업자 파트너 정보 x-portone-description: 사업자 유형의 파트너 추가 정보 입니다. GetPlatformAdditionalFeePoliciesResponse: title: 추가 수수료 정책 다건 조회 성공 응답 정보 description: 추가 수수료 정책 다건 조회 성공 응답 정보 type: object required: - items - page properties: items: title: 조회된 추가 수수료 정책 리스트 type: array items: $ref: '#/components/schemas/PlatformAdditionalFeePolicy' page: $ref: '#/components/schemas/PageInfo' title: 조회된 페이지 정보 x-portone-title: 추가 수수료 정책 다건 조회 성공 응답 정보 GetPlatformDiscountSharePolicyError: title: GetPlatformDiscountSharePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformSetting: title: 플랫폼 설정 description: 플랫폼 설정 type: object required: - supportsMultipleOrderTransfersPerPartner - adjustSettlementDateAfterHolidayIfEarlier - deductWht - settlementAmountType - isForTest - manualSettlementPerTransfer properties: defaultWithdrawalMemo: type: string title: 기본 보내는 이 통장 메모 defaultDepositMemo: type: string title: 기본 받는 이 통장 메모 supportsMultipleOrderTransfersPerPartner: type: boolean title: paymentId, storeId, partnerId가 같은 주문 정산건에 대한 중복 정산 지원 여부 adjustSettlementDateAfterHolidayIfEarlier: type: boolean title: 정산일이 정산시작일보다 작거나 같을 경우 공휴일 후 영업일로 정산일 다시 계산 여부 deductWht: type: boolean title: 지급 금액에서 원천징수세 차감 여부 settlementAmountType: $ref: '#/components/schemas/SettlementAmountType' title: 정산 금액 취급 기준 isForTest: type: boolean manualSettlementPerTransfer: type: boolean title: 수기정산을 정산 건별로 정산내역/지급내역으로 생성 x-portone-title: 플랫폼 설정 UpdatePlatformAdditionalFeePolicyBody: title: 추가 수수료 정책 업데이트를 위한 입력 정보 description: '추가 수수료 정책 업데이트를 위한 입력 정보 값이 명시하지 않은 필드는 업데이트되지 않습니다.' type: object properties: fee: $ref: '#/components/schemas/PlatformFeeInput' title: 책정 수수료 name: type: string title: 추가 수수료 정책 이름 memo: type: string title: 해당 추가 수수료 정책에 대한 메모 vatPayer: $ref: '#/components/schemas/PlatformPayer' title: 부가세를 부담할 주체 x-portone-title: 추가 수수료 정책 업데이트를 위한 입력 정보 x-portone-description: 값이 명시하지 않은 필드는 업데이트되지 않습니다. PlatformBulkTask: title: PlatformBulkTask type: object required: - id - graphqlId - status - type - progressStats - isForTest - statusUpdatedAt - createdAt - updatedAt properties: id: type: string graphqlId: type: string status: $ref: '#/components/schemas/PlatformBulkTaskStatus' type: $ref: '#/components/schemas/PlatformBulkTaskType' progressStats: $ref: '#/components/schemas/PlatformBulkTaskProgressStats' isForTest: type: boolean statusUpdatedAt: type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time CreatePlatformOrderTransferBody: title: 주문 정산건 생성을 위한 입력 정보 description: 주문 정산건 생성을 위한 입력 정보 type: object required: - partnerId - paymentId - orderDetail - discounts - additionalFees properties: partnerId: type: string title: 파트너 아이디 contractId: type: string title: 계약 아이디 description: 기본값은 파트너의 기본 계약 아이디 입니다. memo: type: string title: 메모 paymentId: type: string title: 결제 아이디 orderDetail: $ref: '#/components/schemas/CreatePlatformOrderTransferBodyOrderDetail' title: 주문 정보 taxFreeAmount: type: integer format: int64 title: 주문 면세 금액 description: 주문 항목과 면세 금액을 같이 전달하시면 최종 면세 금액은 주문 항목의 면세 금액이 아닌 전달해주신 면세 금액으로 적용됩니다. settlementStartDate: description: 기본값은 결제 일시 입니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 시작일 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산일 discounts: title: 할인 정보 type: array items: $ref: '#/components/schemas/CreatePlatformOrderTransferBodyDiscount' additionalFees: title: 추가 수수료 정보 type: array items: $ref: '#/components/schemas/CreatePlatformOrderTransferBodyAdditionalFee' externalPaymentDetail: $ref: '#/components/schemas/CreatePlatformOrderTransferBodyExternalPaymentDetail' title: 외부 결제 상세 정보 description: 해당 정보가 존재하는 경우 외부 결제 정산건 으로 등록되고, 존재하지않은 경우 포트원 결제 정산건으로 등록됩니다. isForTest: type: boolean title: 테스트 모드 여부 description: 'Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.' parameters: $ref: '#/components/schemas/TransferParameters' title: 정산 파라미터 (실험기능) userDefinedProperties: title: 사용자 정의 속성 type: array items: $ref: '#/components/schemas/PlatformUserDefinedPropertyKeyValue' id: type: string title: 생성할 정산건 아이디 description: 명시하지 않으면 id 가 임의로 생성됩니다. x-portone-title: 주문 정산건 생성을 위한 입력 정보 PlatformSettlementCycleMethodWeeklyInput: title: PlatformSettlementCycleMethodWeeklyInput type: object required: - daysOfWeek properties: daysOfWeek: title: 요일 type: array items: $ref: '#/components/schemas/DayOfWeek' GetPlatformTransferError: title: GetPlatformTransferError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/PlatformTransferNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' PLATFORM_TRANSFER_NOT_FOUND: '#/components/schemas/PlatformTransferNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' InvalidRequestError: title: 요청된 입력 정보가 유효하지 않은 경우 description: '요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.' type: object required: - type properties: type: type: string message: type: string x-portone-title: 요청된 입력 정보가 유효하지 않은 경우 x-portone-description: 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다. x-portone-status-code: 400 ScheduleDiscountSharePolicyError: title: ScheduleDiscountSharePolicyError oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PlatformArchivedDiscountSharePolicyError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' - $ref: '#/components/schemas/PlatformDiscountSharePolicyScheduleAlreadyExistsError' - $ref: '#/components/schemas/PlatformNotEnabledError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: FORBIDDEN: '#/components/schemas/ForbiddenError' INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PLATFORM_ARCHIVED_DISCOUNT_SHARE_POLICY: '#/components/schemas/PlatformArchivedDiscountSharePolicyError' PLATFORM_DISCOUNT_SHARE_POLICY_NOT_FOUND: '#/components/schemas/PlatformDiscountSharePolicyNotFoundError' PLATFORM_DISCOUNT_SHARE_POLICY_SCHEDULE_ALREADY_EXISTS: '#/components/schemas/PlatformDiscountSharePolicyScheduleAlreadyExistsError' PLATFORM_NOT_ENABLED: '#/components/schemas/PlatformNotEnabledError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' PlatformDuplicatedPartnerSettlementIdsError: title: 선택된 정산건 아이디에 중복이 있는 경우 description: 선택된 정산건 아이디에 중복이 있는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 선택된 정산건 아이디에 중복이 있는 경우 x-portone-status-code: 400 PlatformPartnerOrderSettlement: title: PlatformPartnerOrderSettlement type: object required: - type - id - graphqlId - partner - settlementDate - settlementCurrency - status - contract - settlementStartDateRange - amount - isForTest properties: type: type: string id: type: string title: 정산내역 아이디 graphqlId: type: string partner: $ref: '#/components/schemas/PlatformPartner' title: 파트너 settlementDate: description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. type: string format: date x-portone-description: 날짜를 나타내는 문자열로, `yyyy-MM-dd` 형식을 따릅니다. title: 정산 일 settlementCurrency: $ref: '#/components/schemas/Currency' title: 정산 통화 status: $ref: '#/components/schemas/PlatformPartnerSettlementStatus' title: 정산 상태 statusUpdatedAt: type: string format: date-time title: 상태 업데이트 일시 memo: type: string title: 메모 contract: $ref: '#/components/schemas/PlatformContract' title: 계약 settlementStartDateRange: $ref: '#/components/schemas/DateRange' title: 정산 시작 일 범위 amount: $ref: '#/components/schemas/PlatformOrderSettlementAmount' title: 금액 정보 isForTest: type: boolean title: 테스트 모드 여부 CreatePlatformOrderTransferBodyDiscount: title: 할인 정보 description: 할인 정보 type: object required: - sharePolicyId - amount properties: sharePolicyId: type: string title: 할인 분담 정책 아이디 amount: type: integer format: int64 title: 할인 금액 taxFreeAmount: type: integer format: int64 title: 면세 할인 금액 x-portone-title: 할인 정보 PlatformSettlementCycleMethodMonthlyInput: title: PlatformSettlementCycleMethodMonthlyInput type: object required: - daysOfMonth properties: daysOfMonth: type: array items: type: integer format: int32 securitySchemes: bearerJwt: type: http description: 'Authorization: Bearer `엑세스 토큰`' scheme: bearer portOne: type: http description: 'Authorization: PortOne `발급된 API 시크릿`' scheme: portone x-portone-categories: - id: payment title: 결제 관련 API description: 결제와 관련된 API 기능을 제공합니다. children: - id: payment.paymentSchedule title: 결제 예약 관련 API description: 결제 예약과 관련된 API 기능을 제공합니다. - id: payment.billingKey title: 빌링키 관련 API description: 빌링키와 관련된 API 기능을 제공합니다. - id: payment.cashReceipt title: 현금 영수증 관련 API description: 현금 영수증과 관련된 API 기능을 제공합니다. - id: payment.promotion title: 프로모션 관련 API description: 프로모션과 관련된 API 기능을 제공합니다. - id: payment.additionalFeature title: 결제 부가기능 관련 API description: 결제 부가기능과 관련된 API 기능을 제공합니다. - id: identityVerification title: 본인인증 관련 API description: 본인인증과 관련된 API 기능을 제공합니다. - id: pgSpecific title: 특정 PG사 관련 API description: 특정 PG사에 국한된 API 기능을 제공합니다. - id: reconciliation title: 대사 서비스 API description: 거래 대사 및 정산 대사 관련 API 기능을 제공합니다. - id: b2b title: 세금계산서 API description: 세금계산서 API 기능을 제공합니다. children: - id: b2b.counterparty title: 거래처 관련 API description: 거래처 관련 API 기능을 제공합니다. - id: b2b.taxInvoice title: 세금계산서 발행 관련 API description: 세금계산서 발행 관련 API 기능을 제공합니다. - id: platform title: 파트너 정산 관련 API description: 파트너 정산 서비스 API 기능을 제공합니다. children: - id: platform.policy title: 정책 관련 API description: 파트너 정산에 적용할 정책에 관한 API 입니다. - id: platform.partner title: 파트너 관련 API description: 파트너 정산에 적용할 파트너에 관한 API 입니다. - id: platform.transfer title: 정산 상세내역 관련 API description: 파트너 정산 서비스의 정산 상세내역과 관련된 API 입니다. - id: platform.account title: 계좌 관련 API description: 파트너 정산 서비스의 계좌와 관련된 API 입니다. - id: platform.partnerSettlement title: 정산 내역 관련 API description: 파트너 정산 서비스의 정산 내역과 관련된 API 입니다. - id: platform.payout title: 지급 내역 관련 API description: 파트너 정산 서비스의 지급 내역과 관련된 API 입니다. - id: platform.bulkPayout title: 일괄 지급 내역 관련 API description: 파트너 정산 서비스의 일괄 지급 내역과 관련된 API 입니다. - id: platform.accountTransfer title: 이체 내역 관련 API description: 파트너 정산 서비스의 이체 내역과 관련된 API 입니다. - id: platform.bulkAccountTransfer title: 일괄 이체 내역 관련 API description: 파트너 정산 서비스의 일괄 이체 내역과 관련된 API 입니다. - id: platform.company title: 사업자 관련 API description: 파트너 정산 서비스의 사업자와 관련된 API 입니다. - id: auth title: 인증 관련 API description: '인증과 관련된 API 기능을 제공합니다. 접근 토큰 방식으로 인증하기를 원하는 경우, API 시크릿을 통해 토큰을 발급받은 후 Authorization 헤더에 `Bearer ACCESS_TOKEN` 형식으로 전달합니다.' - id: paymentSession title: 결제 세션 API description: 결제 세션 생성 및 관리 API. 호스티드 체크아웃에 사용됩니다. - id: checkoutProfile title: 체크아웃 프로필 API description: 체크아웃 프로필에서 결제 수단 목록을 조회하기 위한 API. - id: ap title: AP API description: AP 기능을 제공합니다. - id: common title: 공통 API description: 공통 API 기능을 제공합니다.