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
입력한 배송정보를 획득합니다.
택배사 코드표 : https://developers.portone.io/docs/ko/tip/code
지원되는 PG사
- KG이니시스
- NHN KCP
- 키움페이(구 다우, 페이조아)(다우테이타)
- KSNET
- 스마트로 - 신모듈(PG사와의 사전 계약이 반드시 필요합니다.)
- (신) 나이스페이
- 웰컴페이먼츠
Request
Path
Response
200
정상 조회
400
필수 파라메터가 누락되거나 (PG사별로 필수 여부가 다를 수 있음), 지원하는 않는 PG사인 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
배송정보를 조회할 거래건이 존재하지 않음
409
등록된 배송정보가 존재하지 않습니다.
500
배송정보 조회 도중 오류 발생
배송정보 단건수정 API
logis는 하위 필드가 모두 필수입니다.
sender, receiver의 각 세부 항목은 PG사마다 필수 여부가 모두 다릅니다.
지원되는 PG사
- KG이니시스
- 키움페이(구 다우, 페이조아)(다우테이타)
- KSNET
- 스마트로 - 신모듈 (PG사와의 사전 계약이 반드시 필요합니다.)
- 웰컴페이먼츠
Request
Path
Body
Response
200
수정 완료
400
필수 파라메터가 누락되거나 (PG사별로 필수 여부가 다를 수 있음), 지원하는 않는 PG사인 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
배송정보를 수정할 거래건이 존재하지 않음
405
POST요청이 아닌 경우
409
해당거래건은 배송정보를 수정할 수 없는 경우
500
배송정보 수정 도중 오류 발생
배송정보 단건등록 API
logis는 하위 필드가 모두 필수입니다.
sender, receiver의 각 세부 항목은 PG사마다 필수 여부가 모두 다릅니다.
지원되는 PG사
- KG이니시스
- NHN KCP
- 키움페이(구 다우, 페이조아)(다우테이타)
- KSNET
- 스마트로 - 신모듈(PG사와의 사전 계약이 반드시 필요합니다.)
- (신) 나이스페이
- 웰컴페이먼츠
Request
Path
Body
Response
200
등록 완료
400
필수 파라메터가 누락되거나 (PG사별로 필수 여부가 다를 수 있음), 지원하는 않는 PG사인 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
배송정보를 등록할 거래건이 존재하지 않음
405
POST요청이 아닌 경우
409
이미 배송정보 등록이 완료됨, 해당거래건은 배송정보를 등록할 수 없는경우
500
배송정보 등록 도중 오류 발생