결제요청 파라미터
결제요청 파라미터를 확인 할 수 있습니다.
결제요청 파라미터 정의
storeId
* string
storeId
* string가맹점 ID
가맹점 식별코드입니다.
기존 V1 SDK의
userCode
와 동일합니다.
paymentId
* string
paymentId
* string가맹점 주문 고유 번호
가맹점이 채번하는 주문 고유 번호입니다.
이미 승인 완료 된
paymentId
로 결제나 가상계좌 발급을 시도하는 경우 에러가 발생합니다.
orderName
* string
orderName
* string주문명
totalAmount
* number
totalAmount
* 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값을 필수로 입력해야 합니다.
currency
* string
currency
* string결제 통화
원화 결제 시
KRW
로 입력해주세요.
payMethod
* string
payMethod
* string결제수단 구분코드
PG사별 지원되는 결제수단이 모두 상이합니다.
각 PG사별 결제 연동 가이드를 참고하세요
channelName
string
channelName
string채널 이름
콘솔에서 설정한 채널 이름입니다.
pgProvider
파라미터가 없는 경우에 필수로 존재해야 합니다. 두 파라미터가 모두 존재하는 경우channelName
을 적용하니 둘 중 하나만 제공해주세요.
pgProvider
string
pgProvider
stringPG사 구분코드
channelName
파라미터가 없는 경우에 필수로 존재해야 합니다.가능한 PG사 코드는 아래를 참고해주세요.
isTestChannel
boolean
isTestChannel
boolean테스트 채널 정보로 결제할지 여부
미입력 시 기본값은
false
입니다.선택하신 채널이 테스트 채널이 아닌 경우 에러가 발생합니다.
taxFreeAmount
number
taxFreeAmount
number면세 금액
결제 금액 중 면세금액에 해당하는 금액을 입력합니다.
미입력 시 0으로 취급됩니다.
결제 금액과 동일하게 통화별 scale factor가 적용된 금액으로 전달해주세요.
customer
* object
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구매자 연락처
구매자 이메일 주소
유효한 이메일 주소를 입력해주세요.
zipcode
string구매자 우편번호
gender
string구매자 성별
MALE
,FEMALE
,OTHER
중 하나를 입력해주세요.
birthYear
string구매자 출생년도
ex.
"1990"
같은 형식으로 입력해주세요.
windowType
object
windowType
object결제 환경 별 제공되는 결제창 유형
PG사에 따라 가능한 결제창이 다릅니다.
전달되지 않았을 때 결정되는 기본 결제창이 다릅니다.
미입력 시, 해당 PG사의 기본 결제창 방식을 따릅니다.
pc
stringPC에서의 결제창 유형
IFRAME
,REDIRECTION
,POPUP
중 하나를 입력해주세요.
mobile
string모바일에서의 결제창 유형
IFRAME
,REDIRECTION
,POPUP
중 하나를 입력해주세요.
redirectUrl
string
redirectUrl
string리디렉션 방식에서 결제 프로세스 완료 후 이동될 가맹점 URL
결제창이 새로운 창으로 리다이렉트 되어 결제가 진행되는 결제 방식인 경우 필수 설정 항목 입니다.
대부분의 모바일 결제환경에서 결제창 호출시 필수 항목입니다.
리다이렉트 환경에서 해당 필드 누락시 에러가 발생합니다.
noticeUrls
string[]
noticeUrls
string[]웹훅(Webhook) 수신 주소
유효한 형식의 문자열을 입력해주세요.
포트원 관리자 콘솔에 설정한 웹훅 주소 대신 사용할 웹훅 주소를 결제시마다 설정할 수 있습니다.
해당 값 설정시 관리자 콘솔에 설정한 주소로는 웹훅발송이 되지 않는점 유의하시기 바랍니다.
confirmUrl
string
confirmUrl
string최종 결제 승인 요청 여부 확인 URL
유효한 URL 형식의 문자열을 입력해주세요.
confirm_process 사용 시 가맹점 endpoint url 설정
기술지원 메일로 별도 요청이 필요합니다. (support@portone.io)
appScheme
string
appScheme
string모바일 결제 후 가맹점 앱으로 복귀를 위한 URL scheme
WebView 환경 결제시 필수설정 항목 입니다.
ISP/앱카드 앱에서 결제정보인증 후 기존 앱으로 복귀할 때 사용합니다.
isEscrow
boolean
isEscrow
boolean에스크로 결제 여부
미입력 시 기본값:
false
products
object[]
products
object[]에스크로 상품 정보
id
* string상품 ID
name
* string상품명
code
string상품 코드
토스페이먼츠(신모듈)의 경우 필수로 입력해주세요.
unitPrice
* number상품 단위 가격
quantity
* number상품 수량
tag
string상품 태그
isCulturalExpense
boolean
isCulturalExpense
boolean문화비 지출 여부
도서, 공연, 박물관 등 문화비 지출 여부
locale
string
locale
string결제창 언어 (지원되지 않은 일부 PG사 존재)
customData
object
customData
object결제 정보와 함께 관리하고 싶은 가맹점 커스텀 JSON 데이터
bypass
object
bypass
objectPG사 결제창 호출 시 PG사로 그대로 bypass할 값들의 모음
tosspayments
object토스페이먼츠 bypass 파라미터
discountCode
string토스페이먼츠 <> 가맹점 계약에 따라 프로모션 적용이 가능한 코드
useInternationalCardOnly
boolean해외 카드로만 결제가 가능하도록 할 지 여부
country
string
country
string결제 국가
card
object
card
object
payMethod
가CARD
인 경우에만 허용됩니다.카드 정보
카드 결제 시, 카드 결제에 대한 세부 정보
cardCompany
string카드사 다이렉트 호출 시 필요한 카드사 식별 값
installment
object할부 설정
freeInstallmentPlans
object[]무이자 할부 설정
가맹점이 부담하는 무이자 할부 설정입니다.
cardCompany
* string무이자 할부를 제공하는 카드사 식별 값
상단의 카드사 식별 값 항목을 참고해주세요.
months
* number[]무이자 할부를 제공하는 개월 수
monthOption
object할부 개월 수 설정
할부 결제 시 할부 개월 수를 설정할 수 있습니다.
fixedMonth
와availableMonthList
중 하나만 제공해주세요.
fixedMonth
* string구매자가 선택할 수 없도록 고정된 할부 개월수
구매자가 할부 개월 수를 선택할 수 있도록 하려면
availableMonthList
를 사용해주세요.
availableMonthList
* number[]구매자가 선택할 수 있는 할부 개월수 리스트
useCardPoint
boolean카드사 포인트 사용 여부
useAppCardOnly
boolean앱 카드만 허용할지 여부
virtualAccount
object
virtualAccount
object
payMethod
가VIRTUAL_ACCOUNT
인 경우에만 허용됩니다.가상계좌 정보
가상계좌 발급시 가상계좌 상세 옵션
cashReceiptType
string결제창에서 발급 가능한 현금영수증 발급 유형(소득공제용, 지출증빙용, 미발행)
accountType
string카드사 다이렉트 호출 시 필요한 카드사 식별 값
accountKey
string고정식 가상계좌 이용시 가상계좌 키 값
accountExpiry
object고정식 가상계좌 이용시 가상계좌 키 값
validHours
와dueDate
중 하나만 입력해주세요.
validHours
object[]가상계좌 입금 유효 시간
가상계좌 입금 유효 시간
예) 3을 전달하면 지금으로부터 3시간 후가 만료 기한으로 지정 됨
dueDate
object[]가상계좌 입금 유효 시각
YYYYMMDD
YYYYMMDDHHmmss
YYYY-MM-DD
YYYY-MM-DD HH:mm:ss
transfer
object
transfer
object
payMethod
가TRANSFER
인 경우에만 허용됩니다.계좌이체 결제시 계좌이체 상세 옵션
가상계좌 발급시 가상계좌 상세 옵션
cashReceiptType
string결제창에서 발급 가능한 현금영수증 발급 유형(소득공제용, 지출증빙용, 미발행)
bankCode
string계좌이체 은행 다이렉트 호출시 은행 코드
mobile
object
mobile
object
payMethod
가MOBILE
인 경우에만 허용됩니다.휴대폰 소액결제 정보
휴대폰 소액결제시 휴대폰 소액결제 상세 옵션
carrier
string휴대폰 소액결제 통신사 바로 호출을 위한 통신사 구분 값
giftCertificate
object
giftCertificate
object
payMethod
가GIFT_CERTIFICATE
인 경우에만 허용됩니다.상품권 정보
상품권 결제시 상품권 결제 상세 옵션
giftCertificateType
string상품권 결제시, 상품권을 특정할 수 있는 값
easyPay
object
easyPay
object
payMethod
가EASY_PAY
인 경우에만 허용됩니다.간편결제 정보
간편결제시, 간편 결제에 대한 세부 정보
easyPayProvider
string간편결제 수단
installment
object할부 설정
freeInstallmentPlans
object[]무이자 할부 설정
가맹점이 부담하는 무이자 할부 설정입니다.
cardCompany
* string무이자 할부를 제공하는 카드사 식별 값
상단의 카드사 식별 값 항목을 참고해주세요.
months
* number[]무이자 할부를 제공하는 개월 수
monthOption
object할부 개월 수 설정
할부 결제 시 할부 개월 수를 설정할 수 있습니다.
fixedMonth
와availableMonthList
중 하나만 제공해주세요.
fixedMonth
* string구매자가 선택할 수 없도록 고정된 할부 개월수
구매자가 할부 개월 수를 선택할 수 있도록 하려면
availableMonthList
를 사용해주세요.
availableMonthList
* number[]구매자가 선택할 수 있는 할부 개월수 리스트
Last updated