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
Request
Path
Response
200
현금영수증 상세정보 조회 완료
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
존재하지 않는 포트원 거래정보이거나 현금영수증 발행된 내역이 확인되지 않는 경우
현금영수증 단건발급 API
imp_uid 거래를 처리하는데 사용된 PG설정값을 그대로 활용합니다.
(ex. KCP 거래건이면 KCP를 통해 현금영수증 발행 API처리)
현금영수증 발급 금액은 현금성 거래의 금액으로 자동 적용됩니다. 부분취소된 거래인 경우 남은 잔액으로 발급됩니다.
지원되는 PG사
- KG 이니시스
- NHN KCP
- 나이스페이먼츠
- KICC
- 헥토파이낸셜(구 세틀뱅크)
- 키움페이(구 다우, 페이조아)
- 토스페이먼츠 - 신모듈
- KSNET
- 스마트로 - 신모듈
- (신) 나이스페이
- 웰컴페이먼츠
Request
Path
Body
현금영수증을 발행할 결제건의 구매자 이름
현금영수증을 발행할 결제건의 구매자 전화번호
현금영수증 발행금액 중 면세금액으로 지정하지 않으면 0원으로 적용합니다.
Deprecated 되었으므로 tax_free 파라메터를 사용해주세요.부가세(지정하지 않으면 공급가액의 10%로 자동 적용)
Response
200
현금영수증 발행 완료
400
필수 파라메터가 누락된 경우, 결제완료(paid)가 아닌 결제 건에 대해 발행요청한 경우, 이미 현금영수증 발행된 건에 대해 요청한 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
500
현금영수증 발행에 실패한 경우
501
현재 포트원이 현금영수증 관련 지원하지 않는 PG사인 경우
포트원 발급분 취소 API
포트원과 별개로 거래된 현금영수증 취소는 DELETE 외부 발급분 취소 API를 이용해주세요.
지원되는 PG사
- KG 이니시스
- NHN KCP
- 헥토파이낸셜(구 세틀뱅크)
- 나이스페이먼츠
- 키움페이(구 다우, 페이조아)
- 토스페이먼츠 - 신모듈
- (신) 나이스페이
- KSNET
- 스마트로 - 신모듈
- 웰컴페이먼츠
Request
Path
Response
200
현금영수증 발급취소 완료
400
포트원으로 현금영수증이 발급된 적 없는 건에 대해서 발급취소 요청한 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
500
PG사로부터 현금영수증 발급취소 실패응답을 받은 경우
501
현재 포트원이 현금영수증 관련 지원하지 않는 PG사인 경우
외부 발급내역 단건 조회 API
Request
Path
Response
200
현금영수증 상세정보 조회 완료
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
merchant_uid 로 현금영수증 발행된 내역이 확인되지 않는 경우
현금영수증 발급(외부) API
지원되는 PG사
- KG이니시스
- NHN KCP
- 나이스페이먼츠
- KICC
- 헥토파이낸셜(구 세틀뱅크)
- 토스페이먼츠 - 신모듈
- KSNET
- 스마트로 - 신모듈
- (신) 나이스페이
- 웰컴페이먼츠
Request
Path
현금영수증 발행을 위한 고객사 주문번호
Body
현금영수증을 발행할 결제건의 구매자 이름
현금영수증을 발행할 결제건의 구매자 전화번호
현금영수증 발행금액 중 면세금액으로 지정하지 않으면 0원으로 적용
Response
200
현금영수증 발행 완료
400
필수 파라메터가 누락된 경우, 이미 현금영수증 발행된 merchant_uid 에 대해 요청한 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
500
현금영수증 발행에 실패한 경우
501
현재 포트원이 현금영수증 관련 지원하지 않는 PG사인 경우
외부 발급분 취소 API
지원되는 PG사
- KG이니시스
- NHN KCP
- 헥토파이낸셜(구 세틀뱅크)
- 나이스페이먼츠
- 토스페이먼츠 - 신모듈
- KSNET
- 스마트로 - 신모듈
- (신) 나이스페이
- 웰컴페이먼츠
Request
Path
발급취소대상 고객사 주문번호
Response
200
현금영수증 발행취소 완료
400
merchant_uid 파라메터가 누락된 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
현금영수증 발행된 적이 없는 merchant_uid 에 대해 요청한 경우
500
현금영수증 발행취소에 실패한 경우
501
현재 포트원이 현금영수증 관련 지원하지 않는 PG사인 경우