토스페이먼츠(구모듈)

토스페이먼츠 연동 방법을 확인합니다.

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

토스페이먼츠(구모듈) 연동 방법에 관한 매뉴얼입니다.

신규 연동 고객사이시거나 토스페이먼츠 신모듈로의 업그레이드를 원하신다면 토스페이먼츠(신모듈) 연동 가이드로 참고하여 진행해주세요. 구모듈에 비해 신모듈에서 다양한 기능 및 결제수단을 지원하고 있습니다. 신규 고객사의 경우 가급적 신모듈로 연동하는 것을 권장드립니다.

1. 토스페이먼츠 채널 설정하기

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

2. 결제창 호출

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

예시 코드는 아래와 같습니다.

Javascript SDK
IMP.request_pay( { channelKey: "{콘솔 내 연동 정보의 채널키}", pay_method: "card", 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}", appCard: true, // 설정시 신용카드 결제모듈에서 앱카드 결제만 활성화됩니다. }, function (rsp) { // callback 로직 //* ...중략... *// }, );

주요 파라미터 설명

channelKey: string

채널키

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

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

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

pg(deprecated)?: string

PG사 구분코드

uplus 로 지정하면 됩니다.

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

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

pay_method: string

결제수단 구분코드

  • card(신용카드)
  • trans(실시간 계좌이체)
  • vbank(가상계좌)
  • phone(휴대폰소액결제)
  • cultureland(컬쳐랜드 문화상품권)
  • smartculture(스마트문상)
  • booknlife(도서문화상품권)
  • applepay(애플페이)
  • tosspay(토스페이)
  • naverpay(네이버페이)
  • kakaopay(카카오페이)
  • lpay(엘페이)
  • payco(페이코)
  • samsung(삼성페이)
merchant_uid: string

주문번호

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

name: string

주문명

amount: number

결제금액

string 이 아닌점에 유의하세요

buyer_name?: string

구매자 이름

buyer_email?: string

구매자 이메일

buyer_tel?: string

구매자 연락처

buyer_addr?: string

구매자 주소

buyer_postcode?: string

구매자 우편번호

escrow?: boolean

에스크로 설정여부

tax_free?: number

면세금액

vbank_due?: string

가상계좌 입금마감일시

YYYYMMDD 또는 YYYYMMDDHHmmss 형식으로 지정합니다.

language?: string

결제창 언어

  • ko: 한국어 (기본값)
  • en: 영어
appCard?: boolean

앱카드 전용 모드

true 설정 시 신용카드 결제모듈에서 앱카드 결제만 활성화됩니다.

m_redirect_url?: string

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

app_scheme?: string

모바일 앱 URL scheme (모바일 전용)

notice_url?: string | string[]

웹훅 수신 URL

confirm_url?: string

Confirm process URL

custom_data?: object

가맹점 커스텀 데이터

display?: object

결제창에 렌더링될 카드 할부 개월수 리스트 설정값

card_quota?: number[]

할부 개월수

예시

  • []: 일시불만 결제 가능
  • [2,3,4,5,6]: 일시불을 포함한 2, 3, 4, 5, 6개월까지 할부개월 선택 가능
card?: object

카드 결제 옵션

direct?: object

카드사 다이렉트 호출 정보

code?: string

카드사 금융결제원 표준 코드

카드사 코드 참조

quota?: number

할부 개월 수

일시불일 시 0으로 설정합니다.

bypass?: object

토스페이먼츠 구모듈 전용 파라미터

uplus?: object
LGD_AUTO_DISCOUNT?: string

카드 프로모션 자동 적용 여부