개발자센터
V1
V2
파트너 정산 릴리즈 노트 기술 블로그

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 시크릿 확인하기

  1. 관리자 콘솔 상점・계정 관리 화면 접속
  2. 내 식별코드・API Keys 버튼 클릭
API 키와 API 시크릿은 관리자 콘솔 → 상점・계정 관리 메뉴 → 내 식별코드・API Keys 모달을 열어서 확인하실 수 있습니다
API 키와 API 시크릿은 관리자 콘솔 → 상점・계정 관리 메뉴 → 내 식별코드・API Keys 모달을 열어서 확인하실 수 있습니다

API 시크릿은 절대로 외부에 노출되어서는 안 되는 값입니다.
실제 구현에서 액세스 토큰 발급은 꼭 서버 사이드에서 해주세요.

액세스 토큰 발급 받기

access_token 발급 API post/users/getToken 호출

/users/getToken API를 호출해서 액세스 토큰을 발급받습니다
/users/getToken API를 호출해서 액세스 토큰을 발급받습니다

포트원 REST API 서버는 Google Public NTP의 시간과 동기화되고 있습니다.

하위 상점 연동을 할 경우 액세스 토큰을 발급받을 때 Agent 계정API 키API 시크릿을 사용해야 합니다.

Agency & Tier 란?

액세스 토큰 사용하기

발급받은 액세스 토큰은 다른 API를 호출할 때
Authorization 헤더에 Bearer <액세스 토큰> 형식의 값을 넣어주면 됩니다.

자세한 내용은 MDN - HTTP 인증 문서를 참고해주세요.

하위 상점 연동을 할 경우 포트원 API 호출시 Tier 헤더에 하위 상점 티어 코드를 입력해야 합니다.

Agency & Tier 란?

액세스 토큰 만료기한 연장

만료된 액세스 토큰으로 API를 호출하면 401 Unauthorized 응답을 받습니다.
액세스 토큰의 만료 기한은 발행시간부터 30분입니다.

  • 기존 액세스 토큰이 만료되기 전 access_token 발급 API post/users/getToken를 다시 호출했을 경우

    • 기존 액세스 토큰이 반환됩니다.
      만료 기한이 1분 안쪽으로 남았을 때 요청했다면 기존 액세스 토큰의 만료 기한이 5분 연장됩니다.
  • 기존 액세스 토큰이 만료된 다음 access_token 발급 API post/users/getToken를 다시 호출했을 경우

    • 새로운 액세스 토큰이 반환됩니다.

액세스 토큰의 재사용과 만료기한 5분 연장 동작방식은 다음과 같은 상황을 고려해서 설계되었습니다.

  • 한 고객사에서 여러 대의 웹서버가 동시에 경쟁적으로 REST API(/users/getToken)를 호출하는 상황
  • 한 고객사에서 여러 대의 웹서버가 시간 동기화 되어있지 않은 상황

결제 관련 API

결제 금액 사전 등록 관련 API

비인증 결제 관련 API

별도 결제창 호출없이 결제를 진행할 수 있는 비인증 결제 기능을 제공합니다.

정기 결제 관련 API

빌링키 관련 API

가상계좌 관련 API

PG사 관련 API

PG사 별 추가로 지원하는 기능을 제공합니다.

카카오 관련 API

카카오페이에서 지원하는 기능을 제공합니다.

KCP 퀵페이 관련 API

KCP 퀵페이에서 지원하는 기능을 제공합니다.

네이버페이 관련 API

네이버페이에서 지원하는 기능을 제공합니다.

목차

(주문형-네이버페이) 네이버페이 주문환불 API
post/payments/{imp_uid}/naver/cancel
(주문형-네이버페이) 구매자의 환불요청 승인처리 API
post/payments/{imp_uid}/naver/approve-cancel
(주문형-네이버페이) 상품주문 발송처리 API
post/payments/{imp_uid}/naver/ship
(주문형-네이버페이) 교환승인된 상품 재발송처리 API
post/payments/{imp_uid}/naver/ship-exchanged
(주문형-네이버페이) 교환승인된 상품 수거완료처리 API
post/payments/{imp_uid}/naver/collect-exchanged
(주문형-네이버페이) 상품발주처리 API
post/payments/{imp_uid}/naver/place
(주문형-네이버페이) 상품반품요청 API
post/payments/{imp_uid}/naver/request-return
(주문형-네이버페이) 상품 반품승인 처리 API
post/payments/{imp_uid}/naver/approve-return
(주문형-네이버페이) 상품 반품거절 처리 API
post/payments/{imp_uid}/naver/reject-return
(주문형-네이버페이) 상품 반품보류 처리 API
post/payments/{imp_uid}/naver/withhold-return
(주문형-네이버페이) 반품보류상품 반품보류해제 처리 API
post/payments/{imp_uid}/naver/resolve-return
(결제형-네이버페이) 네이버페이 포인트 적립 API
post/payments/{imp_uid}/naver/point
(결제형-네이버페이) 에스크로 주문 확정 API
post/payments/{imp_uid}/naver/confirm
(주문형-네이버페이) 포트원 거래고유번호 기준 네이버페이 상품주문 조회 API
get/payments/{imp_uid}/naver/product-orders
(주문형-네이버페이) 네이버페이 상품주문번호로 상품주문 상세 조회 API
get/naver/product-orders/{product_order_id}
(주문형-네이버페이) 네이버페이 구매평 조회 API
get/naver/reviews
(결제형-네이버페이) 현금영수증 발급 가용액 조회 API
get/payments/{imp_uid}/naver/cash-amount

페이코 관련 API

페이코에서 지원하는 기능을 제공합니다.

페이먼트월 관련 API

페이먼트월에서 지원하는 기능을 제공합니다.

본인인증 관련 API

현금영수증 관련 API

get/receipts/{imp_uid}

발급내역 단건 조회 API

포트원을 통해 발행된 현금영수증 상세정보를 조회하는 API입니다.

Request

Path

imp_uid: string
포트원 거래고유번호

현금영수증을 조회할 결제건의 포트원 거래고유번호

Response

200

현금영수증 상세정보 조회 완료
code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response?: ReceiptAnnotation
(Optional)
imp_uid: string
포트원 거래고유번호

결제건의 포트원 거래고유번호

receipt_tid?: string
PG사 현금영수증 발행 고유번호
(Optional)

결제건에 대해 현금영수증 발행시 PG사의 발행고유번호

apply_num: string
국세청 발행번호

결제건에 대해 현금영수증 발행시 국세청 발행번호

type: string
타입(대상)

현금영수증 발행 대상의 타입

amount: integer
발행 금액

현금영수증 발행 금액

vat: integer
부가세액

현금영수증 발행금액 중 부가세액

receipt_url?: string
현금영수증 URL
(Optional)

발행된 현금영수증을 확인할 수 있는 URL

applied_at: integer
발행시각

현금영수증 발행시각 UNIX timestamp

cancelled_at?: integer
발행취소시각
(Optional)

현금영수증 발행취소시각 UNIX timestamp

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

404

존재하지 않는 포트원 거래정보이거나 현금영수증 발행된 내역이 확인되지 않는 경우
try
Request
Request Sample
N/A
post/receipts/{imp_uid}

현금영수증 단건발급 API

포트원을 통해 발생된 현금성 거래(가상계좌, 게좌이체)의 포트원 거래고유번호(imp_uid)를 기준으로 현금영수증이 발급 됩니다.
imp_uid 거래를 처리하는데 사용된 PG설정값을 그대로 활용합니다.
(ex. KCP 거래건이면 KCP를 통해 현금영수증 발행 API처리)
현금영수증 발급 금액은 현금성 거래의 금액으로 자동 적용됩니다. 부분취소된 거래인 경우 남은 잔액으로 발급됩니다.

지원되는 PG사

  • KG 이니시스
  • NHN KCP
  • 나이스페이먼츠
  • KICC
  • 헥토파이낸셜(구 세틀뱅크)
  • 키움페이(구 다우, 페이조아)
  • 토스페이먼츠 - 신모듈
  • KSNET
  • 스마트로 - 신모듈
  • (신) 나이스페이
  • 웰컴페이먼츠

Request

Path

imp_uid: string
포트원 거래고유번호

현금영수증을 발급할 결제건의 포트원 거래 고유번호

Body

product_type?: string
주문 상품구분
(Optional)

현금영수증 발행 주문 상품구분


identifier: string
식별정보

현금영수증 발행대상 식별정보로 국세청현금영수증카드, 휴대폰번호, 주민등록번호, 사업자등록번호를 기재합니다.


identifier_type?: string
식별정보 구분코드
(Optional)

현금영수증를 발행대상의 식별정보 구분코드


type?: string
타입(대상)
(Optional)

현금영수증 발행할 대상의 타입


company_tel?: string
고객센터 번호
(Optional)

현금영수증 발행 상점 고객센터 번호


company_name?: string
상점 사업자 명
(Optional)

현금영수증 발행 상점 사업자 명


corp_reg_no?: string
상점 사업자 번호
(Optional)

현금영수증 발행 상점 사업자 번호


buyer_name?: string
구매자 이름
(Optional)

현금영수증 발행건 사후 추적을 위해 입력을 강력히 권장합니다.


buyer_email?: string
구매자 Email 주소
(Optional)

현금영수증을 발행할 결제건의 구매자 Email 주소


buyer_tel?: string
구매자 전화번호
(Optional)

현금영수증 발행건 사후 추적을 위해 입력을 강력히 권장합니다.


tax_free?: integer
면세금액
(Optional)

발행금액의 1/11 이 부가세로 자동 적용되므로, 부가세금액 조정을 위해서는 tax_free 파라메터를 활용해주세요.


vat?: integer
(Optional) (Deprecated)
Deprecated 되었으므로 tax_free 파라메터를 사용해주세요.
부가세(지정하지 않으면 공급가액의 10%로 자동 적용)

vat_amount?: number
부가세 지정 금액
(Optional)

부가세 지정 가맹점에 한해 현금영수증 발행 금액 중 부가세 금액으로 부가세를 지정할 수 있습니다.

Response

200

현금영수증 발행 완료
code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response?: ReceiptAnnotation
(Optional)
imp_uid: string
포트원 거래고유번호

결제건의 포트원 거래고유번호

receipt_tid?: string
PG사 현금영수증 발행 고유번호
(Optional)

결제건에 대해 현금영수증 발행시 PG사의 발행고유번호

apply_num: string
국세청 발행번호

결제건에 대해 현금영수증 발행시 국세청 발행번호

type: string
타입(대상)

현금영수증 발행 대상의 타입

amount: integer
발행 금액

현금영수증 발행 금액

vat: integer
부가세액

현금영수증 발행금액 중 부가세액

receipt_url?: string
현금영수증 URL
(Optional)

발행된 현금영수증을 확인할 수 있는 URL

applied_at: integer
발행시각

현금영수증 발행시각 UNIX timestamp

cancelled_at?: integer
발행취소시각
(Optional)

현금영수증 발행취소시각 UNIX timestamp

400

필수 파라메터가 누락된 경우, 결제완료(paid)가 아닌 결제 건에 대해 발행요청한 경우, 이미 현금영수증 발행된 건에 대해 요청한 경우

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

500

현금영수증 발행에 실패한 경우

501

현재 포트원이 현금영수증 관련 지원하지 않는 PG사인 경우
try
Request
Request Sample
N/A
delete/receipts/{imp_uid}

포트원 발급분 취소 API

포트원을 통해 발급한 현금영수증 발급거래를 취소합니다
포트원과 별개로 거래된 현금영수증 취소는 DELETE 외부 발급분 취소 API를 이용해주세요.

지원되는 PG사

  • KG 이니시스
  • NHN KCP
  • 헥토파이낸셜(구 세틀뱅크)
  • 나이스페이먼츠
  • 키움페이(구 다우, 페이조아)
  • 토스페이먼츠 - 신모듈
  • (신) 나이스페이
  • KSNET
  • 스마트로 - 신모듈
  • 웰컴페이먼츠

Request

Path

imp_uid: string
포트원 거래고유번호

현금영수증을 취소할 결제건의 포트원 거래고유번호

Response

200

현금영수증 발급취소 완료
code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response?: ReceiptAnnotation
(Optional)
imp_uid: string
포트원 거래고유번호

결제건의 포트원 거래고유번호

receipt_tid?: string
PG사 현금영수증 발행 고유번호
(Optional)

결제건에 대해 현금영수증 발행시 PG사의 발행고유번호

apply_num: string
국세청 발행번호

결제건에 대해 현금영수증 발행시 국세청 발행번호

type: string
타입(대상)

현금영수증 발행 대상의 타입

amount: integer
발행 금액

현금영수증 발행 금액

vat: integer
부가세액

현금영수증 발행금액 중 부가세액

receipt_url?: string
현금영수증 URL
(Optional)

발행된 현금영수증을 확인할 수 있는 URL

applied_at: integer
발행시각

현금영수증 발행시각 UNIX timestamp

cancelled_at?: integer
발행취소시각
(Optional)

현금영수증 발행취소시각 UNIX timestamp

400

포트원으로 현금영수증이 발급된 적 없는 건에 대해서 발급취소 요청한 경우

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

500

PG사로부터 현금영수증 발급취소 실패응답을 받은 경우

501

현재 포트원이 현금영수증 관련 지원하지 않는 PG사인 경우
try
Request
Request Sample
N/A
get/receipts/external/{merchant_uid}

외부 발급내역 단건 조회 API

포트원 API를 통해 현금영수증만 발행된 건의 상세정보를 조회하는 API입니다. (포트원과 별개로 결제된 현금거래건)

Request

Path

merchant_uid: string
가맹점 주문번호

현금영수증 발행 대상 가맹점 주문번호

Response

200

현금영수증 상세정보 조회 완료
code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)
merchant_uid: string
가맹점 주문번호

현금영수증을 발행한 가맹점의 주문번호

receipt_tid?: string
PG사 현금영수증 발행 고유번호
(Optional)

결제건에 대해 현금영수증 발행시 PG사의 발행고유번호

apply_num: string
국세청 발행번호

결제건에 대해 현금영수증 발행시 국세청 발행번호

type: string
타입(대상)

현금영수증 발행 대상의 타입

amount: integer
발행 금액

현금영수증 발행 금액

vat: integer
부가세액

현금영수증 발행금액 중 부가세액

receipt_url?: string
현금영수증 URL
(Optional)

발행된 현금영수증을 확인할 수 있는 URL

applied_at: integer
발행시각

현금영수증 발행시각 UNIX timestamp

cancelled_at?: integer
발행취소시각
(Optional)

현금영수증 발행취소시각 UNIX timestamp

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

404

merchant_uid 로 현금영수증 발행된 내역이 확인되지 않는 경우
try
Request
Request Sample
N/A
post/receipts/external/{merchant_uid}

현금영수증 발급(외부) API

포트원과 별개로 거래된 일반 현금결제에 대해, 포트원 내에 설정된 PG사로 현금영수증 발행 요청하는 API입니다.

지원되는 PG사

  • KG이니시스
  • NHN KCP
  • 나이스페이먼츠
  • KICC
  • 헥토파이낸셜(구 세틀뱅크)
  • 토스페이먼츠 - 신모듈
  • KSNET
  • 스마트로 - 신모듈
  • (신) 나이스페이
  • 웰컴페이먼츠

Request

Path

merchant_uid: string
가맹점 주문번호

가맹점 주문번호는 현금거래 주문번호와 동일한 번호를 기재해야 추후 대사가 가능한점 유념하시기 바랍니다.

Body

name: string
주문명

현금영수증 발행할 결제건의 주문명


amount: integer
발행 금액

현금영수증 발행할 결제건의 금액


product_type?: string
주문 상품구분
(Optional)

현금영수증 발행할 결제건의 주문 상품구분


identifier: string
식별정보

현금영수증 발행대상 식별정보로 국세청현금영수증카드, 휴대폰번호, 주민등록번호, 사업자등록번호를 기재합니다.


identifier_type?: string
식별정보 구분코드
(Optional)

현금영수증 발행대상의 식별정보 구분코드


type?: string
타입(대상)
(Optional)

현금영수증 발행할 대상의 타입


buyer_name?: string
구매자 이름
(Optional)

현금영수증 발행건 사후 추적을 위해 입력을 강력히 권장합니다.


buyer_email?: string
구매자 Email 주소
(Optional)

현금영수증을 발행할 결제건의 구매자 Email 주소


buyer_tel?: string
구매자 전화번호
(Optional)

현금영수증 발행건 사후 추적을 위해 입력을 강력히 권장합니다.


tax_free?: integer
면세금액
(Optional)

발행금액의 1/11 이 부가세로 자동 적용되므로, 부가세금액 조정을 위해서는 tax_free 파라메터를 활용해주세요.


pg?: string
PG 구분코드
(Optional)

현금영수증을 발행할 PG사 구분코드


vat_amount?: number
부가세 지정 금액
(Optional)

부가세 지정 가맹점에 한해 현금영수증 발행 금액 중 부가세 금액으로 부가세를 지정할 수 있습니다.


corp_reg_no?: string
상점 사업자 번호
(Optional)

현금영수증 발행 상점 사업자 번호


pay_method?: string
결제수단
(Optional)

현금영수증 발행 할 결제건의 결제수단

Response

200

현금영수증 발행 완료
code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)
merchant_uid: string
가맹점 주문번호

현금영수증을 발행한 가맹점의 주문번호

receipt_tid?: string
PG사 현금영수증 발행 고유번호
(Optional)

결제건에 대해 현금영수증 발행시 PG사의 발행고유번호

apply_num: string
국세청 발행번호

결제건에 대해 현금영수증 발행시 국세청 발행번호

type: string
타입(대상)

현금영수증 발행 대상의 타입

amount: integer
발행 금액

현금영수증 발행 금액

vat: integer
부가세액

현금영수증 발행금액 중 부가세액

receipt_url?: string
현금영수증 URL
(Optional)

발행된 현금영수증을 확인할 수 있는 URL

applied_at: integer
발행시각

현금영수증 발행시각 UNIX timestamp

cancelled_at?: integer
발행취소시각
(Optional)

현금영수증 발행취소시각 UNIX timestamp

400

필수 파라메터가 누락된 경우, 이미 현금영수증 발행된 merchant_uid 에 대해 요청한 경우

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

500

현금영수증 발행에 실패한 경우

501

현재 포트원이 현금영수증 관련 지원하지 않는 PG사인 경우
try
Request
Request Sample
N/A
delete/receipts/external/{merchant_uid}

외부 발급분 취소 API

포트원과 별개로 거래된 일반 현금결제에 대해, 포트원 내에 설정된 PG사로 포트원 API를 이용해 현금영수증 발행취소하는 API입니다.

지원되는 PG사

  • KG이니시스
  • NHN KCP
  • 헥토파이낸셜(구 세틀뱅크)
  • 나이스페이먼츠
  • 토스페이먼츠 - 신모듈
  • KSNET
  • 스마트로 - 신모듈
  • (신) 나이스페이
  • 웰컴페이먼츠

Request

Path

merchant_uid: string
가맹점 주문번호

merchant_uid는 현금결제를 구분할 고유주문번호를 의미하며 발행에 사용된 값을 전달하면 됩니다.

Response

200

현금영수증 발행취소 완료
code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)
merchant_uid: string
가맹점 주문번호

현금영수증을 발행한 가맹점의 주문번호

receipt_tid?: string
PG사 현금영수증 발행 고유번호
(Optional)

결제건에 대해 현금영수증 발행시 PG사의 발행고유번호

apply_num: string
국세청 발행번호

결제건에 대해 현금영수증 발행시 국세청 발행번호

type: string
타입(대상)

현금영수증 발행 대상의 타입

amount: integer
발행 금액

현금영수증 발행 금액

vat: integer
부가세액

현금영수증 발행금액 중 부가세액

receipt_url?: string
현금영수증 URL
(Optional)

발행된 현금영수증을 확인할 수 있는 URL

applied_at: integer
발행시각

현금영수증 발행시각 UNIX timestamp

cancelled_at?: integer
발행취소시각
(Optional)

현금영수증 발행취소시각 UNIX timestamp

400

merchant_uid 파라메터가 누락된 경우

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

404

현금영수증 발행된 적이 없는 merchant_uid 에 대해 요청한 경우

500

현금영수증 발행취소에 실패한 경우

501

현재 포트원이 현금영수증 관련 지원하지 않는 PG사인 경우
try
Request
Request Sample
N/A

에스크로 관련 API

가맹점 정보 관련 API

가맹점 정보를 관리하는 기능을 제공합니다.

가맹점의 하위가맹점 관련 API

하위 상점 관련 API

하위 상점과 관련된 기능을 제공합니다.

기타 API

부가적인 기능을 제공합니다.

베네피아 포인트 관련 API

베네피아 포인트(복지 포인트)와 관련된 기능을 제공합니다.

결제기관 관련 API

편의점 결제 관련 API

편의점 결제를 위한 수납 번호(barcode)와 관련된 기능을 제공합니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다