⌨️NHN KCP

NHN KCP 결제창 연동 가이드입니다.

Deprecated

이 문서는 더 이상 관리되지 않습니다.

PortOne 개발자센터를 이용해주세요.

1. NHN KCP PG 설정하기

NHN KCP 설정 페이지의 내용을 참고하여 PG 설정을 진행합니다.

2.결제 요청하기

JavaScript SDK IMP.request_pay(param, callback)을 호출하여 NHN KCP 결제창을 호출할 수 있습니다. 결제결과는 PC의 경우 IMP.request_pay(param, callback) 호출 후 callback 으로 수신되고 모바일의 경우 m_redirect_url 로 리디렉션됩니다.

인증결제 연동하기

Javascript SDK

IMP.request_pay({
    pg : 'kcp.{사이트코드}',   //테스트인경우 kcp.T0000
    pay_method : 'card',
    merchant_uid: "order_no_0001", //상점에서 생성한 고유 주문번호
    name : '주문명:결제테스트',
    amount : 1004,
    company : '상호명',//해당 파라미터 설정시 통합결제창에 해당 상호명이 노출됩니다.
    buyer_email : '[e-mail]',
    buyer_name : '구매자이름',
    buyer_tel : '010-1234-5678',
    buyer_addr : '서울특별시 강남구 삼성동',
    buyer_postcode : '123-456',
    language : 'ko', // en 설정시 영문으로 출력되면 해당 파라미터 생략시 한국어 default
    m_redirect_url : '{모바일에서 결제 완료 후 리디렉션 될 URL}',
    auth_mode:'key-in' // 키인결제(일회성 결제)이용시 설정 
}, function(rsp) { // callback 로직
	//* ...중략... *//
});

주요 파라미터 설명

pg * string

PG사 구분코드

kcp.{사이트코드}

사이트코드 값은 KCP 계약 후 KCP로 부터 발급받을수 있습니다.

pay_method * string

결제수단 구분코드

• card (신용카드)

• samsung (삼성페이)

• trans (실시간 계좌이체)

• vbank(가상계좌)

• phone (휴대폰소액결제)

• payco (페이코 허브형)

• lpay(L페이 허브형)

• cultureland (문화상품권)

• smartculture (스마트문상)

• happymoney (해피머니)

• booknlife (도서문화상품권)

• point (베네피아 포인트)

• kakaopay(카카오페이)

• naverpay(네이버페이)

• applepay(애플페이)

merchant_uid * string

주문번호

매번 고유하게 채번되어야 합니다.

amount * integer

결제금액

string 이 아닌점에 유의하세요

payco 허브형인 경우 KCP 관리자페이지 신청 및 설정이 필요합니다.

신청안내 링크 : https://sir.kr/main/service/p_payco_hub.php

비인증결제 연동하기(예약결제)

인증결제창 호출 파라미터에서 customer_uid 값을 추가하면 비 인증 결제창을 호출할 수 있습니다. 비인증 결제창에서 빌링키를 발급받은 후 해당 빌링키로 결제를 요청합니다.

Javascript SDK

IMP.request_pay({
    pg : 'kcp_billing.{사이트코드}',
    pay_method : 'card', // 'card'만 지원됩니다.
    merchant_uid: "order_monthly_0001", // 상점에서 관리하는 주문 번호
    name : '최초인증결제',
    amount : 0, // 결제창에 표시될 금액. 실제 승인이 이뤄지지는 않습니다.
    customer_uid : 'your-customer-unique-id', // 필수 입력.
    buyer_email : '[e-mail]',
    buyer_name : '포트원',
    buyer_tel : '02-1234-1234',
    m_redirect_url : '{모바일에서 결제 완료 후 리디렉션 될 URL}' 
}, function(rsp) {
    if ( rsp.success ) {
        alert('빌링키 발급 성공');
    } else {
        alert('빌링키 발급 실패');
    }
});

• 비인증 결제를 위해서는 KCP와 협의가 완료된 사이트코드를 관리자콘솔에 설정하셔야 비인증 결제창을 활성화 시킬수 있습니다.

• KCP는 빌링키 발급시 실 결제는 발생되지 않습니다.(금액을 지정해도 결제가 발생되지 않음)

주요 파라미터 설명

pg * string

PG사 구분코드

kcp_billing.{사이트코드}

사이트코드 값은 KCP 계약 후 KCP로 부터 발급받을수 있습니다.

customer_uid * string

카드 빌링키

비 인증 결제창에서 고객이 입력한 카드정보와 1:1로 매칭될 빌링키를 지정합니다.

amount * Integer

결제금액

결제창에 표시될 금액으로 실제 승인은 이루어지지 않습니다.(실 결제를 발생시키기 위해서는 customer_uid 로 REST API 를 이용하여 결제요청을 해주셔야 합니다.)

빌링키(customer_uid)로 결제 요청하기

빌링키 발급이 성공하면 실 빌링키는 customer_uid 와 1:1 매칭되어 포트원 서버에 저장됩니다. customer_uid를 가맹점 내부서버에 저장하시고 비 인증 결제요청 REST API를 호출하시면 결제를 발생시킬 수 있습니다.

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 방식으로 빌링키 발급,결제요청,예약결제를 구현할수 있습니다.

API 결제

일회성 결제 요청하기

REST API POST /subscribe/payments/onetime을 호출하여 일회성 결제를 요청합니다. 요청 시 전달된 카드는 포트원에 등록되지 않습니다.

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}를 호출하여 빌링키 발급을 요청합니다.

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을 호출하여 빌링키 발급과 최초 결제를 요청합니다.

• customer_uid : 빌링키 등록을 위해서 지정해야 합니다.

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) REST API를 다음과 같이 호출합니다.

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

자세한 가이드는 아래 링크를 참조하세요

⏰비 인증결제 연동하기

3. 부가기능

할부개월 고정

javascript

display: {
    card_quota: [6]  // 할부개월 6개월까지만 활성화
}

파라미터 설명

• card_quota :

  • []: 일시불만 결제 가능

  • 2,3,4,5,6: 일시불을 포함한 2, 3, 4, 5, 6개월까지 할부개월 선택 가능\

할부결제는 5만원 이상 결제 요청시에만 이용 가능합니다.

할부개월수 3개월까지 활성화 예제

카드사 모듈 바로 호출

javascript

card: {
     direct: {
        code: "367",
        quota: 3
    }
},
company : "가맹점",  //해당 파라미터를 설정하지 않으면  카드사 모듈 창에 import 로 표기 

파라미터 설명

• code : 카드사 금융결제원 표준 코드. 링크 참조 (string)
• quota : 할부 개월 수. 일시불일 시 0 으로 지정. (integer)

주의사항

• 현재 KG이니시스, KCP, 토스페이먼츠, 나이스페이먼츠, KICC, 다날 6개 PG사에 대해서만 카드사 결제창 direct 호출이 가능합니다.

• 일부 PG사의 경우, 모든 상점아이디에 대하여 카드사 결제창 direct 노출 기능을 지원하지 않습니다. 반드시 포트원을 통해 현재 사용중인 상점아이디가 카드사 결제창 direct 호출이 가능하도록 설정이 되어있는지 PG사에 확인이 필요합니다.

현대카드 결제모듈 바로 호출 예제

특정 카드사 노출

javascript

card : {
    detail : [
        {card_code:"*", enabled:false},     //모든 카드사 비활성화
        {card_code:'366', enabled:true}     //특정 카드만 활성화
    ]
}

파라미터 설명

• card_code : 금결원 카드사코드 링크 참조 (string)
• enabled : 해당카드 활성화 여부 (boolean)

신한카드만 결제창 노출 처리 예제

카드사 간편결제 노출

인증결제시 각 카드사 앱카드 결제 화면만 노출하고 싶은 경우 아래 파라미터를 설정하시면 됩니다.

request_pay()

...
appCard : true .  //true 설정시 각 카드사 앱카드 결제만 활성화
...

4. 기타 파라미터

상품권 결제수단

상품권 결제수단을 사용하기 위해서는 가맹점에서 관리하는 회원ID를 아래와 같은 방법으로 파라미터 설정이 필요합니다.

javascript SDK

bypass : {
    shop_user_id : ‘ABCD123’   //가맹점 회원ID (20byte)
}

상품권 기관 RM 조치를 위해 필수적으로 실어주셔야 합니다.

컬처랜드 문화 상품권을 호출하는 경우

MP.request_pay({
    pg : 'kcp.{문화상품권 대상 사이트코드}',
    pay_method : 'cultureland',    //문화상품권
    merchant_uid: "A00021-TEST",
    name : '당근 10kg',
    amount : 1004,
    buyer_email : '[e-mail]',
    buyer_name : '포트원 기술지원팀',
    buyer_tel : '010-1234-5678',
    buyer_addr : '서울특별시 강남구 삼성동',
    buyer_postcode : '123-456',
    bypass : {
        shop_user_id : 'abaddd'  // 가맹점 회원 id기재
    }
}

에스크로 결제

에스크로 결제를 위해서는 escrow 파라미터를 추가하고 true 값으로 설정되어야 합니다. 에스크로 결제요청 시 장바구니 상품을 묶어서 결제하는 경우 해당 품목에 대한 정보를 전달하기 위해 해당 상품관련 정보를 추가 파라미터(kcpProducts)로 전달해야 합니다. **kcpProducts**는 다음 4개의 필수 속성으로 구성된 객체배열입니다.

amount 값은 결제 금액(param.amount) 값과 관계가 없으며 비교검증되지 않습니다.

• orderNumber : 상품주문번호

• name : 상품명

• quantity : 수량

• amount : 상품 가격

JavaScript SDK

IMP.request_pay({
    pg : 'kcp',
    escrow : true, //에스크로 결제인 경우 필요
    kcpProducts : [
    	{
	    "orderNumber" : "xxxx",
	    "name" : "상품A",
	    "quantity" : 3,
	    "amount" : 1000
	},{
	    "orderNumber" : "yyyy",
	    "name" : "상품B",
	    "quantity" : 2,
	    "amount" : 3000
	}
    ],
    //* ...중략 (README 파일에서 상세 샘플코드를 확인하세요)... *//
})

휴대폰 결제 휴대폰번호 고정

request_pay()

{
  "prefill": {
    "phoneNumber": "고정할 휴대폰번호"
  }

숫자만 입력하세요