PortOne Payment Events By Cursor API

openapi: 3.0.3
info:
  title: PortOne B2b Payment Events By Cursor API
  version: 1.16.0
servers:
- url: https://api.portone.io
  description: 운영환경 서버
tags:
- name: Payment Events By Cursor
paths:
  /payment-events-by-cursor:
    get:
      summary: 결제 이벤트 대용량 다건 조회(커서 기반)
      description: '결제 이벤트 대용량 다건 조회(커서 기반)


        기간 내 모든 결제 이벤트를 커서 기반으로 조회합니다. 결제 이벤트의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 이벤트가 조회됩니다.'
      operationId: getAllPaymentEventsByCursor
      parameters:
      - name: requestBody
        in: query
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAllPaymentEventsByCursorBody'
      responses:
        '200':
          description: 성공 응답으로 조회된 결제 이벤트 리스트와 커서 정보가 반환됩니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllPaymentEventsByCursorResponse'
          x-portone-title: 성공 응답으로 조회된 결제 이벤트 리스트와 커서 정보가 반환됩니다.
        '400':
          description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllPaymentEventsError'
        '401':
          description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllPaymentEventsError'
        '403':
          description: '* `ForbiddenError`: 요청이 거절된 경우'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllPaymentEventsError'
      security:
      - bearerJwt: []
      - portOne: []
      x-portone-category: payment
      x-portone-title: 결제 이벤트 대용량 다건 조회(커서 기반)
      x-portone-description: 기간 내 모든 결제 이벤트를 커서 기반으로 조회합니다. 결제 이벤트의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 이벤트가 조회됩니다.
      x-portone-error:
        $ref: '#/components/schemas/GetAllPaymentEventsError'
      x-portone-unstable: true
      tags:
      - Payment Events By Cursor
components:
  schemas:
    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: 발급 완료된 현금영수증
    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: {}
    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: 거래 취소
    PaymentMethodTransfer:
      title: 계좌 이체 상세 정보
      description: 계좌 이체 상세 정보
      type: object
      required:
      - type
      properties:
        type:
          type: string
        bank:
          $ref: '#/components/schemas/Bank'
          title: 표준 은행 코드
        accountNumber:
          type: string
          title: 계좌번호
      x-portone-title: 계좌 이체 상세 정보
    BeforeRegisteredPaymentEscrow:
      title: 배송 정보 등록 전
      description: 배송 정보 등록 전
      type: object
      required:
      - status
      properties:
        status:
          type: string
          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: 기프트카드
    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: 교보증권
    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: 배송 정보 등록 완료
    CashReceiptType:
      title: 발급 유형
      description: 발급 유형
      type: string
      enum:
      - PERSONAL
      - CORPORATE
      x-portone-title: 발급 유형
      x-portone-enum:
        PERSONAL:
          title: 소득공제용
        CORPORATE:
          title: 지출증빙용
    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: 편의점 결제 상세 정보
    GetAllPaymentEventsByCursorBody:
      title: GetAllPaymentEventsByCursorBody
      description: 결제 이벤트 커서 기반 대용량 다건 조회를 위한 입력 정보
      type: object
      properties:
        storeId:
          type: string
          title: 상점 아이디
          description: Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제 이벤트를 조회합니다.
        from:
          type: string
          format: date-time
          title: 결제 이벤트 생성시점 범위 조건의 시작
          description: 값을 입력하지 않으면 end의 90일 전으로 설정됩니다.
        until:
          type: string
          format: date-time
          title: 결제 이벤트 생성시점 범위 조건의 끝
          description: 값을 입력하지 않으면 현재 시점으로 설정됩니다.
        cursor:
          type: string
          title: 커서
          description: 결제 이벤트 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.
        size:
          type: integer
          format: int32
          title: 페이지 크기
          description: 미입력 시 기본값은 10 이며 최대 1000까지 허용
      x-portone-description: 결제 이벤트 커서 기반 대용량 다건 조회를 위한 입력 정보
    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: 분리 형식
    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: 결제 금액 세부 정보
    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: 취소 완료 상태
    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: 구매 거절
    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: 간편 결제 상세 정보
    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: 고객 정보
    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: 채널 그룹 정보
    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: {}
    PaymentEventWithCursor:
      title: 결제 이벤트 및 커서 정보
      description: 결제 이벤트 및 커서 정보
      type: object
      required:
      - paymentEvent
      - cursor
      properties:
        paymentEvent:
          $ref: '#/components/schemas/PaymentEvent'
          title: 결제 이벤트 정보
        cursor:
          type: string
          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: {}
    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: 구매 확정
    PaymentEvent:
      title: 결제 이벤트
      description: 결제 이벤트
      oneOf:
      - $ref: '#/components/schemas/CancelledPaymentEvent'
      - $ref: '#/components/schemas/PaidPaymentEvent'
      - $ref: '#/components/schemas/PartialCancelledPaymentEvent'
      discriminator:
        propertyName: type
        mapping:
          CANCELLED: '#/components/schemas/CancelledPaymentEvent'
          PAID: '#/components/schemas/PaidPaymentEvent'
          PARTIAL_CANCELLED: '#/components/schemas/PartialCancelledPaymentEvent'
      x-portone-title: 결제 이벤트
      x-portone-discriminator:
        PAID:
          title: 결제 완료 이벤트
        PARTIAL_CANCELLED:
          title: 결제 부분 취소 이벤트
        CANCELLED:
          title: 결제 취소 이벤트
    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
      - 

# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/portone/refs/heads/main/openapi/portone-payment-events-by-cursor-api-openapi.yml