```ts title="Javascript SDK"
IMP.request_pay(
{
channelKey: "{콘솔 내 연동 정보의 채널키}",
pay_method: "card",
merchant_uid: "order_no_0001", //상점에서 생성한 고유 주문번호
name: "주문명:결제테스트",
amount: 1004,
buyer_email: "test@portone.io",
buyer_name: "구매자이름",
buyer_tel: "010-1234-5678", //필수 파라미터 입니다.
buyer_addr: "서울특별시 강남구 삼성동",
buyer_postcode: "123-456",
m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}",
escrow: true, //에스크로 결제인 경우 설정
vbank_due: "YYYYMMDD",
bypass: {
// PC 경우
acceptmethod: "noeasypay", // 간편결제 버튼을 통합결제창에서 제외(PC)
// acceptmethod: "cardpoint", // 카드포인트 사용시 설정(PC)
// 모바일 경우
P_RESERVED: "noeasypay=Y", // 간편결제 버튼을 통합결제창에서 제외(모바일)
// P_RESERVED: "cp_yn=Y", // 카드포인트 사용시 설정(모바일)
// P_RESERVED: "twotrs_bank=Y&iosapp=Y&app_scheme=your_app_scheme://", // iOS에서 계좌이체시 결제가 이뤄지던 앱으로 돌아가기
},
period: {
from: "20200101", //YYYYMMDD
to: "20201231", //YYYYMMDD
},
},
function (rsp) {
// callback 로직
//* ...중략... *//
},
);
```
### 주요 파라미터 설명
- channelKey: string
**채널키**
결제를 진행할 채널을 지정합니다.
포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
(최신 JavaScript SDK 버전부터 사용 가능합니다.)
- pg(deprecated)?: string
**PG사 구분코드**
`html5_inicis.{PG상점아이디}`
PG상점아이디는 KG이니시스와 계약 후 발급받을 수 있습니다.
`pg` 파라미터는 지원 중단 예정입니다.
JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
- pay\_method: string
**결제수단 구분코드**
결제수단 구분코드
- `card` (신용카드)
- `kakaopay` (카카오페이 허브형)
- `naverpay` (네이버페이)
- `samsung` (삼성페이 허브형)
- `applepay` (애플페이 허브형)
- `ssgpay` (SSG페이 허브형)
- `payco` (페이코 허브형)
- `tosspay` (토스페이 허브형)
- `lpay` (L페이 허브형)
- `trans` (실시간 계좌이체)
- `vbank`(가상계좌)
- `phone` (휴대폰소액결제)
- `cultureland` (컬쳐랜드 문화상품권)
- `smartculture` (스마트문상)
- `happymoney` (해피머니 문화상품권)
- `booknlife`(도서문화상품권)
- merchant\_uid: string
**주문번호**
매번 고유하게 채번되어야 합니다.
- name: string
**주문명**
- amount: number
**결제금액**
**string** 이 아닌점에 유의하세요
- buyer\_name?: string
**구매자 이름**
- buyer\_email?: string
**구매자 이메일**
- buyer\_tel: string
**주문자연락처**
필수 파라미터 입니다.
- buyer\_addr?: string
**구매자 주소**
- buyer\_postcode?: string
**구매자 우편번호**
- escrow?: boolean
**에스크로 결제 여부**
- tax\_free?: number
**면세금액**
- vbank\_due?: string
가상계좌 입금마감일시를 지정할수 있습니다.(미 지정시 Default 30일)
- m\_redirect\_url?: string
**모바일 결제 후 리디렉션 될 URL**
- app\_scheme?: string
**모바일 앱 URL scheme** (모바일 전용)
모바일 앱에서 결제 시 ISP/앱카드 등에서 결제 완료 후 가맹점 앱으로 돌아올 때 사용됩니다.
- notice\_url?: string | string\[]
**웹훅 수신 URL**
포트원 관리자 콘솔에 설정한 웹훅 URL 대신 사용할 URL을 지정합니다.
- confirm\_url?: string
**Confirm process URL**
- custom\_data?: object
**가맹점 커스텀 데이터**
결제 정보와 함께 저장할 커스텀 데이터입니다. 결제 조회 시 반환됩니다.
- customer\_id?: string
**구매자 고유 ID**
- digital?: boolean
**디지털 컨텐츠 여부**
휴대폰 소액결제 시 디지털 컨텐츠(`true`)인지 실물 상품(`false`)인지 구분합니다.
- language?: string
**결제창 언어**
- `ko`: 한국어 (기본값)
- `en`: 영어
- period?: object
고객이 구매하는 제품에 대한 제공기간을 명시합니다.
- from: string
**YYYYMMDD**
- to: string
**YYYYMMDD**
- bypass?: object
**KG이니시스 전용 파라미터**
PC와 모바일에서 사용하는 파라미터가 다릅니다.
- acceptmethod?: string
**PC 전용 옵션** (콜론 `:` 구분자로 여러 값 연결)
- `noeasypay`: 간편결제 버튼을 통합결제창에서 제외
- `CARDPOINT`: 카드사 포인트 사용
- `no_receipt`: 현금영수증 미발행
- `SKIN(색상)`: 결제창 배경색상 변경. 색상표 값으로 설정 가능 (예: `SKIN(BLUE)`). 미설정 시 기본값 `#c1272c`
- `cardshowopt(카드코드-호출옵션)`: 신용카드 ACS 창에서 앱카드/안심클릭/간편결제 UI 표시 옵션. 카드코드와 호출옵션은 `-`로 구분 (예: `cardshowopt(04-6)`)
- `disablepoint`: 현대카드 M포인트 강제 미사용
- `usespcp`: 현대카드 M포인트 사용
- `cd_ps(카드코드-할부개월)`: 신한카드 제휴 옵션 (배송비 혜택)
예시: `"acceptmethod": "noeasypay:CARDPOINT:SKIN(BLUE)"`
- P\_RESERVED?: string
**모바일 전용 옵션** (`&` 구분자로 여러 값 연결)
- `noeasypay=Y`: 간편결제 버튼을 통합결제창에서 제외
- `cp_yn=Y`: 신용카드 포인트 사용
- `dcp_yn=Y`: 카드사 다이렉트 호출 시 카드 포인트 사용
- `vbank_receipt=Y`: 가상계좌 현금영수증 입력란 표시 (기본적으로 미표시)
- `bank_receipt=N`: 계좌이체 현금영수증 입력란 숨김 (기본적으로 표시)
- `twotrs_bank=Y`: 계좌이체 거래 시 필수 입력 값
- `apprun_check=Y`: 앱 호출 시 Intent 방식으로 호출 (Android 전용, `app_scheme`과 같이 사용 불가)
- `app_scheme=스키마명://`: 가맹점 앱 scheme 설정 (iOS 지원, ISP/뱅크월렛/은련카드/LPAY/페이코 등)
- `iosapp=Y`: iOS 앱에서 결제 시 설정
- `cardshowopt=카드코드:호출옵션`: 신용카드 ACS 창 표시 옵션
예시: `"P_RESERVED": "noeasypay=Y&twotrs_bank=Y&apprun_check=Y"`
- ini\_PAYSHOT\_KEY?: string
**현대카드 Payshot 고객 Key** (PC 전용)
현대카드 Payshot 사용 시 필수 입력합니다.
형식: `{가맹점구분}{YYYYMMDDHHMMSSmsec}{고객id}`
- P\_PAYSHOT\_KEY?: string
**현대카드 Payshot 고객 Key** (모바일 전용)
현대카드 Payshot 사용 시 필수 입력합니다.
형식: `{가맹점구분}{YYYYMMDDHHMMSSmsec}{고객id}`
**PG사 결제창으로 카드정보를 입력받고 빌링키를 발급할수 있습니다.**
- 인증결제창 호출 파라미터에서 **customer\_uid** 값을 추가하면 비 인증 결제창을 호출할 수 있습니다.
- 비 인증 결제창에서 빌링키를 발급받은 후 해당 빌링키로 결제를 요청합니다.
- amount 파라미터에 금액을 설정하여도 실제 승인은 이루어지지 않습니다.
```ts title="Javascript SDK"
IMP.request_pay(
{
channelKey: "{콘솔 내 연동 정보의 채널키}",
pay_method: "card", // 'card'만 지원됩니다.
merchant_uid: "order_monthly_0001", // 상점에서 관리하는 주문 번호
name: "최초인증결제",
amount: 0, // 결제창에 표시될 금액. 실제 승인이 이뤄지지는 않습니다.
customer_uid: "your-customer-unique-id", // 필수 입력.
buyer_email: "test@portone.io",
buyer_name: "포트원",
buyer_tel: "02-1234-1234",
m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}",
},
function (rsp) {
if (rsp.success) {
alert("빌링키 발급 성공");
} else {
alert("빌링키 발급 실패");
}
},
);
```
### 주요 파라미터 설명
- channelKey: string
**채널키**
결제를 진행할 채널을 지정합니다.
포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
(최신 JavaScript SDK 버전부터 사용 가능합니다.)
- pg(deprecated)?: string
**PG사 구분코드**
`html5_inicis` 로 설정
- KG이니시스에서 발급받은 상점아이디가 여러개(각각 일반 및 정기)인 경우에는 html5\_inicis.{상점아이디} 또는 inicis.{상점아이디}(for ActiveX)로 지정합니다.
`pg` 파라미터는 지원 중단 예정입니다.
JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
- customer\_uid: string
**카드 빌링키**
비 인증 결제창에서 고객이 입력한 카드정보와 1:1로 매칭될 빌링키를 지정합니다.
- merchant\_uid: string
**주문번호**
- name: string
**주문명**
- amount: number
**결제금액**
결제창에 표시될 금액으로 실제 승인은 이루어지지 않습니다.(실 결제를 발생시키기 위해서는 **customer\_uid** 로 **REST API 를 이용하여 결제요청**을 해주셔야 합니다.)
- buyer\_name?: string
**구매자 이름**
- buyer\_email?: string
**구매자 이메일**
- buyer\_tel?: string
**구매자 연락처**
- m\_redirect\_url?: string
**모바일 결제 후 리디렉션 될 URL**
- app\_scheme?: string
**모바일 앱 URL scheme** (모바일 전용)
- notice\_url?: string | string\[]
**웹훅 수신 URL**
- custom\_data?: object
**가맹점 커스텀 데이터**
- customer\_id?: string
**구매자 고유 ID**
- bypass?: object
**빌링키 발급 전용 파라미터**
- inicis?: object
- authtype?: string
**빌링키 발급 결제창 표시 구분** (모바일 전용)
- `01`: 카드번호, 유효기간, 생일 입력 부분만 표시
- 미전달: 카드번호, 유효기간, 주민번호, 비밀번호 입력 부분 표시
**빌링키(customer\_uid)로 결제 요청하기**
빌링키 발급이 성공하면 실 빌링키는 customer\_uid 와 1:1 매칭되어 **포트원 서버에 저장**됩니다. customer\_uid를 고객사 내부서버에 저장하시고 [**비 인증 결제요청 REST API**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fagain)를 호출하시면 결제를 발생시킬 수 있습니다.
```sh title="server-side"
curl -H "Content-Type: application/json" \
-X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
https://api.iamport.kr/subscribe/payments/again
```
**API 방식으로 빌링키 발급,결제요청,예약결제를 구현할수 있습니다.**
**일회성 결제 요청하기**
REST [**API POST /subscribe/payments/onetime**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fonetime)을 호출하여 일회성 결제를 요청합니다. 요청 시 전달된 카드는 포트원에 등록되지 않습니다.
```sh
curl -H "Content-Type: application/json" \
-X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
https://api.iamport.kr/subscribe/payments/onetime
```
**빌링키 발급 요청하기**
REST [**API POST /subscribe/customers/{customer\_uid}**](https://developers.portone.io/api/rest-v1/billingkey?v=v1#post%20%2Fsubscribe%2Fcustomers%2F%7Bcustomer_uid%7D)를 호출하여 빌링키 발급을 요청합니다.
```sh
curl -H "Content-Type: application/json" \
-X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
https://api.iamport.kr/subscribe/customers/your-customer-unique-id
```
**빌링키 발급 및 최초 결제 요청하기**
REST [**API POST /subscribe/payments/onetime**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fonetime)을 호출하여 빌링키 발급과 최초 결제를 요청합니다.
- **`customer_uid`** : 빌링키 등록을 위해서 지정해야 합니다.
- **`amount`** : 0원 이상 설정시 빌링키 발급과 동시에 실결제가 발생됩니다.
```sh
curl -H "Content-Type: application/json" \
-X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
https://api.iamport.kr/subscribe/payments/onetime
```
**빌링키로 결제 요청하기**
빌링키 발급과 최초 결제가 성공하면 빌링키는 전달된 `customer_uid` 와 1:1 매칭되어 포트원에 저장됩니다. 보안상의 이유로 서버는 빌링키에 직접 접근할 수 없기 때문에 `customer_uid`를 이용해서 빌링키 결제([**POST /subscribe/payments/again**](https://developers.portone.io/api/rest-v1/nonAuthPayment?v=v1#post%20%2Fsubscribe%2Fpayments%2Fagain)) REST API를 다음과 같이 호출합니다.
```sh
curl -H "Content-Type: application/json" \
-X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
https://api.iamport.kr/subscribe/payments/again
```
**자세한 가이드는 아래 링크를 참조하세요**
[비인증결제 연동하기](https://developers.portone.io/opi/ko/integration/start/v1/non-auth)