개발자센터

빌링키 발급 요청 파라미터

빌링키 발급 요청 파라미터를 확인할 수 있습니다.

빌링키 발급 요청 파라미터 정의

storeId * string

상점 ID

  • 포트원에서 채번하는 상점 ID입니다.
  • 관리자콘솔의 결제 연동 페이지에서 확인하실 수 있습니다.

channelKey string

채널 키

콘솔에서 표시되는 채널 키입니다.

pgProvider 파라미터가 없는 경우에 필수로 존재해야 합니다. 두 파라미터가 모두 존재하는 경우 channelKey를 적용하니 둘 중 하나만 제공해주세요.

pgProvider string

PG사 구분코드

channelKey 파라미터가 없는 경우에 필수로 존재해야 합니다.

가능한 PG사 코드는 아래를 참고해주세요.

isTestChannel boolean

테스트 채널 정보로 결제할지 여부

미입력 시 기본값은 false입니다.

선택하신 채널이 테스트 채널이 아닌 경우 에러가 발생합니다.

billingKeyMethod * string

빌링키 발급수단 구분코드

PG사별 지원되는 발급수단이 모두 상이합니다.

각 PG사별 결제 연동 가이드를 참고하세요

issueName string

빌링키 발급 시 결제창에 표시되는 제목

KG이니시스, 카카오페이, 네이버페이, 나이스페이먼츠, 스마트로, 토스페이, 웰컴페이먼츠에서만 지원합니다.

issueId string

고객사에서 채번하는 빌링키 발급 건 고유 ID

displayAmount number

빌링키 발급창에 띄워줄 금액

KG이니시스, 네이버페이, 웰컴페이먼츠에서만 지원합니다. 그 외의 PG사에서 금액을 표시하고 싶은 경우 issueName 파라미터를 사용하실 수 있습니다.

해당 파라미터를 입력할 경우 currency 필드도 함께 입력해야 합니다.

currency string

빌링키 발급창에 띄워줄 금액의 화폐

해당 파라미터를 입력할 경우 displayAmount 필드도 함께 입력해야 합니다.

customer * object

고객 정보

  • customerId string

    구매자 고유 ID

  • fullName string

    구매자 전체 이름 fullName과 firstName / lastName이 모두 입력된 경우 fullName으로 기록됩니다.

  • firstName string

    구매자 이름 firstName을 입력하는 경우 lastName도 필수로 입력해야 합니다. fullName이 없고, firstName과 lastName이 존재하는 경우 {firstName} {lastName}으로 저장됩니다.

  • lastName string

    구매자 성 lastName을 입력하는 경우 firstName도 필수로 입력해야 합니다.

  • phoneNumber string

    구매자 연락처

  • email string

    구매자 이메일 주소 유효한 이메일 주소를 입력해주세요.

  • address string

    구매자 주소

  • zipcode string

    구매자 우편번호

  • gender string

    구매자 성별 MALE, FEMALE, OTHER 중 하나를 입력해주세요.

  • birthYear string

    구매자 출생년도 ex. "1990" 같은 형식으로 입력해주세요.

windowType object

결제 환경 별 제공되는 결제창 유형

  • PG사에 따라 가능한 결제창이 다릅니다.
  • 전달되지 않았을 때 결정되는 기본 결제창이 다릅니다.
  • 미입력 시, 해당 PG사의 기본 결제창 방식을 따릅니다.

  • pc string

    PC에서의 결제창 유형 IFRAME, REDIRECTION, POPUP 중 하나를 입력해주세요.

  • mobile string

    모바일에서의 결제창 유형 IFRAME, REDIRECTION, POPUP 중 하나를 입력해주세요.

noticeUrls string[]

웹훅(Webhook) 수신 주소

  • 포트원 관리자 콘솔에 설정한 웹훅 주소 대신 사용할 웹훅 주소를 빌링키 발급시마다 설정할 수 있습니다.
  • 해당 값 설정시 관리자 콘솔에 설정한 주소로는 웹훅발송이 되지 않는점 유의하시기 바랍니다.

redirectUrl string

리디렉션 방식에서 결제 프로세스 완료 후 이동될 고객사 URL

  • 결제창이 새로운 창으로 리다이렉트 되어 결제가 진행되는 결제 방식인 경우 필수 설정 항목 입니다.
  • 대부분의 모바일 결제환경에서 결제창 호출시 필수 항목입니다.
  • 리다이렉트 환경에서 해당 필드 누락시 에러가 발생합니다.

appScheme string

모바일 결제 후 고객사 앱으로 복귀를 위한 URL scheme

  • WebView 환경 결제시 필수설정 항목 입니다.
  • ISP/앱카드 앱에서 결제정보인증 후 기존 앱으로 복귀할 때 사용합니다.

locale string

결제창 언어 (지원되지 않은 일부 PG사 존재)

offerPeriod string

서비스 제공 기간

range(기간 범위)와 interval(제공 주기) 중 하나를 입력해주세요.

  • range object

    기간 범위

    • from string

      시작 시점

    • to string

      종료 시점

  • interval string

    제공 주기 (${number}d | ${number}m | ${number}y 형태로 입력할 수 있습니다.)

customData object

결제 정보와 함께 관리하고 싶은 고객사 커스텀 JSON 데이터

bypass oneof object

PG사 빌링키 발급 창 호출 시 PG사로 그대로 bypass할 값들의 모음

  • kakaopay object

    카카오페이 bypass 파라미터

    • custom_message string

      카카오페이 결제창에 띄워줄 사용자 정의 문구

  • smartro_v2 object

    스마트로 V2 bypass 파라미터

    • SkinColor string

      UI 스타일 (기본값: "RED")

      "RED", "GREEN", "BLUE", "PURPLE" 중 하나의 값으로 입력해주세요.

    • IsPwdPass string

      결제 비밀번호 등록 Skip 여부 ("Y": 비밀번호 설정 미사용, "N"(기본값): 비밀번호 설정 사용)

      "Y", "N" 중 하나의 값으로 입력해주세요.

  • inicis_v2 object

    이니시스 bypass 파라미터

    • carduse 'percard' | 'cocard'

      개인/법인카드 사용 선택 옵션

      • 모바일에서만 동작하는 파라미터입니다.
      • percard 혹은 cocard를 입력할 수 있습니다.
      • percard 입력 시 개인 카드로만 결제를 진행할 수 있으며, cocard 입력 시 법인 카드로만 결제를 진행 할 수 있습니다.

card object

billingKeyMethod가 CARD인 경우에만 허용됩니다.

카드 정보

  • 카드 결제 시, 카드 결제에 대한 세부 정보

  • cardCompany string

    카드사 다이렉트 호출 시 필요한 카드사 식별 값

mobile object

billingKeyMethod가 MOBILE인 경우에만 허용됩니다.

휴대폰 소액결제 정보

  • 휴대폰 소액결제 시 세부 정보

  • carrier string

    휴대폰 소액결제 시 필요한 통신사 식별 값

easyPay object

billingKeyMethod가 EASY_PAY인 경우에만 허용됩니다.

간편결제 정보

  • 간편결제시, 간편 결제에 대한 세부 정보

  • easyPayProvider string

    간편결제 수단