```ts showLineNumbers
const userCode = "고객사 식별코드";
IMP.init(userCode); // 고객사 식별 코드를 넣어 모듈을 초기화해주세요.
IMP.request_pay(
{
channelKey: "{콘솔 내 연동 정보의 채널키}",
merchant_uid: "order_id_1667634130160",
name: "나이키 와플 트레이너 2 SD",
pay_method: "card",
escrow: false,
amount: 109000,
tax_free: 3000,
buyer_name: "홍길동",
buyer_email: "buyer@example.com",
buyer_tel: "02-1670-5176",
buyer_addr: "성수이로 20길 16",
buyer_postcode: "04783",
m_redirect_url: "https://helloworld.com/payments/result", // 모바일 환경에서 필수 입력
notice_url: "https://helloworld.com/api/v1/payments/notice",
confirm_url: "https://helloworld.com/api/v1/payments/confirm",
currency: "KRW",
locale: "ko",
custom_data: { userId: 30930 },
display: { card_quota: [0, 6] },
appCard: false,
useCardPoint: true,
bypass: {
tosspayments: {
useInternationalCardOnly: true, // 영어 결제창 활성화
},
},
},
(response) => {
// PC 환경에서 결제 프로세스 완료 후 실행 될 로직
},
);
```
주요 파라미터 설명
- channelKey: string
**채널키**
결제를 진행할 채널을 지정합니다.
포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
(최신 JavaScript SDK 버전부터 사용 가능합니다.)
- pg(deprecated)?: string
**PG사 구분코드**
`tosspayments` 로 지정하면 됩니다.
`pg` 파라미터는 지원 중단 예정입니다.
JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
- pay\_method?: string
- 카드 (card)
- 계좌이체(trans)
- 가상계좌(vbank)
- 휴대폰 소액결제(phone)
- 도서문화상품권(booknlife)
- 스마트문상(smartculture)
- 컬쳐랜드(cultureland)
- 카카오페이 (kakaopay)
- 네이버페이 (naverpay)
- 엘페이 (lpay)
- 삼성페이(samsungpay)
- SSGpay (ssgpay)
- 애플페이 (applepay)
- 페이코 (payco)
- 토스간편결제 (tosspay)
- merchant\_uid: string
**주문번호**
매번 고유하게 채번되어야 합니다.
- name: string
**주문명**
- amount: number
**결제금액**
**string** 이 아닌점에 유의하세요
- buyer\_name: string
**구매자 이름**
- buyer\_email?: string
**구매자 email 주소**
- buyer\_tel?: string
**구매자 연락처**
- buyer\_addr?: string
**구매자 주소**
- buyer\_postcode?: string
**구매자 우편번호**
- escrow?: boolean
**에스크로 결제 여부**
- tax\_free?: number
**면세금액**
- currency?: string
**통화구분코드**
- m\_redirect\_url?: string
**모바일 결제 후 리디렉션 될 URL**
모바일 환경에서 필수 입력합니다.
- app\_scheme?: string
**모바일 앱 URL scheme** (모바일 전용)
- notice\_url?: string | string\[]
**웹훅 수신 URL**
- confirm\_url?: string
**Confirm process URL**
- custom\_data?: object
**가맹점 커스텀 데이터**
- appCard?: boolean
카드 결제시, 카드 결제창에 앱카드만 선택 가능하도록 할지 여부 (기본값: **false**)
- useCardPoint?: boolean
카드 결제시, 카드 포인트 사용 허용할지 여부
**기타 파라미터 설명**
- bypass?: object
- isCulturalExpense?: boolean
**문화비 지출 여부** (bypass 루트 레벨, 계좌이체/가상계좌 전용)
`pay_method`가 `trans` 또는 `vbank`일 때만 토스페이먼츠에 전달됩니다.
- cashReceiptType?: string
**현금영수증 발급 유형** (bypass 루트 레벨, 계좌이체/가상계좌 전용)
`pay_method`가 `trans` 또는 `vbank`일 때만 토스페이먼츠에 전달됩니다. 미지정 시 결제창에서 선택 가능합니다.
- anonymous (미발행, 자진발급)
- personal (소득공제)
- corporate (지출증빙)
- tosspayments?: object
**토스페이먼츠 전용 파라미터** (카드 결제 전용)
- useInternationalCardOnly?: boolean
해외카드(Visa, MasterCard, UnionPay) 결제 여부입니다. 값이 `true`면 해외카드 결제가 가능한 영문 결제창이 열립니다.
- discountCode?: string
**카드사 할인코드**
```json
{
"pay_method": "trans",
"bypass": {
"isCulturalExpense": true,
"cashReceiptType": "personal"
}
}
```
```json
{
"pay_method": "card",
"bypass": {
"tosspayments": {
"useInternationalCardOnly": true,
"discountCode": "카드사 할인코드"
}
}
}
```
인증결제창 호출 파라미터에서 **customer\_uid** 값을 추가하면 비 인증 결제창을 호출할 수 있습니다. 비 인증 결제창에서 빌링키를 발급받은 후 해당 빌링키로 결제를 요청합니다.
```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}",
customer_id: "matthew", //고객사가 회원에게 부여한 고유 ID
},
function (rsp) {
// callback 로직
},
);
```
- 비인증 결제를 위해서는 **토스페이먼츠로 부터 발급받은 MID정보**를 포트원 관리자콘솔에 설정하셔야 비 인증 결제창을 활성화 시킬수 있습니다.
- 빌링키 발급시 **실 결제는 발생되지 않습니다**.(금액을 지정해도 결제가 발생되지 않음)
**주요 파라미터 설명**
- channelKey: string
**채널키**
결제를 진행할 채널을 지정합니다.
포트원 콘솔 내 \[결제 연동] - \[연동 정보] - \[채널 관리] 에서 확인 가능합니다.
(최신 JavaScript SDK 버전부터 사용 가능합니다.)
- pg(deprecated)?: string
**PG사 구분코드**
`tosspayments` 로 지정하면 됩니다.
`pg` 파라미터는 지원 중단 예정입니다.
JS SDK를 가장 최신 버전으로 업그레이드 후 `channelKey` 파라미터로 채널 설정(PG사 구분)을 대체해주세요.
- customer\_uid: string
**카드 빌링키**
비 인증 결제창에서 고객이 입력한 카드정보와 1:1로 매칭될 빌링키를 지정합니다.
- name: string
**주문명**
- amount: number
**결제금액**
결제창에 표시될 금액으로 실제 승인은 이루어지지 않습니다.(실 결제를 발생시키기 위해서는 **customer\_uid** 로 **REST API 를 이용하여 결제요청**을 해주셔야 합니다.)
- buyer\_name?: string
**구매자 이름**
- buyer\_email?: string
**구매자 이메일**
- buyer\_tel?: string
**구매자 연락처**
- buyer\_addr?: string
**구매자 주소**
- buyer\_postcode?: string
**구매자 우편번호**
- m\_redirect\_url?: string
**모바일 결제 후 리디렉션 될 URL**
- app\_scheme?: string
**모바일 앱 URL scheme** (모바일 전용)
- notice\_url?: string | string\[]
**웹훅 수신 URL**
- custom\_data?: object
**가맹점 커스텀 데이터**
- customer\_id?: string
**`구매자 식별자`**
빌링키를 발급한 고객의 고유 ID 를 지정합니다.(회원ID) 해당 값 설정시 빌링키와 고객을 맵핑할 수 있습니다. 누락시 포트원에서 임의의 값을 설정합니다.
**빌링키(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 방식으로 빌링키 발급,결제요청,예약결제를 구현할수 있습니다.**
**MID 발급시 주의사항**
토스페이먼츠로 부터 MID 발급시 **API version** 은 반드시 **1.4** 이어야 합니다.
**일회성 결제 요청하기**
[**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`** : 빌링키 등록을 위해서 지정해야 합니다.
```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
```