결제요청 파라미터
결제요청 파라미터를 확인 할 수 있습니다.
결제요청 파라미터 정의
storeId
* string
가맹점 ID
- 가맹점 식별코드입니다.
- 기존 V1 SDK의
userCode
와 동일합니다.
paymentId
* string
가맹점 주문 고유 번호
- 가맹점이 채번하는 주문 고유 번호입니다.
- 이미 승인 완료 된
paymentId
로 결제나 가상계좌 발급을 시도하는 경우 에러가 발생합니다.
orderName
* string
주문명
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
결제 통화
- 원화 결제 시
KRW
로 입력해주세요.결제 통화 확인하기
KRW
(한국 원화)USD
(미국 달러)EUR
(유로화)JPY
(일본 엔화)CNY
(중국 위안화)VND
(베트남 동)THB
(태국 바트)SGD
(싱가포르 달러)AUD
(오스트레일리아 달러)HKD
(홍콩 달러)AED
(UAE Dirham)AFN
(Afghani)ALL
(Lek)AMD
(Armenian Dram)ANG
(Netherlands Antillean Guilder)AOA
(Kwanza)ARS
(Argentine Peso)AWG
(Aruban Florin)AZN
(Azerbaijan Manat)BAM
(Convertible Mark)BBD
(Barbados Dollar)BDT
(Taka)BGN
(Bulgarian Lev)BHD
(Bahraini Dinar)BIF
(Burundi Franc)BMD
(Bermudian Dollar)BOB
(Boliviano)BOV
(Mvdol)BRL
(Brazilian Real)BSD
(Bahamian Dollar)BTN
(Ngultrum)BWP
(Pula)BYN
(Belarusian Ruble)BZD
(Belize Dollar)CAD
(Canadian Dollar)CDF
(Congolese Franc)CHE
(WIR Euro)CHF
(Swiss Franc)CHW
(WIR Franc)CLF
(Unidad de Fomento)CLP
(Chilean Peso)COP
(Chilean Peso)COP
(Colombian Peso)COU
(Unidad de Valor Real)CRC
(Costa Rican Colon)CUC
(Peso Convertible)CUP
(Cuban Peso)CVE
(Cabo Verde Escudo)CZK
(Czech Koruna)DJF
(Djibouti Franc)DKK
(Danish Krone)DOP
(Dominican Peso)DZD
(Algerian Dinar)EGP
(Egyptian Pound)ERN
(Nakfa)ETB
(Ethiopian Birr)FJD
(Fiji Dollar)FKP
(Falkland Islands Pound)GBP
(Pound Sterling)GEL
(Lari)GHS
(Ghana Cedi)GIP
(Gibraltar Pound)GMD
(Dalasi)GNF
(Guinean Franc)GTQ
(Quetzal)GYD
(Guyana Dollar)HNL
(Lempira)HRK
(Kuna)HTG
(Gourde)HUF
(Forint)IDR
(Rupiah)ILS
(New Israeli Sheqel)INR
(Indian Rupee)IQD
(Indian Rupee)IRR
(Iranian Rial)ISK
(Iceland Krona)JMD
(Jamaican Dollar)JOD
(Jordanian Dinar)KES
(Kenyan Shilling)KGS
(Som)KHR
(Riel)KMF
(Comorian Franc)KPW
(North Korean Won)KWD
(Kuwaiti Dinar)KYD
(Cayman Islands Dollar)KZT
(Tenge)LAK
(Lao Kip)LBP
(Lebanese Pound)LKR
(Sri Lanka Rupee)LRD
(Loti)LSL
(Libyan Dinar)LYD
(Moroccan Dirham)MAD
(Moldovan Leu)MDL
(Malagasy Ariary)MGA
(Denar)MKD
(Kyat)MMK
(Tugrik)MNT
(Pataca)MOP
(Ouguiya)MRU
(Mauritius Rupee)_MVR
(Rufiyaa)MWK
(Malawi Kwacha)MXN
(Mexican Peso)MXV
(Mexican Unidad de Inversion (UDI))MYR
(Malaysian Ringgit)MZN
(Mozambique Metical)NAD
(Namibia Dollar)NGN
(Naira)NIO
(Cordoba Oro)NOK
(Norwegian Krone)NPR
(Nepalese Rupee)NZD
(New Zealand Dollar)OMR
(Rial Omani)PAB
(Balboa)PEN
(Sol)PGK
(Kina)PHP
(Philippine Peso)PKR
(Pakistan Rupee)PLN
(Zloty)PYG
(Guarani)QAR
(Qatari Rial)RON
(Romanian Leu)RSD
(Serbian Dinar)RUB
(Russian Ruble)RWF
(Rwanda Franc)SAR
(Saudi Riyal)SBD
(Solomon Islands Dollar)SCR
(Seychelles Rupee)SDG
(Sudanese Pound)SEK
(Swedish Krona)SHP
(Saint Helena Pound)SLE
(Leone)SLL
(Leone)SOS
(Somali Shilling)SRD
(Surinam Dollar)SSP
(South Sudanese Pound)STN
(Dobra)SVC
(El Salvador Colon)SYP
(Syrian Pound)SZL
(Lilangeni)TJS
(Somoni)TMT
(Turkmenistan New Manat)TND
(Tunisian Dinar)TOP
(Pa’anga)TRY
(Turkish Lira)TTD
(Trinidad and Tobago Dollar)TWD
(New Taiwan Dollar)TZS
(Tanzanian Shilling)UAH
(Hryvnia)UGX
(Uganda Shilling)USN
(US Dollar (Next day))UYI
(Uruguay Peso en Unidades Indexadas (UI))UYU
(Peso Uruguayo)UYW
(Unidad Previsional)UZS
(Uzbekistan Sum)VED
(Bolívar Soberano)VES
(Bolívar Soberano)VUV
(Vatu)WST
(Tala)XAF
(CFA Franc BEAC)XAG
(Silver)XAU
(Gold)XBA
(Bond Markets Unit European Composite Unit (EURCO))XBB
(Bond Markets Unit European Monetary Unit (E.M.U.-6))XBC
(Bond Markets Unit European Unit of Account 9 (E.U.A.-9))XBD
(Bond Markets Unit European Unit of Account 17 (E.U.A.-17))XCD
(East Caribbean Dollar)XDR
(SDR (Special Drawing Right))XOF
(CFA Franc BCEAO)XPD
(Palladium)XPF
(CFP Franc)XPT
(Platinum)XSU
(Sucre)XTS
(Codes specifically reserved for testing purposes)XUA
(ADB Unit of Account)XXX
(The codes assigned for transactions where no currency is involved)YER
(Yemeni Rial)ZAR
(Rand)ZMW
(Zambian Kwacha)ZWL
(Zimbabwe Dollar)
payMethod
* string
결제수단 구분코드
PG사별 지원되는 결제수단이 모두 상이합니다.
각 PG사별 결제 연동 가이드를 참고하세요
결제수단 구분코드 확인하기
CARD
(카드)VIRTUAL_ACCOUNT
(가상계좌)TRANSFER
(계좌이체)MOBILE
(휴대폰 소액결제)GIFT_CERTIFICATE
(상품권)EASY_PAY
(간편결제)
channelKey
string
채널 키
콘솔에서 채널 연동 시 생성된 채널 키입니다.
pgProvider
파라미터가 없는 경우에 필수로 존재해야 합니다. 두 파라미터가 모두 존재하는 경우channelKey
을 적용하니 둘 중 하나만 제공해주세요.
pgProvider
string
PG사 구분코드
channelKey
파라미터가 없는 경우에 필수로 존재해야 합니다.가능한 PG사 코드는 아래를 참고해주세요.
PG사 코드
HTML5_INICIS
INICIS
NICE
KCP
KCP_BILLING
KCP_QUICK
DANAL
DANAL_TPAY
UPLUS
TOSSPAYMENTS
MOBILIANS
NAVERCO
KICC
SMARTRO
JTNET
DAOU
BLUEWALNUT
PAYPAL
ALIPAY
EXIMBAY
PAYMENTWALL
SETTLE
SETTLE_ACC
SETTLE_FIRM
GALAXIA
NAVERPAY
KAKAOPAY
SMILEPAY
TOSSPAY
CHAI
PAYCO
PAYPLE
INICIS_UNIFIED
SYRUP
KCP_DIRECT
KAKAO
KSNET
isTestChannel
boolean
테스트 채널 정보로 결제할지 여부
미입력 시 기본값은
false
입니다.선택하신 채널이 테스트 채널이 아닌 경우 에러가 발생합니다.
taxFreeAmount
number
면세 금액
- 결제 금액 중 면세금액에 해당하는 금액을 입력합니다.
- 미입력 시 0으로 취급됩니다.
결제 금액과 동일하게 통화별 scale factor가 적용된 금액으로 전달해주세요.
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구매자 연락처
구매자 이메일 주소
유효한 이메일 주소를 입력해주세요.
address
object구매자 주소
country
string국가
국가 코드 확인하기
- AF(Afghanistan)
- AX(Åland Islands)
- AL(Albania)
- DZ(Algeria)
- AS(American Samoa)
- AD(Andorra)
- AO(Angola)
- AI(Anguilla)
- AQ(Antarctica)
- AG(Antigua and Barbuda)
- AR(Argentina)
- AM(Armenia)
- AW(Aruba)
- AU(Australia)
- AT(Austria)
- AZ(Azerbaijan)
- BH(Bahrain)
- BS(Bahamas)
- BD(Bangladesh)
- BB(Barbados)
- BY(Belarus)
- BE(Belgium)
- BZ(Belize)
- BJ(Benin)
- BM(Bermuda)
- BT(Bhutan)
- BO(Bolivia, Plurinational State of)
- BQ(Bonaire, Sint Eustatius and Saba)
- BA(Bosnia and Herzegovina)
- BW(Botswana)
- BV(Bouvet Island)
- BR(Brazil)
- IO(British Indian Ocean Territory)
- BN(Brunei Darussalam)
- BG(Bulgaria)
- BF(Burkina Faso)
- BI(Burundi)
- KH(Cambodia)
- CM(Cameroon)
- CA(Canada)
- CV(Cape Verde)
- KY(Cayman Islands)
- CF(Central African Republic)
- TD(Chad)
- CL(Chile)
- CN(China)
- CX(Christmas Island)
- CC(Cocos (Keeling) Islands)
- CO(Colombia)
- KM(Comoros)
- CG(Congo)
- CD(Congo, the Democratic Republic of the)
- CK(Cook Islands)
- CR(Costa Rica)
- CI(Côte d’Ivoire)
- HR(Croatia)
- CU(Cuba)
- CW(Curaçao)
- CY(Cyprus)
- CZ(Czech Republic)
- DK(Denmark)
- DJ(Djibouti)
- DM(Dominica)
- DO(Dominican Republic)
- EC(Ecuador)
- EG(Egypt)
- SV(El Salvador)
- GQ(Equatorial Guinea)
- ER(Eritrea)
- EE(Estonia)
- ET(Ethiopia)
- FK(Falkland Islands (Malvinas))
- FO(Faroe Islands)
- FJ(Fiji)
- FI(Finland)
- FR(France)
- GF(French Guiana)
- PF(French Polynesia)
- TF(French Southern Territories)
- GA(Gabon)
- GM(Gambia)
- GE(Georgia)
- DE(Germany)
- GH(Ghana)
- GI(Gibraltar)
- GR(Greece)
- GL(Greenland)
- GD(Grenada)
- GP(Guadeloupe)
- GU(Guam)
- GT(Guatemala)
- GG(Guernsey)
- GN(Guinea)
- GW(Guinea-Bissau)
- GY(Guyana)
- HT(Haiti)
- HM(Heard Island and McDonald Islands)
- VA(Holy See (Vatican City State))
- HN(Honduras)
- HK(Hong Kong)
- HU(Hungary)
- IS(Iceland)
- IN(India)
- ID(Indonesia)
- IR(Iran, Islamic Republic of)
- IQ(Iraq)
- IE(Ireland)
- IM(Isle of Man)
- IL(Israel)
- IT(Italy)
- JM(Jamaica)
- JP(Japan)
- JE(Jersey)
- JO(Jordan)
- KZ(Kazakhstan)
- KE(Kenya)
- KI(Kiribati)
- KP(Korea, Democratic People’s Republic of)
- KR(Korea, Republic of)
- KW(Kuwait)
- KG(Kyrgyzstan)
- LA(Lao People’s Democratic Republic)
- LV(Latvia)
- LB(Lebanon)
- LS(Lesotho)
- LR(Liberia)
- LY(Libya)
- LI(Liechtenstein)
- LT(Lithuania)
- LU(Luxembourg)
- MO(Macao)
- MK(Macedonia, the Former Yugoslav Republic of)
- MG(Madagascar)
- MW(Malawi)
- MY(Malaysia)
- MV(Maldives)
- ML(Mali)
- MT(Malta)
- MH(Marshall Islands)
- MQ(Martinique)
- MR(Mauritania)
- MU(Mauritius)
- YT(Mayotte)
- MX(Mexico)
- FM(Micronesia, Federated States of)
- MD(Moldova, Republic of)
- MC(Monaco)
- MN(Mongolia)
- ME(Montenegro)
- MS(Montserrat)
- MA(Morocco)
- MZ(Mozambique)
- MM(Myanmar)
- NA(Namibia)
- NR(Nauru)
- NP(Nepal)
- NL(Netherlands)
- NC(New Caledonia)
- NZ(New Zealand)
- NI(Nicaragua)
- NE(Niger)
- NG(Nigeria)
- NU(Niue)
- NF(Norfolk Island)
- MP(Northern Mariana Islands)
- NO(Norway)
- OM(Oman)
- PK(Pakistan)
- PW(Palau)
- PS(Palestine, State of)
- OA(Panama)
- PG(Papua New Guinea)
- PY(Paraguay)
- PE(Peru)
- PH(Philippines)
- PN(Pitcairn)
- PL(Poland)
- PT(Portugal)
- PR(Puerto Rico)
- QA(Qatar)
- RE(Réunion)
- RO(Romania)
- RU(Russian Federation)
- RW(Rwanda)
- BL(Saint Barthélemy)
- SH(Saint Helena, Ascension and Tristan da Cunha)
- KN(Saint Kitts and Nevis)
- LC(Saint Lucia)
- MF(Saint Martin (French part))
- PM(Saint Pierre and Miquelon)
- VC(Saint Vincent and the Grenadines)
- WS(Samoa)
- SM(San Marino)
- ST(Sao Tome and Principe)
- SA(Saudi Arabia)
- SN(Senegal)
- RS(Serbia)
- SC(Seychelles)
- SL(Sierra Leone)
- SG(Singapore)
- SX(Sint Maarten (Dutch part))
- SK(Slovakia)
- SI(Slovenia)
- SB(Solomon Islands)
- SO(Somalia)
- ZA(South Africa)
- GS(South Georgia and the South Sandwich Islands)
- SS(South Sudan)
- ES(Spain)
- LK(Sri Lanka)
- SD(Sudan)
- SR(Suriname)
- SJ(Svalbard and Jan Mayen)
- SZ(Swaziland)
- SE(Sweden)
- CH(Switzerland)
- SY(Syrian Arab Republic)
- TW(Taiwan, Province of China)
- TJ(Tajikistan)
- TZ(Tanzania, United Republic of)
- TH(Thailand)
- TL(Timor-Leste)
- TG(Togo)
- TK(Tokelau)
- TO(Tonga)
- TT(Trinidad and Tobago)
- TN(Tunisia)
- TR(Turkey)
- TM(Turkmenistan)
- TC(Turks and Caicos Islands)
- TV(Tuvalu)
- UG(Uganda)
- UA(Ukraine)
- AE(United Arab Emirates)
- GB(United Kingdom)
- US(United States)
- UM(United States Minor Outlying Islands)
- UY(Uruguay)
- UZ(Uzbekistan)
- VU(Vanuatu)
- VE(Venezuela, Bolivarian Republic of)
- VN(Viet Nam)
- VG(Virgin Islands, British)
- VI(Virgin Islands, U.S.)
- WF(Wallis and Futuna)
- EH(Western Sahara)
- YE(Yemen)
- ZM(Zambia)
- ZW(Zimbabwe)
addressLine1
* string일반주소
addressLine2
* string상세주소
city
string도시
province
string주, 도, 시
zipcode
string구매자 우편번호
gender
string구매자 성별
MALE
,FEMALE
,OTHER
중 하나를 입력해주세요.
birthYear
string구매자 출생년도
ex.
"1990"
같은 형식으로 입력해주세요.
birthMonth
string구매자 출생월
ex.
"12"
,"07"
같은 형식으로 입력해주세요.
birthDay
string구매자 출생일
ex.
"25"
,"08"
같은 형식으로 입력해주세요.
windowType
object
결제 환경 별 제공되는 결제창 유형
PG사에 따라 가능한 결제창이 다릅니다.
전달되지 않았을 때 결정되는 기본 결제창이 다릅니다.
미입력 시, 해당 PG사의 기본 결제창 방식을 따릅니다.
pc
stringPC에서의 결제창 유형
IFRAME
,REDIRECTION
,POPUP
중 하나를 입력해주세요.
mobile
string모바일에서의 결제창 유형
IFRAME
,REDIRECTION
,POPUP
중 하나를 입력해주세요.
redirectUrl
string
리디렉션 방식에서 결제 프로세스 완료 후 이동될 가맹점 URL
- 결제창이 새로운 창으로 리다이렉트 되어 결제가 진행되는 결제 방식인 경우 필수 설정 항목 입니다.
- 대부분의 모바일 결제환경에서 결제창 호출시 필수 항목입니다.
- 리다이렉트 환경에서 해당 필드 누락시 에러가 발생합니다.
noticeUrls
string[]
웹훅(Webhook) 수신 주소
유효한 형식의 문자열을 입력해주세요.
- 포트원 관리자 콘솔에 설정한 웹훅 주소 대신 사용할 웹훅 주소를 결제시마다 설정할 수 있습니다.
- 해당 값 설정시 관리자 콘솔에 설정한 주소로는 웹훅발송이 되지 않는점 유의하시기 바랍니다.
confirmUrl
string
최종 결제 승인 요청 여부 확인 URL
유효한 URL 형식의 문자열을 입력해주세요.
confirm_process 사용 시 가맹점 endpoint url 설정
- 기술지원 메일로 별도 요청이 필요합니다. (support@portone.io)
appScheme
string
모바일 결제 후 가맹점 앱으로 복귀를 위한 URL scheme
- WebView 환경 결제시 필수설정 항목 입니다.
- ISP/앱카드 앱에서 결제정보인증 후 기존 앱으로 복귀할 때 사용합니다.
isEscrow
boolean
에스크로 결제 여부
미입력 시 기본값:
false
- 에스크로 설정은 PG사와 협의 이후 진행되어야 하는점 주의하세요
products
object[]
에스크로 상품 정보
id
* string상품 ID
name
* string상품명
code
string상품 코드
- 토스페이먼츠(신모듈)의 경우 필수로 입력해주세요.
unitPrice
* number상품 단위 가격
quantity
* number상품 수량
tag
string상품 태그
isCulturalExpense
boolean
문화비 지출 여부
도서, 공연, 박물관 등 문화비 지출 여부
locale
string
결제창 언어 (지원되지 않은 일부 PG사 존재)
상세코드 확인하기
- KO_KR (한국어)
- EN_US (영어)
customData
object
결제 정보와 함께 관리하고 싶은 가맹점 커스텀 JSON 데이터
bypass
oneof object
PG사 결제창 호출 시 PG사로 그대로 bypass할 값들의 모음
tosspayments
object토스페이먼츠 bypass 파라미터
discountCode
string토스페이먼츠 <-> 가맹점 계약에 따라 프로모션 적용이 가능한 코드
useInternationalCardOnly
boolean해외 카드로만 결제가 가능하도록 할 지 여부
kakaopay
object카카오페이 bypass 파라미터
custom_message
string카카오페이 결제창에 띄워줄 사용자 정의 문구
smartro_v2
object스마트로 V2 bypass 파라미터
GoodsCnt
number결제 상품 품목 개수
SkinColor
stringUI 스타일 (기본값:
"RED"
)
"RED"
,"GREEN"
,"BLUE"
,"PURPLE"
중 하나의 값으로 입력해주세요.
OpenType
string해외 카드만 결제를 허용할지 여부(기본값:
"KR"
)
"KR"
,"EN"
중 하나의 값으로 입력해주세요.
naverpay
object네이버페이 bypass 파라미터
useCfmYmdt
string이용완료일 (YYYYMMDD)
productItems
object[]상품 정보
categoryType
* string결제 상품 유형
categoryId
* string결제 상품 분류
uid
* string결제 상품 식별값
name
* string상품명
payReferrer
string결제 상품 유입경로
상세 코드 확인하기
*"NAVER_BOOK"
*"NAVER_MUSIC"
*"NAVER_SHOPPING"
*"NAVER_MAP"
*"NAVER_PLACE"
"SEARCH_AD"
*"NAVER_SEARCH"
*"BRAND_SEARCH"
*"PARTNER_DIRECT"
*"ETC"
startDate
string시작일(YYYYMMDD)
endDate
string종료일(YYYYMMDD)
sellerId
string하위 판매자 식별키
count
* string결제 상품 개수
deliveryFee
number배송비
country
string
결제 국가
국가 코드 확인하기
- AF(Afghanistan)
- AX(Åland Islands)
- AL(Albania)
- DZ(Algeria)
- AS(American Samoa)
- AD(Andorra)
- AO(Angola)
- AI(Anguilla)
- AQ(Antarctica)
- AG(Antigua and Barbuda)
- AR(Argentina)
- AM(Armenia)
- AW(Aruba)
- AU(Australia)
- AT(Austria)
- AZ(Azerbaijan)
- BH(Bahrain)
- BS(Bahamas)
- BD(Bangladesh)
- BB(Barbados)
- BY(Belarus)
- BE(Belgium)
- BZ(Belize)
- BJ(Benin)
- BM(Bermuda)
- BT(Bhutan)
- BO(Bolivia, Plurinational State of)
- BQ(Bonaire, Sint Eustatius and Saba)
- BA(Bosnia and Herzegovina)
- BW(Botswana)
- BV(Bouvet Island)
- BR(Brazil)
- IO(British Indian Ocean Territory)
- BN(Brunei Darussalam)
- BG(Bulgaria)
- BF(Burkina Faso)
- BI(Burundi)
- KH(Cambodia)
- CM(Cameroon)
- CA(Canada)
- CV(Cape Verde)
- KY(Cayman Islands)
- CF(Central African Republic)
- TD(Chad)
- CL(Chile)
- CN(China)
- CX(Christmas Island)
- CC(Cocos (Keeling) Islands)
- CO(Colombia)
- KM(Comoros)
- CG(Congo)
- CD(Congo, the Democratic Republic of the)
- CK(Cook Islands)
- CR(Costa Rica)
- CI(Côte d’Ivoire)
- HR(Croatia)
- CU(Cuba)
- CW(Curaçao)
- CY(Cyprus)
- CZ(Czech Republic)
- DK(Denmark)
- DJ(Djibouti)
- DM(Dominica)
- DO(Dominican Republic)
- EC(Ecuador)
- EG(Egypt)
- SV(El Salvador)
- GQ(Equatorial Guinea)
- ER(Eritrea)
- EE(Estonia)
- ET(Ethiopia)
- FK(Falkland Islands (Malvinas))
- FO(Faroe Islands)
- FJ(Fiji)
- FI(Finland)
- FR(France)
- GF(French Guiana)
- PF(French Polynesia)
- TF(French Southern Territories)
- GA(Gabon)
- GM(Gambia)
- GE(Georgia)
- DE(Germany)
- GH(Ghana)
- GI(Gibraltar)
- GR(Greece)
- GL(Greenland)
- GD(Grenada)
- GP(Guadeloupe)
- GU(Guam)
- GT(Guatemala)
- GG(Guernsey)
- GN(Guinea)
- GW(Guinea-Bissau)
- GY(Guyana)
- HT(Haiti)
- HM(Heard Island and McDonald Islands)
- VA(Holy See (Vatican City State))
- HN(Honduras)
- HK(Hong Kong)
- HU(Hungary)
- IS(Iceland)
- IN(India)
- ID(Indonesia)
- IR(Iran, Islamic Republic of)
- IQ(Iraq)
- IE(Ireland)
- IM(Isle of Man)
- IL(Israel)
- IT(Italy)
- JM(Jamaica)
- JP(Japan)
- JE(Jersey)
- JO(Jordan)
- KZ(Kazakhstan)
- KE(Kenya)
- KI(Kiribati)
- KP(Korea, Democratic People’s Republic of)
- KR(Korea, Republic of)
- KW(Kuwait)
- KG(Kyrgyzstan)
- LA(Lao People’s Democratic Republic)
- LV(Latvia)
- LB(Lebanon)
- LS(Lesotho)
- LR(Liberia)
- LY(Libya)
- LI(Liechtenstein)
- LT(Lithuania)
- LU(Luxembourg)
- MO(Macao)
- MK(Macedonia, the Former Yugoslav Republic of)
- MG(Madagascar)
- MW(Malawi)
- MY(Malaysia)
- MV(Maldives)
- ML(Mali)
- MT(Malta)
- MH(Marshall Islands)
- MQ(Martinique)
- MR(Mauritania)
- MU(Mauritius)
- YT(Mayotte)
- MX(Mexico)
- FM(Micronesia, Federated States of)
- MD(Moldova, Republic of)
- MC(Monaco)
- MN(Mongolia)
- ME(Montenegro)
- MS(Montserrat)
- MA(Morocco)
- MZ(Mozambique)
- MM(Myanmar)
- NA(Namibia)
- NR(Nauru)
- NP(Nepal)
- NL(Netherlands)
- NC(New Caledonia)
- NZ(New Zealand)
- NI(Nicaragua)
- NE(Niger)
- NG(Nigeria)
- NU(Niue)
- NF(Norfolk Island)
- MP(Northern Mariana Islands)
- NO(Norway)
- OM(Oman)
- PK(Pakistan)
- PW(Palau)
- PS(Palestine, State of)
- OA(Panama)
- PG(Papua New Guinea)
- PY(Paraguay)
- PE(Peru)
- PH(Philippines)
- PN(Pitcairn)
- PL(Poland)
- PT(Portugal)
- PR(Puerto Rico)
- QA(Qatar)
- RE(Réunion)
- RO(Romania)
- RU(Russian Federation)
- RW(Rwanda)
- BL(Saint Barthélemy)
- SH(Saint Helena, Ascension and Tristan da Cunha)
- KN(Saint Kitts and Nevis)
- LC(Saint Lucia)
- MF(Saint Martin (French part))
- PM(Saint Pierre and Miquelon)
- VC(Saint Vincent and the Grenadines)
- WS(Samoa)
- SM(San Marino)
- ST(Sao Tome and Principe)
- SA(Saudi Arabia)
- SN(Senegal)
- RS(Serbia)
- SC(Seychelles)
- SL(Sierra Leone)
- SG(Singapore)
- SX(Sint Maarten (Dutch part))
- SK(Slovakia)
- SI(Slovenia)
- SB(Solomon Islands)
- SO(Somalia)
- ZA(South Africa)
- GS(South Georgia and the South Sandwich Islands)
- SS(South Sudan)
- ES(Spain)
- LK(Sri Lanka)
- SD(Sudan)
- SR(Suriname)
- SJ(Svalbard and Jan Mayen)
- SZ(Swaziland)
- SE(Sweden)
- CH(Switzerland)
- SY(Syrian Arab Republic)
- TW(Taiwan, Province of China)
- TJ(Tajikistan)
- TZ(Tanzania, United Republic of)
- TH(Thailand)
- TL(Timor-Leste)
- TG(Togo)
- TK(Tokelau)
- TO(Tonga)
- TT(Trinidad and Tobago)
- TN(Tunisia)
- TR(Turkey)
- TM(Turkmenistan)
- TC(Turks and Caicos Islands)
- TV(Tuvalu)
- UG(Uganda)
- UA(Ukraine)
- AE(United Arab Emirates)
- GB(United Kingdom)
- US(United States)
- UM(United States Minor Outlying Islands)
- UY(Uruguay)
- UZ(Uzbekistan)
- VU(Vanuatu)
- VE(Venezuela, Bolivarian Republic of)
- VN(Viet Nam)
- VG(Virgin Islands, British)
- VI(Virgin Islands, U.S.)
- WF(Wallis and Futuna)
- EH(Western Sahara)
- YE(Yemen)
- ZM(Zambia)
- ZW(Zimbabwe)
productType
string
상품 유형
"PRODUCT_TYPE_REAL"
,"PRODUCT_TYPE_DIGITAL"
중 하나의 값을 입력해주세요.
offerPeriod
string
서비스 제공 기간
range
object기간 범위
from
string시작 시점
to
string종료 시점
storeDetails
object
상점 정보
ceoFullName
string상점 대표자 이름
phoneNumber
string상점 연락처
address
string상점 주소
zipcode
string상점 우편번호
card
object
payMethod
가CARD
인 경우에만 허용됩니다.카드 정보
카드 결제 시, 카드 결제에 대한 세부 정보
cardCompany
string카드사 다이렉트 호출 시 필요한 카드사 식별 값
카드사 식별 값
- KOREA_DEVELOPMENT_BANK(KDB산업은행 카드)
- KFCC(새마을금고 카드)
- SHINHYUP(신협 카드)
- EPOST(우체국 카드)
- SAVINGS_BANK_KOREA(저축은행 카드)
- KAKAO_BANK(카카오뱅크 카드)
- WOORI_CARD(우리카드)
- BC_CARD(BC카드)
- GWANGJU_CARD(광주카드)
- SAMSUNG_CARD(삼성카드)
- SHINHAN_CARD(신한카드)
- HYUNDAI_CARD(현대카드)
- LOTTE_CARD(롯데카드)
- SUHYUP_CARD(수협카드)
- CITI_CARD(씨티카드)
- NH_CARD(NH 농협카드)
- JEONBUK_CARD(전북카드)
- JEJU_CARD(제주카드)
- HANA_CARD(하나카드)
- KOOKMIN_CARD(국민카드)
- K_BANK(K뱅크 카드)
- TOSS_BANK(토스뱅크 카드)
installment
object할부 설정
freeInstallmentPlans
object[]무이자 할부 설정
가맹점이 부담하는 무이자 할부 설정입니다.
cardCompany
* string무이자 할부를 제공하는 카드사 식별 값
상단의 카드사 식별 값 항목을 참고해주세요.
months
* number[]무이자 할부를 제공하는 개월 수
monthOption
object할부 개월 수 설정
할부 결제 시 할부 개월 수를 설정할 수 있습니다.
fixedMonth
와availableMonthList
중 하나만 제공해주세요.
fixedMonth
* string구매자가 선택할 수 없도록 고정된 할부 개월수
구매자가 할부 개월 수를 선택할 수 있도록 하려면
availableMonthList
를 사용해주세요.
availableMonthList
* number[]구매자가 선택할 수 있는 할부 개월수 리스트
useCardPoint
boolean카드사 포인트 사용 여부
useAppCardOnly
boolean앱 카드만 허용할지 여부
virtualAccount
object
payMethod
가VIRTUAL_ACCOUNT
인 경우에만 허용됩니다.가상계좌 정보
가상계좌 발급시 가상계좌 상세 옵션
cashReceiptType
string결제창에서 발급 가능한 현금영수증 발급 유형(소득공제용, 지출증빙용, 미발행)
현금영수증 발급 유형
- PERSONAL (소득공제용)
- CORPORATE (지출증빙용)
- ANONYMOUS (미발행(국세청번호 자동발급))
customerIdentifier
string현금영수증 발행 대상 식별 정보
fixedOption
oneof object고정식 가상계좌 설정
pgAccountId
stringPG사로부터 사전에 가상계좌에 대한 ID를 발급받아 사용하는 경우의 가상계좌 ID
accountNumber
string고정식으로 사용할 가상계좌 번호
bankCode
string가상계좌 은행 다이렉트 호출시 은행 코드
은행 코드 유형
- BANK_OF_KOREA(한국은행)
- KOREA_DEVELOPMENT_BANK(산업은행)
- INDUSTRIAL_BANK_OF_KOREA(기업은행)
- KOOKMIN_BANK(국민은행)
- SUHYUP_BANK(수협은행)
- EXPORT_IMPORT_BANK_OF_KOREA(수출입은행)
- NH_NONGHYUP_BANK(NH농협은행)
- LOCAL_NONGHYUP(지역농․축협)
- WOORI_BANK(우리은행)
- SC_BANK_KOREA(SC제일은행)
- CITI_BANK_KOREA(한국씨티은행)
- DAEGU_BANK(대구은행)
- BUSAN_BANK(부산은행)
- GWANGJU_BANK(광주은행)
- JEJU_BANK(제주은행)
- JEONBUK_BANK(전북은행)
- KYONGNAM_BANK(경남은행)
- KFCC(새마을금고)
- SHINHYUP(신협)
- SAVINGS_BANK_KOREA(저축은행)
- MORGAN_STANLEY_BANK(모건스탠리은행)
- HSBC_BANK(HSBC은행)
- DEUTSCHE_BANK(도이치은행)
- JP_MORGAN_CHASE_BANK(제이피모간체이스은행)
- MIZUHO_BANK(미즈호은행)
- MUFG_BANK(엠유에프지은행)
- BANK_OF_AMERICA_BANK(BOA은행)
- BNP_PARIBAS_BANK(비엔피파리바은행)
- ICBC(중국공상은행)
- BANK_OF_CHINA(중국은행)
- NATIONAL_FORESTRY_COOPERATIVE_FEDERATION(산림조합중앙회)
- UNITED_OVERSEAS_BANK(대화은행)
- BANK_OF_COMMUNICATIONS(교통은행)
- CHINA_CONSTRUCTION_BANK(중국건설은행)
- EPOST(우체국)
- KODIT(신용보증기금)
- KIBO(기술보증기금)
- HANA_BANK(하나은행)
- SHINHAN_BANK(신한은행)
- K_BANK(케이뱅크)
- KAKAO_BANK(카카오뱅크)
- TOSS_BANK(토스뱅크)
- KCIS(한국신용정보원)
- DAISHIN_SAVINGS_BANK(대신저축은행)
- SBI_SAVINGS_BANK(에스비아이저축은행)
- HK_SAVINGS_BANK(에이치케이저축은행)
- WELCOME_SAVINGS_BANK(웰컴저축은행)
- SHINHAN_SAVINGS_BANK(신한저축은행)
- KYOBO_SECURITIES(교보증권)
- DAISHIN_SECURITIES(대신증권)
- MERITZ_SECURITIES(메리츠증권)
- MIRAE_ASSET_SECURITIES(미래에셋증권)
- BOOKOOK_SECURITIES(부국증권)
- SAMSUNG_SECURITIES(삼성증권)
- SHINYOUNG_SECURITIES(신영증권)
- SHINHAN_FINANCIAL_INVESTMENT(신한금융투자)
- YUANTA_SECURITIES(유안타증권)
- EUGENE_INVESTMENT_SECURITIES(유진투자증권)
- KAKAO_PAY_SECURITIES(카카오페이증권)
- TOSS_SECURITIES(토스증권)
- KOREA_FOSS_SECURITIES(한국포스증권)
- HANA_FINANCIAL_INVESTMENT(하나금융투자)
- HI_INVESTMENT_SECURITIES(하이투자증권)
- KOREA_INVESTMENT_SECURITIES(한국투자증권)
- HANWHA_INVESTMENT_SECURITIES(한화투자증권)
- HYUNDAI_MOTOR_SECURITIES(현대차증권자)
- DB_FINANCIAL_INVESTMENT(DB금융투자자)
- KB_SECURITIES(증권)
- KTB_INVESTMENT_SECURITIES(KTB투자증권)
- LIG_INVESTMENT_AND_SECURITIES(LIG투자증권)
- NH_INVESTMENT_SECURITIES(NH투자증권)
- SK_SECURITIES(SK증권)
accountExpiry
object고정식 가상계좌 이용시 가상계좌 키 값
validHours
와dueDate
중 하나만 입력해주세요.
validHours
object[]가상계좌 입금 유효 시간
가상계좌 입금 유효 시간
예) 3을 전달하면 지금으로부터 3시간 후가 만료 기한으로 지정 됨
dueDate
object[]가상계좌 입금 유효 시각
- YYYYMMDD
- YYYYMMDDHHmmss
- YYYY-MM-DD
- YYYY-MM-DD HH:mm:ss
transfer
object
payMethod
가TRANSFER
인 경우에만 허용됩니다.계좌이체 결제시 계좌이체 상세 옵션
가상계좌 발급시 가상계좌 상세 옵션
cashReceiptType
string결제창에서 발급 가능한 현금영수증 발급 유형(소득공제용, 지출증빙용, 미발행)
현금영수증 발급 유형
- PERSONAL (소득공제용)
- CORPORATE (지출증빙용)
- ANONYMOUS (미발행(국세청번호 자동발급))
customerIdentifier
string현금영수증 발행 대상 식별 정보
bankCode
string계좌이체 은행 다이렉트 호출시 은행 코드
은행 코드 유형
- BANK_OF_KOREA(한국은행)
- KOREA_DEVELOPMENT_BANK(산업은행)
- INDUSTRIAL_BANK_OF_KOREA(기업은행)
- KOOKMIN_BANK(국민은행)
- SUHYUP_BANK(수협은행)
- EXPORT_IMPORT_BANK_OF_KOREA(수출입은행)
- NH_NONGHYUP_BANK(NH농협은행)
- LOCAL_NONGHYUP(지역농․축협)
- WOORI_BANK(우리은행)
- SC_BANK_KOREA(SC제일은행)
- CITI_BANK_KOREA(한국씨티은행)
- DAEGU_BANK(대구은행)
- BUSAN_BANK(부산은행)
- GWANGJU_BANK(광주은행)
- JEJU_BANK(제주은행)
- JEONBUK_BANK(전북은행)
- KYONGNAM_BANK(경남은행)
- KFCC(새마을금고)
- SHINHYUP(신협)
- SAVINGS_BANK_KOREA(저축은행)
- MORGAN_STANLEY_BANK(모건스탠리은행)
- HSBC_BANK(HSBC은행)
- DEUTSCHE_BANK(도이치은행)
- JP_MORGAN_CHASE_BANK(제이피모간체이스은행)
- MIZUHO_BANK(미즈호은행)
- MUFG_BANK(엠유에프지은행)
- BANK_OF_AMERICA_BANK(BOA은행)
- BNP_PARIBAS_BANK(비엔피파리바은행)
- ICBC(중국공상은행)
- BANK_OF_CHINA(중국은행)
- NATIONAL_FORESTRY_COOPERATIVE_FEDERATION(산림조합중앙회)
- UNITED_OVERSEAS_BANK(대화은행)
- BANK_OF_COMMUNICATIONS(교통은행)
- CHINA_CONSTRUCTION_BANK(중국건설은행)
- EPOST(우체국)
- KODIT(신용보증기금)
- KIBO(기술보증기금)
- HANA_BANK(하나은행)
- SHINHAN_BANK(신한은행)
- K_BANK(케이뱅크)
- KAKAO_BANK(카카오뱅크)
- TOSS_BANK(토스뱅크)
- KCIS(한국신용정보원)
- DAISHIN_SAVINGS_BANK(대신저축은행)
- SBI_SAVINGS_BANK(에스비아이저축은행)
- HK_SAVINGS_BANK(에이치케이저축은행)
- WELCOME_SAVINGS_BANK(웰컴저축은행)
- SHINHAN_SAVINGS_BANK(신한저축은행)
- KYOBO_SECURITIES(교보증권)
- DAISHIN_SECURITIES(대신증권)
- MERITZ_SECURITIES(메리츠증권)
- MIRAE_ASSET_SECURITIES(미래에셋증권)
- BOOKOOK_SECURITIES(부국증권)
- SAMSUNG_SECURITIES(삼성증권)
- SHINYOUNG_SECURITIES(신영증권)
- SHINHAN_FINANCIAL_INVESTMENT(신한금융투자)
- YUANTA_SECURITIES(유안타증권)
- EUGENE_INVESTMENT_SECURITIES(유진투자증권)
- KAKAO_PAY_SECURITIES(카카오페이증권)
- TOSS_SECURITIES(토스증권)
- KOREA_FOSS_SECURITIES(한국포스증권)
- HANA_FINANCIAL_INVESTMENT(하나금융투자)
- HI_INVESTMENT_SECURITIES(하이투자증권)
- KOREA_INVESTMENT_SECURITIES(한국투자증권)
- HANWHA_INVESTMENT_SECURITIES(한화투자증권)
- HYUNDAI_MOTOR_SECURITIES(현대차증권자)
- DB_FINANCIAL_INVESTMENT(DB금융투자자)
- KB_SECURITIES(증권)
- KTB_INVESTMENT_SECURITIES(KTB투자증권)
- LIG_INVESTMENT_AND_SECURITIES(LIG투자증권)
- NH_INVESTMENT_SECURITIES(NH투자증권)
- SK_SECURITIES(SK증권)
mobile
object
payMethod
가MOBILE
인 경우에만 허용됩니다.휴대폰 소액결제 정보
휴대폰 소액결제시 휴대폰 소액결제 상세 옵션
carrier
string휴대폰 소액결제 통신사 바로 호출을 위한 통신사 구분 값
통신사 구분 값 유형
- SKT (SKT)
- KT (KT)
- LGU (LGU)
- HELLO (LG 헬로모바일)
- KCT (티플러스)
- SK7 (SK 세븐모바일)
giftCertificate
object
payMethod
가GIFT_CERTIFICATE
인 경우에만 허용됩니다.상품권 정보
상품권 결제시 상품권 결제 상세 옵션
giftCertificateType
string상품권 결제시, 상품권을 특정할 수 있는 값
상품권 유형
- BOOKNLIFE (도서문화상품권)
- SMART_MUNSANG (스마트문상, (구)게임문화상품권)
- CULTURELAND (문화상품권)
- HAPPYMONEY (해피머니)
easyPay
object
payMethod
가EASY_PAY
인 경우에만 허용됩니다.간편결제 정보
간편결제시, 간편 결제에 대한 세부 정보
easyPayProvider
string간편결제 수단
간편결제 수단 유형
- PAYCO (페이코)
- SAMSUNGPAY (삼성페이)
- APPLEPAY (애플페이)
- SSGPAY (SSGPAY)
- KAKAOPAY (KAKAOPAY)
- NAVERPAY (NAVERPAY)
- CHAI (CHAI)
- LPAY (LPAY)
- KPAY (KPAY)
- TOSSPAY (TOSSPAY)
- LGPAY (LGPAY)
installment
object할부 설정
freeInstallmentPlans
object[]무이자 할부 설정
가맹점이 부담하는 무이자 할부 설정입니다.
cardCompany
* string무이자 할부를 제공하는 카드사 식별 값
상단의 카드사 식별 값 항목을 참고해주세요.
months
* number[]무이자 할부를 제공하는 개월 수
monthOption
object할부 개월 수 설정
할부 결제 시 할부 개월 수를 설정할 수 있습니다.
fixedMonth
와availableMonthList
중 하나만 제공해주세요.
fixedMonth
* string구매자가 선택할 수 없도록 고정된 할부 개월수
구매자가 할부 개월 수를 선택할 수 있도록 하려면
availableMonthList
를 사용해주세요.
availableMonthList
* number[]구매자가 선택할 수 있는 할부 개월수 리스트