PortOne REST API - V1
결제완료된 정보, 결제취소, 상태별 결제목록 조회 등의 기능을 하는 REST API를 제공합니다.
비인증 결제, 정기 자동결제 등 부가기능을 위한 REST API도 제공합니다.
V1 API hostname: api.iamport.kr
인증 관련 API
포트원 API를 호출할 때는 액세스 토큰을 Authorization
헤더에 넣어주어야 합니다.
액세스 토큰은 access_token 발급 API post/users/getToken를 호출해서 발급받을 수 있습니다.
액세스 토큰 발급 API를 호출하려면 API 키와 API 시크릿을 인자로 넣어주어야 합니다.
결제 관련 API
목차
결제 금액 사전 등록 관련 API
비인증 결제 관련 API
정기 결제 관련 API
목차
빌링키 관련 API
목차
가상계좌 관련 API
PG사 관련 API
카카오 관련 API
KCP 퀵페이 관련 API
페이코 관련 API
페이먼트월 관련 API
본인인증 관련 API
현금영수증 관련 API
에스크로 관련 API
고객사 정보 관련 API
고객사의 하위 상점 관련 API
하위 상점 정보 조회 API
Request
Path
하위 상점의 고유 코드로 알파벳 대문자 또는 숫자만 사용 가능합니다.(반드시 3자리)
Response
200
0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
알파벳 대문자 또는 숫자 3자리로 구성됩니다.
하위 상점(Tier)의 관리명칭
401
404
하위 상점 정보 수정 API
Request
Path
하위 상점의 고유 코드로 알파벳 대문자 또는 숫자만 사용 가능합니다.(반드시 3자리)
Body
내부 관리용으로 사용되는 하위 상점의 명칭
Response
200
0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
알파벳 대문자 또는 숫자 3자리로 구성됩니다.
하위 상점(Tier)의 관리명칭
400
401
404
500
하위 상점 정보 등록 API
Request
Path
하위 상점의 고유 코드로 알파벳 대문자 또는 숫자만 사용 가능합니다.(반드시 3자리)
Body
내부 관리용으로 사용되는 하위 상점의 명칭
Response
200
0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
알파벳 대문자 또는 숫자 3자리로 구성됩니다.
하위 상점(Tier)의 관리명칭
400
401
500
하위 상점 정보 삭제 API
Request
Path
하위 상점의 고유 코드로 알파벳 대문자 또는 숫자만 사용 가능합니다.(반드시 3자리)
Response
200
0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
알파벳 대문자 또는 숫자 3자리로 구성됩니다.
하위 상점(Tier)의 관리명칭