개발자센터

엑심베이

엑심베이 결제 연동 방법을 안내합니다.

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

1. 엑심베이 채널 설정하기

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

2. 결제 요청하기

JavaScript SDK IMP.request_pay(param, callback)을 호출하여 엑심베이 결제창을 호출할 수 있습니다. 결제결과는 PC / 모바일 모두 callback 으로 전달됩니다.

Javascript SDK
IMP.request_pay(
  {
    channelKey: "{콘솔 내 연동 정보의 채널키}",
    pay_method: "card",
    merchant_uid: "order_no_0001", // 상점에서 관리하는 주문 번호
    name: "주문명:결제테스트",
    amount: 14.2,
    currency: "USD", // 기본값: USD
    buyer_email: "test@portone.io",
    buyer_name: "구매자이름",
    buyer_tel: "010-1234-5678",
    buyer_addr: "서울특별시 강남구 삼성동",
    buyer_postcode: "123-456",
    popup: false, // 팝업창 활성 비활성화 컨트롤
  },
  function (rsp) {
    // callback 로직
    /* ...중략... */
  },
);

주요 파라미터 설명

channelKey: string

채널키

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

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

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

pg(deprecated)?: string

PG사 구분코드

eximbay 로 지정하면 됩니다.

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

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

pay_method: string

결제수단 구분코드

  • 신용카드: card
  • 알리페이 / 알리페이 플러스: alipay (상점아이디 설정에 따라 알리페이 혹은 알리페이 플러스로 호출됩니다. )
  • 해외카드: card
  • 유니온페이: unionpay
  • 텐페이: tenpay
  • 일본 편의점결제(eContext): econtext
  • 위챗페이: wechat
  • 몰페이: molpay
merchant_uid: string

고객사 고유주문번호

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

name: string

주문명

buyer_name: string

구매자명

buyer_email?: string

구매자 이메일

buyer_tel: string

구매자 연락처

buyer_addr?: string

구매자 주소

bypass.shipTo_street1의 기본값으로 사용됩니다.

buyer_postcode?: string

구매자 우편번호

bypass.shipTo_postalCode의 기본값으로 사용됩니다.

amount: number

결제금액

string 이 아닌점에 유의하세요

currency?: string

결제통화코드 (기본값: USD)

KRW, USD, EUR, GBP, JPY, THB, SGD, RUB, HKD, CAD, AUD

language?: string

결제창 언어

  • ko: 한국어
  • en: 영어
  • zh: 중국어
  • jp: 일본어
popup?: boolean

팝업창 활성화 여부

m_redirect_url?: string

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

notice_url?: string | string[]

웹훅 수신 URL

custom_data?: object

가맹점 커스텀 데이터

bypass?: object

엑심베이 전용 파라미터

eximbay?: object
issuercountry?: string

국내 결제창 호출 시 KR로 설정

shipTo_city?: string

배송지 도시

shipTo_country?: string

배송지 국가코드

shipTo_firstName?: string

수취인 이름

shipTo_lastName?: string

수취인 성

shipTo_phoneNumber?: string

수취인 연락처

shipTo_state?: string

배송지 주/도

billTo_city?: string

청구지 도시

billTo_country?: string

청구지 국가코드

billTo_firstName?: string

청구인 이름

billTo_lastName?: string

청구인 성

billTo_phoneNumber?: string

청구인 연락처

billTo_postalCode?: string

청구지 우편번호

billTo_state?: string

청구지 주/도

billTo_street1?: string

청구지 주소

siteforeigncur?: string

외화 표시 통화

참고사항

포트원은 엑심베이 정기결제를 지원하지 않습니다.

3. 기타 파라미터

엑심베이국내 결제창을 사용하기 위해서는 아래와 같은 방법으로 파라미터 설정이 필요합니다.

{
  "bypass": {
    "eximbay": {
      "issuercountry": "KR"
    }
  }
}

국내 결제창 카드 별 승인 통화

해외카드

  • VISA/MAster/JCB : KRW 승인 (자국통화승인 서비스 가능)
  • AMEX/UnionPay : USD 승인 (자국통화승인 서비스 불가)

국내카드(국내에서 발행 된 (8개) 카드사 모두 이용 가능)

  • 결제(승인)/정산 통화 : KRW만 지원

국내 결제창을 호출하는 경우

IMP.request_pay({
  channelKey: "{콘솔 내 연동 정보의 채널키}",
  pay_method: "card",
  merchant_uid: "order_no_0001",
  name: "주문명:결제테스트",
  amount: 14.2,
  currency: "KRW",
  buyer_email: "test@portone.io",
  buyer_name: "구매자이름",
  buyer_tel: "010-1234-5678",
  buyer_addr: "서울특별시 강남구 삼성동",
  buyer_postcode: "123-456",
  popup: false,
  bypass: {
    eximbay: {
      issuercountry: "KR",
    },
  },
});