개발자센터

PortOne REST API - V1

결제완료된 정보, 결제취소, 상태별 결제목록 조회 등의 기능을 하는 REST API를 제공합니다.
비인증 결제, 정기 자동결제 등 부가기능을 위한 REST API도 제공합니다.

2026년 1월 26일부로 포트원 V1 결제내역 단건조회 API에 동작 변경이 있습니다.

자세한 사항은 V1 결제내역 단건조회 API 동작 변경 안내를 참고해주세요.

V1 API hostname: api.iamport.kr

Swagger JSON 내려받기Postman 등에서 import하여 활용할 수 있습니다.


하위호환성

포트원이 제공하는 모든 Stable API에 대해 아래와 같은 하위호환성이 보장됩니다.

  1. 현재 사용 가능한 입력 형식은 앞으로도 사용할 수 있습니다.

    • 입력 형식 내 필드 정의가 삭제되지 않습니다.

    • 필수 입력 정보가 추가되거나, 선택 입력 정보가 필수로 변경되지 않습니다.

      • 오로지 선택 입력 정보만 추가될 수 있습니다.

    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.

    • enum 타입의 값이 삭제되지 않습니다.

  2. 출력 형식이 확장될 수 있지만, 축소되지 않습니다.

    • 출력 형식 내 필드 정의가 삭제되지 않습니다.

    • 사용 중인 필수 출력 정보가 선택사항으로 변경되거나 출력 시 누락되지 않습니다.

      • 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
      • 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.

    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.

    • 단, 새로운 필드 또는 enum 값, oneOf 케이스가 추가될 수 있습니다.

      • 알지 못하는 필드 및 값이 주어지더라도 crash가 발생하지 않도록 유의하여 개발해주세요.

UNSTABLE이 표기된 일부 API의 경우, 위 하위호환성 정책과 무관하게 변경 및 지원 종료될 수 있으니 이용에 유의하세요.

하위 상점의 API 사용

하위 상점에 대해 API를 사용하려는 경우 API 호출 시 Tier 헤더(HTTP Request Header)로 하위상점의 티어코드를 전달해야 합니다.
[Agency & Tier 란?]

인증 관련 API

포트원 API를 호출할 때는 액세스 토큰을 Authorization 헤더에 넣어주어야 합니다.
액세스 토큰은 access_token 발급 API post/users/getToken를 호출해서 발급받을 수 있습니다.

액세스 토큰 발급 API를 호출하려면 API 키와 API 시크릿을 인자로 넣어주어야 합니다.

결제 관련 API

결제 건과 관련된 기능을 제공합니다.
get/payments/{imp_uid}/balance

결제 상세내역 조회 API

포트원 거래고유번호로 결제수단별 금액 상세정보를 확인합니다.(현재, PAYCO결제수단에 한해 제공되고 있습니다. 타 PG사의 경우 파라메터 검증 등 검토/협의 단계에 있습니다.

Request

Path

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

상세정보를 조회할 결제건의 포트원 거래고유번호

Response

200 Ok

정상 조회

code?: integer
응답코드

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

message?: string
응답메세지

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

response?: PaymentBalanceResponseAnnotation

401 Error

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

404 Error

유효하지 않은 imp_uid

405 Error

허용되지 않는 HTTP METHOD

try
Request
Request Sample
N/A
get/payments/{imp_uid}

결제내역 단건조회 API

포트원 거래고유번호로 결제내역을 확인합니다

Request

Path

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

결제내역을 확인할 결제건의 포트원 거래고유번호

Query

include_sandbox?: boolean
테스트 결제건 포함 여부

테스트 채널을 통해 발생한 결제건을 조회 결과에 포함할지 여부 (기본값: false)

(본 파라미터는 2026년 1월 26일부터 추가 예정입니다.)

Response

200 Ok

정상 조회

code?: integer
응답코드

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

message?: string
응답메세지

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

response?: PaymentAnnotation

401 Error

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

404 Error

유효하지 않은 imp_uid

try
Request
Request Sample
N/A
get/payments

결제내역 복수조회 API

여러 개의 포트원 거래고유번호 또는 고객사 주문번호로 결제내역을 한 번에 조회합니다.(최대 100개)
(예시) /payments?imp_uid[]=imp_448280090638&imp_uid[]=imp_448280090639&merchant_uid[]=merchant_143434085216

Request

Query

imp_uid[]?: Array<string>
포트원 거래고유번호

조회할 결제건의 포트원 거래고유번호 리스트

merchant_uid[]?: Array<string>
고객사 주문번호

결제요청 시 고객사에서 요청한 고객사 주문번호

Response

200 Ok

요청된 모든 imp_uid 에 대한 결제정보 응답완료

code?: integer
응답코드

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

message?: string
응답메세지

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

response?: Array<PaymentAnnotation>

207 Partial Success

요청된 imp_uid 중 일부 거래 조회 실패(ex. 접근권한없음 또는 존재하지 않는 imp_uid)

code?: integer
응답코드

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

message?: string
응답메세지

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

response?: Array<PaymentAnnotation>

401 Error

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

404 Error

해당되는 결제건을 찾지 못하였습니다.

try
Request
Request Sample
N/A
get/payments/find/{merchant_uid}/{payment_status}

결제 단건조회(고유 고객사 주문번호 조회) API

고객사지정 고유번호로 결제내역을 확인합니다
동일한 merchant_uid가 여러 건 존재하는 경우, 정렬 기준에 따라 가장 첫 번째 해당되는 건을 반환합니다. (모든 내역에 대한 조회가 필요하시면 GET 결제 복수조회(고객사 주문번호 중복 포함) API를 사용해주세요.)

payment_status를 추가로 지정하시면, 해당 status에 해당하는 가장 최신 데이터를 반환합니다.

Request

Path

merchant_uid: string
고객사 주문번호

결제요청 시 고객사에서 요청한 고객사 주문번호

payment_status?: string
거래상태 구분코드

특정 status상태의 값만 필터링하고 싶은 경우에 사용하는 파라미터로 지정하지 않으면 모든 상태를 대상으로 조회합니다

Query

sorting?: "-started" | "started" | "-paid" | ...
정렬구분코드

정렬 기준을 설정하는 파라미터로 기본값은 -started입니다.

Response

200 Ok

정상 조회

code?: integer
응답코드

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

message?: string
응답메세지

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

response?: PaymentAnnotation

401 Error

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

404 Error

거래건이 존재하지 않는 경우

try
Request
Request Sample
N/A
get/payments/findAll/{merchant_uid}/{payment_status}

결제 복수조회(고객사 주문번호 중복 포함) API

고객사지정 고유번호 및 상태기준으로 결제내역을 확인합니다
동일한 merchant_uid가 여러 건 존재하는 경우, 존재하는 모든 거래가 조회됩니다.

payment_status를 추가로 지정하시면, 해당 status에 해당하는 가장 최신 데이터를 반환합니다.

Request

Path

merchant_uid: string
고객사 주문번호

결제요청 시 고객사에서 요청한 고객사 주문번호

payment_status?: string
결제상태코드

특정 status상태의 값만 필터링하고 싶은 경우에 사용하는 파라미터로 지정하지 않으면 모든 상태를 조회합니다.

Query

page?: integer
페이지번호

1부터 시작하며 기본값은 1입니다.

limit?: integer
페이지당 조회건수

한 번에 조회할 결제건수.(최대 1000건, 기본값 20건)

sorting?: "-started" | "started" | "-paid" | ...
정렬기준

정렬기준을 나타내는 파라미터로 기본값은 -started입니다.

Response

200 Ok

정상 조회

code?: integer
응답코드

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

message?: string
응답메세지

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

response?: PagedPaymentAnnotation

400 Error

merchant_uid누락, 올바르지 않은 status 등 파라메터가 잘못된 경우

401 Error

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

404 Error

유효하지 않은 merchant_uid

try
Request
Request Sample
N/A
get/payments/status/{payment_status}

결제상태기준 복수조회 API

미결제/결제완료/결제취소/결제실패 상태 별로 검색할 수 있습니다.(20건씩 최신순 페이징)

검색기간은 최대 90일까지이며 to파라메터의 기본값은 현재 unix timestamp이고 from파라메터의 기본값은 to파라메터 기준으로 90일 전입니다. 때문에, from/to 파라메터가 없이 호출되면 현재 시점 기준으로 최근 90일 구간에 대한 데이터를 검색하게 됩니다.
from, to 파라메터를 지정하여 90일 단위로 과거 데이터 조회는 가능합니다.

Request

Path

payment_status: "all" | "ready" | "paid" | ...
결제상태코드

조회할 결제건의 결제상태 코드

Query

page?: integer
페이지번호

1부터 시작하며 기본값 1입니다.

limit?: integer
페이지 당 조회건수

한 번에 조회할 결제건수.(최대 1000건, 기본값 20건)

from?: integer
검색 시작 시각

기본값은 to 파라메터 기준으로 90일 전 unix timestamp입니다. (시간별 검색 시작 시각(>=) UNIX TIMESTAMP)

to?: integer
검색 종료 시각

기본값은 현재 unix timestamp입니다. (시간별 검색 종료 시각(<=) UNIX TIMESTAMP)

sorting?: "-started" | "started" | "-paid" | ...
정렬기준

정렬기준을 나타내는 파라미터로 기본값은 -started입니다.

Response

200 Ok

정상 조회

code?: integer
응답코드

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

message?: string
응답메세지

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

response?: PagedPaymentAnnotation

400 Error

유효하지 않은 payment_status인 경우, 데이터 범위를 넘어선 page인 경우

401 Error

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

try
Request
Request Sample
N/A
post/payments/cancel

결제취소 API

승인된 결제를 취소합니다.
신용카드/실시간계좌이체/휴대폰소액결제의 경우 즉시 취소처리가 이뤄지게 되며, 가상계좌와 휴대폰소액결제 익월 환불(KCP)의 경우는 환불받으실 계좌정보를 같이 전달해주시면 환불정보가 PG사에 등록되어 익영업일에 처리됩니다. (가상계좌 환불, 휴대폰소액결제 익월 환불(KCP)의 경우 관련 특약계약 필요)

Request

Body

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

취소할 거래의 포트원 거래고유번호

merchant_uid?: string
고객사 주문번호

고객사에서 전달한 거래 고유번호로 imp_uid, merchant_uid 중 하나는 필수이어야 합니다. (두 값이 모두 넘어오면 imp_uid를 우선 적용합니다.)

amount?: number
(부분)취소 요청금액

(부분)취소요청 금액으로 (누락하거나 0을 입력하는 경우 전액 취소 요청합니다.)

tax_free?: number
(부분)취소요청 금액 중 면세금액

단, 아래 PG사의 경우 자동으로 0원 처리 되지 않으므로 면세 결제에 한하여 필수 입력 바랍니다.

vat_amount?: number
(부분)취소요청금액 중 부가세 금액

단, 결제 시 부가세를 지정했던 경우 필수 입력 바랍니다.

checksum?: number
현재시점의 취소 가능한 잔액

API요청자가 기록하고 있는 취소가능 잔액과 포트원이 기록하고 있는 취소가능 잔액이 일치하는지 사전에 검증하고, 검증에 실패하면 트랜잭션을 수행하지 않습니다. null인 경우에는 검증 프로세스를 생략합니다.

reason?: string
취소 사유

결제건을 취소하려는 사유

refund_holder?: string
환불계좌 예금주

환불받을 계좌의 예금주

refund_bank?: string
환금계좌 은행코드

은행 코드 리스트 확인하기

refund_account?: string
환불계좌 계좌번호

환불받을 계좌번호

refund_tel?: string
환불계좌 예금주 연락처

환불받을 계좌의 예금주 연락처 (가상계좌 취소인 경우 필수)

retain_promotion?: boolean
프로모션 정책 유지 여부

프로모션이 적용된 결제일 경우 결제 취소 이후 잔여 금액이 프로모션 정책에 위반되더라도 프로모션을 유지할지에 대한 여부 (default: false)

extra?: array
추가 파라미터

결제 취소 요청시 필요한 추가 정보

Response

200 Ok

정상 조회

code?: integer
응답코드

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

message?: string
응답메세지

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

response?: PaymentAnnotation

401 Error

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

try
Request
Request Sample
N/A

결제 금액 사전 등록 관련 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

포트원 결제건 및 외부 결제 건의 현금영수증 관리와 관련된 기능을 제공합니다.

에스크로 관련 API

에스크로 결제 건의 배송 정보와 관련된 기능을 제공합니다.

고객사 정보 관련 API

고객사 정보를 관리하는 기능을 제공합니다.

고객사의 하위 상점 관련 API

대표 상점에 대한 하위 상점 관리와 관련된 기능을 제공합니다.

하위 상점 관련 API

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

기타 API

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

베네피아 포인트 관련 API

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

결제기관 관련 API

금융결제원 기준 카드사, 은행의 표준 코드와 기관정보 조회 기능을 제공합니다.

편의점 결제 관련 API

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

타입 정의

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