PortOne REST API - V2
API 결제, 결제 정보 조회, 결제 취소 등의 기능을 제공하는 REST API입니다.
V2 API hostname: api.portone.io
요청 및 응답 형식
요청과 응답의 본문은 JSON 형식입니다.
API 응답에 포함된 필드는 별도 안내 없이 추가될 수 있으니, 알지 못하는 필드가 있는 경우에는 무시하도록 개발해 주세요.
API 매개 변수 중 URL 경로에 들어가는 문자열 값이 있는 경우, URL 경로에 들어갈 수 없는 문자열은 이스케이프하여야 합니다. 자바스크립트의 encodeURIComponent
함수 등을 사용할 수 있습니다.
인증 방식
V2 API를 사용하기 위해서는 V2 API Secret이 필요하며, 포트원 콘솔 내 결제연동 탭에서 발급받을 수 있습니다.
인증 관련 API를 제외한 모든 API는 HTTP Authorization
헤더로 인증 정보를 전달해 주셔야 합니다. Authorization 헤더에 전달하는 형식은 두 가지 중 하나입니다.
- API Secret 직접 사용 (간편)
Authorization: PortOne MY_API_SECRET - 액세스 토큰 사용
Authorization: Bearer MY_ACCESS_TOKEN
GET 요청 시 Body 대신 Query 사용
GET 요청 시에 Body를 사용해야 하는 경우, Body 대신 Query를 사용할 수 있습니다.
이 경우, Body 객체를 requestBody
Query 필드에 넣어주시면 됩니다.
인증 관련 API
결제 관련 API
목차
결제 예약 관련 API
빌링키 관련 API
현금 영수증 관련 API
현금 영수증 단건 조회
Request
Path
결제 건 아이디
Query
접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
Response
200
성공 응답으로 현금 영수증 객체를 반환합니다.
(결제, 본인인증 등에) 선택된 채널 정보
채널 타입
PG사 결제 모듈
통화 단위
OMR
Rial OmaniCUC
Peso ConvertibleBBD
Barbados DollarPLN
ZlotySVC
El Salvador ColonBMD
Bermudian DollarTJS
SomoniTND
Tunisian DinarGNF
Guinean FrancSDG
Sudanese PoundMRU
OuguiyaXBB
Bond Markets Unit European Monetary Unit (E.M.U.-6)PKR
Pakistan RupeeFKP
Falkland Islands PoundMUR
Mauritius RupeeXAF
CFA Franc BEACSAR
Saudi RiyalCAD
Canadian DollarHKD
Hong Kong DollarPYG
GuaraniMGA
Malagasy AriaryUYI
Uruguay Peso en Unidades Indexadas (UI)AUD
Australian DollarAMD
Armenian DramYER
Yemeni RialCHE
WIR EuroMMK
KyatSEK
Swedish KronaTRY
Turkish LiraXBC
Bond Markets Unit European Unit of Account 9 (E.U.A.-9)KES
Kenyan ShillingGEL
LariGTQ
QuetzalTZS
Tanzanian ShillingCUP
Cuban PesoALL
LekERN
NakfaBRL
Brazilian RealUGX
Uganda ShillingXUA
ADB Unit of AccountGIP
Gibraltar PoundMZN
Mozambique MeticalKRW
대한민국 원화JOD
Jordanian DinarIQD
Iraqi DinarVUV
VatuXXX
The codes assigned for transactions where no currency is involvedUZS
Uzbekistan SumBOV
MvdolUAH
HryvniaPEN
SolKMF
Comorian Franc DOP
Dominican PesoBDT
TakaLKR
Sri Lanka RupeeFJD
Fiji DollarLSL
LotiBSD
Bahamian DollarSRD
Surinam DollarXTS
Codes specifically reserved for testing purposesSHP
Saint Helena PoundLRD
Liberian DollarQAR
Qatari RialBND
Brunei DollarCDF
Congolese FrancSLE
LeoneUSN
US Dollar (Next day)VES
Bolívar SoberanoTMT
Turkmenistan New ManatCHW
WIR FrancBGN
Bulgarian LevJMD
Jamaican DollarSZL
LilangeniCZK
Czech KorunaZMW
Zambian KwachaUYU
Peso UruguayoNPR
Nepalese RupeeEGP
Egyptian PoundAZN
Azerbaijan ManatCLP
Chilean PesoMOP
PatacaSCR
Seychelles RupeeHTG
GourdeVND
DongLAK
Lao KipBTN
NgultrumGBP
Pound SterlingSSP
South Sudanese PoundXPD
PalladiumTWD
New Taiwan DollarDZD
Algerian DinarMXN
Mexican PesoXDR
SDR (Special Drawing Right)ZWL
Zimbabwe DollarAWG
Aruban FlorinTHB
BahtISK
Iceland KronaLBP
Lebanese PoundSGD
Singapore DollarMWK
Malawi KwachaKZT
TengeCRC
Costa Rican ColonWST
TalaDJF
Djibouti FrancLYD
Libyan DinarNGN
NairaBIF
Burundi FrancAED
UAE DirhamCHF
Swiss FrancRWF
Rwanda FrancXBD
Bond Markets Unit European Unit of Account 17 (E.U.A.-17)INR
Indian RupeeCLF
Unidad de FomentoXOF
CFA Franc BCEAOCOU
Unidad de Valor RealMXV
Mexican Unidad de Inversion (UDI)PGK
KinaCNY
Yuan RenminbiSYP
Syrian PoundVED
Bolívar SoberanoRON
Romanian LeuAFN
AfghaniPHP
Philippine PesoMDL
Moldovan LeuKHR
RielXPT
PlatinumCOP
Colombian PesoDKK
Danish KroneKYD
Cayman Islands DollarXPF
CFP FrancGMD
DalasiMVR
RufiyaaSTN
DobraTTD
Trinidad and Tobago DollarPAB
BalboaXAU
GoldXAG
SilverJPY
일본 엔화TOP
Pa’angaBWP
PulaMKD
DenarARS
Argentine PesoHUF
ForintMYR
Malaysian RinggitUSD
미국 달러SLL
LeoneMAD
Moroccan DirhamRUB
Russian RubleMNT
TugrikBOB
BolivianoGYD
Guyana DollarSBD
Solomon Islands DollarXBA
Bond Markets Unit European Composite Unit (EURCO)BHD
Bahraini DinarHNL
LempiraUYW
Unidad PrevisionalNZD
New Zealand DollarXCD
East Caribbean DollarXSU
SucreKGS
SomAOA
KwanzaBZD
Belize DollarIDR
RupiahSOS
Somali ShillingNIO
Cordoba OroGHS
Ghana CediANG
Netherlands Antillean GuilderRSD
Serbian DinarILS
New Israeli SheqelNOK
Norwegian KroneKWD
Kuwaiti DinarNAD
Namibia DollarETB
Ethiopian BirrBYN
Belarusian RubleKPW
North Korean WonEUR
EuroCVE
Cabo Verde EscudoZAR
RandIRR
Iranian RialHRK
Kuna (Replaced by EUR)BAM
Convertible Mark발급 유형
PERSONAL
소득공제용CORPORATE
지출증빙용400
InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우
401
UnauthorizedError
: 인증 정보가 올바르지 않은 경우
403
ForbiddenError
: 요청이 거절된 경우
404
CashReceiptNotFoundError
: 현금영수증이 존재하지 않는 경우
현금 영수증 수동 발급
Request
Body
접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
외부 결제 건에 대한 수동 발급의 경우, 아이디를 직접 채번하여 입력합니다.
발급 유형
PERSONAL
소득공제용CORPORATE
지출증빙용통화 단위
OMR
Rial OmaniCUC
Peso ConvertibleBBD
Barbados DollarPLN
ZlotySVC
El Salvador ColonBMD
Bermudian DollarTJS
SomoniTND
Tunisian DinarGNF
Guinean FrancSDG
Sudanese PoundMRU
OuguiyaXBB
Bond Markets Unit European Monetary Unit (E.M.U.-6)PKR
Pakistan RupeeFKP
Falkland Islands PoundMUR
Mauritius RupeeXAF
CFA Franc BEACSAR
Saudi RiyalCAD
Canadian DollarHKD
Hong Kong DollarPYG
GuaraniMGA
Malagasy AriaryUYI
Uruguay Peso en Unidades Indexadas (UI)AUD
Australian DollarAMD
Armenian DramYER
Yemeni RialCHE
WIR EuroMMK
KyatSEK
Swedish KronaTRY
Turkish LiraXBC
Bond Markets Unit European Unit of Account 9 (E.U.A.-9)KES
Kenyan ShillingGEL
LariGTQ
QuetzalTZS
Tanzanian ShillingCUP
Cuban PesoALL
LekERN
NakfaBRL
Brazilian RealUGX
Uganda ShillingXUA
ADB Unit of AccountGIP
Gibraltar PoundMZN
Mozambique MeticalKRW
대한민국 원화JOD
Jordanian DinarIQD
Iraqi DinarVUV
VatuXXX
The codes assigned for transactions where no currency is involvedUZS
Uzbekistan SumBOV
MvdolUAH
HryvniaPEN
SolKMF
Comorian Franc DOP
Dominican PesoBDT
TakaLKR
Sri Lanka RupeeFJD
Fiji DollarLSL
LotiBSD
Bahamian DollarSRD
Surinam DollarXTS
Codes specifically reserved for testing purposesSHP
Saint Helena PoundLRD
Liberian DollarQAR
Qatari RialBND
Brunei DollarCDF
Congolese FrancSLE
LeoneUSN
US Dollar (Next day)VES
Bolívar SoberanoTMT
Turkmenistan New ManatCHW
WIR FrancBGN
Bulgarian LevJMD
Jamaican DollarSZL
LilangeniCZK
Czech KorunaZMW
Zambian KwachaUYU
Peso UruguayoNPR
Nepalese RupeeEGP
Egyptian PoundAZN
Azerbaijan ManatCLP
Chilean PesoMOP
PatacaSCR
Seychelles RupeeHTG
GourdeVND
DongLAK
Lao KipBTN
NgultrumGBP
Pound SterlingSSP
South Sudanese PoundXPD
PalladiumTWD
New Taiwan DollarDZD
Algerian DinarMXN
Mexican PesoXDR
SDR (Special Drawing Right)ZWL
Zimbabwe DollarAWG
Aruban FlorinTHB
BahtISK
Iceland KronaLBP
Lebanese PoundSGD
Singapore DollarMWK
Malawi KwachaKZT
TengeCRC
Costa Rican ColonWST
TalaDJF
Djibouti FrancLYD
Libyan DinarNGN
NairaBIF
Burundi FrancAED
UAE DirhamCHF
Swiss FrancRWF
Rwanda FrancXBD
Bond Markets Unit European Unit of Account 17 (E.U.A.-17)INR
Indian RupeeCLF
Unidad de FomentoXOF
CFA Franc BCEAOCOU
Unidad de Valor RealMXV
Mexican Unidad de Inversion (UDI)PGK
KinaCNY
Yuan RenminbiSYP
Syrian PoundVED
Bolívar SoberanoRON
Romanian LeuAFN
AfghaniPHP
Philippine PesoMDL
Moldovan LeuKHR
RielXPT
PlatinumCOP
Colombian PesoDKK
Danish KroneKYD
Cayman Islands DollarXPF
CFP FrancGMD
DalasiMVR
RufiyaaSTN
DobraTTD
Trinidad and Tobago DollarPAB
BalboaXAU
GoldXAG
SilverJPY
일본 엔화TOP
Pa’angaBWP
PulaMKD
DenarARS
Argentine PesoHUF
ForintMYR
Malaysian RinggitUSD
미국 달러SLL
LeoneMAD
Moroccan DirhamRUB
Russian RubleMNT
TugrikBOB
BolivianoGYD
Guyana DollarSBD
Solomon Islands DollarXBA
Bond Markets Unit European Composite Unit (EURCO)BHD
Bahraini DinarHNL
LempiraUYW
Unidad PrevisionalNZD
New Zealand DollarXCD
East Caribbean DollarXSU
SucreKGS
SomAOA
KwanzaBZD
Belize DollarIDR
RupiahSOS
Somali ShillingNIO
Cordoba OroGHS
Ghana CediANG
Netherlands Antillean GuilderRSD
Serbian DinarILS
New Israeli SheqelNOK
Norwegian KroneKWD
Kuwaiti DinarNAD
Namibia DollarETB
Ethiopian BirrBYN
Belarusian RubleKPW
North Korean WonEUR
EuroCVE
Cabo Verde EscudoZAR
RandIRR
Iranian RialHRK
Kuna (Replaced by EUR)BAM
Convertible Mark금액 세부 입력 정보
고객사에서 직접 계산이 필요한 경우 입력합니다. 입력하지 않으면 면세 금액을 제외한 금액의 1/11 로 자동 계산됩니다.
상품 유형
PHYSICAL
실물 상품DIGITAL
디지털 상품서비스, 온라인 상품 등 실물이 존재하지 않는 무형의 상품을 의미합니다.
현금영수증 발급 시 고객 관련 입력 정보
Response
200
성공 응답
현금영수증 내역
400
InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우
401
UnauthorizedError
: 인증 정보가 올바르지 않은 경우
403
ForbiddenError
: 요청이 거절된 경우
404
ChannelNotFoundError
: 요청된 채널이 존재하지 않는 경우
409
CashReceiptAlreadyIssuedError
: 현금영수증이 이미 발급된 경우
502
PgProviderError
: PG사에서 오류를 전달한 경우
현금 영수증 취소
Request
Path
결제 건 아이디
Query
접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
Response
200
성공 응답
400
InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우
401
UnauthorizedError
: 인증 정보가 올바르지 않은 경우
403
ForbiddenError
: 요청이 거절된 경우
404
CashReceiptNotIssuedError
: 현금영수증이 발급되지 않은 경우CashReceiptNotFoundError
: 현금영수증이 존재하지 않는 경우
502
PgProviderError
: PG사에서 오류를 전달한 경우