개발자센터

KG파이낸셜 (구모듈)

KG파이낸셜 (구모듈) 결제 연동 방법을 안내합니다.

이 문서는 V1(구 아임포트) 연동 고객사 대상입니다. 신규 연동의 경우 V2 버전 사용을 권장합니다.

1. KG파이낸셜 채널 설정하기

결제대행사 채널 설정하기 페이지의 내용을 참고하여 채널 설정을 진행합니다.

2. 결제 요청하기

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

Javascript SDK
IMP.request_pay(
  {
    channelKey: "{콘솔 내 연동 정보의 채널키}",
    pay_method: "phone",
    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}",
  },
  function (rsp) {
    // callback 로직
    //* ...중략... *//
  },
);

주요 파라미터 설명

channelKey: string

채널키

결제를 진행할 채널을 지정합니다.

포트원 콘솔 내 [결제 연동] - [연동 정보] - [채널 관리] 에서 확인 가능합니다.

(최신 JavaScript SDK 버전부터 사용 가능합니다.)

pg(deprecated)?: string

PG사 구분코드

mobilians 로 지정하면 됩니다.

pg 파라미터는 지원 중단 예정입니다.

JS SDK를 가장 최신 버전으로 업그레이드 후 channelKey 파라미터로 채널 설정(PG사 구분)을 대체해주세요.

pay_method: string

결제수단 구분코드

  • card (신용카드)
  • phone (휴대폰 소액결제)
merchant_uid: string

주문번호

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

name: string

주문명

amount: number

결제금액

string 이 아닌점에 유의하세요

buyer_name?: string

구매자 이름

buyer_email?: string

구매자 이메일

buyer_tel?: string

구매자 연락처

buyer_addr?: string

구매자 주소

buyer_postcode?: string

구매자 우편번호

vbank_due?: string

가상계좌 입금마감일시

YYYYMMDD 형식으로 지정합니다. 미지정 시 5일 후로 자동 설정됩니다.

m_redirect_url?: string

모바일 결제 후 리디렉션 될 URL

app_scheme?: string

모바일 앱 URL scheme

notice_url?: string | string[]

웹훅 수신 URL

confirm_url?: string

Confirm process URL

custom_data?: object

가맹점 커스텀 데이터

customer_id?: string

구매자 고유 ID

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

Javascript SDK
IMP.request_pay(
  {
    channelKey: "{콘솔 내 연동 정보의 채널키}",
    pay_method: "phone",
    merchant_uid: "order_monthly_0001", // 상점에서 관리하는 주문 번호
    name: "최초인증결제",
    amount: 1004, // 결제창에 표시될 금액. 실제 승인이 이뤄지지는 않습니다.
    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("빌링키 발급 실패");
    }
  },
);
  • 비 인증 결제를 위해서는 KG파이낸셜과 계약이 완료된 MID 정보를 관리자콘솔에 설정하셔야 비 인증 결제창을 활성화시킬 수 있습니다.
  • KG파이낸셜 휴대폰 결제는 빌링키 발급시 실 결제가 발생됩니다.
  • 최초 승인일자 기준 매월 동일한 일자에 동일 금액이 재결제되어야 합니다.

주요 파라미터 설명

channelKey: string

채널키

결제를 진행할 채널을 지정합니다.

포트원 콘솔 내 [결제 연동] - [연동 정보] - [채널 관리] 에서 확인 가능합니다.

(최신 JavaScript SDK 버전부터 사용 가능합니다.)

pg(deprecated)?: string

PG사 구분코드

mobilians.<KG파이낸셜과 계약이 완료된 MID> 로 지정하면 됩니다.

pg 파라미터는 지원 중단 예정입니다.

JS SDK를 가장 최신 버전으로 업그레이드 후 channelKey 파라미터로 채널 설정(PG사 구분)을 대체해주세요.

customer_uid: string

카드 빌링키

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

amount: number

결제금액

결제창에 표시될 금액으로 실제 승인이 발생됩니다.

(실 결제를 발생시키기 위해서는 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":1004}' \
     https://api.iamport.kr/subscribe/payments/again

포트원을 통해 KG파이낸셜을 사용할 때에는 API 방식 비 인증 결제를 사용할 수 없습니다.