PortOne REST API - V1
결제완료된 정보, 결제취소, 상태별 결제목록 조회 등의 기능을 하는 REST API를 제공합니다.
비인증 결제, 정기 자동결제 등 부가기능을 위한 REST API도 제공합니다.
자세한 사항은TLS 지원 범위를 참고해주세요.
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
기타 API
베네피아 포인트 관련 API
결제기관 관련 API
편의점 결제 관련 API
수납번호 발급 API
Request
Body
고객사 거래 고유번호
Response
200
편의점결제 수납번호(barcode) 생성 완료
결제에 사용된 마스킹된 카드번호
결제건에 사용된 카드 구분코드
결제건의 결제완료 시각 UNIX timestamp
결제건의 결제실패시각 UNIX timestamp
결제건의 결제취소시각 UNIX timestamp
결제건의 결제실패 사유
결제건의 결제취소 사유
(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
수납취소 API
Request
Path
Response
200
편의점결제 수납번호(barcode) 말소 완료
결제에 사용된 마스킹된 카드번호
결제건에 사용된 카드 구분코드
결제건의 결제완료 시각 UNIX timestamp
결제건의 결제실패시각 UNIX timestamp
결제건의 결제취소시각 UNIX timestamp
결제건의 결제실패 사유
결제건의 결제취소 사유
(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우