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

PortOne JavaScript SDK for server-side usage

import type { CancelPaymentBodyRefundAccount } from "./../payment/CancelPaymentBodyRefundAccount.js";
import type { CancelRequester } from "./../payment/CancelRequester.js";
import type { PromotionDiscountRetainOption } from "./../payment/PromotionDiscountRetainOption.js";
/** 결제 취소 요청 입력 정보 */
export type CancelPaymentBody = {
    /**
     * 상점 아이디
     *
     * 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
     */
    storeId?: string;
    /**
     * 취소 총 금액
     *
     * 값을 입력하지 않으면 전액 취소됩니다.
     * (int64)
     */
    amount?: number;
    /**
     * 취소 금액 중 면세 금액
     *
     * 값을 입력하지 않으면 전액 과세 취소됩니다.
     * (int64)
     */
    taxFreeAmount?: number;
    /**
     * 취소 금액 중 부가세액
     *
     * 값을 입력하지 않으면 자동 계산됩니다.
     * (int64)
     */
    vatAmount?: number;
    /** 취소 사유 */
    reason: string;
    /**
     * 취소 요청자
     *
     * 고객에 의한 취소일 경우 Customer, 관리자에 의한 취소일 경우 Admin으로 입력합니다.
     */
    requester?: CancelRequester;
    /**
     * 프로모션 할인율 유지 옵션
     *
     * 프로모션이 적용된 결제를 부분 취소하는 경우, 최초 할인율을 유지할지 여부를 선택할 수 있습니다.
     * RETAIN 으로 설정 시, 최초 할인율을 유지할 수 있도록 취소 금액이 조정됩니다.
     * RELEASE 으로 설정 시, 취소 후 남은 금액이 속한 구간에 맞게 프로모션 할인이 새롭게 적용됩니다.
     * 값을 입력하지 않으면 RELEASE 로 취급합니다.
     */
    promotionDiscountRetainOption?: PromotionDiscountRetainOption;
    /**
     * 결제 건의 취소 가능 잔액
     *
     * 본 취소 요청 이전의 취소 가능 잔액으로써, 값을 입력하면 잔액이 일치하는 경우에만 취소가 진행됩니다. 값을 입력하지 않으면 별도의 검증 처리를 수행하지 않습니다.
     * (int64)
     */
    currentCancellableAmount?: number;
    /**
     * 환불 계좌
     *
     * 계좌 환불일 경우 입력합니다. 계좌 환불이 필요한 경우는 가상계좌 환불, 휴대폰 익월 환불 등이 있습니다.
     */
    refundAccount?: CancelPaymentBodyRefundAccount;
};