openapi: 3.0.3
info:
  title: PortOne B2b Payments API
  version: 1.16.0
servers:
- url: https://api.portone.io
  description: 운영환경 서버
tags:
- name: Payments
paths:
  /payments/{paymentId}/billing-key:
    post:
      summary: 빌링키 결제
      description: '빌링키 결제


        빌링키로 결제를 진행합니다.'
      operationId: payWithBillingKey
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingKeyPaymentInput'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayWithBillingKeyResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우

            * `PromotionPayMethodDoesNotMatchError`: 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우

            * `DiscountAmountExceedsTotalAmountError`: 프로모션 할인 금액이 결제 시도 금액 이상인 경우

            * `MaxTransactionCountReachedError`: 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayWithBillingKeyError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayWithBillingKeyError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayWithBillingKeyError'
        '404':
          description: '* `BillingKeyNotFoundError`: 빌링키가 존재하지 않는 경우

            * `ChannelNotFoundError`: 요청된 채널이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayWithBillingKeyError'
        '409':
          description: '* `AlreadyPaidError`: 결제가 이미 완료된 경우

            * `SumOfPartsExceedsTotalAmountError`: 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우

            * `BillingKeyAlreadyDeletedError`: 빌링키가 이미 삭제된 경우

            * `PaymentScheduleAlreadyExistsError`: 결제 예약건이 이미 존재하는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayWithBillingKeyError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayWithBillingKeyError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 빌링키 결제
      x-portone-description: 빌링키로 결제를 진행합니다.
      x-portone-error:
        $ref: '#/components/schemas/PayWithBillingKeyError'
      tags:
      - Payments
  /payments/{paymentId}/cancel:
    post:
      summary: 결제 취소
      description: '결제 취소


        결제 취소를 요청합니다.'
      operationId: cancelPayment
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelPaymentBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우

            * `NegativePromotionAdjustedCancelAmountError`: 프로모션에 의해 조정된 취소 금액이 음수인 경우

            * `PromotionDiscountRetainOptionShouldNotBeChangedError`: 프로모션 혜택 유지 옵션을 이전 부분 취소와 다른 것으로 입력한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentError'
        '409':
          description: '* `PaymentNotPaidError`: 결제가 완료되지 않은 경우

            * `PaymentAlreadyCancelledError`: 결제가 이미 취소된 경우

            * `CancellableAmountConsistencyBrokenError`: 취소 가능 잔액 검증에 실패한 경우

            * `CancelAmountExceedsCancellableAmountError`: 결제 취소 금액이 취소 가능 금액을 초과한 경우

            * `SumOfPartsExceedsCancelAmountError`: 면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우

            * `CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError`: 취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우

            * `CancelTaxAmountExceedsCancellableTaxAmountError`: 취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우

            * `MaxCancelCountReachedError`: 취소 시도 횟수가 초과된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 결제 취소
      x-portone-description: 결제 취소를 요청합니다.
      x-portone-error:
        $ref: '#/components/schemas/CancelPaymentError'
      tags:
      - Payments
  /payments/{paymentId}/cancellations/{cancellationId}/stop:
    post:
      summary: 결제 취소 요청 취소
      description: '결제 취소 요청 취소


        비동기적으로 수행되는 결제 취소 요청을 취소합니다.

        Triple-A에서만 사용됩니다.'
      operationId: stopPaymentCancellation
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      - name: cancellationId
        in: path
        description: 취소 요청 아이디
        required: true
        schema:
          type: string
        x-portone-title: 취소 요청 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopPaymentCancellationBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopPaymentCancellationResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopPaymentCancellationError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopPaymentCancellationError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopPaymentCancellationError'
        '404':
          description: '* `PaymentCancellationNotFoundError`: 결제 취소 내역이 존재하지 않는 경우

            * `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopPaymentCancellationError'
        '409':
          description: '* `PaymentCancellationNotPendingError`: 결제 취소 내역이 취소 요청 상태가 아닌 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopPaymentCancellationError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopPaymentCancellationError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 결제 취소 요청 취소
      x-portone-description: '비동기적으로 수행되는 결제 취소 요청을 취소합니다.

        Triple-A에서만 사용됩니다.'
      x-portone-error:
        $ref: '#/components/schemas/StopPaymentCancellationError'
      tags:
      - Payments
  /payments/{paymentId}/capture:
    post:
      summary: 수동 매입
      description: '수동 매입


        수동 매입을 요청합니다. PG 및 포트원과의 사전 협의가 필요합니다.'
      operationId: capturePayment
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CapturePaymentBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapturePaymentResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapturePaymentError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapturePaymentError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapturePaymentError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapturePaymentError'
        '409':
          description: '* `PaymentNotPaidError`: 결제가 완료되지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapturePaymentError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapturePaymentError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 수동 매입
      x-portone-description: 수동 매입을 요청합니다. PG 및 포트원과의 사전 협의가 필요합니다.
      x-portone-error:
        $ref: '#/components/schemas/CapturePaymentError'
      tags:
      - Payments
  /payments/{paymentId}/cash-receipt/cancel:
    post:
      summary: 현금 영수증 취소
      description: '현금 영수증 취소


        현금 영수증 취소를 요청합니다.'
      operationId: cancelCashReceiptByPaymentId
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      - name: storeId
        in: query
        description: '상점 아이디


          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.'
        required: false
        schema:
          type: string
        x-portone-title: 상점 아이디
        x-portone-description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelCashReceiptResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelCashReceiptError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelCashReceiptError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelCashReceiptError'
        '404':
          description: '* `CashReceiptNotIssuedError`: 현금영수증이 발급되지 않은 경우

            * `CashReceiptNotFoundError`: 현금영수증이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelCashReceiptError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelCashReceiptError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment.cashReceipt
      x-portone-title: 현금 영수증 취소
      x-portone-description: 현금 영수증 취소를 요청합니다.
      x-portone-error:
        $ref: '#/components/schemas/CancelCashReceiptError'
      tags:
      - Payments
  /payments/{paymentId}/cash-receipt:
    get:
      summary: 현금 영수증 단건 조회
      description: '현금 영수증 단건 조회


        주어진 결제 아이디에 대응되는 현금 영수증 내역을 조회합니다.'
      operationId: getCashReceiptByPaymentId
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      - name: storeId
        in: query
        description: '상점 아이디


          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.'
        required: false
        schema:
          type: string
        x-portone-title: 상점 아이디
        x-portone-description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
      responses:
        '200':
          description: 성공 응답으로 현금 영수증 객체를 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashReceipt'
          x-portone-description: 성공 응답으로 현금 영수증 객체를 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCashReceiptError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCashReceiptError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCashReceiptError'
        '404':
          description: '* `CashReceiptNotFoundError`: 현금영수증이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCashReceiptError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment.cashReceipt
      x-portone-title: 현금 영수증 단건 조회
      x-portone-description: 주어진 결제 아이디에 대응되는 현금 영수증 내역을 조회합니다.
      x-portone-error:
        $ref: '#/components/schemas/GetCashReceiptError'
      tags:
      - Payments
  /payments/{paymentId}/confirm:
    post:
      summary: 인증 결제 수동 승인
      description: '인증 결제 수동 승인


        수동 승인으로 설정된 인증 결제에 대해, 결제를 완료 처리합니다.'
      operationId: confirmPayment
      parameters:
      - name: paymentId
        in: path
        description: 결제 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 아이디
      requestBody:
        description: 결제 승인 요청 정보
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmPaymentBody'
        required: true
        x-portone-title: 결제 승인 요청 정보
      responses:
        '200':
          description: 성공 응답으로 결제 승인 결과를 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmedPaymentSummary'
          x-portone-title: 성공 응답으로 결제 승인 결과를 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우

            * `InvalidPaymentTokenError`: 유효하지 않은 결제 토큰인 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmPaymentError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmPaymentError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmPaymentError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmPaymentError'
        '409':
          description: '* `AlreadyPaidError`: 결제가 이미 완료된 경우

            * `InformationMismatchError`: 정보가 일치하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmPaymentError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmPaymentError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 인증 결제 수동 승인
      x-portone-description: 수동 승인으로 설정된 인증 결제에 대해, 결제를 완료 처리합니다.
      x-portone-error:
        $ref: '#/components/schemas/ConfirmPaymentError'
      tags:
      - Payments
  /payments/{paymentId}/escrow/complete:
    post:
      summary: 에스크로 구매 확정
      description: '에스크로 구매 확정


        에스크로 결제를 구매 확정 처리합니다'
      operationId: confirmEscrow
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmEscrowBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmEscrowResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmEscrowError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmEscrowError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmEscrowError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmEscrowError'
        '409':
          description: '* `PaymentNotPaidError`: 결제가 완료되지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmEscrowError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmEscrowError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 에스크로 구매 확정
      x-portone-description: 에스크로 결제를 구매 확정 처리합니다
      x-portone-error:
        $ref: '#/components/schemas/ConfirmEscrowError'
      tags:
      - Payments
  /payments/{paymentId}/escrow/logistics:
    post:
      summary: 에스크로 배송 정보 등록
      description: '에스크로 배송 정보 등록


        에스크로 배송 정보를 등록합니다.'
      operationId: applyEscrowLogistics
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterEscrowLogisticsBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyEscrowLogisticsResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyEscrowLogisticsError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyEscrowLogisticsError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyEscrowLogisticsError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyEscrowLogisticsError'
        '409':
          description: '* `PaymentNotPaidError`: 결제가 완료되지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyEscrowLogisticsError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyEscrowLogisticsError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 에스크로 배송 정보 등록
      x-portone-description: 에스크로 배송 정보를 등록합니다.
      x-portone-error:
        $ref: '#/components/schemas/ApplyEscrowLogisticsError'
      tags:
      - Payments
    patch:
      summary: 에스크로 배송 정보 수정
      description: '에스크로 배송 정보 수정


        에스크로 배송 정보를 수정합니다.'
      operationId: modifyEscrowLogistics
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyEscrowLogisticsBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyEscrowLogisticsResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyEscrowLogisticsError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyEscrowLogisticsError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyEscrowLogisticsError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyEscrowLogisticsError'
        '409':
          description: '* `PaymentNotPaidError`: 결제가 완료되지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyEscrowLogisticsError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyEscrowLogisticsError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 에스크로 배송 정보 수정
      x-portone-description: 에스크로 배송 정보를 수정합니다.
      x-portone-error:
        $ref: '#/components/schemas/ModifyEscrowLogisticsError'
      tags:
      - Payments
  /payments/{paymentId}/instant:
    post:
      summary: 수기 결제
      description: '수기 결제


        카드 비인증 결제 또는 가상 계좌 발급을 API로 요청합니다.'
      operationId: payInstantly
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstantPaymentInput'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayInstantlyResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우

            * `PromotionPayMethodDoesNotMatchError`: 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우

            * `DiscountAmountExceedsTotalAmountError`: 프로모션 할인 금액이 결제 시도 금액 이상인 경우

            * `MaxTransactionCountReachedError`: 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayInstantlyError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayInstantlyError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayInstantlyError'
        '404':
          description: '* `ChannelNotFoundError`: 요청된 채널이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayInstantlyError'
        '409':
          description: '* `AlreadyPaidError`: 결제가 이미 완료된 경우

            * `SumOfPartsExceedsTotalAmountError`: 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우

            * `PaymentScheduleAlreadyExistsError`: 결제 예약건이 이미 존재하는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayInstantlyError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayInstantlyError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 수기 결제
      x-portone-description: 카드 비인증 결제 또는 가상 계좌 발급을 API로 요청합니다.
      x-portone-error:
        $ref: '#/components/schemas/PayInstantlyError'
      tags:
      - Payments
  /payments/{paymentId}/pre-register:
    post:
      summary: 결제 정보 사전 등록
      description: '결제 정보 사전 등록


        결제 정보를 사전 등록합니다.'
      operationId: preRegisterPayment
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreRegisterPaymentBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreRegisterPaymentResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreRegisterPaymentError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreRegisterPaymentError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreRegisterPaymentError'
        '409':
          description: '* `AlreadyPaidError`: 결제가 이미 완료된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreRegisterPaymentError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 결제 정보 사전 등록
      x-portone-description: 결제 정보를 사전 등록합니다.
      x-portone-error:
        $ref: '#/components/schemas/PreRegisterPaymentError'
      tags:
      - Payments
  /payments/{paymentId}/register-store-receipt:
    post:
      summary: 영수증 내 하위 상점 거래 등록
      description: '영수증 내 하위 상점 거래 등록


        결제 내역 매출전표에 하위 상점의 거래를 등록합니다.

        지원되는 PG사:

        KG이니시스(이용 전 콘솔 -> 결제연동 탭에서 INIApi Key 등록 필요)'
      operationId: registerStoreReceipt
      parameters:
      - name: paymentId
        in: path
        description: 등록할 하위 상점 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 등록할 하위 상점 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterStoreReceiptBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterStoreReceiptResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterStoreReceiptError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterStoreReceiptError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterStoreReceiptError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterStoreReceiptError'
        '409':
          description: '* `PaymentNotPaidError`: 결제가 완료되지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterStoreReceiptError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterStoreReceiptError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 영수증 내 하위 상점 거래 등록
      x-portone-description: '결제 내역 매출전표에 하위 상점의 거래를 등록합니다.

        지원되는 PG사:

        KG이니시스(이용 전 콘솔 -> 결제연동 탭에서 INIApi Key 등록 필요)'
      x-portone-error:
        $ref: '#/components/schemas/RegisterStoreReceiptError'
      tags:
      - Payments
  /payments/{paymentId}/resend-webhook:
    post:
      summary: 웹훅 재발송
      description: '웹훅 재발송


        웹훅을 재발송합니다.'
      operationId: resendWebhook
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResendWebhookBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResendWebhookResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우

            * `MaxWebhookRetryCountReachedError`: 동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResendWebhookError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResendWebhookError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResendWebhookError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우

            * `WebhookNotFoundError`: 웹훅 내역이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResendWebhookError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 웹훅 재발송
      x-portone-description: 웹훅을 재발송합니다.
      x-portone-error:
        $ref: '#/components/schemas/ResendWebhookError'
      tags:
      - Payments
  /payments/{paymentId}/schedule:
    post:
      summary: 결제 예약
      description: '결제 예약


        결제를 예약합니다.'
      operationId: createPaymentSchedule
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentScheduleBody'
        required: true
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentScheduleResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentScheduleError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentScheduleError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentScheduleError'
        '404':
          description: '* `BillingKeyNotFoundError`: 빌링키가 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentScheduleError'
        '409':
          description: '* `AlreadyPaidOrWaitingError`: 결제가 이미 완료되었거나 대기중인 경우

            * `SumOfPartsExceedsTotalAmountError`: 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우

            * `BillingKeyAlreadyDeletedError`: 빌링키가 이미 삭제된 경우

            * `PaymentScheduleAlreadyExistsError`: 결제 예약건이 이미 존재하는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentScheduleError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment.paymentSchedule
      x-portone-title: 결제 예약
      x-portone-description: 결제를 예약합니다.
      x-portone-error:
        $ref: '#/components/schemas/CreatePaymentScheduleError'
      tags:
      - Payments
  /payments/{paymentId}/transactions:
    get:
      summary: 결제 시도 내역 조회
      description: '결제 시도 내역 조회


        주어진 아이디에 대응되는 결제 건의 결제 시도 내역을 조회합니다.'
      operationId: getPaymentTransactions
      parameters:
      - name: paymentId
        in: path
        description: 조회할 결제 아이디
        required: true
        schema:
          type: string
        x-portone-title: 조회할 결제 아이디
      - name: storeId
        in: query
        description: 상점 아이디
        required: false
        schema:
          type: string
        x-portone-title: 상점 아이디
      responses:
        '200':
          description: 성공 응답으로 결제 시도 이력을 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentTransactionsResponse'
          x-portone-title: 성공 응답으로 결제 시도 이력을 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentTransactionsError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentTransactionsError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentTransactionsError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentTransactionsError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 결제 시도 내역 조회
      x-portone-description: 주어진 아이디에 대응되는 결제 건의 결제 시도 내역을 조회합니다.
      x-portone-error:
        $ref: '#/components/schemas/GetPaymentTransactionsError'
      x-portone-unstable: true
      tags:
      - Payments
  /payments/{paymentId}/virtual-account/close:
    post:
      summary: 가상계좌 말소
      description: '가상계좌 말소


        발급된 가상계좌를 말소합니다.'
      operationId: closeVirtualAccount
      parameters:
      - name: paymentId
        in: path
        description: 결제 건 아이디
        required: true
        schema:
          type: string
        x-portone-title: 결제 건 아이디
      - name: storeId
        in: query
        description: '상점 아이디


          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.'
        required: false
        schema:
          type: string
        x-portone-title: 상점 아이디
        x-portone-description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseVirtualAccountResponse'
          x-portone-title: 성공 응답
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseVirtualAccountError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseVirtualAccountError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseVirtualAccountError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseVirtualAccountError'
        '409':
          description: '* `PaymentNotWaitingForDepositError`: 결제 건이 입금 대기 상태가 아닌 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseVirtualAccountError'
        '502':
          description: '* `PgProviderError`: PG사에서 오류를 전달한 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseVirtualAccountError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 가상계좌 말소
      x-portone-description: 발급된 가상계좌를 말소합니다.
      x-portone-error:
        $ref: '#/components/schemas/CloseVirtualAccountError'
      tags:
      - Payments
  /payments/{paymentId}:
    get:
      summary: 결제 단건 조회
      description: '결제 단건 조회


        주어진 아이디에 대응되는 결제 건을 조회합니다.'
      operationId: getPayment
      parameters:
      - name: paymentId
        in: path
        description: 조회할 결제 아이디
        required: true
        schema:
          type: string
        x-portone-title: 조회할 결제 아이디
      - name: storeId
        in: query
        description: '상점 아이디


          접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.'
        required: false
        schema:
          type: string
        x-portone-title: 상점 아이디
        x-portone-description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
      responses:
        '200':
          description: 성공 응답으로 결제 건 객체를 반환합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
          x-portone-title: 성공 응답으로 결제 건 객체를 반환합니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentError'
        '404':
          description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 결제 단건 조회
      x-portone-description: 주어진 아이디에 대응되는 결제 건을 조회합니다.
      x-portone-error:
        $ref: '#/components/schemas/GetPaymentError'
      tags:
      - Payments
  /payments:
    get:
      summary: 결제 다건 조회(페이지 기반)
      description: '결제 다건 조회(페이지 기반)


        주어진 조건에 맞는 결제 건들을 페이지 기반으로 조회합니다.'
      operationId: getPayments
      parameters:
      - name: requestBody
        in: query
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPaymentsBody'
      responses:
        '200':
          description: 성공 응답으로 조회된 결제 건 리스트와 페이지 정보가 반환됩니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentsResponse'
          x-portone-title: 성공 응답으로 조회된 결제 건 리스트와 페이지 정보가 반환됩니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentsError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentsError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentsError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 결제 다건 조회(페이지 기반)
      x-portone-description: 주어진 조건에 맞는 결제 건들을 페이지 기반으로 조회합니다.
      x-portone-error:
        $ref: '#/components/schemas/GetPaymentsError'
      tags:
      - Payments
components:
  schemas:
    RegisterStoreReceiptError:
      title: RegisterStoreReceiptError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PaymentNotPaidError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PAYMENT_NOT_PAID: '#/components/schemas/PaymentNotPaidError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    ModifyEscrowLogisticsBody:
      title: 에스크로 배송 정보 수정 입력 정보
      description: 에스크로 배송 정보 수정 입력 정보
      type: object
      required:
      - logistics
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        sender:
          $ref: '#/components/schemas/PaymentEscrowSenderInput'
          title: 에스크로 발송자 정보
        receiver:
          $ref: '#/components/schemas/PaymentEscrowReceiverInput'
          title: 에스크로 수취인 정보
        logistics:
          $ref: '#/components/schemas/PaymentLogistics'
          title: 에스크로 물류 정보
        sendEmail:
          type: boolean
          title: 이메일 알림 전송 여부
          description: 에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
      x-portone-title: 에스크로 배송 정보 수정 입력 정보
    ApplyEscrowLogisticsResponse:
      title: 에스크로 배송 정보 등록 성공 응답
      description: 에스크로 배송 정보 등록 성공 응답
      type: object
      required:
      - invoiceNumber
      - sentAt
      - appliedAt
      properties:
        invoiceNumber:
          type: string
          title: 송장 번호
        sentAt:
          type: string
          format: date-time
          title: 발송 시점
        appliedAt:
          type: string
          format: date-time
          title: 에스크로 정보 등록 시점
      x-portone-title: 에스크로 배송 정보 등록 성공 응답
    PaymentMethodTransfer:
      title: 계좌 이체 상세 정보
      description: 계좌 이체 상세 정보
      type: object
      required:
      - type
      properties:
        type:
          type: string
        bank:
          $ref: '#/components/schemas/Bank'
          title: 표준 은행 코드
        accountNumber:
          type: string
          title: 계좌번호
      x-portone-title: 계좌 이체 상세 정보
    CancelledPayment:
      title: 결제 취소 상태 건
      description: 결제 취소 상태 건
      type: object
      required:
      - status
      - id
      - transactionId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - origin
      - cancellations
      - cancelledAt
      properties:
        status:
          type: string
          title: 결제 건 상태
        id:
          type: string
          title: 결제 건 아이디
        transactionId:
          type: string
          title: 결제 건 포트원 채번 아이디
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        origin:
          $ref: '#/components/schemas/PaymentOrigin'
          title: 결제 출처 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점
        pgTxId:
          type: string
          title: PG사 거래 아이디
        cashReceipt:
          $ref: '#/components/schemas/PaymentCashReceipt'
          title: 현금영수증
        cashReceiptIssuanceStatus:
          $ref: '#/components/schemas/CashReceiptIssuanceStatus'
          title: 현금영수증 발행여부
          description: '승인 시점에 확인된 발행여부입니다.

            발행번호 없이 발행여부만 제공 가능한 경우, ISSUED이면서 cashReceipt가 존재하지 않을 수 있습니다.'
        receiptUrl:
          type: string
          title: 거래 영수증 URL
        cancellations:
          title: 결제 취소 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentCancellation'
        cancelledAt:
          type: string
          format: date-time
          title: 결제 취소 시점
      x-portone-title: 결제 취소 상태 건
    DiscountAmountExceedsTotalAmountError:
      title: 프로모션 할인 금액이 결제 시도 금액 이상인 경우
      description: 프로모션 할인 금액이 결제 시도 금액 이상인 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 프로모션 할인 금액이 결제 시도 금액 이상인 경우
      x-portone-status-code: 400
    AlreadyPaidOrWaitingError:
      title: 결제가 이미 완료되었거나 대기중인 경우
      description: 결제가 이미 완료되었거나 대기중인 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제가 이미 완료되었거나 대기중인 경우
      x-portone-status-code: 409
    PaymentAlreadyCancelledError:
      title: 결제가 이미 취소된 경우
      description: 결제가 이미 취소된 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제가 이미 취소된 경우
      x-portone-status-code: 409
    PaymentNotFoundError:
      title: 결제 건이 존재하지 않는 경우
      description: 결제 건이 존재하지 않는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제 건이 존재하지 않는 경우
      x-portone-status-code: 404
    Customer:
      title: 고객 정보
      description: 고객 정보
      type: object
      properties:
        id:
          type: string
          title: 고객 아이디
          description: 고객사가 지정한 고객의 고유 식별자입니다.
        name:
          type: string
          title: 이름
        birthYear:
          type: string
          title: 출생 연도
        birthMonth:
          type: string
          title: 출생 월
        birthDay:
          type: string
          title: 출생 일자
        gender:
          $ref: '#/components/schemas/Gender'
          title: 성별
        email:
          type: string
          title: 이메일
        phoneNumber:
          type: string
          title: 전화번호
        address:
          $ref: '#/components/schemas/Address'
          title: 주소
        zipcode:
          type: string
          title: 우편번호
      x-portone-title: 고객 정보
    BillingKeyPaymentScheduleInput:
      title: 빌링키 결제 예약 요청 입력 정보
      description: 빌링키 결제 예약 요청 입력 정보
      type: object
      required:
      - billingKey
      - orderName
      - amount
      - currency
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        billingKey:
          type: string
          title: 빌링키 결제에 사용할 빌링키
        channelKey:
          type: string
          title: 채널 키
          description: 다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시
        orderName:
          type: string
          title: 주문명
        customer:
          $ref: '#/components/schemas/CustomerInput'
          title: 고객 정보
        customData:
          type: string
          title: 사용자 지정 데이터
        amount:
          $ref: '#/components/schemas/PaymentAmountInput'
          title: 결제 금액 세부 입력 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        installmentMonth:
          type: integer
          format: int32
          title: 할부 개월 수
        useFreeInterestFromMerchant:
          type: boolean
          title: 무이자 할부 이자를 고객사가 부담할지 여부
        useCardPoint:
          type: boolean
          title: 카드 포인트 사용 여부
        cashReceipt:
          $ref: '#/components/schemas/CashReceiptInput'
          title: 현금영수증 정보
          description: 나이스페이먼츠를 통해 네이버페이 포인트 빌링결제 시, 현금영수증 발급을 위해 입력 가능 (신청 필요)
        country:
          $ref: '#/components/schemas/Country'
          title: 결제 국가
        noticeUrls:
          type: array
          items:
            type: string
          title: 웹훅 주소
          description: '결제 승인/실패 시 요청을 받을 웹훅 주소입니다.

            상점에 설정되어 있는 값보다 우선적으로 적용됩니다.

            빈 배열은 무시됩니다.'
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
          description: 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
        productCount:
          type: integer
          format: int32
          title: 상품 개수
        productType:
          $ref: '#/components/schemas/PaymentProductType'
          title: 상품 유형
        shippingAddress:
          $ref: '#/components/schemas/SeparatedAddressInput'
          title: 배송지 주소
        promotionId:
          type: string
          title: 해당 결제에 적용할 프로모션 아이디
        locale:
          $ref: '#/components/schemas/Locale'
          title: 결제 시 사용할 언어
          description: 엑심베이의 경우 필수 입력입니다.
        bypass:
          type: object
          title: PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
      x-portone-title: 빌링키 결제 예약 요청 입력 정보
    PaymentWebhookTrigger:
      title: 웹훅 실행 트리거
      description: '웹훅 실행 트리거


        수동 웹훅 재발송, 가상계좌 입금, 비동기 취소 승인 시 발생한 웹훅일 때 필드의 값이 존재합니다.'
      type: string
      enum:
      - MANUAL
      - VIRTUAL_ACCOUNT_DEPOSIT
      - ASYNC_CANCEL_APPROVED
      - ASYNC_CANCEL_FAILED
      - ASYNC_PAY_APPROVED
      - ASYNC_PAY_FAILED
      - ASYNC_PAY_PENDING
      - DISPUTE_CREATED
      - DISPUTE_RESOLVED
      x-portone-title: 웹훅 실행 트리거
      x-portone-description: 수동 웹훅 재발송, 가상계좌 입금, 비동기 취소 승인 시 발생한 웹훅일 때 필드의 값이 존재합니다.
      x-portone-enum:
        ASYNC_PAY_PENDING: {}
        ASYNC_CANCEL_APPROVED: {}
        DISPUTE_CREATED: {}
        ASYNC_CANCEL_FAILED: {}
        MANUAL: {}
        DISPUTE_RESOLVED: {}
        VIRTUAL_ACCOUNT_DEPOSIT: {}
        ASYNC_PAY_FAILED: {}
        ASYNC_PAY_APPROVED: {}
    PaymentCashReceiptStatus:
      title: 결제건 내 현금영수증 상태
      description: 결제건 내 현금영수증 상태
      type: string
      enum:
      - ISSUED
      - CANCELLED
      x-portone-title: 결제건 내 현금영수증 상태
      x-portone-enum:
        ISSUED: {}
        CANCELLED: {}
    PayWithBillingKeyResponse:
      title: 빌링키 결제 성공 응답
      description: 빌링키 결제 성공 응답
      type: object
      required:
      - payment
      properties:
        payment:
          $ref: '#/components/schemas/BillingKeyPaymentSummary'
          title: 결제 건 요약 정보
      x-portone-title: 빌링키 결제 성공 응답
    GetPaymentError:
      title: GetPaymentError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    PaymentAmount:
      title: 결제 금액 세부 정보
      description: 결제 금액 세부 정보
      type: object
      required:
      - total
      - taxFree
      - discount
      - paid
      - cancelled
      - cancelledTaxFree
      properties:
        total:
          type: integer
          format: int64
          title: 총 결제금액
        taxFree:
          type: integer
          format: int64
          title: 면세액
        vat:
          type: integer
          format: int64
          title: 부가세액
        supply:
          type: integer
          format: int64
          title: 공급가액
        discount:
          type: integer
          format: int64
          title: 총 할인금액
          description: 카드사 할인금액, 포트원 프로모션 할인금액, 간편결제 할인금액(적립형 포인트 결제, 쿠폰 할인) 등을 포함합니다.
        paid:
          type: integer
          format: int64
          title: 실제 결제금액
        cancelled:
          type: integer
          format: int64
          title: 총 취소금액
        cancelledTaxFree:
          type: integer
          format: int64
          title: 총 취소금액 중 면세액
      x-portone-title: 결제 금액 세부 정보
    FailedPaymentCancellation:
      title: 취소 실패 상태
      description: 취소 실패 상태
      type: object
      required:
      - status
      - id
      - totalAmount
      - taxFreeAmount
      - vatAmount
      - reason
      - requestedAt
      properties:
        status:
          type: string
          title: 결제 취소 내역 상태
        id:
          type: string
          title: 취소 내역 아이디
        pgCancellationId:
          type: string
          title: PG사 결제 취소 내역 아이디
        totalAmount:
          type: integer
          format: int64
          title: 취소 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 취소 금액 중 면세 금액
        vatAmount:
          type: integer
          format: int64
          title: 취소 금액 중 부가세액
        easyPayDiscountAmount:
          type: integer
          format: int64
          title: 적립형 포인트의 환불 금액
        reason:
          type: string
          title: 취소 사유
        cancelledAt:
          type: string
          format: date-time
          title: 취소 시점
        requestedAt:
          type: string
          format: date-time
          title: 취소 요청 시점
        trigger:
          $ref: '#/components/schemas/Trigger'
          title: 취소 요청 경로
      x-portone-title: 취소 실패 상태
    PaymentOriginPlatformType:
      title: 플랫폼 타입
      description: 플랫폼 타입
      type: string
      enum:
      - PC
      - MOBILE
      - API
      x-portone-title: 플랫폼 타입
      x-portone-enum:
        PC: {}
        MOBILE: {}
        API: {}
    IssueFailedCashReceipt:
      title: 발급 실패
      description: 발급 실패
      type: object
      required:
      - status
      - merchantId
      - storeId
      - paymentId
      - orderName
      - isManual
      properties:
        status:
          type: string
          title: 현금영수증 상태
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        paymentId:
          type: string
          title: 결제 건 아이디
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 현금영수증 발급에 사용된 채널
        orderName:
          type: string
          title: 주문명
        isManual:
          type: boolean
          title: 수동 발급 여부
        statusUpdatedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
      x-portone-title: 발급 실패
    CancelledCashReceipt:
      title: 발급 취소
      description: 발급 취소
      type: object
      required:
      - status
      - merchantId
      - storeId
      - paymentId
      - channel
      - amount
      - currency
      - orderName
      - isManual
      - issueNumber
      - issuedAt
      - cancelledAt
      properties:
        status:
          type: string
          title: 현금영수증 상태
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        paymentId:
          type: string
          title: 결제 건 아이디
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 현금영수증 발급에 사용된 채널
        amount:
          type: integer
          format: int64
          title: 결제 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 면세액
        vatAmount:
          type: integer
          format: int64
          title: 부가세액
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        orderName:
          type: string
          title: 주문명
        isManual:
          type: boolean
          title: 수동 발급 여부
        type:
          $ref: '#/components/schemas/CashReceiptType'
          title: 현금영수증 유형
        pgReceiptId:
          type: string
          title: PG사 현금영수증 아이디
        issueNumber:
          type: string
          title: 승인번호
        url:
          type: string
          title: 현금영수증 URL
        issuedAt:
          type: string
          format: date-time
          title: 발급 시점
        cancelledAt:
          type: string
          format: date-time
          title: 취소 시점
        statusUpdatedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
      x-portone-title: 발급 취소
    InstantPaymentMethodInputVirtualAccount:
      title: 가상계좌 수단 정보 입력 정보
      description: 가상계좌 수단 정보 입력 정보
      type: object
      required:
      - bank
      - expiry
      - option
      properties:
        bank:
          $ref: '#/components/schemas/Bank'
          title: 은행
        expiry:
          $ref: '#/components/schemas/InstantPaymentMethodInputVirtualAccountExpiry'
          title: 입금 만료 기한
        option:
          $ref: '#/components/schemas/InstantPaymentMethodInputVirtualAccountOption'
          title: 가상계좌 유형
        cashReceipt:
          $ref: '#/components/schemas/InstantPaymentMethodInputVirtualAccountCashReceiptInfo'
          title: 현금영수증 정보
        remitteeName:
          type: string
          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 에 사용되는 페이지 입력 정보
    CancelPaymentBody:
      title: 결제 취소 요청 입력 정보
      description: 결제 취소 요청 입력 정보
      type: object
      required:
      - reason
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        amount:
          type: integer
          format: int64
          title: 취소 총 금액
          description: 값을 입력하지 않으면 전액 취소됩니다.
        taxFreeAmount:
          type: integer
          format: int64
          title: 취소 금액 중 면세 금액
          description: 값을 입력하지 않으면 전액 과세 취소됩니다.
        vatAmount:
          type: integer
          format: int64
          title: 취소 금액 중 부가세액
          description: 값을 입력하지 않으면 자동 계산됩니다.
        reason:
          type: string
          title: 취소 사유
        requester:
          $ref: '#/components/schemas/CancelRequester'
          title: 취소 요청자
          description: 고객에 의한 취소일 경우 Customer, 관리자에 의한 취소일 경우 Admin으로 입력합니다.
        promotionDiscountRetainOption:
          $ref: '#/components/schemas/PromotionDiscountRetainOption'
          title: 프로모션 할인율 유지 옵션
          description: '프로모션이 적용된 결제를 부분 취소하는 경우, 최초 할인율을 유지할지 여부를 선택할 수 있습니다.

            RETAIN 으로 설정 시, 최초 할인율을 유지할 수 있도록 취소 금액이 조정됩니다.

            RELEASE 으로 설정 시, 취소 후 남은 금액이 속한 구간에 맞게 프로모션 할인이 새롭게 적용됩니다.

            값을 입력하지 않으면 RELEASE 로 취급합니다.'
        currentCancellableAmount:
          type: integer
          format: int64
          title: 결제 건의 취소 가능 잔액
          description: 본 취소 요청 이전의 취소 가능 잔액으로써, 값을 입력하면 잔액이 일치하는 경우에만 취소가 진행됩니다. 값을 입력하지 않으면 별도의 검증 처리를 수행하지 않습니다.
        refundAccount:
          $ref: '#/components/schemas/CancelPaymentBodyRefundAccount'
          title: 환불 계좌
          description: 계좌 환불일 경우 입력합니다. 계좌 환불이 필요한 경우는 가상계좌 환불, 휴대폰 익월 환불 등이 있습니다.
        refundEmail:
          type: string
          title: 환불 이메일
          description: Triple-A 결제 환불에 필요합니다. 해당 이메일로 환불 안내가 발송됩니다.
        skipWebhook:
          type: boolean
          title: 웹훅 생략 여부
          description: 취소가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
      x-portone-title: 결제 취소 요청 입력 정보
    PaymentSortBy:
      title: 결제 건 정렬 기준
      description: 결제 건 정렬 기준
      type: string
      enum:
      - REQUESTED_AT
      - STATUS_CHANGED_AT
      x-portone-title: 결제 건 정렬 기준
      x-portone-enum:
        REQUESTED_AT:
          title: 결제 요청 시점
        STATUS_CHANGED_AT:
          title: 상태 변경 시점
    CreatePaymentScheduleError:
      title: CreatePaymentScheduleError
      oneOf:
      - $ref: '#/components/schemas/AlreadyPaidOrWaitingError'
      - $ref: '#/components/schemas/BillingKeyAlreadyDeletedError'
      - $ref: '#/components/schemas/BillingKeyNotFoundError'
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentScheduleAlreadyExistsError'
      - $ref: '#/components/schemas/SumOfPartsExceedsTotalAmountError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          ALREADY_PAID_OR_WAITING: '#/components/schemas/AlreadyPaidOrWaitingError'
          BILLING_KEY_ALREADY_DELETED: '#/components/schemas/BillingKeyAlreadyDeletedError'
          BILLING_KEY_NOT_FOUND: '#/components/schemas/BillingKeyNotFoundError'
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_SCHEDULE_ALREADY_EXISTS: '#/components/schemas/PaymentScheduleAlreadyExistsError'
          SUM_OF_PARTS_EXCEEDS_TOTAL_AMOUNT: '#/components/schemas/SumOfPartsExceedsTotalAmountError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    PayWithBillingKeyError:
      title: PayWithBillingKeyError
      oneOf:
      - $ref: '#/components/schemas/AlreadyPaidError'
      - $ref: '#/components/schemas/BillingKeyAlreadyDeletedError'
      - $ref: '#/components/schemas/BillingKeyNotFoundError'
      - $ref: '#/components/schemas/ChannelNotFoundError'
      - $ref: '#/components/schemas/DiscountAmountExceedsTotalAmountError'
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/MaxTransactionCountReachedError'
      - $ref: '#/components/schemas/PaymentScheduleAlreadyExistsError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/PromotionPayMethodDoesNotMatchError'
      - $ref: '#/components/schemas/SumOfPartsExceedsTotalAmountError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          ALREADY_PAID: '#/components/schemas/AlreadyPaidError'
          BILLING_KEY_ALREADY_DELETED: '#/components/schemas/BillingKeyAlreadyDeletedError'
          BILLING_KEY_NOT_FOUND: '#/components/schemas/BillingKeyNotFoundError'
          CHANNEL_NOT_FOUND: '#/components/schemas/ChannelNotFoundError'
          DISCOUNT_AMOUNT_EXCEEDS_TOTAL_AMOUNT: '#/components/schemas/DiscountAmountExceedsTotalAmountError'
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          MAX_TRANSACTION_COUNT_REACHED: '#/components/schemas/MaxTransactionCountReachedError'
          PAYMENT_SCHEDULE_ALREADY_EXISTS: '#/components/schemas/PaymentScheduleAlreadyExistsError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          PROMOTION_PAY_METHOD_DOES_NOT_MATCH: '#/components/schemas/PromotionPayMethodDoesNotMatchError'
          SUM_OF_PARTS_EXCEEDS_TOTAL_AMOUNT: '#/components/schemas/SumOfPartsExceedsTotalAmountError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    PaymentMethodCrypto:
      title: 암호화폐 결제 상세 정보
      description: 암호화폐 결제 상세 정보
      type: object
      required:
      - type
      properties:
        type:
          type: string
      x-portone-title: 암호화폐 결제 상세 정보
    PaymentProductType:
      title: 상품 유형
      description: 상품 유형
      type: string
      enum:
      - PHYSICAL
      - DIGITAL
      x-portone-title: 상품 유형
      x-portone-enum:
        PHYSICAL:
          title: 실물 상품
        DIGITAL:
          title: 디지털 상품
          description: 서비스, 온라인 상품 등 실물이 존재하지 않는 무형의 상품을 의미합니다.
    ConfirmPaymentBody:
      title: 결제 승인 입력 정보
      description: 결제 승인 입력 정보
      type: object
      required:
      - paymentToken
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        paymentToken:
          type: string
          title: 결제 토큰
          description: 인증 완료 시 발급된 토큰입니다.
        txId:
          type: string
          title: 결제 시도 아이디
          description: 검증용 파라미터로, 결제 시도 아이디와 일치하지 않을 경우 오류가 반환됩니다.
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
          description: 검증용 파라미터로, 결제 건 화폐와 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
        totalAmount:
          type: integer
          format: int64
          title: 결제 금액
          description: 검증용 파라미터로, 결제 건 총 금액과 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
        taxFreeAmount:
          type: integer
          format: int64
          title: 면세 금액
          description: 검증용 파라미터로, 결제 건 면세 금액과 일치하지 않을 경우 오류가 반환됩니다.
        isTest:
          type: boolean
          title: 테스트 결제 여부
          description: 검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
        skipWebhook:
          type: boolean
          title: 웹훅 생략 여부
          description: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
      x-portone-title: 결제 승인 입력 정보
    PromotionDiscountRetainOption:
      title: PromotionDiscountRetainOption
      type: string
      enum:
      - RETAIN
      - RELEASE
      x-portone-enum:
        RETAIN: {}
        RELEASE: {}
    PaymentWebhook:
      title: 성공 웹훅 내역
      description: 성공 웹훅 내역
      type: object
      required:
      - id
      - url
      properties:
        paymentStatus:
          $ref: '#/components/schemas/PaymentWebhookPaymentStatus'
          title: 웹훅 발송 시 결제 건 상태
          description: V1 결제 건인 경우, 값이 존재하지 않습니다.
        id:
          type: string
          title: 웹훅 아이디
        status:
          $ref: '#/components/schemas/PaymentWebhookStatus'
          title: 웹훅 상태
        url:
          type: string
          title: 웹훅이 발송된 url
          description: V1 결제 건인 경우, 값이 존재하지 않습니다.
        isAsync:
          type: boolean
          title: 비동기 웹훅 여부
          description: V1 결제 건인 경우, 값이 존재하지 않습니다.
        currentExecutionCount:
          type: integer
          format: int32
          title: 현재 발송 횟수
        maxExecutionCount:
          type: integer
          format: int32
          title: 최대 발송 횟수
        trigger:
          $ref: '#/components/schemas/PaymentWebhookTrigger'
          title: 웹훅 실행 맥락
        request:
          $ref: '#/components/schemas/PaymentWebhookRequest'
          title: 웹훅 요청 정보
        response:
          $ref: '#/components/schemas/PaymentWebhookResponse'
          title: 웹훅 응답 정보
        triggeredAt:
          type: string
          format: date-time
          title: 웹훅 처리 시작 시점
      x-portone-title: 성공 웹훅 내역
    ConfirmEscrowError:
      title: ConfirmEscrowError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PaymentNotPaidError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PAYMENT_NOT_PAID: '#/components/schemas/PaymentNotPaidError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    PaymentScheduleSummary:
      title: 결제 예약 건
      description: 결제 예약 건
      type: object
      required:
      - id
      properties:
        id:
          type: string
          title: 결제 예약 건 아이디
      x-portone-title: 결제 예약 건
    CapturePaymentResponse:
      title: 수동 매입 성공 응답
      description: 수동 매입 성공 응답
      type: object
      x-portone-title: 수동 매입 성공 응답
    StopPaymentCancellationBody:
      title: 결제 취소 요청 취소 입력 정보
      description: 결제 취소 요청 취소 입력 정보
      type: object
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
      x-portone-title: 결제 취소 요청 취소 입력 정보
    PgProviderError:
      title: PG사에서 오류를 전달한 경우
      description: PG사에서 오류를 전달한 경우
      type: object
      required:
      - type
      - pgCode
      - pgMessage
      properties:
        type:
          type: string
        message:
          type: string
        pgCode:
          type: string
        pgMessage:
          type: string
      x-portone-title: PG사에서 오류를 전달한 경우
      x-portone-status-code: 502
    SelectedChannelType:
      title: 채널 타입
      description: 채널 타입
      type: string
      enum:
      - LIVE
      - TEST
      x-portone-title: 채널 타입
      x-portone-enum:
        LIVE:
          title: 실 연동 채널
        TEST:
          title: 테스트 연동 채널
    PaymentScheduleAlreadyExistsError:
      title: 결제 예약건이 이미 존재하는 경우
      description: 결제 예약건이 이미 존재하는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제 예약건이 이미 존재하는 경우
      x-portone-status-code: 409
    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: {}
    CancelledPaymentCashReceipt:
      title: 취소된 현금영수증
      description: 취소된 현금영수증
      type: object
      required:
      - status
      - issueNumber
      - totalAmount
      - currency
      - issuedAt
      - cancelledAt
      properties:
        status:
          type: string
          title: 결제 건 내 현금영수증 상태
        type:
          $ref: '#/components/schemas/CashReceiptType'
          title: 현금영수증 유형
        pgReceiptId:
          type: string
          title: PG사 영수증 발급 아이디
        issueNumber:
          type: string
          title: 승인 번호
        totalAmount:
          type: integer
          format: int64
          title: 총 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 면세액
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        url:
          type: string
          title: 현금영수증 URL
        issuedAt:
          type: string
          format: date-time
          title: 발급 시점
        cancelledAt:
          type: string
          format: date-time
          title: 취소 시점
      x-portone-title: 취소된 현금영수증
    Trigger:
      title: Trigger
      type: string
      enum:
      - CONSOLE
      - API
      - PORTONE_ADMIN
      - CHARGEBACK
      x-portone-enum:
        CONSOLE: {}
        API: {}
        PORTONE_ADMIN: {}
        CHARGEBACK: {}
    RequestedPaymentCancellation:
      title: 취소 요청 상태
      description: 취소 요청 상태
      type: object
      required:
      - status
      - id
      - totalAmount
      - taxFreeAmount
      - vatAmount
      - reason
      - requestedAt
      properties:
        status:
          type: string
          title: 결제 취소 내역 상태
        id:
          type: string
          title: 취소 내역 아이디
        pgCancellationId:
          type: string
          title: PG사 결제 취소 내역 아이디
        totalAmount:
          type: integer
          format: int64
          title: 취소 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 취소 금액 중 면세 금액
        vatAmount:
          type: integer
          format: int64
          title: 취소 금액 중 부가세액
        easyPayDiscountAmount:
          type: integer
          format: int64
          title: 적립형 포인트의 환불 금액
        reason:
          type: string
          title: 취소 사유
        cancelledAt:
          type: string
          format: date-time
          title: 취소 시점
        requestedAt:
          type: string
          format: date-time
          title: 취소 요청 시점
        trigger:
          $ref: '#/components/schemas/Trigger'
          title: 취소 요청 경로
      x-portone-title: 취소 요청 상태
    PaymentMethodMobile:
      title: 모바일 상세 정보
      description: 모바일 상세 정보
      type: object
      required:
      - type
      properties:
        type:
          type: string
        phoneNumber:
          type: string
          title: 전화번호
      x-portone-title: 모바일 상세 정보
    RegisterStoreReceiptResponse:
      title: 영수증 내 하위 상점 거래 등록 응답
      description: 영수증 내 하위 상점 거래 등록 응답
      type: object
      properties:
        receiptUrl:
          type: string
          title: 결제 영수증 URL
      x-portone-title: 영수증 내 하위 상점 거래 등록 응답
    RegisterStoreReceiptBody:
      title: 영수증 내 하위 상점 거래 등록 정보
      description: 영수증 내 하위 상점 거래 등록 정보
      type: object
      required:
      - items
      properties:
        items:
          title: 하위 상점 거래 목록
          type: array
          items:
            $ref: '#/components/schemas/RegisterStoreReceiptBodyItem'
        storeId:
          type: string
          title: 상점 아이디
      x-portone-title: 영수증 내 하위 상점 거래 등록 정보
    BillingKeyAlreadyDeletedError:
      title: 빌링키가 이미 삭제된 경우
      description: 빌링키가 이미 삭제된 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 빌링키가 이미 삭제된 경우
      x-portone-status-code: 409
    PaidPaymentTransaction:
      title: 결제 완료 상태 건
      description: 결제 완료 상태 건
      type: object
      required:
      - status
      - id
      - paymentId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - paidAt
      properties:
        status:
          type: string
          title: 결제 시도 상태
        id:
          type: string
          title: 결제 시도 아이디 (transactionId)
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        paymentId:
          type: string
          title: 결제 건 아이디
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점
        pgTxId:
          type: string
          title: PG사 거래 아이디
        pgResponse:
          type: string
          title: PG사 거래 응답 본문
        cashReceipt:
          $ref: '#/components/schemas/PaymentCashReceipt'
          title: 현금영수증
        cashReceiptIssuanceStatus:
          $ref: '#/components/schemas/CashReceiptIssuanceStatus'
          title: 현금영수증 발행여부
          description: '승인 시점에 확인된 발행여부입니다.

            발행번호 없이 발행여부만 제공 가능한 경우, ISSUED이면서 cashReceipt가 존재하지 않을 수 있습니다.'
        receiptUrl:
          type: string
          title: 거래 영수증 URL
      x-portone-title: 결제 완료 상태 건
    ModifyEscrowLogisticsResponse:
      title: 에스크로 배송 정보 수정 성공 응답
      description: 에스크로 배송 정보 수정 성공 응답
      type: object
      required:
      - invoiceNumber
      - sentAt
      - modifiedAt
      properties:
        invoiceNumber:
          type: string
          title: 송장 번호
        sentAt:
          type: string
          format: date-time
          title: 발송 시점
        modifiedAt:
          type: string
          format: date-time
          title: 에스크로 정보 수정 시점
      x-portone-title: 에스크로 배송 정보 수정 성공 응답
    PaymentEscrow:
      title: 에스크로 정보
      description: '에스크로 정보


        V1 결제 건의 경우 타입이 REGISTERED 로 고정됩니다.'
      oneOf:
      - $ref: '#/components/schemas/BeforeRegisteredPaymentEscrow'
      - $ref: '#/components/schemas/CancelledPaymentEscrow'
      - $ref: '#/components/schemas/ConfirmedPaymentEscrow'
      - $ref: '#/components/schemas/DeliveredPaymentEscrow'
      - $ref: '#/components/schemas/RegisteredPaymentEscrow'
      - $ref: '#/components/schemas/RejectConfirmedPaymentEscrow'
      - $ref: '#/components/schemas/RejectedPaymentEscrow'
      discriminator:
        propertyName: status
        mapping:
          BEFORE_REGISTERED: '#/components/schemas/BeforeRegisteredPaymentEscrow'
          CANCELLED: '#/components/schemas/CancelledPaymentEscrow'
          CONFIRMED: '#/components/schemas/ConfirmedPaymentEscrow'
          DELIVERED: '#/components/schemas/DeliveredPaymentEscrow'
          REGISTERED: '#/components/schemas/RegisteredPaymentEscrow'
          REJECTED: '#/components/schemas/RejectedPaymentEscrow'
          REJECT_CONFIRMED: '#/components/schemas/RejectConfirmedPaymentEscrow'
      x-portone-title: 에스크로 정보
      x-portone-description: V1 결제 건의 경우 타입이 REGISTERED 로 고정됩니다.
      x-portone-discriminator:
        CONFIRMED:
          title: 구매 확정
        REJECTED:
          title: 구매 거절
        CANCELLED:
          title: 거래 취소
        REJECT_CONFIRMED:
          title: 구매 거절 확정
        DELIVERED:
          title: 배송 완료
        BEFORE_REGISTERED:
          title: 배송 정보 등록 전
        REGISTERED:
          title: 배송 정보 등록 완료
    Gender:
      title: 성별
      description: 성별
      type: string
      enum:
      - MALE
      - FEMALE
      - OTHER
      x-portone-title: 성별
      x-portone-enum:
        MALE:
          title: 남성
        FEMALE:
          title: 여성
        OTHER:
          title: 그 외 성별
    CancellableAmountConsistencyBrokenError:
      title: 취소 가능 잔액 검증에 실패한 경우
      description: 취소 가능 잔액 검증에 실패한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 취소 가능 잔액 검증에 실패한 경우
      x-portone-status-code: 409
    RegisterEscrowLogisticsBody:
      title: 에스크로 배송 정보 등록 입력 정보
      description: 에스크로 배송 정보 등록 입력 정보
      type: object
      required:
      - logistics
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        sender:
          $ref: '#/components/schemas/PaymentEscrowSenderInput'
          title: 에스크로 발송자 정보
        receiver:
          $ref: '#/components/schemas/PaymentEscrowReceiverInput'
          title: 에스크로 수취인 정보
        logistics:
          $ref: '#/components/schemas/PaymentLogistics'
          title: 에스크로 물류 정보
        sendEmail:
          type: boolean
          title: 이메일 알림 전송 여부
          description: 에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
      x-portone-title: 에스크로 배송 정보 등록 입력 정보
    CancelledPaymentEscrow:
      title: 거래 취소
      description: 거래 취소
      type: object
      required:
      - status
      - company
      - invoiceNumber
      properties:
        status:
          type: string
          title: 에스크로 상태
        company:
          type: string
          title: 택배사
        invoiceNumber:
          type: string
          title: 송장번호
        sentAt:
          type: string
          format: date-time
          title: 발송 일시
        appliedAt:
          type: string
          format: date-time
          title: 배송등록 처리 일자
      x-portone-title: 거래 취소
    ApplyEscrowLogisticsError:
      title: ApplyEscrowLogisticsError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PaymentNotPaidError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PAYMENT_NOT_PAID: '#/components/schemas/PaymentNotPaidError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    PaymentLogistics:
      title: 배송정보
      description: 배송정보
      type: object
      required:
      - company
      - invoiceNumber
      - sentAt
      properties:
        company:
          $ref: '#/components/schemas/PaymentLogisticsCompany'
          title: 물류회사
        invoiceNumber:
          type: string
          title: 송장번호
        sentAt:
          type: string
          format: date-time
          title: 발송시점
        receivedAt:
          type: string
          format: date-time
          title: 수령시점
        address:
          $ref: '#/components/schemas/SeparatedAddressInput'
          title: 주소
      x-portone-title: 배송정보
    BeforeRegisteredPaymentEscrow:
      title: 배송 정보 등록 전
      description: 배송 정보 등록 전
      type: object
      required:
      - status
      properties:
        status:
          type: string
          title: 에스크로 상태
      x-portone-title: 배송 정보 등록 전
    PaymentEscrowSenderInput:
      title: 에스크로 발송자 정보
      description: 에스크로 발송자 정보
      type: object
      properties:
        name:
          type: string
          title: 이름
        phoneNumber:
          type: string
          title: 전화번호
        zipcode:
          type: string
          title: 우편번호
        relationship:
          type: string
          title: 수취인과의 관계
        address:
          $ref: '#/components/schemas/SeparatedAddressInput'
          title: 주소
      x-portone-title: 에스크로 발송자 정보
    NegativePromotionAdjustedCancelAmountError:
      title: 프로모션에 의해 조정된 취소 금액이 음수인 경우
      description: 프로모션에 의해 조정된 취소 금액이 음수인 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 프로모션에 의해 조정된 취소 금액이 음수인 경우
      x-portone-status-code: 400
    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: 교보증권
    PaymentNotPaidError:
      title: 결제가 완료되지 않은 경우
      description: 결제가 완료되지 않은 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제가 완료되지 않은 경우
      x-portone-status-code: 409
    PaymentStatus:
      title: 결제 건 상태
      description: 결제 건 상태
      type: string
      enum:
      - READY
      - PENDING
      - VIRTUAL_ACCOUNT_ISSUED
      - PAID
      - FAILED
      - PARTIAL_CANCELLED
      - CANCELLED
      x-portone-title: 결제 건 상태
      x-portone-enum:
        PENDING: {}
        VIRTUAL_ACCOUNT_ISSUED: {}
        PAID: {}
        READY: {}
        FAILED: {}
        CANCELLED: {}
        PARTIAL_CANCELLED: {}
    PartialCancelledPayment:
      title: 결제 부분 취소 상태 건
      description: 결제 부분 취소 상태 건
      type: object
      required:
      - status
      - id
      - transactionId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - origin
      - cancellations
      - cancelledAt
      properties:
        status:
          type: string
          title: 결제 건 상태
        id:
          type: string
          title: 결제 건 아이디
        transactionId:
          type: string
          title: 결제 건 포트원 채번 아이디
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        origin:
          $ref: '#/components/schemas/PaymentOrigin'
          title: 결제 출처 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점
        pgTxId:
          type: string
          title: PG사 거래 아이디
        cashReceipt:
          $ref: '#/components/schemas/PaymentCashReceipt'
          title: 현금영수증
        cashReceiptIssuanceStatus:
          $ref: '#/components/schemas/CashReceiptIssuanceStatus'
          title: 현금영수증 발행여부
          description: '승인 시점에 확인된 발행여부입니다.

            발행번호 없이 발행여부만 제공 가능한 경우, ISSUED이면서 cashReceipt가 존재하지 않을 수 있습니다.'
        receiptUrl:
          type: string
          title: 거래 영수증 URL
        cancellations:
          title: 결제 취소 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentCancellation'
        cancelledAt:
          type: string
          format: date-time
          title: 결제 취소 시점
      x-portone-title: 결제 부분 취소 상태 건
    PaymentMethodEasyPay:
      title: 간편 결제 상세 정보
      description: 간편 결제 상세 정보
      type: object
      required:
      - type
      properties:
        type:
          type: string
        provider:
          $ref: '#/components/schemas/EasyPayProvider'
          title: 간편 결제 PG사
        easyPayMethod:
          $ref: '#/components/schemas/PaymentMethodEasyPayMethod'
          title: 간편 결제 수단
      x-portone-title: 간편 결제 상세 정보
    RejectedPaymentEscrow:
      title: 구매 거절
      description: 구매 거절
      type: object
      required:
      - status
      - company
      - invoiceNumber
      properties:
        status:
          type: string
          title: 에스크로 상태
        company:
          type: string
          title: 택배사
        invoiceNumber:
          type: string
          title: 송장번호
        sentAt:
          type: string
          format: date-time
          title: 발송 일시
        appliedAt:
          type: string
          format: date-time
          title: 배송등록 처리 일자
      x-portone-title: 구매 거절
    SucceededPaymentCancellation:
      title: 취소 완료 상태
      description: 취소 완료 상태
      type: object
      required:
      - status
      - id
      - totalAmount
      - taxFreeAmount
      - vatAmount
      - reason
      - requestedAt
      properties:
        status:
          type: string
          title: 결제 취소 내역 상태
        id:
          type: string
          title: 취소 내역 아이디
        pgCancellationId:
          type: string
          title: PG사 결제 취소 내역 아이디
        totalAmount:
          type: integer
          format: int64
          title: 취소 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 취소 금액 중 면세 금액
        vatAmount:
          type: integer
          format: int64
          title: 취소 금액 중 부가세액
        easyPayDiscountAmount:
          type: integer
          format: int64
          title: 적립형 포인트의 환불 금액
        reason:
          type: string
          title: 취소 사유
        cancelledAt:
          type: string
          format: date-time
          title: 취소 시점
        requestedAt:
          type: string
          format: date-time
          title: 취소 요청 시점
        receiptUrl:
          type: string
          title: 취소 영수증 URL
        trigger:
          $ref: '#/components/schemas/Trigger'
          title: 취소 요청 경로
      x-portone-title: 취소 완료 상태
    PaymentNotWaitingForDepositError:
      title: 결제 건이 입금 대기 상태가 아닌 경우
      description: 결제 건이 입금 대기 상태가 아닌 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제 건이 입금 대기 상태가 아닌 경우
      x-portone-status-code: 409
    PaymentTimestampType:
      title: 조회 시점 기준
      description: '조회 시점 기준


        어떤 시점을 기준으로 조회를 할 것인지 선택합니다.

        CREATED_AT: 결제 건 생성 시점을 기준으로 조회합니다.

        STATUS_CHANGED_AT: 상태 승인 시점을 기준으로 조회합니다. 결제 건의 최종 상태에 따라 검색 기준이 다르게 적용됩니다.

        ready -> 결제 요청 시점 기준

        paid -> 결제 완료 시점 기준

        cancelled -> 결제 취소 시점 기준

        failed -> 결제 실패 시점 기준

        값을 입력하지 않으면 STATUS_CHANGED_AT 으로 자동 적용됩니다.'
      type: string
      enum:
      - CREATED_AT
      - STATUS_CHANGED_AT
      x-portone-title: 조회 시점 기준
      x-portone-description: '어떤 시점을 기준으로 조회를 할 것인지 선택합니다.

        CREATED_AT: 결제 건 생성 시점을 기준으로 조회합니다.

        STATUS_CHANGED_AT: 상태 승인 시점을 기준으로 조회합니다. 결제 건의 최종 상태에 따라 검색 기준이 다르게 적용됩니다.

        ready -> 결제 요청 시점 기준

        paid -> 결제 완료 시점 기준

        cancelled -> 결제 취소 시점 기준

        failed -> 결제 실패 시점 기준

        값을 입력하지 않으면 STATUS_CHANGED_AT 으로 자동 적용됩니다.'
      x-portone-enum:
        CREATED_AT:
          title: 결제 건 생성 시점
        STATUS_CHANGED_AT:
          title: 상태 변경 시점
    GetPaymentsError:
      title: GetPaymentsError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    BillingKeyNotFoundError:
      title: 빌링키가 존재하지 않는 경우
      description: 빌링키가 존재하지 않는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 빌링키가 존재하지 않는 경우
      x-portone-status-code: 404
    CreatePaymentScheduleResponse:
      title: 결제 예약 성공 응답
      description: 결제 예약 성공 응답
      type: object
      required:
      - schedule
      properties:
        schedule:
          $ref: '#/components/schemas/PaymentScheduleSummary'
          title: 결제 예약 건
      x-portone-title: 결제 예약 성공 응답
    PaymentTextSearchField:
      title: 통합검색 항목
      description: 통합검색 항목
      type: string
      enum:
      - ALL
      - PAYMENT_ID
      - TX_ID
      - SCHEDULE_ID
      - FAIL_REASON
      - CARD_ISSUER
      - CARD_ACQUIRER
      - CARD_BIN
      - CARD_NUMBER
      - CARD_APPROVAL_NUMBER
      - CARD_RECEIPT_NAME
      - CARD_INSTALLMENT
      - TRANS_BANK
      - VIRTUAL_ACCOUNT_HOLDER_NAME
      - VIRTUAL_ACCOUNT_BANK
      - VIRTUAL_ACCOUNT_NUMBER
      - PG_MERCHANT_ID
      - PG_TX_ID
      - PG_RECEIPT_ID
      - RECEIPT_APPROVAL_NUMBER
      - PG_CANCELLATION_ID
      - CANCEL_REASON
      - ORDER_NAME
      - CUSTOMER_NAME
      - CUSTOMER_EMAIL
      - CUSTOMER_PHONE_NUMBER
      - CUSTOMER_ADDRESS
      - CUSTOMER_ZIPCODE
      - USER_AGENT
      - BILLING_KEY
      - PROMOTION_ID
      - GIFT_CERTIFICATION_APPROVAL_NUMBER
      x-portone-title: 통합검색 항목
      x-portone-enum:
        CUSTOMER_EMAIL: {}
        USER_AGENT: {}
        FAIL_REASON: {}
        CARD_BIN: {}
        PG_MERCHANT_ID: {}
        RECEIPT_APPROVAL_NUMBER: {}
        TRANS_BANK: {}
        CARD_ISSUER: {}
        VIRTUAL_ACCOUNT_BANK: {}
        ORDER_NAME: {}
        TX_ID: {}
        CARD_ACQUIRER: {}
        CANCEL_REASON: {}
        CUSTOMER_NAME: {}
        SCHEDULE_ID: {}
        GIFT_CERTIFICATION_APPROVAL_NUMBER: {}
        PROMOTION_ID: {}
        PAYMENT_ID: {}
        CARD_APPROVAL_NUMBER: {}
        CUSTOMER_ADDRESS: {}
        PG_CANCELLATION_ID: {}
        ALL: {}
        PG_RECEIPT_ID: {}
        VIRTUAL_ACCOUNT_NUMBER: {}
        CARD_NUMBER: {}
        PG_TX_ID: {}
        BILLING_KEY: {}
        CUSTOMER_PHONE_NUMBER: {}
        CARD_RECEIPT_NAME: {}
        CARD_INSTALLMENT: {}
        CUSTOMER_ZIPCODE: {}
        VIRTUAL_ACCOUNT_HOLDER_NAME: {}
    PaymentClientType:
      title: 결제가 발생한 클라이언트 환경
      description: 결제가 발생한 클라이언트 환경
      type: string
      enum:
      - SDK_MOBILE
      - SDK_PC
      - API
      x-portone-title: 결제가 발생한 클라이언트 환경
      x-portone-enum:
        SDK_MOBILE: {}
        SDK_PC: {}
        API: {}
    Country:
      title: 국가
      description: 국가
      type: string
      enum:
      - AD
      - AE
      - AF
      - AG
      - AI
      - AL
      - AM
      - AO
      - AQ
      - AR
      - AS
      - AT
      - AU
      - AW
      - AX
      - AZ
      - BA
      - BB
      - BD
      - BE
      - BF
      - BG
      - BH
      - BI
      - BJ
      - BL
      - BM
      - BN
      - BO
      - BQ
      - BR
      - BS
      - BT
      - BV
      - BW
      - BY
      - BZ
      - CA
      - CC
      - CD
      - CF
      - CG
      - CH
      - CI
      - CK
      - CL
      - CM
      - CN
      - CO
      - CR
      - CU
      - CV
      - CW
      - CX
      - CY
      - CZ
      - DE
      - DJ
      - DK
      - DM
      - DO
      - DZ
      - EC
      - EE
      - EG
      - EH
      - ER
      - ES
      - ET
      - FI
      - FJ
      - FK
      - FM
      - FO
      - FR
      - GA
      - GB
      - GD
      - GE
      - GF
      - GG
      - GH
      - GI
      - GL
      - GM
      - GN
      - GP
      - GQ
      - GR
      - GS
      - GT
      - GU
      - GW
      - GY
      - HK
      - HM
      - HN
      - HR
      - HT
      - HU
      - ID
      - IE
      - IL
      - IM
      - IN
      - IO
      - IQ
      - IR
      - IS
      - IT
      - JE
      - JM
      - JO
      - JP
      - KE
      - KG
      - KH
      - KI
      - KM
      - KN
      - KP
      - KR
      - KW
      - KY
      - KZ
      - LA
      - LB
      - LC
      - LI
      - LK
      - LR
      - LS
      - LT
      - LU
      - LV
      - LY
      - MA
      - MC
      - MD
      - ME
      - MF
      - MG
      - MH
      - MK
      - ML
      - MM
      - MN
      - MO
      - MP
      - MQ
      - MR
      - MS
      - MT
      - MU
      - MV
      - MW
      - MX
      - MY
      - MZ
      - NA
      - NC
      - NE
      - NF
      - NG
      - NI
      - NL
      - 'NO'
      - NP
      - NR
      - NU
      - NZ
      - OM
      - PA
      - PE
      - PF
      - PG
      - PH
      - PK
      - PL
      - PM
      - PN
      - PR
      - PS
      - PT
      - PW
      - PY
      - QA
      - RE
      - RO
      - RS
      - RU
      - RW
      - SA
      - SB
      - SC
      - SD
      - SE
      - SG
      - SH
      - SI
      - SJ
      - SK
      - SL
      - SM
      - SN
      - SO
      - SR
      - SS
      - ST
      - SV
      - SX
      - SY
      - SZ
      - TC
      - TD
      - TF
      - TG
      - TH
      - TJ
      - TK
      - TL
      - TM
      - TN
      - TO
      - TR
      - TT
      - TV
      - TW
      - TZ
      - UA
      - UG
      - UM
      - US
      - UY
      - UZ
      - VA
      - VC
      - VE
      - VG
      - VI
      - VN
      - VU
      - WF
      - WS
      - YE
      - YT
      - ZA
      - ZM
      - ZW
      x-portone-title: 국가
      x-portone-enum:
        CV:
          title: Cabo Verde
        MA:
          title: Morocco
        AO:
          title: Angola
        VN:
          title: Viet Nam
        IN:
          title: India
        KW:
          title: Kuwait
        ML:
          title: Mali
        ID:
          title: Indonesia
        JE:
          title: Jersey
        HM:
          title: Heard Island and McDonald Islands
        EG:
          title: Egypt
        BG:
          title: Bulgaria
        SG:
          title: Singapore
        SV:
          title: El Salvador
        BD:
          title: Bangladesh
        TC:
          title: Turks and Caicos Islands (the)
        TH:
          title: Thailand
        AT:
          title: Austria
        GQ:
          title: Equatorial Guinea
        TR:
          title: Türkiye
        HT:
          title: Haiti
        UM:
          title: United States Minor Outlying Islands (the)
        MH:
          title: Marshall Islands (the)
        MY:
          title: Malaysia
        RU:
          title: Russian Federation (the)
        NI:
          title: Nicaragua
        BZ:
          title: Belize
        KP:
          title: Korea (the Democratic People's Republic of)
        VE:
          title: Venezuela (Bolivarian Republic of)
        IL:
          title: Israel
        GD:
          title: Grenada
        GI:
          title: Gibraltar
        TN:
          title: Tunisia
        DM:
          title: Dominica
        MO:
          title: Macao
        PR:
          title: Puerto Rico
        NF:
          title: Norfolk Island
        TW:
          title: Taiwan (Province of China)
        KN:
          title: Saint Kitts and Nevis
        PH:
          title: Philippines (the)
        WF:
          title: Wallis and Futuna
        JO:
          title: Jordan
        ME:
          title: Montenegro
        ES:
          title: Spain
        AZ:
          title: Azerbaijan
        MR:
          title: Mauritania
        SM:
          title: San Marino
        BL:
          title: Saint Barthélemy
        PK:
          title: Pakistan
        NZ:
          title: New Zealand
        GP:
          title: Guadeloupe
        NA:
          title: Namibia
        JM:
          title: Jamaica
        AX:
          title: Åland Islands
        CM:
          title: Cameroon
        US:
          title: United States of America (the)
        GU:
          title: Guam
        SB:
          title: Solomon Islands
        MV:
          title: Maldives
        SI:
          title: Slovenia
        CW:
          title: Curaçao
        BH:
          title: Bahrain
        VG:
          title: Virgin Islands (British)
        HK:
          title: Hong Kong
        SD:
          title: Sudan (the)
        AD:
          title: Andorra
        RO:
          title: Romania
        LU:
          title: Luxembourg
        VC:
          title: Saint Vincent and the Grenadines
        FO:
          title: Faroe Islands (the)
        GL:
          title: Greenland
        BW:
          title: Botswana
        CF:
          title: Central African Republic (the)
        CI:
          title: Côte d'Ivoire
        KG:
          title: Kyrgyzstan
        BV:
          title: Bouvet Island
        KY:
          title: Cayman Islands (the)
        LY:
          title: Libya
        MM:
          title: Myanmar
        MZ:
          title: Mozambique
        IR:
          title: Iran (Islamic Republic of)
        EH:
          title: Western Sahara
        IQ:
          title: Iraq
        BB:
          title: Barbados
        SZ:
          title: Eswatini
        IE:
          title: Ireland
        FK:
          title: Falkland Islands (the) [Malvinas]
        NP:
          title: Nepal
        BE:
          title: Belgium
        AU:
          title: Australia
        TZ:
          title: Tanzania, the United Republic of
        UY:
          title: Uruguay
        SA:
          title: Saudi Arabia
        ZW:
          title: Zimbabwe
        MD:
          title: Moldova (the Republic of)
        HU:
          title: Hungary
        PG:
          title: Papua New Guinea
        AF:
          title: Afghanistan
        MU:
          title: Mauritius
        SL:
          title: Sierra Leone
        GT:
          title: Guatemala
        BO:
          title: Bolivia (Plurinational State of)
        TM:
          title: Turkmenistan
        NE:
          title: Niger (the)
        CL:
          title: Chile
        FI:
          title: Finland
        MN:
          title: Mongolia
        'NO':
          title: Norway
        GG:
          title: Guernsey
        EE:
          title: Estonia
        KM:
          title: Comoros (the)
        LT:
          title: Lithuania
        ER:
          title: Eritrea
        SH:
          title: Saint Helena, Ascension and Tristan da Cunha
        SY:
          title: Syrian Arab Republic (the)
        LC:
          title: Saint Lucia
        CC:
          title: Cocos (Keeling) Islands (the)
        PL:
          title: Poland
        CH:
          title: Switzerland
        ST:
          title: Sao Tome and Principe
        NG:
          title: Nigeria
        TF:
          title: French Southern Territories (the)
        KI:
          title: Kiribati
        LV:
          title: Latvia
        UG:
          title: Uganda
        CY:
          title: Cyprus
        MW:
          title: Malawi
        CG:
          title: Congo (the)
        MF:
          title: Saint Martin (French part)
        PM:
          title: Saint Pierre and Miquelon
        IS:
          title: Iceland
        BI:
          title: Burundi
        TK:
          title: Tokelau
        SE:
          title: Sweden
        AE:
          title: United Arab Emirates (the)
        KZ:
          title: Kazakhstan
        LB:
          title: Lebanon
        AR:
          title: Argentina
        GS:
          title: South Georgia and the South Sandwich Islands
        BF:
          title: Burkina Faso
        DJ:
          title: Djibouti
        BA:
          title: Bosnia and Herzegovina
        SJ:
          title: Svalbard and Jan Mayen
        FR:
          title: France
        GM:
          title: Gambia (the)
        HR:
          title: Croatia
        BS:
          title: Bahamas (the)
        RS:
          title: Serbia
        WS:
          title: Samoa
        GB:
          title: United Kingdom of Great Britain and Northern Ireland (the)
        LS:
          title: Lesotho
        UZ:
          title: Uzbekistan
        PF:
          title: French Polynesia
        AG:
          title: Antigua and Barbuda
        GW:
          title: Guinea-Bissau
        FJ:
          title: Fiji
        CO:
          title: Colombia
        ZM:
          title: Zambia
        AQ:
          title: Antarctica
        GF:
          title: French Guiana
        NU:
          title: Niue
        BN:
          title: Brunei Darussalam
        RW:
          title: Rwanda
        PT:
          title: Portugal
        SO:
          title: Somalia
        MT:
          title: Malta
        PW:
          title: Palau
        KH:
          title: Cambodia
        SX:
          title: Sint Maarten (Dutch part)
        TJ:
          title: Tajikistan
        KR:
          title: Korea (the Republic of)
        SS:
          title: South Sudan
        PY:
          title: Paraguay
        AM:
          title: Armenia
        MC:
          title: Monaco
        CX:
          title: Christmas Island
        TT:
          title: Trinidad and Tobago
        UA:
          title: Ukraine
        LI:
          title: Liechtenstein
        BR:
          title: Brazil
        PA:
          title: Panama
        MQ:
          title: Martinique
        NR:
          title: Nauru
        PN:
          title: Pitcairn
        GA:
          title: Gabon
        TG:
          title: Togo
        FM:
          title: Micronesia (Federated States of)
        GN:
          title: Guinea
        YT:
          title: Mayotte
        CD:
          title: Congo (the Democratic Republic of the)
        MG:
          title: Madagascar
        AI:
          title: Anguilla
        YE:
          title: Yemen
        HN:
          title: Honduras
        IT:
          title: Italy
        RE:
          title: Réunion
        DO:
          title: Dominican Republic (the)
        IO:
          title: British Indian Ocean Territory (the)
        GR:
          title: Greece
        AS:
          title: American Samoa
        ZA:
          title: South Africa
        GY:
          title: Guyana
        BY:
          title: Belarus
        LK:
          title: Sri Lanka
        BT:
          title: Bhutan
        OM:
          title: Oman
        CK:
          title: Cook Islands (the)
        KE:
          title: Kenya
        CZ:
          title: Czechia
        GH:
          title: Ghana
        MX:
          title: Mexico
        SK:
          title: Slovakia
        MK:
          title: North Macedonia
        DZ:
          title: Algeria
        QA:
          title: Qatar
        CU:
          title: Cuba
        BJ:
          title: Benin
        LA:
          title: Lao People's Democratic Republic (the)
        TL:
          title: Timor-Leste
        DK:
          title: Denmark
        VI:
          title: Virgin Islands (U.S.)
        NL:
          title: Netherlands (Kingdom of the)
        CA:
          title: Canada
        BM:
          title: Bermuda
        JP:
          title: Japan
        AW:
          title: Aruba
        TO:
          title: Tonga
        CN:
          title: China
        VU:
          title: Vanuatu
        AL:
          title: Albania
        ET:
          title: Ethiopia
        IM:
          title: Isle of Man
        SN:
          title: Senegal
        PE:
          title: Peru
        BQ:
          title: Bonaire, Sint Eustatius and Saba
        NC:
          title: New Caledonia
        MP:
          title: Northern Mariana Islands (the)
        GE:
          title: Georgia
        CR:
          title: Costa Rica
        VA:
          title: Holy See (the)
        PS:
          title: Palestine, State of
        EC:
          title: Ecuador
        TV:
          title: Tuvalu
        LR:
          title: Liberia
        MS:
          title: Montserrat
        TD:
          title: Chad
        SC:
          title: Seychelles
        DE:
          title: Germany
        SR:
          title: Suriname
    PromotionPayMethodDoesNotMatchError:
      title: 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우
      description: 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우
      x-portone-status-code: 400
    CashReceiptNotFoundError:
      title: 현금영수증이 존재하지 않는 경우
      description: 현금영수증이 존재하지 않는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 현금영수증이 존재하지 않는 경우
      x-portone-status-code: 404
    CashReceiptInputType:
      title: 입력 시 발급 유형
      description: 입력 시 발급 유형
      type: string
      enum:
      - PERSONAL
      - CORPORATE
      - NO_RECEIPT
      x-portone-title: 입력 시 발급 유형
      x-portone-enum:
        PERSONAL:
          title: 소득공제용
        CORPORATE:
          title: 지출증빙용
        NO_RECEIPT:
          title: 미발행
          description: PG사 설정에 따라 PG사가 자동으로 자진발급 처리할 수 있습니다.
    PaymentMethodEasyPayMethod:
      title: 간편 결제 수단
      description: 간편 결제 수단
      oneOf:
      - $ref: '#/components/schemas/PaymentMethodCard'
      - $ref: '#/components/schemas/PaymentMethodEasyPayMethodCharge'
      - $ref: '#/components/schemas/PaymentMethodTransfer'
      discriminator:
        propertyName: type
        mapping:
          PaymentMethodCard: '#/components/schemas/PaymentMethodCard'
          PaymentMethodEasyPayMethodCharge: '#/components/schemas/PaymentMethodEasyPayMethodCharge'
          PaymentMethodTransfer: '#/components/schemas/PaymentMethodTransfer'
      x-portone-title: 간편 결제 수단
      x-portone-discriminator:
        PaymentMethodCard:
          title: 결제수단 카드 정보
        PaymentMethodTransfer:
          title: 계좌 이체 상세 정보
        PaymentMethodEasyPayMethodCharge:
          title: 충전식 포인트 결제 정보
    PaymentInstallment:
      title: 할부 정보
      description: 할부 정보
      type: object
      required:
      - month
      - isInterestFree
      properties:
        month:
          type: integer
          format: int32
          title: 할부 개월 수
        isInterestFree:
          type: boolean
          title: 무이자할부 여부
        isInterestFreeFromMerchant:
          type: boolean
          title: 상점 부담 무이자할부 여부
          description: 정보 필요시 포트원과 협의해 주세요.
      x-portone-title: 할부 정보
    CancelPaymentError:
      title: CancelPaymentError
      oneOf:
      - $ref: '#/components/schemas/CancelAmountExceedsCancellableAmountError'
      - $ref: '#/components/schemas/CancelTaxAmountExceedsCancellableTaxAmountError'
      - $ref: '#/components/schemas/CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError'
      - $ref: '#/components/schemas/CancellableAmountConsistencyBrokenError'
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/MaxCancelCountReachedError'
      - $ref: '#/components/schemas/NegativePromotionAdjustedCancelAmountError'
      - $ref: '#/components/schemas/PaymentAlreadyCancelledError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PaymentNotPaidError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/PromotionDiscountRetainOptionShouldNotBeChangedError'
      - $ref: '#/components/schemas/SumOfPartsExceedsCancelAmountError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          CANCELLABLE_AMOUNT_CONSISTENCY_BROKEN: '#/components/schemas/CancellableAmountConsistencyBrokenError'
          CANCEL_AMOUNT_EXCEEDS_CANCELLABLE_AMOUNT: '#/components/schemas/CancelAmountExceedsCancellableAmountError'
          CANCEL_TAX_AMOUNT_EXCEEDS_CANCELLABLE_TAX_AMOUNT: '#/components/schemas/CancelTaxAmountExceedsCancellableTaxAmountError'
          CANCEL_TAX_FREE_AMOUNT_EXCEEDS_CANCELLABLE_TAX_FREE_AMOUNT: '#/components/schemas/CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError'
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          MAX_CANCEL_COUNT_REACHED: '#/components/schemas/MaxCancelCountReachedError'
          NEGATIVE_PROMOTION_ADJUSTED_CANCEL_AMOUNT: '#/components/schemas/NegativePromotionAdjustedCancelAmountError'
          PAYMENT_ALREADY_CANCELLED: '#/components/schemas/PaymentAlreadyCancelledError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PAYMENT_NOT_PAID: '#/components/schemas/PaymentNotPaidError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          PROMOTION_DISCOUNT_RETAIN_OPTION_SHOULD_NOT_BE_CHANGED: '#/components/schemas/PromotionDiscountRetainOptionShouldNotBeChangedError'
          SUM_OF_PARTS_EXCEEDS_CANCEL_AMOUNT: '#/components/schemas/SumOfPartsExceedsCancelAmountError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    CardCredential:
      title: 카드 인증 관련 정보
      description: 카드 인증 관련 정보
      type: object
      required:
      - number
      - expiryYear
      - expiryMonth
      properties:
        number:
          type: string
          title: 카드 번호 (숫자만)
        expiryYear:
          type: string
          title: 유효 기간 만료 연도 (2자리)
        expiryMonth:
          type: string
          title: 유효 기간 만료 월 (2자리)
        birthOrBusinessRegistrationNumber:
          type: string
          title: 생년월일 (yyMMdd) 또는 사업자 등록 번호 (10자리, 숫자만)
        passwordTwoDigits:
          type: string
          title: 비밀번호 앞 2자리
      x-portone-title: 카드 인증 관련 정보
    PaymentWebhookPaymentStatus:
      title: 웹훅 발송 시 결제 건 상태
      description: 웹훅 발송 시 결제 건 상태
      type: string
      enum:
      - READY
      - VIRTUAL_ACCOUNT_ISSUED
      - PAID
      - FAILED
      - PARTIAL_CANCELLED
      - CANCELLED
      - PAY_PENDING
      x-portone-title: 웹훅 발송 시 결제 건 상태
      x-portone-enum:
        VIRTUAL_ACCOUNT_ISSUED: {}
        PAID: {}
        READY: {}
        FAILED: {}
        PAY_PENDING: {}
        CANCELLED: {}
        PARTIAL_CANCELLED: {}
    CancelTaxAmountExceedsCancellableTaxAmountError:
      title: 취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우
      description: 취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우
      x-portone-status-code: 409
    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: 반환된 페이지 결과 정보
    PortOneVersion:
      title: 포트원 버전
      description: 포트원 버전
      type: string
      enum:
      - V1
      - V2
      x-portone-title: 포트원 버전
      x-portone-enum:
        V1: {}
        V2: {}
    BillingKeyPaymentSummary:
      title: 빌링키 결제 완료된 결제 건 요약 정보
      description: 빌링키 결제 완료된 결제 건 요약 정보
      type: object
      required:
      - pgTxId
      - paidAt
      properties:
        pgTxId:
          type: string
          title: PG사 결제 아이디
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점
      x-portone-title: 빌링키 결제 완료된 결제 건 요약 정보
    CloseVirtualAccountError:
      title: CloseVirtualAccountError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PaymentNotWaitingForDepositError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PAYMENT_NOT_WAITING_FOR_DEPOSIT: '#/components/schemas/PaymentNotWaitingForDepositError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    CloseVirtualAccountResponse:
      title: 가상계좌 말소 성공 응답
      description: 가상계좌 말소 성공 응답
      type: object
      required:
      - closedAt
      properties:
        closedAt:
          type: string
          format: date-time
          title: 가상계좌 말소 시점
      x-portone-title: 가상계좌 말소 성공 응답
    PayInstantlyResponse:
      title: 수기 결제 성공 응답
      description: 수기 결제 성공 응답
      type: object
      required:
      - payment
      properties:
        payment:
          $ref: '#/components/schemas/InstantPaymentSummary'
          title: 결제 건 요약 정보
      x-portone-title: 수기 결제 성공 응답
    PreRegisterPaymentBody:
      title: 결제 정보 사전 등록 입력 정보
      description: 결제 정보 사전 등록 입력 정보
      type: object
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        totalAmount:
          type: integer
          format: int64
          title: 결제 총 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 결제 면세 금액
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
      x-portone-title: 결제 정보 사전 등록 입력 정보
    InformationMismatchError:
      title: 정보가 일치하지 않는 경우
      description: 정보가 일치하지 않는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 정보가 일치하지 않는 경우
      x-portone-status-code: 409
    PaymentEscrowReceiverInput:
      title: 에스크로 수취인 정보
      description: 에스크로 수취인 정보
      type: object
      properties:
        name:
          type: string
          title: 이름
        phoneNumber:
          type: string
          title: 전화번호
        zipcode:
          type: string
          title: 우편번호
        address:
          $ref: '#/components/schemas/SeparatedAddressInput'
          title: 주소
      x-portone-title: 에스크로 수취인 정보
    SelectedChannel:
      title: (결제, 본인인증 등에) 선택된 채널 정보
      description: (결제, 본인인증 등에) 선택된 채널 정보
      type: object
      required:
      - type
      - pgProvider
      - pgMerchantId
      properties:
        type:
          $ref: '#/components/schemas/SelectedChannelType'
          title: 채널 타입
        id:
          type: string
          title: 채널 아이디
        key:
          type: string
          title: 채널 키
        name:
          type: string
          title: 채널 명
        pgProvider:
          $ref: '#/components/schemas/PgProvider'
          title: PG사 결제 모듈
        pgMerchantId:
          type: string
          title: PG사 고객사 식별 아이디
      x-portone-title: (결제, 본인인증 등에) 선택된 채널 정보
    CancelPaymentBodyRefundAccount:
      title: 고객 정보 입력 형식
      description: 고객 정보 입력 형식
      type: object
      required:
      - bank
      - number
      - holderName
      properties:
        bank:
          $ref: '#/components/schemas/Bank'
          title: 은행
        number:
          type: string
          title: 계좌번호
        holderName:
          type: string
          title: 예금주
        holderPhoneNumber:
          type: string
          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
    StopPaymentCancellationError:
      title: StopPaymentCancellationError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentCancellationNotFoundError'
      - $ref: '#/components/schemas/PaymentCancellationNotPendingError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_CANCELLATION_NOT_FOUND: '#/components/schemas/PaymentCancellationNotFoundError'
          PAYMENT_CANCELLATION_NOT_PENDING: '#/components/schemas/PaymentCancellationNotPendingError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    PaymentCancellationNotPendingError:
      title: 결제 취소 내역이 취소 요청 상태가 아닌 경우
      description: 결제 취소 내역이 취소 요청 상태가 아닌 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제 취소 내역이 취소 요청 상태가 아닌 경우
      x-portone-status-code: 409
    DateTimeRange:
      title: 시간 범위
      description: 시간 범위
      type: object
      required:
      - from
      - until
      properties:
        from:
          type: string
          format: date-time
        until:
          type: string
          format: date-time
      x-portone-title: 시간 범위
    GetPaymentsResponse:
      title: 결제 건 다건 조회 성공 응답 정보
      description: 결제 건 다건 조회 성공 응답 정보
      type: object
      required:
      - items
      - page
      properties:
        items:
          title: 조회된 결제 건 리스트
          type: array
          items:
            $ref: '#/components/schemas/Payment'
        page:
          $ref: '#/components/schemas/PageInfo'
          title: 조회된 페이지 정보
      x-portone-title: 결제 건 다건 조회 성공 응답 정보
    PaymentCashReceipt:
      title: 결제 건 내 현금영수증 정보
      description: 결제 건 내 현금영수증 정보
      oneOf:
      - $ref: '#/components/schemas/CancelledPaymentCashReceipt'
      - $ref: '#/components/schemas/IssuedPaymentCashReceipt'
      discriminator:
        propertyName: status
        mapping:
          CANCELLED: '#/components/schemas/CancelledPaymentCashReceipt'
          ISSUED: '#/components/schemas/IssuedPaymentCashReceipt'
      x-portone-title: 결제 건 내 현금영수증 정보
      x-portone-discriminator:
        ISSUED:
          title: 발급 완료
        CANCELLED:
          title: 발급 취소
    PayPendingPaymentTransaction:
      title: 결제 완료 대기 상태 건
      description: 결제 완료 대기 상태 건
      type: object
      required:
      - status
      - id
      - paymentId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      properties:
        status:
          type: string
          title: 결제 시도 상태
        id:
          type: string
          title: 결제 시도 아이디 (transactionId)
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        paymentId:
          type: string
          title: 결제 건 아이디
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        pgTxId:
          type: string
          title: PG사 거래 아이디
      x-portone-title: 결제 완료 대기 상태 건
    PreRegisterPaymentResponse:
      title: 결제 사전 등록 성공 응답
      description: 결제 사전 등록 성공 응답
      type: object
      x-portone-title: 결제 사전 등록 성공 응답
    CashReceiptIssuanceStatus:
      title: 현금영수증 발행여부
      description: 현금영수증 발행여부
      type: string
      enum:
      - ISSUED
      - NOT_ISSUED
      x-portone-title: 현금영수증 발행여부
      x-portone-enum:
        ISSUED:
          title: 발행 완료
        NOT_ISSUED:
          title: 미발행
    MaxWebhookRetryCountReachedError:
      title: 동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우
      description: 동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우
      x-portone-status-code: 400
    PaymentProduct:
      title: 상품 정보
      description: 상품 정보
      type: object
      required:
      - id
      - name
      - amount
      - quantity
      properties:
        id:
          type: string
          title: 상품 고유 식별자
          description: 고객사가 직접 부여한 식별자입니다.
        name:
          type: string
          title: 상품명
        tag:
          type: string
          title: 상품 태그
          description: 카테고리 등으로 활용될 수 있습니다.
        code:
          type: string
          title: 상품 코드
        amount:
          type: integer
          format: int64
          title: 상품 단위가격
        quantity:
          type: integer
          format: int32
          title: 주문 수량
        link:
          type: string
          title: 판매 링크
      x-portone-title: 상품 정보
    PaymentMethodGiftCertificate:
      title: 상품권 상세 정보
      description: 상품권 상세 정보
      type: object
      required:
      - type
      - approvalNumber
      properties:
        type:
          type: string
        giftCertificateType:
          $ref: '#/components/schemas/PaymentMethodGiftCertificateType'
          title: 상품권 종류
        approvalNumber:
          type: string
          title: 상품권 승인 번호
      x-portone-title: 상품권 상세 정보
    MaxTransactionCountReachedError:
      title: 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
      description: 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
      x-portone-status-code: 400
    PaymentMethodVirtualAccountRefundStatus:
      title: 가상계좌 환불 상태
      description: 가상계좌 환불 상태
      type: string
      enum:
      - PENDING
      - PARTIAL_REFUND_FAILED
      - FAILED
      - COMPLETED
      x-portone-title: 가상계좌 환불 상태
      x-portone-enum:
        PENDING:
          title: 처리중
        PARTIAL_REFUND_FAILED:
          title: 부분 환불 실패
        FAILED:
          title: 환불 실패
        COMPLETED:
          title: 환불 완료
    DisputeStatus:
      title: 분쟁 상태
      description: 분쟁 상태
      type: string
      enum:
      - UNRESOLVED
      - RESOLVED
      x-portone-title: 분쟁 상태
      x-portone-enum:
        UNRESOLVED:
          title: 분쟁 발생 상태
          description: 분쟁이 발생하였으며 아직 해소되지 않은 상태입니다.
        RESOLVED:
          title: 분쟁 해소 상태
          description: 분쟁이 발생하였으나 해소된 상태입니다.
    SeparatedAddressInput:
      title: 분리 형식 주소 입력 정보
      description: 분리 형식 주소 입력 정보
      type: object
      required:
      - addressLine1
      - addressLine2
      properties:
        addressLine1:
          type: string
          title: 상세 주소 1
        addressLine2:
          type: string
          title: 상세 주소 2
        city:
          type: string
          title: 시/군/구
        province:
          type: string
          title: 주/도/시
        country:
          $ref: '#/components/schemas/Country'
          title: 국가
      x-portone-title: 분리 형식 주소 입력 정보
    SortOrder:
      title: 정렬 방식
      description: 정렬 방식
      type: string
      enum:
      - DESC
      - ASC
      x-portone-title: 정렬 방식
      x-portone-enum:
        DESC:
          title: 내림차순
        ASC:
          title: 오름차순
    IssuedPaymentCashReceipt:
      title: 발급 완료된 현금영수증
      description: 발급 완료된 현금영수증
      type: object
      required:
      - status
      - issueNumber
      - totalAmount
      - currency
      - issuedAt
      properties:
        status:
          type: string
          title: 결제 건 내 현금영수증 상태
        type:
          $ref: '#/components/schemas/CashReceiptType'
          title: 현금영수증 유형
        pgReceiptId:
          type: string
          title: PG사 영수증 발급 아이디
        issueNumber:
          type: string
          title: 승인 번호
        totalAmount:
          type: integer
          format: int64
          title: 총 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 면세액
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        url:
          type: string
          title: 현금영수증 URL
        issuedAt:
          type: string
          format: date-time
          title: 발급 시점
      x-portone-title: 발급 완료된 현금영수증
    InstantPaymentMethodInputVirtualAccountOption:
      title: 가상계좌 발급 방식
      description: 가상계좌 발급 방식
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/InstantPaymentMethodInputVirtualAccountOptionType'
          title: 발급 유형
        fixed:
          $ref: '#/components/schemas/InstantPaymentMethodInputVirtualAccountOptionFixed'
          title: 고정식 가상계좌 발급 방식
          description: 발급 유형을 FIXED 로 선택했을 시에만 입력합니다.
      x-portone-title: 가상계좌 발급 방식
    CancelCashReceiptError:
      title: CancelCashReceiptError
      oneOf:
      - $ref: '#/components/schemas/CashReceiptNotFoundError'
      - $ref: '#/components/schemas/CashReceiptNotIssuedError'
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          CASH_RECEIPT_NOT_FOUND: '#/components/schemas/CashReceiptNotFoundError'
          CASH_RECEIPT_NOT_ISSUED: '#/components/schemas/CashReceiptNotIssuedError'
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    Payment:
      title: 결제 건
      description: 결제 건
      oneOf:
      - $ref: '#/components/schemas/CancelledPayment'
      - $ref: '#/components/schemas/FailedPayment'
      - $ref: '#/components/schemas/PaidPayment'
      - $ref: '#/components/schemas/PartialCancelledPayment'
      - $ref: '#/components/schemas/PayPendingPayment'
      - $ref: '#/components/schemas/ReadyPayment'
      - $ref: '#/components/schemas/VirtualAccountIssuedPayment'
      discriminator:
        propertyName: status
        mapping:
          CANCELLED: '#/components/schemas/CancelledPayment'
          FAILED: '#/components/schemas/FailedPayment'
          PAID: '#/components/schemas/PaidPayment'
          PARTIAL_CANCELLED: '#/components/schemas/PartialCancelledPayment'
          PAY_PENDING: '#/components/schemas/PayPendingPayment'
          READY: '#/components/schemas/ReadyPayment'
          VIRTUAL_ACCOUNT_ISSUED: '#/components/schemas/VirtualAccountIssuedPayment'
      x-portone-title: 결제 건
      x-portone-discriminator:
        VIRTUAL_ACCOUNT_ISSUED:
          title: 가상계좌 발급 완료
        PAID:
          title: 결제 완료
        READY:
          title: 결제 준비
        FAILED:
          title: 결제 실패
        PAY_PENDING:
          title: 결제 완료 대기
        CANCELLED:
          title: 결제 취소
        PARTIAL_CANCELLED:
          title: 결제 부분 취소
    PaymentTransaction:
      title: 결제 시도
      description: 결제 시도
      oneOf:
      - $ref: '#/components/schemas/CancelledPaymentTransaction'
      - $ref: '#/components/schemas/FailedPaymentTransaction'
      - $ref: '#/components/schemas/PaidPaymentTransaction'
      - $ref: '#/components/schemas/PartialCancelledPaymentTransaction'
      - $ref: '#/components/schemas/PayPendingPaymentTransaction'
      - $ref: '#/components/schemas/ReadyPaymentTransaction'
      - $ref: '#/components/schemas/VirtualAccountIssuedPaymentTransaction'
      discriminator:
        propertyName: status
        mapping:
          CANCELLED: '#/components/schemas/CancelledPaymentTransaction'
          FAILED: '#/components/schemas/FailedPaymentTransaction'
          PAID: '#/components/schemas/PaidPaymentTransaction'
          PARTIAL_CANCELLED: '#/components/schemas/PartialCancelledPaymentTransaction'
          PAY_PENDING: '#/components/schemas/PayPendingPaymentTransaction'
          READY: '#/components/schemas/ReadyPaymentTransaction'
          VIRTUAL_ACCOUNT_ISSUED: '#/components/schemas/VirtualAccountIssuedPaymentTransaction'
      x-portone-title: 결제 시도
      x-portone-discriminator:
        VIRTUAL_ACCOUNT_ISSUED:
          title: 가상계좌 발급 완료
        PAID:
          title: 결제 완료
        READY:
          title: 결제 준비
        FAILED:
          title: 결제 실패
        PAY_PENDING:
          title: 결제 완료 대기
        CANCELLED:
          title: 결제 취소
        PARTIAL_CANCELLED:
          title: 결제 부분 취소
    PgProvider:
      title: PG사 결제 모듈
      description: PG사 결제 모듈
      type: string
      enum:
      - HTML5_INICIS
      - PAYPAL
      - PAYPAL_V2
      - INICIS
      - DANAL
      - NICE
      - DANAL_TPAY
      - JTNET
      - UPLUS
      - NAVERPAY
      - KAKAO
      - SETTLE
      - KCP
      - MOBILIANS
      - KAKAOPAY
      - NAVERCO
      - SYRUP
      - KICC
      - EXIMBAY
      - SMILEPAY
      - PAYCO
      - KCP_BILLING
      - ALIPAY
      - PAYPLE
      - CHAI
      - BLUEWALNUT
      - SMARTRO
      - SMARTRO_V2
      - PAYMENTWALL
      - TOSSPAYMENTS
      - KCP_QUICK
      - DAOU
      - GALAXIA
      - TOSSPAY
      - KCP_DIRECT
      - SETTLE_ACC
      - SETTLE_FIRM
      - INICIS_UNIFIED
      - KSNET
      - PINPAY
      - NICE_V2
      - TOSS_BRANDPAY
      - WELCOME
      - TOSSPAY_V2
      - INICIS_V2
      - KPN
      - KCP_V2
      - HYPHEN
      - EXIMBAY_V2
      - INICIS_JP
      - PAYLETTER_GLOBAL
      - MOBILIANS_V2
      - TRIPLE_A
      - KICC_V2
      - INNOPAY
      - HECTO_GLOBAL
      x-portone-title: PG사 결제 모듈
      x-portone-enum:
        KICC: {}
        SYRUP: {}
        KCP_BILLING: {}
        SMARTRO_V2: {}
        CHAI: {}
        NICE_V2: {}
        KAKAO: {}
        DANAL: {}
        KAKAOPAY: {}
        EXIMBAY: {}
        ALIPAY: {}
        HTML5_INICIS: {}
        WELCOME: {}
        SMARTRO: {}
        PAYLETTER_GLOBAL: {}
        PAYCO: {}
        SMILEPAY: {}
        PAYMENTWALL: {}
        NAVERPAY: {}
        EXIMBAY_V2: {}
        INNOPAY: {}
        KCP_QUICK: {}
        NAVERCO: {}
        DAOU: {}
        GALAXIA: {}
        PINPAY: {}
        MOBILIANS_V2: {}
        INICIS_JP: {}
        SETTLE_ACC: {}
        TOSSPAY_V2: {}
        TOSSPAY: {}
        SETTLE_FIRM: {}
        INICIS: {}
        TOSS_BRANDPAY: {}
        JTNET: {}
        PAYPAL: {}
        DANAL_TPAY: {}
        KCP_DIRECT: {}
        SETTLE: {}
        MOBILIANS: {}
        UPLUS: {}
        HYPHEN: {}
        PAYPAL_V2: {}
        HECTO_GLOBAL: {}
        TRIPLE_A: {}
        KPN: {}
        KICC_V2: {}
        INICIS_V2: {}
        KCP_V2: {}
        INICIS_UNIFIED: {}
        BLUEWALNUT: {}
        NICE: {}
        TOSSPAYMENTS: {}
        PAYPLE: {}
        KSNET: {}
        KCP: {}
    GetPaymentTransactionsError:
      title: GetPaymentTransactionsError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    CancelPaymentResponse:
      title: 결제 취소 성공 응답
      description: 결제 취소 성공 응답
      type: object
      required:
      - cancellation
      properties:
        cancellation:
          $ref: '#/components/schemas/PaymentCancellation'
          title: 결제 취소 내역
      x-portone-title: 결제 취소 성공 응답
    PaymentMethod:
      title: 결제수단 정보
      description: 결제수단 정보
      oneOf:
      - $ref: '#/components/schemas/PaymentMethodCard'
      - $ref: '#/components/schemas/PaymentMethodConvenienceStore'
      - $ref: '#/components/schemas/PaymentMethodCrypto'
      - $ref: '#/components/schemas/PaymentMethodEasyPay'
      - $ref: '#/components/schemas/PaymentMethodGiftCertificate'
      - $ref: '#/components/schemas/PaymentMethodMobile'
      - $ref: '#/components/schemas/PaymentMethodTransfer'
      - $ref: '#/components/schemas/PaymentMethodVirtualAccount'
      discriminator:
        propertyName: type
        mapping:
          PaymentMethodCard: '#/components/schemas/PaymentMethodCard'
          PaymentMethodConvenienceStore: '#/components/schemas/PaymentMethodConvenienceStore'
          PaymentMethodCrypto: '#/components/schemas/PaymentMethodCrypto'
          PaymentMethodEasyPay: '#/components/schemas/PaymentMethodEasyPay'
          PaymentMethodGiftCertificate: '#/components/schemas/PaymentMethodGiftCertificate'
          PaymentMethodMobile: '#/components/schemas/PaymentMethodMobile'
          PaymentMethodTransfer: '#/components/schemas/PaymentMethodTransfer'
          PaymentMethodVirtualAccount: '#/components/schemas/PaymentMethodVirtualAccount'
      x-portone-title: 결제수단 정보
      x-portone-discriminator:
        PaymentMethodCard:
          title: 결제수단 카드 정보
        PaymentMethodConvenienceStore:
          title: 편의점 결제 상세 정보
        PaymentMethodEasyPay:
          title: 간편 결제 상세 정보
        PaymentMethodMobile:
          title: 모바일 상세 정보
        PaymentMethodGiftCertificate:
          title: 상품권 상세 정보
        PaymentMethodCrypto:
          title: 암호화폐 결제 상세 정보
        PaymentMethodTransfer:
          title: 계좌 이체 상세 정보
        PaymentMethodVirtualAccount:
          title: 가상계좌 상세 정보
    CardType:
      title: 카드 유형
      description: 카드 유형
      type: string
      enum:
      - CREDIT
      - DEBIT
      - GIFT
      x-portone-title: 카드 유형
      x-portone-enum:
        CREDIT:
          title: 신용카드
        DEBIT:
          title: 체크카드
        GIFT:
          title: 기프트카드
    CashReceiptType:
      title: 발급 유형
      description: 발급 유형
      type: string
      enum:
      - PERSONAL
      - CORPORATE
      x-portone-title: 발급 유형
      x-portone-enum:
        PERSONAL:
          title: 소득공제용
        CORPORATE:
          title: 지출증빙용
    RegisteredPaymentEscrow:
      title: 배송 정보 등록 완료
      description: 배송 정보 등록 완료
      type: object
      required:
      - status
      - company
      - invoiceNumber
      properties:
        status:
          type: string
          title: 에스크로 상태
        company:
          type: string
          title: 택배사
        invoiceNumber:
          type: string
          title: 송장번호
        sentAt:
          type: string
          format: date-time
          title: 발송 일시
        appliedAt:
          type: string
          format: date-time
          title: 배송등록 처리 일자
      x-portone-title: 배송 정보 등록 완료
    Locale:
      title: 결제 언어
      description: 결제 언어
      type: string
      enum:
      - KO_KR
      - EN_US
      - ZH_CN
      - ZH_TW
      - JA_JP
      - RU_RU
      - TH_TH
      - VI_VN
      x-portone-title: 결제 언어
      x-portone-enum:
        KO_KR:
          title: 한국어 (대한민국)
        VI_VN:
          title: 베트남어 (베트남)
        ZH_CN:
          title: 중국어 (중국)
        TH_TH:
          title: 타이어 (타이)
        ZH_TW:
          title: 중국어 (대만)
        EN_US:
          title: 영어 (미국)
        JA_JP:
          title: 일본어 (일본)
        RU_RU:
          title: 러시아어 (러시아)
    GetPaymentTransactionsResponse:
      title: 결제 시도 내역 조회 응답 정보
      description: 결제 시도 내역 조회 응답 정보
      type: object
      required:
      - items
      properties:
        items:
          title: 결제 시도 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentTransaction'
      x-portone-title: 결제 시도 내역 조회 응답 정보
    PaymentOrigin:
      title: 결제 출처 정보
      description: 결제 출처 정보
      type: object
      required:
      - platformType
      - ipAddress
      properties:
        platformType:
          $ref: '#/components/schemas/PaymentOriginPlatformType'
          title: 결제를 요청한 플랫폼 타입
        userAgent:
          type: string
          title: 결제를 요청한 user agent 문자열
        url:
          type: string
          title: 결제를 요청한 페이지 URL
        ipAddress:
          type: string
          title: 결제를 요청한 IP 주소
      x-portone-title: 결제 출처 정보
    Address:
      title: 분리 형식 주소
      description: '분리 형식 주소


        oneLine(한 줄 형식 주소) 필드는 항상 존재합니다.'
      oneOf:
      - $ref: '#/components/schemas/OneLineAddress'
      - $ref: '#/components/schemas/SeparatedAddress'
      discriminator:
        propertyName: type
        mapping:
          ONE_LINE: '#/components/schemas/OneLineAddress'
          SEPARATED: '#/components/schemas/SeparatedAddress'
      x-portone-title: 분리 형식 주소
      x-portone-description: oneLine(한 줄 형식 주소) 필드는 항상 존재합니다.
      x-portone-discriminator:
        ONE_LINE:
          title: 한 줄 형식
        SEPARATED:
          title: 분리 형식
    PaymentCancellationNotFoundError:
      title: 결제 취소 내역이 존재하지 않는 경우
      description: 결제 취소 내역이 존재하지 않는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제 취소 내역이 존재하지 않는 경우
      x-portone-status-code: 404
    InstantPaymentMethodInput:
      title: 수기 결제 수단 입력 정보
      description: '수기 결제 수단 입력 정보


        하나의 필드만 입력합니다.'
      type: object
      properties:
        card:
          $ref: '#/components/schemas/InstantPaymentMethodInputCard'
          title: 카드
        virtualAccount:
          $ref: '#/components/schemas/InstantPaymentMethodInputVirtualAccount'
          title: 가상계좌
      x-portone-title: 수기 결제 수단 입력 정보
      x-portone-description: 하나의 필드만 입력합니다.
    PromotionDiscountRetainOptionShouldNotBeChangedError:
      title: 프로모션 혜택 유지 옵션을 이전 부분 취소와 다른 것으로 입력한 경우
      description: 프로모션 혜택 유지 옵션을 이전 부분 취소와 다른 것으로 입력한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 프로모션 혜택 유지 옵션을 이전 부분 취소와 다른 것으로 입력한 경우
      x-portone-status-code: 400
    MaxCancelCountReachedError:
      title: 취소 시도 횟수가 초과된 경우
      description: 취소 시도 횟수가 초과된 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 취소 시도 횟수가 초과된 경우
      x-portone-status-code: 409
    ChannelGroupSummary:
      title: 채널 그룹 정보
      description: 채널 그룹 정보
      type: object
      required:
      - id
      - name
      - isForTest
      properties:
        id:
          type: string
          title: 채널 그룹 아이디
        name:
          type: string
          title: 채널 그룹 이름
        isForTest:
          type: boolean
          title: 테스트 채널 그룹 여부
      x-portone-title: 채널 그룹 정보
    SumOfPartsExceedsCancelAmountError:
      title: 면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우
      description: 면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우
      x-portone-status-code: 409
    Card:
      title: 카드 상세 정보
      description: 카드 상세 정보
      type: object
      properties:
        publisher:
          type: string
          title: 발행사 코드
        issuer:
          type: string
          title: 발급사 코드
        brand:
          $ref: '#/components/schemas/CardBrand'
          title: 카드 브랜드
        type:
          $ref: '#/components/schemas/CardType'
          title: 카드 유형
        ownerType:
          $ref: '#/components/schemas/CardOwnerType'
          title: 카드 소유주 유형
        bin:
          type: string
          title: 카드 번호 앞 6자리 또는 8자리의 BIN (Bank Identification Number)
        name:
          type: string
          title: 카드 상품명
        number:
          type: string
          title: 마스킹된 카드 번호
      x-portone-title: 카드 상세 정보
    InstantPaymentInput:
      title: 수기 결제 요청 정보
      description: 수기 결제 요청 정보
      type: object
      required:
      - method
      - orderName
      - amount
      - currency
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        channelKey:
          type: string
          title: 채널 키
          description: 채널 키 또는 채널 그룹 ID 필수
        channelGroupId:
          type: string
          title: 채널 그룹 ID
          description: 채널 키 또는 채널 그룹 ID 필수
        method:
          $ref: '#/components/schemas/InstantPaymentMethodInput'
          title: 결제수단 정보
        orderName:
          type: string
          title: 주문명
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
          description: 기본값은 false 입니다.
        isEscrow:
          type: boolean
          title: 에스크로 결제 여부
          description: 기본값은 false 입니다.
        customer:
          $ref: '#/components/schemas/CustomerInput'
          title: 고객 정보
        customData:
          type: string
          title: 사용자 지정 데이터
        amount:
          $ref: '#/components/schemas/PaymentAmountInput'
          title: 결제 금액 세부 입력 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        country:
          $ref: '#/components/schemas/Country'
          title: 결제 국가
        noticeUrls:
          type: array
          items:
            type: string
          title: 웹훅 주소
          description: '결제 웹훅 주소입니다.

            상점에 설정되어 있는 값보다 우선적으로 적용됩니다.

            빈 배열은 무시됩니다.'
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
          description: 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
        productCount:
          type: integer
          format: int32
          title: 상품 개수
        productType:
          $ref: '#/components/schemas/PaymentProductType'
          title: 상품 유형
        shippingAddress:
          $ref: '#/components/schemas/SeparatedAddressInput'
          title: 배송지 주소
        promotionId:
          type: string
          title: 해당 결제에 적용할 프로모션 아이디
        bypass:
          type: object
          title: PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
        skipWebhook:
          type: boolean
          title: 웹훅 생략 여부
          description: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
      x-portone-title: 수기 결제 요청 정보
    InstantPaymentMethodInputVirtualAccountOptionType:
      title: 가상계좌 발급 유형
      description: 가상계좌 발급 유형
      type: string
      enum:
      - NORMAL
      - FIXED
      x-portone-title: 가상계좌 발급 유형
      x-portone-enum:
        NORMAL:
          title: 회전식 가상계좌
          description: 일반적으로 사용되는 방식이며 PG사에서 직접 채번한 가상계좌번호를 사용합니다.
        FIXED:
          title: 고정식 가상계좌
    InvalidPaymentTokenError:
      title: 유효하지 않은 결제 토큰인 경우
      description: 유효하지 않은 결제 토큰인 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 유효하지 않은 결제 토큰인 경우
      x-portone-status-code: 400
    CashReceiptInput:
      title: 현금영수증 입력 정보
      description: 현금영수증 입력 정보
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/CashReceiptInputType'
          title: 현금영수증 유형
        customerIdentityNumber:
          type: string
          title: 사용자 식별 번호
          description: 미발행 유형 선택 시 입력하지 않습니다.
      x-portone-title: 현금영수증 입력 정보
    StopPaymentCancellationResponse:
      title: 결제 취소 요청 취소 성공 응답
      description: 결제 취소 요청 취소 성공 응답
      type: object
      required:
      - stoppedAt
      properties:
        stoppedAt:
          type: string
          format: date-time
          title: 결제 취소 요청 취소 완료 시각
      x-portone-title: 결제 취소 요청 취소 성공 응답
    GetCashReceiptError:
      title: GetCashReceiptError
      oneOf:
      - $ref: '#/components/schemas/CashReceiptNotFoundError'
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          CASH_RECEIPT_NOT_FOUND: '#/components/schemas/CashReceiptNotFoundError'
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    CancelledPaymentTransaction:
      title: 결제 취소 상태 건
      description: 결제 취소 상태 건
      type: object
      required:
      - status
      - id
      - paymentId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - cancellations
      - cancelledAt
      properties:
        status:
          type: string
          title: 결제 시도 상태
        id:
          type: string
          title: 결제 시도 아이디 (transactionId)
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        paymentId:
          type: string
          title: 결제 건 아이디
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점
        pgTxId:
          type: string
          title: PG사 거래 아이디
        cashReceipt:
          $ref: '#/components/schemas/PaymentCashReceipt'
          title: 현금영수증
        cashReceiptIssuanceStatus:
          $ref: '#/components/schemas/CashReceiptIssuanceStatus'
          title: 현금영수증 발행여부
          description: '승인 시점에 확인된 발행여부입니다.

            발행번호 없이 발행여부만 제공 가능한 경우, ISSUED이면서 cashReceipt가 존재하지 않을 수 있습니다.'
        receiptUrl:
          type: string
          title: 거래 영수증 URL
        cancellations:
          title: 결제 취소 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentCancellation'
        cancelledAt:
          type: string
          format: date-time
          title: 결제 취소 시점
      x-portone-title: 결제 취소 상태 건
    PaymentCancellation:
      title: 결제 취소 내역
      description: 결제 취소 내역
      oneOf:
      - $ref: '#/components/schemas/FailedPaymentCancellation'
      - $ref: '#/components/schemas/RequestedPaymentCancellation'
      - $ref: '#/components/schemas/SucceededPaymentCancellation'
      discriminator:
        propertyName: status
        mapping:
          FAILED: '#/components/schemas/FailedPaymentCancellation'
          REQUESTED: '#/components/schemas/RequestedPaymentCancellation'
          SUCCEEDED: '#/components/schemas/SucceededPaymentCancellation'
      x-portone-title: 결제 취소 내역
      x-portone-discriminator:
        REQUESTED:
          title: 취소 요청
        FAILED:
          title: 취소 실패
        SUCCEEDED:
          title: 취소 완료
    Dispute:
      title: 분쟁 내역
      description: 분쟁 내역
      type: object
      required:
      - status
      - reason
      - createdAt
      properties:
        status:
          $ref: '#/components/schemas/DisputeStatus'
          title: 분쟁 상태
        pgDisputeId:
          type: string
          title: PG사 분쟁 아이디
        reason:
          type: string
          title: 분쟁 사유
        createdAt:
          type: string
          format: date-time
          title: 분쟁 발생 시각
        resolvedAt:
          type: string
          format: date-time
          title: 분쟁 해소 시각
      x-portone-title: 분쟁 내역
    RegisterStoreReceiptBodyItem:
      title: 하위 상점 거래 정보
      description: 하위 상점 거래 정보
      type: object
      required:
      - storeBusinessRegistrationNumber
      - storeName
      - totalAmount
      - currency
      properties:
        storeBusinessRegistrationNumber:
          type: string
          title: 하위 상점 사업자등록번호
        storeName:
          type: string
          title: 하위 상점명
        totalAmount:
          type: integer
          format: int64
          title: 결제 총 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 면세액
        vatAmount:
          type: integer
          format: int64
          title: 부가세액
        supplyAmount:
          type: integer
          format: int64
          title: 공급가액
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
      x-portone-title: 하위 상점 거래 정보
    FailedPayment:
      title: 결제 실패 상태 건
      description: 결제 실패 상태 건
      type: object
      required:
      - status
      - id
      - transactionId
      - merchantId
      - storeId
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - origin
      - failedAt
      - failure
      properties:
        status:
          type: string
          title: 결제 건 상태
        id:
          type: string
          title: 결제 건 아이디
        transactionId:
          type: string
          title: 결제 건 포트원 채번 아이디
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        origin:
          $ref: '#/components/schemas/PaymentOrigin'
          title: 결제 출처 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        failedAt:
          type: string
          format: date-time
          title: 결제 실패 시점
        failure:
          $ref: '#/components/schemas/PaymentFailure'
          title: 결제 실패 정보
      x-portone-title: 결제 실패 상태 건
    OneLineAddress:
      title: 한 줄 형식 주소
      description: '한 줄 형식 주소


        한 줄 형식 주소만 존재합니다.'
      type: object
      required:
      - type
      - oneLine
      properties:
        type:
          type: string
        oneLine:
          type: string
          title: 주소 (한 줄)
      x-portone-title: 한 줄 형식 주소
      x-portone-description: 한 줄 형식 주소만 존재합니다.
    ResendWebhookResponse:
      title: 웹훅 재발송 응답 정보
      description: 웹훅 재발송 응답 정보
      type: object
      required:
      - webhook
      properties:
        webhook:
          $ref: '#/components/schemas/PaymentWebhook'
          title: 재발송 웹훅 정보
      x-portone-title: 웹훅 재발송 응답 정보
    BillingKeyPaymentInput:
      title: 빌링키 결제 요청 입력 정보
      description: 빌링키 결제 요청 입력 정보
      type: object
      required:
      - billingKey
      - orderName
      - amount
      - currency
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        billingKey:
          type: string
          title: 빌링키 결제에 사용할 빌링키
        channelKey:
          type: string
          title: 채널 키
          description: 다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시
        orderName:
          type: string
          title: 주문명
        customer:
          $ref: '#/components/schemas/CustomerInput'
          title: 고객 정보
        customData:
          type: string
          title: 사용자 지정 데이터
        amount:
          $ref: '#/components/schemas/PaymentAmountInput'
          title: 결제 금액 세부 입력 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        installmentMonth:
          type: integer
          format: int32
          title: 할부 개월 수
        useFreeInterestFromMerchant:
          type: boolean
          title: 무이자 할부 이자를 고객사가 부담할지 여부
        useCardPoint:
          type: boolean
          title: 카드 포인트 사용 여부
        cashReceipt:
          $ref: '#/components/schemas/CashReceiptInput'
          title: 현금영수증 정보
          description: 나이스페이먼츠를 통해 네이버페이 포인트 빌링결제 시, 현금영수증 발급을 위해 입력 가능 (신청 필요)
        country:
          $ref: '#/components/schemas/Country'
          title: 결제 국가
        noticeUrls:
          type: array
          items:
            type: string
          title: 웹훅 주소
          description: '결제 승인/실패 시 요청을 받을 웹훅 주소입니다.

            상점에 설정되어 있는 값보다 우선적으로 적용됩니다.

            빈 배열은 무시됩니다.'
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
          description: 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
        productCount:
          type: integer
          format: int32
          title: 상품 개수
        productType:
          $ref: '#/components/schemas/PaymentProductType'
          title: 상품 유형
        shippingAddress:
          $ref: '#/components/schemas/SeparatedAddressInput'
          title: 배송지 주소
        promotionId:
          type: string
          title: 해당 결제에 적용할 프로모션 아이디
        locale:
          $ref: '#/components/schemas/Locale'
          title: 결제 시 사용할 언어
          description: 엑심베이의 경우 필수 입력입니다.
        bypass:
          type: object
          title: PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
        skipWebhook:
          type: boolean
          title: 웹훅 생략 여부
          description: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
      x-portone-title: 빌링키 결제 요청 입력 정보
    ReadyPaymentTransaction:
      title: 준비 상태 건
      description: 준비 상태 건
      type: object
      required:
      - status
      - id
      - paymentId
      - merchantId
      - storeId
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      properties:
        status:
          type: string
          title: 결제 시도 상태
        id:
          type: string
          title: 결제 시도 아이디 (transactionId)
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        paymentId:
          type: string
          title: 결제 건 아이디
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제의 배송 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
      x-portone-title: 준비 상태 건
    CancelAmountExceedsCancellableAmountError:
      title: 결제 취소 금액이 취소 가능 금액을 초과한 경우
      description: 결제 취소 금액이 취소 가능 금액을 초과한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제 취소 금액이 취소 가능 금액을 초과한 경우
      x-portone-status-code: 409
    RejectConfirmedPaymentEscrow:
      title: 구매 거절 확정
      description: 구매 거절 확정
      type: object
      required:
      - status
      - company
      - invoiceNumber
      properties:
        status:
          type: string
          title: 에스크로 상태
        company:
          type: string
          title: 택배사
        invoiceNumber:
          type: string
          title: 송장번호
        sentAt:
          type: string
          format: date-time
          title: 발송 일시
        appliedAt:
          type: string
          format: date-time
          title: 배송등록 처리 일자
      x-portone-title: 구매 거절 확정
    CancelCashReceiptResponse:
      title: 현금 영수증 취소 성공 응답
      description: 현금 영수증 취소 성공 응답
      type: object
      required:
      - cancelledAmount
      - cancelledAt
      properties:
        cancelledAmount:
          type: integer
          format: int64
          title: 취소 금액
        cancelledAt:
          type: string
          format: date-time
          title: 현금 영수증 취소 완료 시점
      x-portone-title: 현금 영수증 취소 성공 응답
    ResendWebhookBody:
      title: ResendWebhookBody
      description: 웹훅 재발송을 위한 입력 정보
      type: object
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        webhookId:
          type: string
          title: 웹훅 아이디
          description: 입력하지 않으면 결제 건의 가장 최근 웹훅 아이디가 기본 적용됩니다
      x-portone-description: 웹훅 재발송을 위한 입력 정보
    PaymentMethodCard:
      title: 결제수단 카드 정보
      description: 결제수단 카드 정보
      type: object
      required:
      - type
      properties:
        type:
          type: string
        card:
          $ref: '#/components/schemas/Card'
          title: 카드 상세 정보
        approvalNumber:
          type: string
          title: 승인 번호
        installment:
          $ref: '#/components/schemas/PaymentInstallment'
          title: 할부 정보
        pointUsed:
          type: boolean
          title: 카드 포인트 사용여부
      x-portone-title: 결제수단 카드 정보
    CashReceiptNotIssuedError:
      title: 현금영수증이 발급되지 않은 경우
      description: 현금영수증이 발급되지 않은 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 현금영수증이 발급되지 않은 경우
      x-portone-status-code: 404
    PaymentWebhookRequest:
      title: 웹훅 요청 정보
      description: 웹훅 요청 정보
      type: object
      required:
      - body
      properties:
        header:
          type: string
          title: 요청 헤더
        body:
          type: string
          title: 요청 본문
        requestedAt:
          type: string
          format: date-time
          title: 요청 시점
      x-portone-title: 웹훅 요청 정보
    PayInstantlyError:
      title: PayInstantlyError
      oneOf:
      - $ref: '#/components/schemas/AlreadyPaidError'
      - $ref: '#/components/schemas/ChannelNotFoundError'
      - $ref: '#/components/schemas/DiscountAmountExceedsTotalAmountError'
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/MaxTransactionCountReachedError'
      - $ref: '#/components/schemas/PaymentScheduleAlreadyExistsError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/PromotionPayMethodDoesNotMatchError'
      - $ref: '#/components/schemas/SumOfPartsExceedsTotalAmountError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          ALREADY_PAID: '#/components/schemas/AlreadyPaidError'
          CHANNEL_NOT_FOUND: '#/components/schemas/ChannelNotFoundError'
          DISCOUNT_AMOUNT_EXCEEDS_TOTAL_AMOUNT: '#/components/schemas/DiscountAmountExceedsTotalAmountError'
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          MAX_TRANSACTION_COUNT_REACHED: '#/components/schemas/MaxTransactionCountReachedError'
          PAYMENT_SCHEDULE_ALREADY_EXISTS: '#/components/schemas/PaymentScheduleAlreadyExistsError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          PROMOTION_PAY_METHOD_DOES_NOT_MATCH: '#/components/schemas/PromotionPayMethodDoesNotMatchError'
          SUM_OF_PARTS_EXCEEDS_TOTAL_AMOUNT: '#/components/schemas/SumOfPartsExceedsTotalAmountError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    ConfirmEscrowBody:
      title: 에스크로 구매 확정 입력 정보
      description: 에스크로 구매 확정 입력 정보
      type: object
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
        fromStore:
          type: boolean
          title: 확인 주체가 상점인지 여부
          description: '구매확정요청 주체가 고객사 관리자인지 구매자인지 구분하기 위한 필드입니다.

            네이버페이 전용 파라미터이며, 구분이 모호한 경우 고객사 관리자(true)로 입력합니다.'
      x-portone-title: 에스크로 구매 확정 입력 정보
    ConfirmPaymentError:
      title: ConfirmPaymentError
      oneOf:
      - $ref: '#/components/schemas/AlreadyPaidError'
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InformationMismatchError'
      - $ref: '#/components/schemas/InvalidPaymentTokenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          ALREADY_PAID: '#/components/schemas/AlreadyPaidError'
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INFORMATION_MISMATCH: '#/components/schemas/InformationMismatchError'
          INVALID_PAYMENT_TOKEN: '#/components/schemas/InvalidPaymentTokenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    FailedPaymentTransaction:
      title: 결제 실패 상태 건
      description: 결제 실패 상태 건
      type: object
      required:
      - status
      - id
      - paymentId
      - merchantId
      - storeId
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - failedAt
      - failure
      properties:
        status:
          type: string
          title: 결제 시도 상태
        id:
          type: string
          title: 결제 시도 아이디 (transactionId)
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        paymentId:
          type: string
          title: 결제 건 아이디
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        failedAt:
          type: string
          format: date-time
          title: 결제 실패 시점
        failure:
          $ref: '#/components/schemas/PaymentFailure'
          title: 결제 실패 정보
      x-portone-title: 결제 실패 상태 건
    ConfirmEscrowResponse:
      title: 에스크로 구매 확정 성공 응답
      description: 에스크로 구매 확정 성공 응답
      type: object
      required:
      - completedAt
      properties:
        completedAt:
          type: string
          format: date-time
          title: 에스크로 구매 확정 시점
      x-portone-title: 에스크로 구매 확정 성공 응답
    PaymentMethodVirtualAccount:
      title: 가상계좌 상세 정보
      description: 가상계좌 상세 정보
      type: object
      required:
      - type
      - accountNumber
      properties:
        type:
          type: string
        bank:
          $ref: '#/components/schemas/Bank'
          title: 표준 은행 코드
        accountNumber:
          type: string
          title: 계좌번호
        accountType:
          $ref: '#/components/schemas/PaymentMethodVirtualAccountType'
          title: 계좌 유형
        remitteeName:
          type: string
          title: 계좌주
        remitterName:
          type: string
          title: 송금인(입금자)
        expiredAt:
          type: string
          format: date-time
          title: 입금만료시점
        issuedAt:
          type: string
          format: date-time
          title: 계좌발급시점
        refundStatus:
          $ref: '#/components/schemas/PaymentMethodVirtualAccountRefundStatus'
          title: 가상계좌 결제가 환불 단계일 때의 환불 상태
      x-portone-title: 가상계좌 상세 정보
    VirtualAccountIssuedPaymentTransaction:
      title: 가상계좌 발급 완료 상태 건
      description: 가상계좌 발급 완료 상태 건
      type: object
      required:
      - status
      - id
      - paymentId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      properties:
        status:
          type: string
          title: 결제 시도 상태
        id:
          type: string
          title: 결제 시도 아이디 (transactionId)
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        paymentId:
          type: string
          title: 결제 건 아이디
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        pgTxId:
          type: string
          title: PG사 거래 아이디
      x-portone-title: 가상계좌 발급 완료 상태 건
    SumOfPartsExceedsTotalAmountError:
      title: 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우
      description: 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우
      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
    PaymentTextSearch:
      title: 통합검색 입력 정보
      description: 통합검색 입력 정보
      type: object
      required:
      - field
      - value
      properties:
        field:
          $ref: '#/components/schemas/PaymentTextSearchField'
        value:
          type: string
      x-portone-title: 통합검색 입력 정보
    PaymentFailure:
      title: 결제 실패 정보
      description: 결제 실패 정보
      type: object
      properties:
        reason:
          type: string
          title: 실패 사유
        pgCode:
          type: string
          title: PG사 실패 코드
        pgMessage:
          type: string
          title: PG사 실패 메시지
      x-portone-title: 결제 실패 정보
    PaymentAmountInput:
      title: 금액 세부 입력 정보
      description: 금액 세부 입력 정보
      type: object
      required:
      - total
      properties:
        total:
          type: integer
          format: int64
          title: 총 금액
        taxFree:
          type: integer
          format: int64
          title: 면세액
        vat:
          type: integer
          format: int64
          title: 부가세액
          description: '고객사에서 직접 계산이 필요한 경우 입력합니다.

            입력하지 않으면 면세 금액을 제외한 금액의 1/11 로 자동 계산됩니다.'
      x-portone-title: 금액 세부 입력 정보
    PartialCancelledPaymentTransaction:
      title: 결제 부분 취소 상태 건
      description: 결제 부분 취소 상태 건
      type: object
      required:
      - status
      - id
      - paymentId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - cancellations
      - cancelledAt
      properties:
        status:
          type: string
          title: 결제 시도 상태
        id:
          type: string
          title: 결제 시도 아이디 (transactionId)
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        paymentId:
          type: string
          title: 결제 건 아이디
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점
        pgTxId:
          type: string
          title: PG사 거래 아이디
        cashReceipt:
          $ref: '#/components/schemas/PaymentCashReceipt'
          title: 현금영수증
        cashReceiptIssuanceStatus:
          $ref: '#/components/schemas/CashReceiptIssuanceStatus'
          title: 현금영수증 발행여부
          description: '승인 시점에 확인된 발행여부입니다.

            발행번호 없이 발행여부만 제공 가능한 경우, ISSUED이면서 cashReceipt가 존재하지 않을 수 있습니다.'
        receiptUrl:
          type: string
          title: 거래 영수증 URL
        cancellations:
          title: 결제 취소 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentCancellation'
        cancelledAt:
          type: string
          format: date-time
          title: 결제 취소 시점
      x-portone-title: 결제 부분 취소 상태 건
    CapturePaymentError:
      title: CapturePaymentError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PaymentNotPaidError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PAYMENT_NOT_PAID: '#/components/schemas/PaymentNotPaidError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    PaymentMethodConvenienceStore:
      title: 편의점 결제 상세 정보
      description: 편의점 결제 상세 정보
      type: object
      required:
      - type
      properties:
        type:
          type: string
        convenienceStoreBrand:
          $ref: '#/components/schemas/ConvenienceStoreBrand'
          title: 편의점 브랜드
        confirmationNumber:
          type: string
          title: 결제 확인 번호
        receiptNumber:
          type: string
          title: 결제 접수 번호
        paymentDeadline:
          type: string
          format: date-time
          title: 결제 마감 시간
      x-portone-title: 편의점 결제 상세 정보
    ModifyEscrowLogisticsError:
      title: ModifyEscrowLogisticsError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/PaymentNotPaidError'
      - $ref: '#/components/schemas/PgProviderError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          PAYMENT_NOT_PAID: '#/components/schemas/PaymentNotPaidError'
          PG_PROVIDER: '#/components/schemas/PgProviderError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
    CustomerInput:
      title: 고객 정보 입력 정보
      description: 고객 정보 입력 정보
      type: object
      properties:
        id:
          type: string
          title: 고객 아이디
          description: 고객사가 지정한 고객의 고유 식별자입니다.
        name:
          $ref: '#/components/schemas/CustomerNameInput'
          title: 이름
        birthYear:
          type: string
          title: 출생 연도
        birthMonth:
          type: string
          title: 출생월
        birthDay:
          type: string
          title: 출생일
        country:
          $ref: '#/components/schemas/Country'
          title: 국가
        gender:
          $ref: '#/components/schemas/Gender'
          title: 성별
        email:
          type: string
          title: 이메일
        phoneNumber:
          type: string
          title: 전화번호
        address:
          $ref: '#/components/schemas/SeparatedAddressInput'
          title: 주소
        zipcode:
          type: string
          title: 우편번호
        businessRegistrationNumber:
          type: string
          title: 사업자 등록 번호
      x-portone-title: 고객 정보 입력 정보
    InstantPaymentMethodInputCard:
      title: 카드 수단 정보 입력 정보
      description: 카드 수단 정보 입력 정보
      type: object
      required:
      - credential
      properties:
        credential:
          $ref: '#/components/schemas/CardCredential'
          title: 카드 인증 관련 정보
        installmentMonth:
          type: integer
          format: int32
          title: 카드 할부 개월 수
        useFreeInstallmentPlan:
          type: boolean
          title: 무이자 할부 적용 여부
        useFreeInterestFromMerchant:
          type: boolean
          title: 무이자 할부 이자를 고객사가 부담할지 여부
        useCardPoint:
          type: boolean
          title: 카드 포인트 사용 여부
      x-portone-title: 카드 수단 정보 입력 정보
    CancelRequester:
      title: 결제 취소 요청 주체
      description: 결제 취소 요청 주체
      type: string
      enum:
      - CUSTOMER
      - ADMIN
      x-portone-title: 결제 취소 요청 주체
      x-portone-enum:
        CUSTOMER:
          title: 구매자
        ADMIN:
          title: 관리자
    GetPaymentsBody:
      title: 결제 다건 조회를 위한 입력 정보
      description: 결제 다건 조회를 위한 입력 정보
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageInput'
          title: 요청할 페이지 정보
          description: 미 입력 시 number = 0, size = 10 으로 기본값이 적용됩니다. (number + 1) * size가 60,000을 초과할 수 없습니다.
        filter:
          $ref: '#/components/schemas/PaymentFilterInput'
          title: 조회할 결제 건 조건 필터
          description: V1 결제 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.
      x-portone-title: 결제 다건 조회를 위한 입력 정보
    CustomerSeparatedName:
      title: 고객 분리형 이름
      description: 고객 분리형 이름
      type: object
      required:
      - first
      - last
      properties:
        first:
          type: string
          title: 이름
        last:
          type: string
          title: 성
      x-portone-title: 고객 분리형 이름
    ConfirmedPaymentSummary:
      title: 결제 수동 승인 완료된 결제 건 요약 정보
      description: 결제 수동 승인 완료된 결제 건 요약 정보
      type: object
      required:
      - pgTxId
      - paidAt
      properties:
        pgTxId:
          type: string
          title: PG사 결제 아이디
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점
      x-portone-title: 결제 수동 승인 완료된 결제 건 요약 정보
    InstantPaymentMethodInputVirtualAccountOptionFixed:
      title: 고정식 가상계좌 발급 유형
      description: '고정식 가상계좌 발급 유형


        pgAccountId, accountNumber 유형 중 한 개의 필드만 입력합니다.'
      type: object
      properties:
        pgAccountId:
          type: string
          title: Account ID 고정식 가상계좌
          description: '고객사가 가상계좌번호를 직접 관리하지 않고 PG사가 pgAccountId에 매핑되는 가상계좌번호를 내려주는 방식입니다.

            동일한 pgAccountId로 가상계좌 발급 요청시에는 항상 같은 가상계좌번호가 내려옵니다.'
        accountNumber:
          type: string
          title: Account Number 고정식 가상계좌
          description: PG사가 일정 개수만큼의 가상계좌번호를 발급하여 고객사에게 미리 전달하고 고객사가 그 중 하나를 선택하여 사용하는 방식입니다.
      x-portone-title: 고정식 가상계좌 발급 유형
      x-portone-description: pgAccountId, accountNumber 유형 중 한 개의 필드만 입력합니다.
    PaymentFilterInputEscrowStatus:
      title: 에스크로 상태
      description: 에스크로 상태
      type: string
      enum:
      - REGISTERED
      - DELIVERED
      - CONFIRMED
      - REJECTED
      - CANCELLED
      - REJECT_CONFIRMED
      x-portone-title: 에스크로 상태
      x-portone-enum:
        CONFIRMED: {}
        REJECTED: {}
        CANCELLED: {}
        REJECT_CONFIRMED: {}
        DELIVERED: {}
        REGISTERED: {}
    SeparatedAddress:
      title: 분리 형식 주소
      description: '분리 형식 주소


        한 줄 형식 주소와 분리 형식 주소 모두 존재합니다.

        한 줄 형식 주소는 분리 형식 주소를 이어 붙인 형태로 생성됩니다.'
      type: object
      required:
      - type
      - oneLine
      - addressLine1
      - addressLine2
      properties:
        type:
          type: string
        oneLine:
          type: string
          title: 주소 (한 줄)
        addressLine1:
          type: string
          title: 상세 주소 1
        addressLine2:
          type: string
          title: 상세 주소 2
        city:
          type: string
          title: 시/군/구
        province:
          type: string
          title: 주/도/시
        country:
          $ref: '#/components/schemas/Country'
          title: 국가
      x-portone-title: 분리 형식 주소
      x-portone-description: '한 줄 형식 주소와 분리 형식 주소 모두 존재합니다.

        한 줄 형식 주소는 분리 형식 주소를 이어 붙인 형태로 생성됩니다.'
    ConfirmedPaymentEscrow:
      title: 구매 확정
      description: 구매 확정
      type: object
      required:
      - status
      - company
      - invoiceNumber
      - isAutomaticallyConfirmed
      properties:
        status:
          type: string
          title: 에스크로 상태
        company:
          type: string
          title: 택배사
        invoiceNumber:
          type: string
          title: 송장번호
        sentAt:
          type: string
          format: date-time
          title: 발송 일시
        appliedAt:
          type: string
          format: date-time
          title: 배송등록 처리 일자
        isAutomaticallyConfirmed:
          type: boolean
          title: 자동 구매 확정 처리 여부
      x-portone-title: 구매 확정
    InstantPaymentSummary:
      title: 수기 결제가 완료된 결제 건 요약 정보
      description: 수기 결제가 완료된 결제 건 요약 정보
      type: object
      required:
      - pgTxId
      - paidAt
      properties:
        pgTxId:
          type: string
          title: PG 결제 아이디
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점 (가상 계좌는 발급 완료 시점)
      x-portone-title: 수기 결제가 완료된 결제 건 요약 정보
    CardOwnerType:
      title: 카드 소유주 유형
      description: 카드 소유주 유형
      type: string
      enum:
      - PERSONAL
      - CORPORATE
      x-portone-title: 카드 소유주 유형
      x-portone-enum:
        PERSONAL:
          title: 개인
        CORPORATE:
          title: 법인
    CardBrand:
      title: 카드 브랜드
      description: 카드 브랜드
      type: string
      enum:
      - LOCAL
      - MASTER
      - UNIONPAY
      - VISA
      - JCB
      - AMEX
      - DINERS
      x-portone-title: 카드 브랜드
      x-portone-enum:
        VISA: {}
        JCB: {}
        DINERS: {}
        MASTER: {}
        LOCAL: {}
        AMEX: {}
        UNIONPAY: {}
    PaymentMethodGiftCertificateType:
      title: 상품권 종류
      description: 상품권 종류
      type: string
      enum:
      - BOOKNLIFE
      - SMART_MUNSANG
      - CULTURELAND
      - HAPPYMONEY
      - CULTUREGIFT
      x-portone-title: 상품권 종류
      x-portone-enum:
        SMART_MUNSANG: {}
        CULTUREGIFT: {}
        BOOKNLIFE: {}
        CULTURELAND: {}
        HAPPYMONEY: {}
    InstantPaymentMethodInputVirtualAccountExpiry:
      title: 입금 만료 기한
      description: '입금 만료 기한


        validHours와 dueDate 둘 중 하나의 필드만 입력합니다.'
      type: object
      properties:
        validHours:
          type: integer
          format: int32
          title: 유효 시간
          description: 시간 단위로 입력합니다.
        dueDate:
          type: string
          format: date-time
          title: 만료 시점
      x-portone-title: 입금 만료 기한
      x-portone-description: validHours와 dueDate 둘 중 하나의 필드만 입력합니다.
    PayPendingPayment:
      title: 결제 완료 대기 상태 건
      description: 결제 완료 대기 상태 건
      type: object
      required:
      - status
      - id
      - transactionId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - origin
      properties:
        status:
          type: string
          title: 결제 건 상태
        id:
          type: string
          title: 결제 건 아이디
        transactionId:
          type: string
          title: 결제 건 포트원 채번 아이디
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        origin:
          $ref: '#/components/schemas/PaymentOrigin'
          title: 결제 출처 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        pgTxId:
          type: string
          title: PG사 거래 아이디
      x-portone-title: 결제 완료 대기 상태 건
    CustomerNameInput:
      title: 고객 이름 입력 정보
      description: '고객 이름 입력 정보


        두 개의 이름 형식 중 한 가지만 선택하여 입력해주세요.'
      type: object
      properties:
        full:
          type: string
          title: 한 줄 이름 형식
        separated:
          $ref: '#/components/schemas/CustomerSeparatedName'
          title: 분리형 이름 형식
      x-portone-title: 고객 이름 입력 정보
      x-portone-description: 두 개의 이름 형식 중 한 가지만 선택하여 입력해주세요.
    PaymentLogisticsCompany:
      title: 물류 회사
      description: 물류 회사
      type: string
      enum:
      - LOTTE
      - LOGEN
      - DONGWON
      - POST
      - CJ
      - HANJIN
      - DAESIN
      - ILYANG
      - KYUNGDONG
      - CHUNIL
      - POST_REGISTERED
      - GS
      - WOORI
      - HAPDONG
      - FEDEX
      - UPS
      - GSM_NTON
      - SUNGWON
      - LX_PANTOS
      - ACI
      - CJ_INTL
      - USPS
      - EMS
      - DHL
      - KGL
      - GOODSTOLUCK
      - KUNYOUNG
      - SLX
      - SF
      - ETC
      x-portone-title: 물류 회사
      x-portone-enum:
        POST_REGISTERED:
          title: 등기우편
        GOODSTOLUCK:
          title: 굿투럭
        UPS:
          title: UPS
        CJ_INTL:
          title: CJ대한통운 국제특송
        LOTTE:
          title: 롯데글로벌로지스
        CHUNIL:
          title: 천일택배
        KGL:
          title: KGL네트웍스
        EMS:
          title: EMS
        ILYANG:
          title: 일양로지스
        HAPDONG:
          title: 합동택배
        SUNGWON:
          title: 성원글로벌카고
        KUNYOUNG:
          title: 건영택배
        LOGEN:
          title: 로젠택배
        LX_PANTOS:
          title: LX판토스
        DHL:
          title: DHL
        HANJIN:
          title: 한진택배
        FEDEX:
          title: FedEx
        ACI:
          title: ACI
        WOORI:
          title: 우리택배
        CJ:
          title: 대한통운
        GS:
          title: GS네트웍스
        DONGWON:
          title: 동원로엑스
        USPS:
          title: USPS
        KYUNGDONG:
          title: 경동택배
        SF:
          title: SF Express
        DAESIN:
          title: 대신택배
        ETC:
          title: 기타
        SLX:
          title: SLX
        GSM_NTON:
          title: GSM NtoN
        POST:
          title: 우체국택배
    WebhookNotFoundError:
      title: 웹훅 내역이 존재하지 않는 경우
      description: 웹훅 내역이 존재하지 않는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 웹훅 내역이 존재하지 않는 경우
      x-portone-status-code: 404
    VirtualAccountIssuedPayment:
      title: 가상계좌 발급 완료 상태 건
      description: 가상계좌 발급 완료 상태 건
      type: object
      required:
      - status
      - id
      - transactionId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - origin
      properties:
        status:
          type: string
          title: 결제 건 상태
        id:
          type: string
          title: 결제 건 아이디
        transactionId:
          type: string
          title: 결제 건 포트원 채번 아이디
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        origin:
          $ref: '#/components/schemas/PaymentOrigin'
          title: 결제 출처 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        pgTxId:
          type: string
          title: PG사 거래 아이디
      x-portone-title: 가상계좌 발급 완료 상태 건
    ResendWebhookError:
      title: ResendWebhookError
      oneOf:
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/MaxWebhookRetryCountReachedError'
      - $ref: '#/components/schemas/PaymentNotFoundError'
      - $ref: '#/components/schemas/UnauthorizedError'
      - $ref: '#/components/schemas/WebhookNotFoundError'
      discriminator:
        propertyName: type
        mapping:
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          MAX_WEBHOOK_RETRY_COUNT_REACHED: '#/components/schemas/MaxWebhookRetryCountReachedError'
          PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
          WEBHOOK_NOT_FOUND: '#/components/schemas/WebhookNotFoundError'
    InstantPaymentMethodInputVirtualAccountCashReceiptInfo:
      title: 가상계좌 결제 시 현금영수증 정보
      description: 가상계좌 결제 시 현금영수증 정보
      type: object
      required:
      - type
      - customerIdentityNumber
      properties:
        type:
          $ref: '#/components/schemas/CashReceiptInputType'
          title: 현금영수증 유형
        customerIdentityNumber:
          type: string
          title: 사용자 식별 번호
      x-portone-title: 가상계좌 결제 시 현금영수증 정보
    PaymentWebhookResponse:
      title: 웹훅 응답 정보
      description: 웹훅 응답 정보
      type: object
      required:
      - code
      - header
      - body
      - respondedAt
      properties:
        code:
          type: string
          title: 응답 HTTP 코드
        header:
          type: string
          title: 응답 헤더
        body:
          type: string
          title: 응답 본문
        respondedAt:
          type: string
          format: date-time
          title: 응답 시점
      x-portone-title: 웹훅 응답 정보
    CreatePaymentScheduleBody:
      title: 결제 예약 요청 입력 정보
      description: 결제 예약 요청 입력 정보
      type: object
      required:
      - payment
      - timeToPay
      properties:
        payment:
          $ref: '#/components/schemas/BillingKeyPaymentScheduleInput'
          title: 빌링키 결제 입력 정보
        timeToPay:
          type: string
          format: date-time
          title: 결제 예정 시점
      x-portone-title: 결제 예약 요청 입력 정보
    CapturePaymentBody:
      title: 수동 매입 입력 정보
      description: 수동 매입 입력 정보
      type: object
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.
      x-portone-title: 수동 매입 입력 정보
    ReadyPayment:
      title: 준비 상태 건
      description: 준비 상태 건
      type: object
      required:
      - status
      - id
      - transactionId
      - merchantId
      - storeId
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - origin
      properties:
        status:
          type: string
          title: 결제 건 상태
        id:
          type: string
          title: 결제 건 아이디
        transactionId:
          type: string
          title: 결제 건 포트원 채번 아이디
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        origin:
          $ref: '#/components/schemas/PaymentOrigin'
          title: 결제 출처 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제의 배송 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
      x-portone-title: 준비 상태 건
    PaymentMethodVirtualAccountType:
      title: 가상계좌 유형
      description: 가상계좌 유형
      type: string
      enum:
      - FIXED
      - NORMAL
      x-portone-title: 가상계좌 유형
      x-portone-enum:
        FIXED:
          title: 고정식
        NORMAL:
          title: 회전식
    AlreadyPaidError:
      title: 결제가 이미 완료된 경우
      description: 결제가 이미 완료된 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 결제가 이미 완료된 경우
      x-portone-status-code: 409
    PaymentMethodEasyPayMethodCharge:
      title: 충전식 포인트 결제 정보
      description: 충전식 포인트 결제 정보
      type: object
      required:
      - type
      properties:
        type:
          type: string
        bank:
          $ref: '#/components/schemas/Bank'
          title: 표준 은행 코드
      x-portone-title: 충전식 포인트 결제 정보
    PaymentWebhookStatus:
      title: 웹훅 전송 상태
      description: 웹훅 전송 상태
      type: string
      enum:
      - SUCCEEDED
      - FAILED_NOT_OK_RESPONSE
      - FAILED_UNEXPECTED_ERROR
      x-portone-title: 웹훅 전송 상태
      x-portone-enum:
        SUCCEEDED: {}
        FAILED_NOT_OK_RESPONSE: {}
        FAILED_UNEXPECTED_ERROR: {}
    ForbiddenError:
      title: 요청이 거절된 경우
      description: 요청이 거절된 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 요청이 거절된 경우
      x-portone-status-code: 403
    PaidPayment:
      title: 결제 완료 상태 건
      description: 결제 완료 상태 건
      type: object
      required:
      - status
      - id
      - transactionId
      - merchantId
      - storeId
      - channel
      - version
      - requestedAt
      - updatedAt
      - statusChangedAt
      - orderName
      - amount
      - currency
      - customer
      - origin
      - paidAt
      - disputes
      properties:
        status:
          type: string
          title: 결제 건 상태
        id:
          type: string
          title: 결제 건 아이디
        transactionId:
          type: string
          title: 결제 건 포트원 채번 아이디
          description: V1 결제 건의 경우 imp_uid에 해당합니다.
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        method:
          $ref: '#/components/schemas/PaymentMethod'
          title: 결제수단 정보
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 결제 채널
        channelGroup:
          $ref: '#/components/schemas/ChannelGroupSummary'
          title: 결제 채널 그룹 정보
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        scheduleId:
          type: string
          title: 결제 예약 건 아이디
          description: 결제 예약을 이용한 경우에만 존재
        billingKey:
          type: string
          title: 결제 시 사용된 빌링키
          description: 빌링키 결제인 경우에만 존재
        webhooks:
          title: 웹훅 발송 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentWebhook'
        requestedAt:
          type: string
          format: date-time
          title: 결제 요청 시점
        updatedAt:
          type: string
          format: date-time
          title: 업데이트 시점
        statusChangedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
        orderName:
          type: string
          title: 주문명
        amount:
          $ref: '#/components/schemas/PaymentAmount'
          title: 결제 금액 관련 세부 정보
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        customer:
          $ref: '#/components/schemas/Customer'
          title: 구매자 정보
        origin:
          $ref: '#/components/schemas/PaymentOrigin'
          title: 결제 출처 정보
        promotionId:
          type: string
          title: 프로모션 아이디
        isCulturalExpense:
          type: boolean
          title: 문화비 지출 여부
        escrow:
          $ref: '#/components/schemas/PaymentEscrow'
          title: 에스크로 결제 정보
          description: 에스크로 결제인 경우 존재합니다.
        products:
          title: 상품 정보
          type: array
          items:
            $ref: '#/components/schemas/PaymentProduct'
        productCount:
          type: integer
          format: int32
          title: 상품 갯수
        customData:
          type: string
          title: 사용자 지정 데이터
        country:
          $ref: '#/components/schemas/Country'
          title: 국가 코드
        paidAt:
          type: string
          format: date-time
          title: 결제 완료 시점
        pgTxId:
          type: string
          title: PG사 거래 아이디
        pgResponse:
          type: string
          title: PG사 거래 응답 본문
        cashReceipt:
          $ref: '#/components/schemas/PaymentCashReceipt'
          title: 현금영수증
        cashReceiptIssuanceStatus:
          $ref: '#/components/schemas/CashReceiptIssuanceStatus'
          title: 현금영수증 발행여부
          description: '승인 시점에 확인된 발행여부입니다.

            발행번호 없이 발행여부만 제공 가능한 경우, ISSUED이면서 cashReceipt가 존재하지 않을 수 있습니다.'
        receiptUrl:
          type: string
          title: 거래 영수증 URL
        disputes:
          title: 분쟁 목록
          type: array
          items:
            $ref: '#/components/schemas/Dispute'
        cancellations:
          title: 결제 취소 요청 내역
          type: array
          items:
            $ref: '#/components/schemas/PaymentCancellation'
      x-portone-title: 결제 완료 상태 건
    DeliveredPaymentEscrow:
      title: 배송 완료
      description: 배송 완료
      type: object
      required:
      - status
      - company
      - invoiceNumber
      properties:
        status:
          type: string
          title: 에스크로 상태
        company:
          type: string
          title: 택배사
        invoiceNumber:
          type: string
          title: 송장번호
        sentAt:
          type: string
          format: date-time
          title: 발송 일시
        appliedAt:
          type: string
          format: date-time
          title: 배송등록 처리 일자
      x-portone-title: 배송 완료
    ConvenienceStoreBrand:
      title: 편의점 브랜드
      description: 편의점 브랜드
      type: string
      enum:
      - LAWSON
      - FAMILY_MART
      - MINI_STOP
      - SEVEN_ELEVEN
      - SEICOMART
      x-portone-title: 편의점 브랜드
      x-portone-enum:
        SEVEN_ELEVEN:
          title: 세븐일레븐
        MINI_STOP:
          title: 미니스톱
        FAMILY_MART:
          title: 패밀리마트
        SEICOMART:
          title: 세이코마트
        LAWSON:
          title: 로손
    CashReceipt:
      title: 현금영수증 내역
      description: 현금영수증 내역
      oneOf:
      - $ref: '#/components/schemas/CancelledCashReceipt'
      - $ref: '#/components/schemas/IssueFailedCashReceipt'
      - $ref: '#/components/schemas/IssuedCashReceipt'
      discriminator:
        propertyName: status
        mapping:
          CANCELLED: '#/components/schemas/CancelledCashReceipt'
          ISSUED: '#/components/schemas/IssuedCashReceipt'
          ISSUE_FAILED: '#/components/schemas/IssueFailedCashReceipt'
      x-portone-title: 현금영수증 내역
      x-portone-discriminator:
        ISSUE_FAILED:
          title: 발급 실패
        ISSUED:
          title: 발급 완료
        CANCELLED:
          title: 발급 취소
    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
    IssuedCashReceipt:
      title: 발급 완료
      description: 발급 완료
      type: object
      required:
      - status
      - merchantId
      - storeId
      - paymentId
      - channel
      - amount
      - currency
      - orderName
      - isManual
      - issueNumber
      - issuedAt
      properties:
        status:
          type: string
          title: 현금영수증 상태
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
        paymentId:
          type: string
          title: 결제 건 아이디
        channel:
          $ref: '#/components/schemas/SelectedChannel'
          title: 현금영수증 발급에 사용된 채널
        amount:
          type: integer
          format: int64
          title: 결제 금액
        taxFreeAmount:
          type: integer
          format: int64
          title: 면세액
        vatAmount:
          type: integer
          format: int64
          title: 부가세액
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        orderName:
          type: string
          title: 주문명
        isManual:
          type: boolean
          title: 수동 발급 여부
        type:
          $ref: '#/components/schemas/CashReceiptType'
          title: 현금영수증 유형
        pgReceiptId:
          type: string
          title: PG사 현금영수증 아이디
        issueNumber:
          type: string
          title: 승인 번호
        url:
          type: string
          title: 현금영수증 URL
        issuedAt:
          type: string
          format: date-time
          title: 발급 시점
        statusUpdatedAt:
          type: string
          format: date-time
          title: 상태 업데이트 시점
      x-portone-title: 발급 완료
    CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError:
      title: 취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우
      description: 취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우
      x-portone-status-code: 409
    PaymentFilterInput:
      title: 결제 다건 조회를 위한 입력 정보
      description: 결제 다건 조회를 위한 입력 정보
      type: object
      properties:
        merchantId:
          type: string
          title: 고객사 아이디
        storeId:
          type: string
          title: 상점 아이디
          description: Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제 건을 조회합니다.
        timestampType:
          $ref: '#/components/schemas/PaymentTimestampType'
          title: 조회 기준 시점 유형
        from:
          type: string
          format: date-time
          title: 결제 요청/상태 승인 시점 범위의 시작
          description: 값을 입력하지 않으면 end의 90일 전으로 설정됩니다.
        until:
          type: string
          format: date-time
          title: 결제 요청/상태 승인 시점 범위의 끝
          description: 값을 입력하지 않으면 현재 시점으로 설정됩니다.
        status:
          title: 결제 상태 리스트
          type: array
          items:
            $ref: '#/components/schemas/PaymentStatus'
          description: 값을 입력하지 않으면 결제상태 필터링이 적용되지 않습니다.
        methods:
          type: array
          items:
            $ref: '#/components/schemas/PaymentMethodType'
          title: 결제수단 리스트
          description: 값을 입력하지 않으면 결제수단 필터링이 적용되지 않습니다.
        pgProvider:
          title: PG사 결제 모듈 리스트
          type: array
          items:
            $ref: '#/components/schemas/PgProvider'
          description: 값을 입력하지 않으면 PG사 결제 모듈 필터링이 적용되지 않습니다.
        isTest:
          type: boolean
          title: 테스트 결제 여부
        isScheduled:
          type: boolean
          title: 결제 예약 건 필터링
        sortBy:
          $ref: '#/components/schemas/PaymentSortBy'
          title: 결제 건 정렬 기준
        sortOrder:
          $ref: '#/components/schemas/SortOrder'
          title: 결제 건 정렬 방식
        version:
          $ref: '#/components/schemas/PortOneVersion'
          title: 포트원 버전
        webhookStatus:
          $ref: '#/components/schemas/PaymentWebhookStatus'
          title: 최종 결제 상태의 웹훅 상태
        platformType:
          $ref: '#/components/schemas/PaymentClientType'
          title: 플랫폼 유형
        currency:
          $ref: '#/components/schemas/Currency'
          title: 통화
        isEscrow:
          type: boolean
          title: 에스크로 결제 여부
        escrowStatus:
          $ref: '#/components/schemas/PaymentFilterInputEscrowStatus'
          title: 에스크로 결제의 배송 정보 상태
        cardBrand:
          $ref: '#/components/schemas/CardBrand'
          title: 카드 브랜드
        cardType:
          $ref: '#/components/schemas/CardType'
          title: 카드 유형
        cardOwnerType:
          $ref: '#/components/schemas/CardOwnerType'
          title: 카드 소유주 유형
        giftCertificateType:
          $ref: '#/components/schemas/PaymentMethodGiftCertificateType'
          title: 상품권 종류
        cashReceiptType:
          $ref: '#/components/schemas/CashReceiptInputType'
          title: 현금영수증 유형
        cashReceiptStatus:
          $ref: '#/components/schemas/PaymentCashReceiptStatus'
          title: 현금영수증 상태
        cashReceiptIssuedAtRange:
          $ref: '#/components/schemas/DateTimeRange'
          title: 현금영수증 발급 시간 범위
        cashReceiptCancelledAtRange:
          $ref: '#/components/schemas/DateTimeRange'
          title: 현금영수증 취소 시간 범위
        textSearch:
          title: 통합 검색 리스트 필터
          type: array
          items:
            $ref: '#/components/schemas/PaymentTextSearch'
      x-portone-title: 결제 다건 조회를 위한 입력 정보
    ChannelNotFoundError:
      title: 요청된 채널이 존재하지 않는 경우
      description: 요청된 채널이 존재하지 않는 경우
      type: object
      required:
      - type
      properties:
        type:
          type: string
        message:
          type: string
      x-portone-title: 요청된 채널이 존재하지 않는 경우
      x-portone-status-code: 404
    PreRegisterPaymentError:
      title: PreRegisterPaymentError
      oneOf:
      - $ref: '#/components/schemas/AlreadyPaidError'
      - $ref: '#/components/schemas/ForbiddenError'
      - $ref: '#/components/schemas/InvalidRequestError'
      - $ref: '#/components/schemas/UnauthorizedError'
      discriminator:
        propertyName: type
        mapping:
          ALREADY_PAID: '#/components/schemas/AlreadyPaidError'
          FORBIDDEN: '#/components/schemas/ForbiddenError'
          INVALID_REQUEST: '#/components/schemas/InvalidRequestError'
          UNAUTHORIZED: '#/components/schemas/UnauthorizedError'
  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 기능을 제공합니다.