PortOne REST API - V2
API 결제, 결제 정보 조회, 결제 취소 등의 기능을 제공하는 REST API입니다.
V2 API hostname: api.portone.io
요청 및 응답 형식
요청과 응답의 본문은 JSON 형식입니다.
API 매개 변수 중 URL 경로에 들어가는 문자열 값이 있는 경우, URL 경로에 들어갈 수 없는 문자열은 이스케이프하여야 합니다. 자바스크립트의 encodeURIComponent
함수 등을 사용할 수 있습니다.
인증 방식
V2 API를 사용하기 위해서는 V2 API Secret이 필요하며, 포트원 관리자콘솔 내 결제연동 탭에서 발급받으실 수 있습니다.
인증 관련 API를 제외한 모든 API는 HTTP Authorization
헤더로 아래 형식의 인증 정보를 전달해주셔야 합니다.
Authorization: PortOne MY_API_SECRET
GET 요청 시 Body 대신 Query 사용하기
GET 요청 시에 Body를 전달해야 하는 경우, Body 대신 Query를 사용할 수 있습니다.
이 경우, Body 객체를 requestBody
Query 필드에 넣어주시면 됩니다.
하위호환성
포트원이 제공하는 모든 Stable API에 대해 아래와 같은 하위호환성이 보장됩니다.
현재 사용 가능한 입력 형식은 앞으로도 사용할 수 있습니다.
- 입력 형식 내 필드 정의가 삭제되지 않습니다.
필수 입력 정보가 추가되거나, 선택 입력 정보가 필수로 변경되지 않습니다.
- 오로지 선택 입력 정보만 추가될 수 있습니다.
- 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
- enum 타입의 값이 삭제되지 않습니다.
출력 형식이 확장될 수 있지만, 축소되지 않습니다.
- 출력 형식 내 필드 정의가 삭제되지 않습니다.
사용 중인 필수 출력 정보가 선택사항으로 변경되거나 출력 시 누락되지 않습니다.
- 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
- 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.
- 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
단, 새로운 필드 또는 enum 값, oneOf 케이스가 추가될 수 있습니다.
- 알지 못하는 필드 및 값이 주어지더라도 crash가 발생하지 않도록 유의하여 개발해주세요.
UNSTABLE
이 표기된 일부 API의 경우, 위 하위호환성 정책과 무관하게 변경 및 지원 종료될 수 있으니 이용에 유의하세요.
인증 관련 API
결제 관련 API
목차
결제 예약 관련 API
빌링키 관련 API
현금 영수증 관련 API
프로모션 관련 API
본인인증 관련 API
본인인증 단건 조회
Request
Path
조회할 본인인증 아이디
Query
접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
Response
200
성공 응답으로 본인 인증 객체를 반환합니다.
(결제, 본인인증 등에) 선택된 채널 정보
채널 타입
PG사 결제 모듈
요청 시 고객 정보
특수 문자(-) 없이 숫자로만 이루어진 번호 형식입니다.
본인인증 실패 정보
400
InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우
401
UnauthorizedError
: 인증 정보가 올바르지 않은 경우
403
ForbiddenError
: 요청이 거절된 경우
404
IdentityVerificationNotFoundError
: 요청된 본인인증 건이 존재하지 않는 경우
본인인증 요청 전송
Request
Path
본인인증 아이디
Body
접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
본인인증 요청을 위한 고객 정보
특수 문자(-) 없이 숫자만 입력합니다.
SMS 방식의 경우 필수로 입력합니다.
고객의 요청 속도 제한에 사용됩니다.
본인인증 통신사
SKT
SKTKT
KTLGU
LGUSKT_MVNO
SKT 알뜰폰KT_MVNO
KT 알뜰폰LGU_MVNO
LGU 알뜰폰본인인증 방식
SMS
APP
Response
200
성공 응답
400
InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우MaxTransactionCountReachedError
: 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
401
UnauthorizedError
: 인증 정보가 올바르지 않은 경우
403
ForbiddenError
: 요청이 거절된 경우
404
IdentityVerificationNotFoundError
: 요청된 본인인증 건이 존재하지 않는 경우ChannelNotFoundError
: 요청된 채널이 존재하지 않는 경우
409
IdentityVerificationAlreadyVerifiedError
: 본인인증 건이 이미 인증 완료된 상태인 경우IdentityVerificationAlreadySentError
: 본인인증 건이 이미 API로 요청된 상태인 경우
502
PgProviderError
: PG사에서 오류를 전달한 경우
본인인증 확인
Request
Path
본인인증 아이디
Body
접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
SMS 방식에서만 사용됩니다.
Response
200
성공 응답
완료된 본인인증 내역
(결제, 본인인증 등에) 선택된 채널 정보
인증된 고객 정보
400
InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우
401
UnauthorizedError
: 인증 정보가 올바르지 않은 경우
403
ForbiddenError
: 요청이 거절된 경우
404
IdentityVerificationNotFoundError
: 요청된 본인인증 건이 존재하지 않는 경우IdentityVerificationNotSentError
: 본인인증 건이 API로 요청된 상태가 아닌 경우
409
IdentityVerificationAlreadyVerifiedError
: 본인인증 건이 이미 인증 완료된 상태인 경우
502
PgProviderError
: PG사에서 오류를 전달한 경우
SMS 본인인증 요청 재전송
Request
Path
본인인증 아이디
Query
접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
Response
200
성공 응답
400
InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우
401
UnauthorizedError
: 인증 정보가 올바르지 않은 경우
403
ForbiddenError
: 요청이 거절된 경우
404
IdentityVerificationNotFoundError
: 요청된 본인인증 건이 존재하지 않는 경우IdentityVerificationNotSentError
: 본인인증 건이 API로 요청된 상태가 아닌 경우
409
IdentityVerificationAlreadyVerifiedError
: 본인인증 건이 이미 인증 완료된 상태인 경우
502
PgProviderError
: PG사에서 오류를 전달한 경우