@portone/server-sdk
Version:
PortOne JavaScript SDK for server-side usage
83 lines (82 loc) • 2.81 kB
TypeScript
import type { CashReceiptInput } from "./../common/CashReceiptInput.js";
import type { Country } from "./../common/Country.js";
import type { Currency } from "./../common/Currency.js";
import type { CustomerInput } from "./../common/CustomerInput.js";
import type { Locale } from "./../common/Locale.js";
import type { PaymentAmountInput } from "./../common/PaymentAmountInput.js";
import type { PaymentProduct } from "./../common/PaymentProduct.js";
import type { PaymentProductType } from "./../common/PaymentProductType.js";
import type { SeparatedAddressInput } from "./../common/SeparatedAddressInput.js";
/** 빌링키 결제 요청 입력 정보 */
export type BillingKeyPaymentInput = {
/**
* 상점 아이디
*
* 접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
*/
storeId?: string;
/** 빌링키 결제에 사용할 빌링키 */
billingKey: string;
/**
* 채널 키
*
* 다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시
*/
channelKey?: string;
/** 주문명 */
orderName: string;
/** 고객 정보 */
customer?: CustomerInput;
/** 사용자 지정 데이터 */
customData?: string;
/** 결제 금액 세부 입력 정보 */
amount: PaymentAmountInput;
/** 통화 */
currency: Currency;
/**
* 할부 개월 수
* (int32)
*/
installmentMonth?: number;
/** 무이자 할부 이자를 고객사가 부담할지 여부 */
useFreeInterestFromMerchant?: boolean;
/** 카드 포인트 사용 여부 */
useCardPoint?: boolean;
/** 현금영수증 정보 */
cashReceipt?: CashReceiptInput;
/** 결제 국가 */
country?: Country;
/**
* 웹훅 주소
*
* 결제 승인/실패 시 요청을 받을 웹훅 주소입니다.
* 상점에 설정되어 있는 값보다 우선적으로 적용됩니다.
* 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
*/
noticeUrls?: string[];
/**
* 상품 정보
*
* 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
*/
products?: PaymentProduct[];
/**
* 상품 개수
* (int32)
*/
productCount?: number;
/** 상품 유형 */
productType?: PaymentProductType;
/** 배송지 주소 */
shippingAddress?: SeparatedAddressInput;
/** 해당 결제에 적용할 프로모션 아이디 */
promotionId?: string;
/**
* 결제 시 사용할 언어
*
* 엑심베이의 경우 필수 입력입니다.
*/
locale?: Locale;
/** PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고) */
bypass?: object;
};