결제요청 파라미터

가맹점 ID

가맹점 식별코드입니다.
기존 V1 SDK의 userCode와 동일합니다.

가맹점 주문 고유 번호

가맹점이 채번하는 주문 고유 번호입니다.
이미 승인 완료 된 paymentId로 결제나 가상계좌 발급을 시도하는 경우 에러가 발생합니다.

주문명

결제 금액

결제를 원하는 통화(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값을 필수로 입력해야 합니다.

결제 통화

원화 결제 시 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)

결제수단 구분코드

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

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

결제수단 구분코드 확인하기

CARD (카드)
VIRTUAL_ACCOUNT (가상계좌)
TRANSFER (계좌이체)
MOBILE (휴대폰 소액결제)
GIFT_CERTIFICATE (상품권)
EASY_PAY (간편결제)

채널 이름

콘솔에서 설정한 채널 이름입니다.

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

PG사 구분코드

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

가능한 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

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

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

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

면세 금액

결제 금액 중 면세금액에 해당하는 금액을 입력합니다.
미입력 시 0으로 취급됩니다.

결제 금액과 동일하게 통화별 scale factor가 적용된 금액으로 전달해주세요.

고객 정보

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

구매자 이메일 주소

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

zipcode string

구매자 우편번호

gender string

구매자 성별

MALE, FEMALE, OTHER 중 하나를 입력해주세요.

birthYear string

구매자 출생년도

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

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

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

pc string

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

mobile string

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

리디렉션 방식에서 결제 프로세스 완료 후 이동될 가맹점 URL

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

웹훅(Webhook) 수신 주소

유효한 형식의 문자열을 입력해주세요.

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

최종 결제 승인 요청 여부 확인 URL

유효한 URL 형식의 문자열을 입력해주세요.

​confirm_process 사용 시 가맹점 endpoint url 설정

기술지원 메일로 별도 요청이 필요합니다. ([email protected])

모바일 결제 후 가맹점 앱으로 복귀를 위한 URL scheme

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

에스크로 결제 여부

미입력 시 기본값: false

에스크로 설정은 PG사와 협의 이후 진행되어야 하는점 주의하세요

에스크로 상품 정보

id * string

상품 ID

name * string

상품명

code string

상품 코드

토스페이먼츠(신모듈)의 경우 필수로 입력해주세요.

unitPrice * number

상품 단위 가격

quantity * number

상품 수량

tag string

상품 태그

문화비 지출 여부

도서, 공연, 박물관 등 문화비 지출 여부

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

상세코드 확인하기

KO_KR (한국어)
EN_US (영어)

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

PG사 결제창 호출 시 PG사로 그대로 bypass할 값들의 모음

tosspayments object

토스페이먼츠 bypass 파라미터

discountCode string

토스페이먼츠 <> 가맹점 계약에 따라 프로모션 적용이 가능한 코드

useInternationalCardOnly boolean

해외 카드로만 결제가 가능하도록 할 지 여부

결제 국가

국가 코드 확인하기

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)