웰컴페이먼츠

웰컴페이먼츠 연동 방법을 안내합니다.

1. 웰컴페이먼츠 채널 설정하기

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

2. 최신 JavaScript SDK로 업데이트하기

웰컴페이먼츠 결제는 최신 SDK에서만 지원되는 기능입니다.

JS SDK
<script src="https://cdn.iamport.kr/v1/iamport.js"></script>

웰컴페이먼츠를 연동하기 위해서는 위에 안내된 JS SDK를 이용하셔야 합니다

JavaScript SDK 문서를 통해 최신 SDK를 설치해주세요.

3.결제 요청하기

JavaScript SDK IMP.request_pay(param, callback)을 호출하여 웰컴페이먼츠 결제/빌링키 발급/빌링키 발급과 동시에 결제창을 호출할 수 있습니다. 트랜잭션 결과는 PC의 경우 callback 함수로 전달되고 모바일의 경우 m_redirect_url로 302 리디렉션됩니다.

Javascript SDK
IMP.request_pay( { channelKey: "{콘솔 내 연동 정보의 채널키}", pay_method: "card", merchant_uid: "orderNo0001", // 고객사에서 채번한 주문 고유 번호입니다. name: "주문명:결제테스트", amount: 1004, buyer_email: "test@portone.io", buyer_name: "구매자이름", buyer_tel: "010-1234-5678", m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}", }, function (rsp) { // callback 로직 const { imp_uid, merchant_uid } = rsp; // 콜백 함수로 전달 받은 imp_uid로 포트원 결제 내역 조회 API를 통해 결제 상태를 판단합니다. }, );

일반 결제 창 호출 파라미터에서 customer_uid, customer_id값을 추가하면 빌링키 발급 창을 호출할 수 있습니다. 빌링키 발급 창에서 빌링키를 발급 받은 후, 빌링 결제 API를 호출해 해당 빌링키로 결제를 할 수 있습니다.

Javascript SDK
IMP.request_pay( { channelKey: "{콘솔 내 연동 정보의 채널키}", pay_method: "card", // 빌링키 발급 수단입니다. 웰컴페이먼츠의 경우 'card'만 지원됩니다. merchant_uid: "orderMonthly0001", // 고객사에서 채번한 주문 고유 번호입니다. name: "빌링키 발급", amount: 1000, // 전달한 결제 금액 만큼 실제로 승인되지는 않으며, 단순히 빌링키 발급 창에 표기 용도입니다. customer_uid: "your-customer-unique-id", // 고객사가 구매자의 결제 수단을 특정하기 위해 채번한 고유 ID로 빌링키 발급시 필수 입력입니다. customer_id: "matthew", // 고객사가 회원에게 부여한 고유 ID입니다. buyer_email: "test@portone.io", buyer_name: "포트원", buyer_tel: "02-1234-1234", m_redirect_url: "{모바일에서 빌링키 발급 완료 후 리디렉션 될 URL}", }, function (rsp) { const { imp_uid, merchant_uid } = rsp; // 콜백 함수로 전달 받은 imp_uid로 포트원 결제 내역 조회 API를 통해 빌링키 발급 상태를 판단합니다. }, );
Javascript SDK
IMP.request_pay( { channelKey: "{콘솔 내 연동 정보의 채널키}", pay_method: "phone", // 빌링키 발급 및 결제 수단입니다. 웰컴페이먼츠의 경우 'phone'만 지원합니다. merchant_uid: "orderNo0001", // 고객사에서 채번한 주문 고유 번호입니다. name: "주문명:결제테스트", amount: 1000, // 전달한 금액 만큼 실제로 승인이 됩니다. customer_uid: "your-customer-unique-id", // 고객사가 구매자의 결제 수단을 특정하기 위해 채번한 고유 ID로 빌링키 발급시 필수 입력입니다. customer_id: "matthew", // 고객사가 회원에게 부여한 고유 ID입니다. buyer_email: "test@portone.io", buyer_name: "구매자이름", buyer_tel: "010-1234-5678", m_redirect_url: "{모바일에서 결제 완료 후 리디렉션 될 URL}", }, function (rsp) { // callback 로직 const { imp_uid, merchant_uid } = rsp; // 콜백 함수로 전달 받은 imp_uid로 포트원 결제 내역 조회 API를 통해 결제 상태를 판단합니다. }, );