requestPayment 요청 형식

requestPayment 호출 시 사용되는 파라미터의 형식을 확인할 수 있습니다.

`requestPayment` 요청 데이터 정의

request: PaymentRequest

storeId: string

스토어 아이디

포트원 계정에 생성된 상점을 식별하는 고유한 값으로 관리자 콘솔에서 확인할 수 있습니다.

paymentId: string

고객사 주문 고유 번호

고객사가 채번하는 주문 고유 번호입니다.
이미 승인 완료 된 paymentId로 결제나 가상계좌 발급을 시도하는 경우 에러가 발생합니다.

orderName: string

주문명

주문명으로 고객사에서 자유롭게 입력합니다.

totalAmount: number

결제 금액

결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.

1000 만큼 원화(KRW) 결제를 하는 경우, scale factor가 0이기 때문에 1000 * (10의 0승) = 1000을 전달해야 합니다.
1.50 만큼 달러(USD) 결제를 하는 경우, scale factor가 2이기 때문에 1.50 * (10의 2승) = 150을 전달해야 합니다.

이렇게 전달 된 값은 실제로 PG사에 결제를 요청할때 currency에 따라 올바른 값으로 변환되기 때문에 반드시 currency값을 필수로 입력해야 합니다.

currency: Currency

결제 통화 코드

ISO 4217 통화 코드
ISO 4217

payMethod: PaymentPayMethod

결제수단 구분코드

PG사별 지원되는 결제수단이 모두 상이합니다.

각 PG사별 결제 연동 가이드를 참고하세요

channelKey?: string

채널 키

콘솔에서 채널 연동 시 생성된 채널 키입니다.

channelGroupId?: string

스마트 라우팅 그룹 ID

관리자 콘솔의 [연동 관리] → [스마트 라우팅] 메뉴에서 확인할 수 있습니다.
스마트 라우팅 그룹 ID를 지정하여 결제창을 호출하면, 스마트 라우팅 그룹 내 설정된 채널 비율에 따라 확률 기반으로 하나의 결제대행사가 호출됩니다.

taxFreeAmount?: number

면세 금액

결제 금액 중 면세금액에 해당하는 금액을 입력합니다.
미입력 시 0으로 취급됩니다.
결제 금액과 동일하게 통화별 scale factor가 적용된 금액으로 전달해주세요.

vatAmount?: number

부가세

부가세 금액을 입력합니다.
미입력 시 과세 금액의 1/11 로 자동 계산됩니다.
결제 금액과 동일하게 통화별 scale factor가 적용된 금액으로 전달해주세요.

customer?: Customer

customerId?: string

구매자 고유 ID

fullName?: string

구매자 전체 이름

fullName과 firstName / lastName이 모두 입력된 경우 fullName으로 기록됩니다.

firstName?: string

구매자 이름

firstName을 입력하는 경우 lastName도 필수로 입력해야 합니다. fullName이 없고, firstName과 lastName이 존재하는 경우 {firstName} {lastName}으로 저장됩니다.

lastName?: string

구매자 성

lastName을 입력하는 경우 firstName도 필수로 입력해야 합니다.

phoneNumber?: string

구매자 연락처

email?: string

구매자 이메일 주소

유효한 이메일 주소를 입력해주세요.

address?: Address

주소 정보

country?: Country

국가

ISO 3166-1 alpha-2 코드

addressLine1: string

일반주소

addressLine2: string

상세주소

city?: string

도시

province?: string

주, 도, 시

zipcode?: string

구매자 우편번호

gender?: Gender

구매자 성별

birthYear?: string

구매자 출생년도

ex. "1990" 같은 형식으로 입력해주세요.

birthMonth?: string

구매자 출생월

ex. "12", "07" 같은 형식으로 입력해주세요.

birthDay?: string

구매자 출생일

ex. "25", "08" 같은 형식으로 입력해주세요.

firstNameKana?: string

구매자 이름 후리가나

일본어 읽는 법 표기

lastNameKana?: string

구매자 성 후리가나

일본어 읽는 법 표기

windowType?: WindowTypes

환경 별 제공되는 결제/본인인증 창 유형

PG사에 따라 가능한 창 유형이 다릅니다.
전달되지 않았을 때 결정되는 기본 창이 다릅니다.
미입력 시, 해당 PG사의 기본 창 방식을 따릅니다.

pc?: WindowType

mobile?: WindowType

redirectUrl?: string

리디렉션 방식에서 프로세스 완료 후 이동될 고객사 URL

결제/본인인증 창이 새로운 창으로 리다이렉트 되어 프로세스가 진행되는 방식인 경우 필수 설정 항목 입니다.
대부분의 모바일 환경에서 창 호출시 필수 항목입니다.
리다이렉트 환경에서 해당 필드 누락시 에러가 발생합니다.

noticeUrls?: Array<string>

웹훅(Webhook) 수신 주소

유효한 형식의 문자열을 입력해주세요.

포트원 관리자 콘솔에 설정한 웹훅 주소 대신 사용할 웹훅 주소를 결제시마다 설정할 수 있습니다.
해당 값 설정시 관리자 콘솔에 설정한 주소로는 웹훅발송이 되지 않는점 유의하시기 바랍니다.

confirmUrl?: string

최종 결제 승인 요청 여부 확인 URL

유효한 URL 형식의 문자열을 입력해주세요.

confirm_process 사용 시 고객사 endpoint url 설정

기술지원 메일로 별도 요청이 필요합니다. (tech.support@portone.io)

appScheme?: string

모바일 결제 후 고객사 앱으로 복귀를 위한 URL scheme

WebView 환경 결제시 필수설정 항목 입니다.
ISP/앱카드 앱에서 결제정보인증 후 기존 앱으로 복귀할 때 사용합니다.

isEscrow?: boolean

에스크로 결제 여부

미입력 시 기본값: false

에스크로 설정은 PG사와 협의 이후 진행되어야 합니다.

products?: Array<Product>

구매 상품 상세 정보

id: string

상품 ID

상품명

code?: string

상품 코드

토스페이먼츠의 경우 필수로 입력해주세요.

amount: number

상품 단위 가격

결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.

1000 만큼 원화(KRW) 결제를 하는 경우, scale factor가 0이기 때문에 1000 * (10의 0승) = 1000을 전달해야 합니다.
1.50 만큼 달러(USD) 결제를 하는 경우, scale factor가 2이기 때문에 1.50 * (10의 2승) = 150을 전달해야 합니다.

이렇게 전달 된 값은 실제로 PG사에 결제를 요청할때 currency에 따라 올바른 값으로 변환되기 때문에 반드시 currency값을 필수로 입력해야 합니다.

quantity: number

상품 수량

tag?: string

상품 태그

link?: string

상품 판매 URL

isCulturalExpense?: boolean

문화비 지출 여부

도서, 공연, 박물관 등 문화비 지출 여부

locale?: Locale

결제창 언어 (지원되지 않은 일부 PG사 존재)

customData?: json

결제 정보와 함께 관리하고 싶은 고객사 커스텀 JSON 데이터

bypass?: PaymentBypass

PG사 결제창 호출 시 PG사로 그대로 bypass할 값들의 모음

tosspayments?: TosspaymentsPaymentBypass

토스페이먼츠 bypass 파라미터

discountCode?: string

토스페이먼츠 <-> 고객사 계약에 따라 프로모션 적용이 가능한 코드

useInternationalCardOnly?: boolean

해외 카드로만 결제가 가능하도록 할 지 여부

ksnet?: KsnetPaymentBypass

KSNET bypass 파라미터

sndQpayType?: KsnetSndQpayType

간편 결제 표시 구분

easyPayDirect?: boolean

KSNET 간편결제 다이렉트 여부

kakaopay?: KakaopayPaymentBypass

카카오페이 bypass 파라미터

custom_message?: string

카카오페이 결제창에 띄워줄 사용자 정의 문구

smartro_v2?: SmartroV2PaymentBypass

스마트로 V2 bypass 파라미터

GoodsCnt?: number

결제 상품 품목 개수

SkinColor?: SmartroV2SkinColor

UI 스타일 (기본값: "RED")

"RED", "GREEN", "BLUE", "PURPLE" 중 하나의 값으로 입력해주세요.

OpenType?: SmartroV2OpenType

해외 카드만 결제를 허용할지 여부(기본값: "KR")

"KR", "EN" 중 하나의 값으로 입력해주세요.

naverpay?: NaverpayPaymentBypass

네이버페이 bypass 파라미터

useCfmYmdt?: string

이용 완료일(YYYYMMDD)

productItems: Array<NaverpayProductItem>

categoryType: string

결제 상품 유형

categoryId: string

결제 상품 분류

uid: string

결제 상품 식별값

상품명

payReferrer?: NaverpayProductItemPayReferrer

결제 상품 유입경로

startDate?: string

시작일(YYYYMMDD)

endDate?: string

종료일(YYYYMMDD)

sellerId?: string

하위 판매자 식별키

결제 상품 개수

subMerchantInfo?: NaverpaySubMerchantInfo

하부 가맹점 정보. PG 업종 가맹점인 경우에만 필수 값

subMerchantName: string

하부 가맹점 명

subMerchantId: string

하부 가맹점 ID

subMerchantBusinessNo: string

하부 가맹점 사업자 번호(숫자 10자리)

subMerchantPayId: string

하부 가맹점 결제 키

subMerchantTelephoneNo: string

하부 가맹점 대표 전화번호

subMerchantCustomerServiceUrl: string

하부 가맹점 고객 서비스 URL

deliveryFee?: number

배송비

nice_v2?: NiceV2PaymentBypass

(신)나이스페이먼츠 bypass 파라미터

LogoImage?: string

결제창 로고 이미지 URL

NPDisableScroll?: NiceV2DisableScroll

결제창 스크롤 미사용 여부 (PC Only, Y: 미사용 / N(default): 사용)

SkinType?: NiceV2SkinType

결제창 스킨 색상 설정

"red", "green", "purple", "gray", "dark" 중 하나의 값으로 입력해주세요.

UserCI?: string

문화 상품권 결제시 결제 고객 사용자 인증 CI 정보. 아이디/비밀번호 외 추가로 CI 인증이 필요한 경우 사용. 사용 전 영업 담당자와 사전 협의 필수

MallUserID?: string

상점 사용자 아이디. 문화 상품권 결제시 경우 필수 입력

DirectCouponYN?: NiceV2DirectCoupon

신용카드 쿠폰 자동 적용 여부 (Y: 사전 등록된 선 할인 쿠폰을 자동 적용 / N: 쿠폰 미적용(기본값))

할부 거래 요청 시 할인 적용 후 승인 금액이 할부 가능 금액 (50,000) 미만인 경우 인증 실패 처리

DirectShowOpt?: NiceV2DirectShow

다이렉트 호출 결제 수단 (BANK: 계좌이체/CELLPHONE: 휴대폰 소액결제)

CardShowOpt?: string

카드사 별 호출 방식

형식) 카드코드:노출유형|카드코드:노출유형

예시) 08:3|02:3 → 롯데카드와 국민카드 선택시 앱 카드 직접 호출 방식으로 렌더링

노출 유형: 1(안심클릭), 2(간편결제), 3(앱 카드 직접 호출)
카드 코드: 02(국민), 04(삼성), 06(신한), 07(현대), 08(롯데), 12(NH), 15(우리)만 가능

PaycoClientId?: string

페이코 계정 자동 로그인 기능 사용하기 위해 페이코에서 고객사에 발급한 ClientId

PaycoAccessToken?: string

페이코 계정 자동 로그인 기능 사용을 위한 접속 토큰

SamPayMallType?: NiceV2SamPayMallType

삼성페이 고객사 유형 (01: 삼성페이 內 쇼핑 / 99: 기타 (기본값))

toss_brandpay?: TossBrandpayPaymentBypass

토스 브랜드페이 bypass 파라미터

brandpayOptions?: TossBrandpayBrandpayOptions

loadBrandpay 호출시 전달하는 세번째 파라미터

ui?: TossBrandpayBrandpayOptionsUi

highlightColor?: string

UI의 메인 색상. (기본값: #3182f6)

buttonStyle?: TossBrandpayBrandpayOptionsUiButtonStyle

버튼 스타일

default(기본값): 모서리가 둥글고 주변에 여백을 가진 버튼
full: 하단 영역이 전부 채워지는 형태의 버튼

labels?: TossBrandpayBrandpayOptionsUiLabels

oneTouchPay?: string

UI에 표시되는 원터치 결제를 대신해 사용할 텍스트. (기본값: "원터치 결제")

navigationBar?: TossBrandpayBrandpayOptionsUiNavigationBar

visible?: boolean

내비게이션 바 사용 여부. (기본값: true)

paddingTop?: number

내비게이션 바 위쪽에 설정할 여백 값. 값의 단위는 px

widgetOptions?: TossBrandpayWidgetOptions

브랜드페이 위젯 render() 함수 호출시 전달하는 두번째 파라미터

methodType?: TossBrandpayWidgetOptionsMethodType

위젯에 보여줄 결제 수단. 예) 카드 전달시 등록한 결제 수단 중 카드만 노출 됨

methodId?: string

위젯에서 기본 결제 수단으로 선택할 결제 수단의 ID

ui?: TossBrandpayWidgetOptionsUi

promotionSection?: TossBrandpayWidgetOptionsUiPromotionSection

summary?: TossBrandpayWidgetOptionsUiPromotionSectionSummary

visible?: boolean

혜택 배지 영역을 보여줄지 여부. 혜택 배지 영역에서는 즉시 할인 대상 카드 정보 등을 간략히 보여 줌. 기본값은 true

description?: TossBrandpayWidgetOptionsUiPromotionSectionDescription

visible?: boolean

결제 혜택 영역을 보여줄지 여부. 기본값은 true

defaultOpen?: boolean

결제 혜택의 상세 설명을 보여줄지 여부. 각 카드사의 결제 혜택을 자세히 설명 함. 기본값은 false

discountCode?: string

카드사 할인코드

methodId?: string

등록되어 있는 결제수단 중 하나를 지정해서 바로 결제하고 싶을 때 사용

welcome?: WelcomePaymentBypass

웰컴페이먼츠 bypass 파라미터

logo_url?: string

메인 로고 URL (크기: 89x19)

logo_2nd?: string

서브 로고 URL (크기: 64x13)

acceptmethod?: Array<string>

다양한 결제 옵션을 설정하기 위한 파라미터 배열입니다.

가능한 값들은 다음과 같습니다:

SKIN(#색상코드): 결제 창의 배경 색상 설정 (기본값: #c1272c)
- 예시: SKIN(#fc6b2d)
below1000: 1,000원 미만 결제 허용 여부
onlyeasypaycode(간편결제코드들): 카드 결제창에 렌더링될 간편 결제 리스트 지정
- 예시: onlyeasypaycode(kakaopay:lpay:payco)
- 간편결제코드:
  - 카카오페이: kakaopay
  - 엘페이: lpay
  - 페이코: payco
  - 토스페이: tosspay
SLIMQUOTA(코드-개월:개월^코드-개월:개월): 부분 무이자 할부 옵션
- 형식: SLIMQUOTA(카드코드-할부개월:부분무이자개월^...)
paypopup: 안심 클릭을 팝업 형태로 렌더링 할지 여부
hppdefaultcorp(통신사코드): 휴대폰 소액결제 시 기본 선택 통신사 지정
- 예시: hppdefaultcorp(KTF)
- 통신사코드:
  - SKT: SK 텔레콤
  - KTF: KT
  - LGT: LG 유플러스
  - MVNO: 알뜰폰 전체
  - CJH: 알뜰폰 CJ 헬로 모바일
  - KCT: 알뜰폰 티플러스
  - SKL: 알뜰폰 SK 세븐 모바일
hppnofix(Y|N): 휴대폰 소액결제창에 자동 입력되는 buyer_tel 값을 수정할 수 있는지 여부
- Y: 수정 불가능
- N: 수정 가능 (기본값)
va_ckprice: 가상계좌 발급 시, 주민번호 채번 할 때 금액 체크 기능

P_CARD_OPTION?: string

신용카드 우선 선택 옵션

예시: selcode=14
해당 카드 코드에 해당하는 카드가 선택된 채로 표시
간편결제는 불가능 (타 카드 선택 가능)

선택적 표시 옵션

예시 1: onlycard=visa3d
예시 2: selcode=14:onlycard=visa3d
선택적 표시 가능 결제 방식:
- 안심결제: visa3d
- ISP: isp
- 간편결제: easypay

P_ONLY_EASYPAYCODE?: string

카드 결제창에 렌더링될 간편 결제 리스트를 지정합니다.

예시: 카카오페이, 엘페이, 페이코만 렌더링 → KAKAOPAY:LPAY:PAYCO

카카오페이: KAKAOPAY
엘페이: LPAY
페이코: PAYCO
토스페이: TOSSPAY

P_RESERVED?: Array<string>

결제창 동작을 제어하기 위한 파라미터들을 설정하는 배열입니다.

가능한 값들은 다음과 같습니다:

below1000=Y: 1,000원 미만 결제 허용 여부
hpp_default_corp=통신사코드: 휴대폰 소액결제 시 기본 선택 통신사 지정
- 예시: hpp_default_corp=KTF
- 통신사코드:
  - SKT: SK 텔레콤
  - KTF: KT
  - LGT: LG 유플러스
  - MVNO: 알뜰폰 전체
  - CJH: 알뜰폰 CJ 헬로 모바일
  - KCT: 알뜰폰 티플러스
  - SKL: 알뜰폰 SK 세븐 모바일
hpp_nofix=Y|N: 휴대폰 소액결제창에서 자동 입력된 buyer_tel 수정 가능 여부
- Y: 수정 불가능
- N: 수정 가능 (기본값)

tosspay_v2?: TosspayV2PaymentBypass

토스페이 bypass 파라미터

expiredTime?: string

결제 만료 기한 (yyyy-MM-dd HH:mm:ss)

cashReceiptTradeOption?: TosspayV2CashReceiptTradeOption

현금영수증 발급타입

CULTURE: 문화비
GENERAL: 일반 (기본값)
PUBLIC_TP: 교통비

inicis_v2?: InicisV2Bypass

KG이니시스 bypass 파라미터

KG이니시스는 PC 결제 모듈과 모바일 결제 모듈이 분리되어 있기 때문에 bypass 파라미터 또한 PC용과 모바일용이 분리되어 있습니다.

logo_url?: string

PC용 파라미터

결제창에 삽입할 메인 로고 url

결제창 중앙 상단에 표시됩니다. 이미지 권장 사이즈는 89*18 입니다.

logo_2nd?: string

PC용 파라미터

결제창에 삽입할 서브 로고 url

결제창 우측 상단에 표시됩니다. 이미지 권장 사이즈는 64*13 입니다.

parentemail?: string

PC용 파라미터

보호자 이메일 주소

14세 미만 고객의 경우 필수 입력입니다. "@", "." 외의 특수문자는 입력 불가합니다.

Ini_SSGPAY_MDN?: string

PC용 파라미터

SSGPAY 결제요청 시 PUSH 전송 휴대폰번호

- 없이 숫자만 허용합니다.

acceptmethod?: Array<string>

PC용 파라미터

추가 옵션

아래 string 중 원하는 옵션들을 골라 array 형태로 입력합니다.

SKIN(#색상코드)

결제창 배경색상 설정 [기본값: #C1272C]

예시: SKIN(#fc6b2d)
below1000

(카드결제 & 간편결제 시) 1000원 미만 결제 허용 옵션
ocb

(카드결제 시) 카드 메인화면에 OCB 적립을 위한 카드번호 창 표시옵션 (별도 계약시 이용 가능)
paypopup

(카드결제 시) 안심클릭계열 신용카드 POPUP 형태 표시옵션
hidebar

(카드결제 시) 프로그레스바 미노출 옵션
noeasypay

(카드결제 시) 간편결제 미노출 옵션
slimquota(코드-개월:개월^코드-개월:개월)

부분 무이자 설정 (별도 계약시 이용 가능)

string 부분에는 코드-개월:개월^코드-개월:개월 와 같은 형식으로 입력합니다. (ex. slimquota(11-2:3^34-2:3)) 카드사 코드는 KG이니시스 통합 코드 페이지에서 "결제요청 시 카드코드" 섹션을 참고하시기 바랍니다.
mallpoint(카드코드:카드코드)

몰포인트 (별도 계약시 이용 가능)

string 부분에는 카드코드:카드코드 와 같은 형식으로 입력합니다. (ex. mallpoint(11:34)) 카드사 코드는 KG이니시스 통합 코드 페이지에서 "결제요청 시 카드코드" 섹션을 참고하시기 바랍니다.

P_CARD_OPTION?: string

모바일용 파라미터

신용카드 우선선택 옵션

설정한 카드코드에 해당하는 카드가 선택된 채로 Display 됩니다. selcode=카드코드 형식으로 입력합니다. (ex. selcode=14)

P_MNAME?: string

모바일용 파라미터

가맹점 이름

P_RESERVED?: Array<string>

모바일용 파라미터

추가 옵션

아래 string 중 원하는 옵션들을 골라 array 형태로 입력합니다.

below1000=Y

(카드결제 & 간편결제 시) 1000원 미만 결제 허용 옵션
noeasypay=Y

(카드결제 시) 간편결제 미노출 옵션
global_visa3d=Y

해외카드 노출 옵션
apprun_check=Y

(android의 경우) custom url scheme 대신 intent schema(intent://) 호출

kpn?: KpnBypass

KPN bypass 파라미터

CardSelect?: Array<KpnCardSelect>

해외카드 (VISA + MASTER + JCB) : GLOBAL
11Pay (SKPay) : 11PAY
구인증 : LEGACY_AUTH
키인 : KEY_IN

"GLOBAL"

해외카드

"11PAY"

11Pay

"LEGACY_AUTH"

구인증

"KEY_IN"

키인

kcp_v2?: KcpV2Bypass

NHN KCP bypass 파라미터

skin_indx?: string

site_logo?: string

shop_user_id: string

kcp_pay_title?: string

complex_pnt_yn?: KcpV2ComplexPnt

포인트 결제의 경우 신용카드 + 포인트 결제인데, N으로 설정 시 포인트로만 결제가 이루어짐

pt_memcorp_cd?: string

disp_tax_yn?: KcpV2DispTax

가상계좌, 계좌이체 시 현금영수증 노출 여부

site_name?: string

결제창에 노출될 고객사 상호명

deli_term?: string

에스크로 배송 예상 소요일

hyphen?: HyphenBypass

하이픈 bypass 파라미터

designCd?: string

eximbay_v2?: EximbayV2Bypass

엑심베이 V2 bypass 파라미터

payment?: EximbayV2Payment

결제 정보

payment_method?: string

결제수단 다이렉트

multi_payment_method?: Array<string>

결제수단 다이렉트 목록

merchant?: EximbayV2Merchant

상점 정보

shop?: string

상점명

partner_code?: string

파트너 코드

tax?: EximbayV2Tax

세금 정보

receipt_status?: EximbayV2TaxReceiptStatus

현금영수증 발급 여부

surcharge?: Array<EximbayV2Surcharge>

최대 3개의 추가 비용 목록

name?: string

항목명

quantity?: string

수량

unit_price?: string

단가 (음수 가능)

ship_to?: EximbayV2ShipTo

배송지 정보

city?: string

배송지 도시

country?: string

배송지 국가 (ISO 3166 두 자리 국가 코드)

first_name?: string

수신인의 성을 제외한 이름

last_name?: string

수신인의 성

phone_number?: string

수신인 전화번호

postal_code?: string

배송지 우편번호

state?: string

배송지가 미국 혹은 캐나다인 경우, 배송지 주 정보

street1?: string

배송지 상세 주소

bill_to?: EximbayV2BillTo

청구지 정보

city?: string

청구지 도시

country?: string

청구지 국가 (ISO 3166 두 자리 국가 코드)

first_name?: string

청구 카드 명의자의 성을 제외한 이름

last_name?: string

청구 카드 명의자의 성

phone_number?: string

청구 카드 명의자의 전화번호

postal_code?: string

청구지 우편번호

state?: string

청구지가 미국 혹은 캐나다인 경우, 청구지 주 정보

street1?: string

청구지 상세 주소

settings?: EximbayV2Settings

설정 정보

call_from_app?: EximbayV2SettingsCallFromApp

인앱 웹뷰 여부

issuer_country?: string

해외 결제 가맹점에서 국내 결제를 사용할 경우 KR

virtualaccount_expiry_date?: string

입금 만료 일자 (yyyyMMddHH)

inicis_jp?: InicisJpBypass

이니시스 일본 bypass 파라미터

paymentUI?: InicisJpPaymentUI

결제창 UI 설정

colorTheme?: string

결제창 색상

가능한 값:

red1
red2
red3
red4
orange
yellow
black
purple
green
blue1
blue2
blue3
blue4
blue5
blue6

logoUrl?: string

가맹점 로고 이미지 URL

69 * 20 픽셀 크기의 이미지 URL

payletter_global?: PayletterGlobalBypass

페이레터 해외결제 bypass 파라미터

pginfo?: string

결제수단 지정용 파라미터

해외카드 인증 : PLCreditCard
해외카드 비인증(3DS) : PLCreditCardMpi
유니온페이 : PLUnionPay_HC
위챗페이 PC결제: WeChatPayQRCodePayment
위챗페이 모바일결제 : WeChatPayH5Payment
알리페이 : ICBAlipay

servicename?: string

고객사 서비스명, WeChatPay, Alipay 이용 시 필수 입력

country?: Country

국가

ISO 3166-1 alpha-2 코드

productType?: ProductType

상품 유형

offerPeriod?: OfferPeriod

서비스 제공 기간

range와 interval 중 하나를 입력해주세요.

range: 제공 기간 범위
interval: 제공 기간 주기

예1) 2023년 1월 1일 00시 00분 00초(KST) ~

range: {
 from: '2023-01-01T00:00:00+09:00'
}

예2) ~ 2023년 1월 1일 00시 00분 00초(KST)

range: {
 to: '2023-01-01T00:00:00+09:00'
}

예3) 2023년 1월 1일 00시 00분 00초(KST) ~ 2023년 12월 31일 23시 59분 59초(KST)

range: {
 from: '2023-12-31T23:59:59+09:00'
 to: '2023-01-01T00:00:00+09:00'
}

예4) 30일 주기 interval: '30d'

예5) 6개월 주기 interval: '6m'

예6) 1년 주기 interval: '1y'

range?: OfferPeriodRange

기간 범위

OfferPeriodRangeFrom

시작 시점만 있는 기간 범위

from: string

시작 시점

OfferPeriodRangeTo

종료 지점만 있는 기간 범위

to: string

종료 지점

OfferPeriodRangeFromTo

시작 시점과 종료 지점이 모두 있는 기간 범위

from: string

시작 시점

to: string

종료 지점

interval?: string

제공 주기

제공 주기 (${number}d | ${number}m | ${number}y 형태로 입력할 수 있습니다.)

storeDetails?: StoreDetails

상점 정보

KSNET 카카오페이의 경우 필수 입력
(신)나이스페이의 경우 매출 전표에 표기 할 용도로 선택 입력
이니시스 일본결제의 경우 JPPG(gmoPayment) 결제의 상점정보로 사용되거나 편의점 결제 시 영수증 표시 정보로 사용됨.

ceoFullName?: string

상점 대표자 이름

phoneNumber?: string

상점 연락처

address?: string

상점 주소

zipcode?: string

상점 우편번호

email?: string

상점 이메일

businessName?: string

상점 사업자 명

businessRegistrationNumber?: string

상점 사업자 등록 번호

storeName?: string

상점명

storeNameShort?: string

상점명 약어

storeNameEn?: string

상점명 영문

storeNameKana?: string

상점명 후리카나 (일본어 읽는법 표기)

openingHours?: { open, close }

상점 영업시간 (HH:mm)

open?: string

영업 시작 시간

close?: string

영업 종료 시간

contactName?: string

상점 연락처 정보 이름

ex: 문의창구, 연락처, 지원창구

shippingAddress?: Address

주소 정보

country?: Country

국가

ISO 3166-1 alpha-2 코드

addressLine1: string

일반주소

addressLine2: string

상세주소

city?: string

도시

province?: string

주, 도, 시

promotionId?: string

프로모션 아이디

popup?: Popup

결제창이 팝업 방식일 경우 결제창에 적용할 속성

center?: boolean

true로 설정하면 결제창이 브라우저 화면의 정중앙에 표시됩니다.

card: PaymentRequestUnionCard

payMethod가 CARD인 경우에만 허용됩니다.

카드 정보

카드 결제 시, 카드 결제에 대한 세부 정보

virtualAccount: PaymentRequestUnionVirtualAccount

payMethod가 VIRTUAL_ACCOUNT인 경우에만 허용됩니다.

가상계좌 정보

가상계좌 발급시 가상계좌 상세 옵션

transfer: PaymentRequestUnionTransfer

payMethod가 TRANSFER인 경우에만 허용됩니다.

계좌이체 정보

계좌이체 결제시 계좌이체 상세 옵션

mobile: PaymentRequestUnionMobile

payMethod가 MOBILE인 경우에만 허용됩니다.

휴대폰 소액결제 정보

휴대폰 소액결제시 휴대폰 소액결제 상세 옵션

giftCertificate: PaymentRequestUnionGiftCertificate

payMethod가 GIFT_CERTIFICATE인 경우에만 허용됩니다.

상품권 정보

상품권 결제시 상품권 결제 상세 옵션

easyPay: PaymentRequestUnionEasyPay

payMethod가 EASY_PAY인 경우에만 허용됩니다.

paypal: {}

payMethod가 PAYPAL인 경우에만 허용됩니다.

alipay: {}

payMethod가 ALIPAY인 경우에만 허용됩니다.

convenienceStore: PaymentRequestUnionConvenienceStore

payMethod가 CONVENIENCE_STORE인 경우에만 허용됩니다.

requestPayment 요청 형식

requestPayment 요청 데이터 정의

`requestPayment` 요청 데이터 정의