개발자센터

updateLoadPaymentUIRequest 요청 형식

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

updateLoadPaymentUIRequest 요청 데이터 정의

request: LoadPaymentUIRequest
uiType: PaymentUIType
storeId: string

스토어 아이디

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

주문 번호

orderName: string

주문명

totalAmount: number

결제 금액(실제 결제 금액 X 10^ 해당 currency의 scale factor, 예) $1.50 -> 150)

channelKey: string

채널 이름

taxFreeAmount?: number

면세 금액

  • 결제 금액 중 면세금액에 해당하는 금액을 입력합니다.
  • 미입력 시 0으로 취급됩니다.
  • 결제 금액과 동일하게 통화별 scale factor가 적용된 금액으로 전달해주세요.
vatAmount?: number

부가세

  • 부가세 금액을 입력합니다.
  • 미입력 시 과세 금액의 1/11 로 자동 계산됩니다.
  • 결제 금액과 동일하게 통화별 scale factor가 적용된 금액으로 전달해주세요.
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" 같은 형식으로 입력해주세요.

firstNameKana?: string

구매자 이름 후리가나

일본어 읽는 법 표기

lastNameKana?: string

구매자 성 후리가나

일본어 읽는 법 표기

redirectUrl?: string

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

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

웹훅 URL

confirmUrl?: string

Confirm URL

appScheme?: string

앱 URL Scheme

isEscrow?: boolean

에스크로 결제 여부

products?: Array<Product>

구매 상품 상세 정보

id: string

상품 ID

name: string

상품명

code?: string

상품 코드

  • 토스페이먼츠의 경우 필수로 입력해주세요.
amount: number

상품 단위 가격

결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.

  • 1000 만큼 원화(KRW) 결제를 하는 경우, scale factor가 0이기 때문에 1000 * (10의 0승) = 1000을 전달해야 합니다.
  • 1.50 만큼 달러(USD) 결제를 하는 경우, scale factor가 2이기 때문에 1.50 * (10의 2승) = 150을 전달해야 합니다.

이렇게 전달 된 값은 실제로 PG사에 결제를 요청할때 currency에 따라 올바른 값으로 변환되기 때문에 반드시 currency값을 필수로 입력해야 합니다.

quantity: number

상품 수량

tag?: string

상품 태그

link?: string

상품 판매 URL

isCulturalExpense?: boolean

문화비 지출 여부

currency: Currency

결제 통화 코드

locale?: Locale

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

customData?: json

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

offerPeriod?: OfferPeriod

서비스 제공 기간

range와 interval 중 하나를 입력해주세요.

  • range: 제공 기간 범위
  • interval: 제공 기간 주기

예1) 2023년 1월 1일 00시 00분 00초(KST) ~

range: {
 from: '2023-01-01T00:00:00+09:00'
}

예2) ~ 2023년 1월 1일 00시 00분 00초(KST)

range: {
 to: '2023-01-01T00:00:00+09:00'
}

예3) 2023년 1월 1일 00시 00분 00초(KST) ~ 2023년 12월 31일 23시 59분 59초(KST)

range: {
 from: '2023-12-31T23:59:59+09:00'
 to: '2023-01-01T00:00:00+09:00'
}

예4) 30일 주기 interval: '30d'

예5) 6개월 주기 interval: '6m'

예6) 1년 주기 interval: '1y'

range?: { from } | { to } | { from, to }

기간 범위

{ from }
from: string

시작 시점

{ to }
to: string

종료 지점

{ from, to }
from: string

시작 시점

to: string

종료 지점

interval?: string

제공 주기

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

productType?: ProductType

상품 유형

storeDetails?: StoreDetails

상점 정보

  • KSNET 카카오페이의 경우 필수 입력
  • (신)나이스페이의 경우 매출 전표에 표기 할 용도로 선택 입력
  • 이니시스 일본결제의 경우 JPPG(gmoPayment) 결제의 상점정보로 사용되거나 편의점 결제 시 영수증 표시 정보로 사용됨.
ceoFullName?: string

상점 대표자 이름

phoneNumber?: string

상점 연락처

address?: string

상점 주소

zipcode?: string

상점 우편번호

email?: string

상점 이메일

businessName?: string

상점 사업자 명

businessRegistrationNumber?: string

상점 사업자 등록 번호

storeName?: string

상점명

storeNameShort?: string

상점명 약어

storeNameEn?: string

상점명 영문

storeNameKana?: string

상점명 후리카나 (일본어 읽는법 표기)

openingHours?: { open, close }

상점 영업시간 (HH:mm)

open?: string

영업 시작 시간

close?: string

영업 종료 시간

contactName?: string

상점 연락처 정보 이름

ex: 문의창구, 연락처, 지원창구

bypass?: LoadPaymentUIBypass
paypal_v2?: PaypalV2LoadPaymentUIBypass
style?: { color, height, label, ... }

SPB 버튼 렌더링에 필요한 파라미터

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

버튼 색상

height?: number

버튼 높이

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

버튼 라벨

layout?: "vertical"|"horizontal"

버튼 렌더링 방향

shape?: "rect"|"pill"

버튼 모양

period?: string

label이 installment일 때 할부 결제 되는 월

tagline?: boolean

버튼 하위에 문구 노출 여부

enable-funding?: string

허용할 결제 수단 (예: "card, credit, bancontact")

disable-funding?: string

차단할 결제 수단 (예: "venmo, mercadopago")

purchase_units?: Array<{ shipping }>

create order API 호출에 필요한 파라미터

shipping?: { address }

구매 상품 정보

address?: { address_line_1, address_line_2, admin_area_1, ... }

수령지 정보

address_line_1: string

수령지 주소. 미 입력 시 입력된 주소로 override되지 않음

address_line_2?: string
admin_area_1?: string
admin_area_2: string

필수 입력. 미 입력 시 create order 실패

postal_code?: string
country_code: Country

국가

payer?: { tax_info, address }
tax_info?: { tax_id, tax_id_type }

구매자 정보

tax_id: string

구매자 세금 정보 (브라질 구매자의 경우 필수 입력)

tax_id_type: string
address?: { address_line_1, address_line_2, admin_area_1, ... }
address_line_1?: string

구매자 주소지 정보

address_line_2?: string
admin_area_1?: string
admin_area_2?: string
postal_code?: string

우편번호

country_code: Country

국가

additional_data?: Array<{ key, value }>

STC 파라미터

key: string
value: string
country?: Country

국가

shippingAddress?: Address

주소 정보

country?: Country

국가

addressLine1: string

일반주소

addressLine2: string

상세주소

city?: string

도시

province?: string

주, 도, 시

promotionGroupId?: string

프로모션 그룹 ID

promotionIds?: Array<string>

프로모션 ID 목록