NHN KCP

인증결제창 호출 파라미터에서 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: "test@portone.io",
    buyer_name: "포트원",
    buyer_tel: "02-1234-1234",
    m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}",
  },
  function (rsp) {
    if (rsp.success) {
      alert("빌링키 발급 성공");
    } else {
      alert("빌링키 발급 실패");
    }
  },
);

주요 파라미터 설명

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

일회성 결제 요청하기

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

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

{
  "card": {
    "direct": {
      "code": "367",
      "quota": 3
      // 카드사 포인트 사용 경우
      // quota: 80 = 80(현대카드 포인트 할부개월) + 0(일시불)
      // quota: 93 = 80(현대카드 포인트 할부개월) + 13개월 할부
      // quota: 60 = 60(기타카드 포인트 할부개월) + 0(일시불)
      // quota: 63 = 60(기타카드 포인트 할부개월) + 3개월 할부
    }
  },
  "company": "고객사", // 해당 파라미터를 설정하지 않으면  카드사 모듈 창에 import 로 표기
}

파라미터 설명

• code: 카드사 금융결제원 표준 코드. 링크 참조 (string)

• quota: 할부 개월 수. 일시불일 시 0 으로 지정. 만약, 신용 카드사 포인트를 사용할 경우 카드사별 포인트 할부개월^[1]을 할부 개월 수에 더해줘야 합니다. (integer)

  ^[1] 카드사별 포인트 할부개월

  카드사 포인트	포인트 할부개월
  현대M	+80
  국민	+60
  비씨	+60
  삼성	+60
  하나/외환	+60
  롯데	+60
  신한	+60
  농협	+60
  씨티	+60
  우리	+60

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

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

파라미터 설명

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

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

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

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

에스크로 결제를 위해서는 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 파일에서 상세 샘플코드를 확인하세요)... */
});

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

숫자만 입력하세요

IMP.request_pay({
  // ...
  bypass: {
    coupon_apply_yn: "Y", // 미사용시 "N"
  },
  // ...
});

인증 결제창내 할인쿠폰 UX를 활성/비활성화 할 수 있습니다. 해당 기능은 KCP와 협의 후 사용 가능 합니다.

IMP.request_pay({
  // ...
  bypass: {
    batch_birth_day_yn: "Y", // 결제창 렌더링 시 생년월일 입력 박스 고정 활성화
  },
  // ...
});

NHN KCP 결제창을 이용한 빌링키 발급 시 PC 환경에서 공인인증서 절차를 생략하는 경우 카드 정보 입력 화면에서 생년월일 입력 박스가 표시되도록 고정시킬 수 있습니다. 해당 파라미터를 설정하지 않고 빌링키 발급 진행 시 최초 주민등록번호 입력 박스가 표시되며, 카드 정보 8자리 입력 시 생년월일 입력 박스로 변환됩니다.