개발자센터

updateLoadIssueBillingKeyUIRequest 요청 형식

updateLoadIssueBillingKeyUIRequest 호출 시 사용되는 파라미터의 형식을 확인할 수 있습니다.

updateLoadIssueBillingKeyUIRequest 요청 데이터 정의

request: LoadIssueBillingKeyUIRequest
uiType: IssueBillingKeyUIType
displayAmount?: number

빌링키 발급 창에 디스플레이 용으로 띄우는 금액

currency?: Currency

결제 통화 코드

storeId: string

스토어 아이디

  • 포트원 계정에 생성된 상점을 식별하는 고유한 값으로 관리자 콘솔에서 확인할 수 있습니다.
channelKey: string

채널 키

콘솔에서 채널 연동 시 생성된 채널 키입니다.

billingKeyMethod: BillingKeyMethod

빌링키 발급 수단

issueName?: string

빌링키 발급 주문 명

issueId?: string

빌링키 발급 주문 고유 번호

customer?: Customer
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?: Address

주소 정보

country?: Country

국가

addressLine1: string

일반주소

addressLine2: string

상세주소

city?: string

도시

province?: string

주, 도, 시

zipcode?: string

구매자 우편번호

gender?: Gender

구매자 성별

birthYear?: string

구매자 출생년도

ex. "1990" 같은 형식으로 입력해주세요.

birthMonth?: string

구매자 출생월

ex. "12", "07" 같은 형식으로 입력해주세요.

birthDay?: string

구매자 출생일

ex. "25", "08" 같은 형식으로 입력해주세요.

redirectUrl?: string

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

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

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

customData?: json

빌링키 발급 정보와 함께 관리하고 싶은 고객사 커스텀 JSON 데이터

appScheme?: string

앱 URL Scheme

noticeUrls?: Array<string>

웹훅 URL

productType?: ProductType

상품 유형

bypass?: LoadIssueBillingKeyUIBypass
paypal_v2?: PaypalV2LoadIssueBillingKeyUIBypass
style?: { color, height, label, ... }

Paypal 빌링키 발급 UI 호출 시 필요한 파라미터

color?: "gold"|"blue"|"silver"|...

버튼 색상

height?: number

버튼 높이

label?: "paypal"|"checkout"|"buynow"|...

버튼 라벨

layout?: "vertical"|"horizontal"

버튼 렌더링 방향

shape?: "rect"|"pill"

버튼 모양

tagline?: boolean

버튼 하위에 문구 노출 여부

shipping_address?: { recipient_name, line1, line2, ... }
recipient_name?: string

수령인 이름

line1: string

도로명 주소

line2?: string

아파트 동 호수

city: string

도시 이름

state?: string

주 이름 (아르헨티나, 브라질, 캐나다, 중국, 인도, 이탈리아, 일본, 멕시코, 태국 또는 미국의 경우 필수)

postal_code?: string

우편번호

country_code: Country

국가

additional_data?: Array<{ key, value }>

STC 파라미터

key: string
value: string