@portone/server-sdk/dist/generated/payment/PartialCancelledPaymentEvent.d.ts

PortOne JavaScript SDK for server-side usage

import type { ChannelGroupSummary } from "./../common/ChannelGroupSummary.js";
import type { Country } from "./../common/Country.js";
import type { Currency } from "./../common/Currency.js";
import type { Customer } from "./../common/Customer.js";
import type { PaymentAmount } from "./../payment/PaymentAmount.js";
import type { PaymentCancellation } from "./../payment/PaymentCancellation.js";
import type { PaymentCashReceipt } from "./../payment/PaymentCashReceipt.js";
import type { PaymentEscrow } from "./../payment/PaymentEscrow.js";
import type { PaymentMethod } from "./../payment/PaymentMethod.js";
import type { PaymentProduct } from "./../common/PaymentProduct.js";
import type { PaymentWebhook } from "./../payment/PaymentWebhook.js";
import type { PortOneVersion } from "./../common/PortOneVersion.js";
import type { SelectedChannel } from "./../common/SelectedChannel.js";
/** 결제 부분 취소 상태 이벤트 */
export type PartialCancelledPaymentEvent = {
    /** 결제 이벤트 종류 */
    type: "PARTIAL_CANCELLED";
    /** 결제 이벤트 아이디 */
    id: string;
    /** 결제 건 아이디 */
    paymentId: string;
    /** 결제 시도 아이디 */
    transactionId: string;
    /** 고객사 아이디 */
    merchantId: string;
    /** 상점 아이디 */
    storeId: string;
    /** 결제수단 정보 */
    method?: PaymentMethod;
    /** 결제 채널 */
    channel: SelectedChannel;
    /** 결제 채널 그룹 정보 */
    channelGroup?: ChannelGroupSummary;
    /** 포트원 버전 */
    version: PortOneVersion;
    /**
     * 결제 예약 건 아이디
     *
     * 결제 예약을 이용한 경우에만 존재
     */
    scheduleId?: string;
    /** 웹훅 발송 내역 */
    webhooks?: PaymentWebhook[];
    /**
     * 결제 요청 시점
     * (RFC 3339 date-time)
     */
    requestedAt: string;
    /**
     * 이벤트 생성 시점
     * (RFC 3339 date-time)
     */
    createdAt: string;
    /** 주문명 */
    orderName: string;
    /** 총 결제 금액 관련 세부 정보 */
    totalAmount: PaymentAmount;
    /** 통화 */
    currency: Currency;
    /** 구매자 정보 */
    customer: Customer;
    /** 문화비 지출 여부 */
    isCulturalExpense?: boolean;
    /**
     * 에스크로 결제 정보
     *
     * 에스크로 결제인 경우 존재합니다.
     */
    escrow?: PaymentEscrow;
    /** 상품 정보 */
    products?: PaymentProduct[];
    /**
     * 상품 갯수
     * (int32)
     */
    productCount?: number;
    /** 사용자 지정 데이터 */
    customData?: string;
    /** 국가 코드 */
    country?: Country;
    /** PG사 거래 아이디 */
    pgTxId?: string;
    /** 현금영수증 */
    cashReceipt?: PaymentCashReceipt;
    /** 거래 영수증 URL */
    receiptUrl?: string;
    /** 결제 취소 정보 */
    cancellation?: PaymentCancellation;
    /** 프로모션 아이디 */
    promotionId?: string;
    /**
     * 처리 금액
     *
     * 해당 이벤트에서 처리된 금액으로, 취소 이벤트인 경우 음수로 표기됩니다.
     * (int64)
     */
    eventAmount: number;
};