개발자센터
V1
V2
원 페이먼트 인프라파트너 정산 자동화
API & SDK
리소스

PortOne REST API - V1

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

2024년 9월 1일부로 포트원 V1 API에 대해 일부 보안 규격이 지원 종료됩니다.
자세한 사항은TLS 지원 범위를 참고해주세요.

V1 API hostname: api.iamport.kr

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

인증 관련 API

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

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

결제 관련 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
post/payments/{imp_uid}/naver/cancel

(주문형-네이버페이) 네이버페이 주문환불 API

(주문형-네이버페이) 네이버페이 상품주문들을 환불처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 환불처리할 수 있습니다. 시도된 상품주문 중 환불처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
환불할 거래건의 네이버페이 상품주문번호
(Optional)
reason?: string
취소 사유 코드
(Optional)

Response

200

모든주문환불성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부주문 환불성공 & 일부주문 환불실패네이버페이에 환불요청시 product_order_id 개별로 환불요청이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든주문 환불실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/approve-cancel

(주문형-네이버페이) 구매자의 환불요청 승인처리 API

네이버페이 주문형 구매자가 환불요청한 상품주문들을 환불승인처리합니다. 상품발주처리 중 구매자의 환불요청이 있는 경우, 최종 환불처리를 위해서는 판매자의 승인이 필요하므로 본 API 를 사용하셔야 합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래고유번호(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 환불승인처리할 수 있습니다. 시도된 상품주문 중 환불승인처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
환불승인할 거래건의 네이버페이 상품주문번호
(Optional)

Response

200

주문환불승인성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부주문 환불승인성공 & 일부주문 환불승인실패포트원에서 네이버페이에 환불승인요청시 product_order_id 개별로 환불승인요청이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든주문 환불승인실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/ship

(주문형-네이버페이) 상품주문 발송처리 API

(주문형-네이버페이) 네이버페이 상품주문들을 발송처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 발송처리할 수 있습니다. 시도된 상품주문 중 발송처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
발송처리할 거래건의 네이버페이 상품주문번호
(Optional)
delivery_method: string
배송방법 코드
dispatched_at: integer
발송일
delivery_company?: string
택배사 코드
(Optional)
tracking_number?: string
송장번호
(Optional)

Response

200

모든 상품주문 발송처리 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 발송처리성공 & 일부주문 발송처리실패포트원에서 네이버페이에 발송처리 요청시 product_order_id 개별로 발송요청이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

400

delivery_method / dispatched_at 파라메터가 누락되거나 올바르지 않은 경우

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 발송처리실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/ship-exchanged

(주문형-네이버페이) 교환승인된 상품 재발송처리 API

(주문형-네이버페이) 네이버페이 교환승인된 상품주문들을 재발송처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 재발송처리할 수 있습니다. 시도된 상품주문 중 재발송처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
재발송처리할 거래건의 네이버페이 상품주문번호
(Optional)
delivery_method: string
배송방법 코드
delivery_company?: string
택배사 코드
(Optional)
tracking_number?: string
송장번호
(Optional)

Response

200

모든 상품주문 재발송처리 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 재발송처리성공 & 일부주문 재발송처리실패포트원에서 네이버페이에 재발송처리 요청시 product_order_id 개별로 재발송요청이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

400

delivery_method 파라메터가 누락되거나 올바르지 않은 경우

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 재발송처리실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/collect-exchanged

(주문형-네이버페이) 교환승인된 상품 수거완료처리 API

(주문형-네이버페이) 네이버페이 교환승인된 상품주문들을 수거완료처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 수거완료처리할 수 있습니다. 시도된 상품주문 중 수거완료처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
네이버페이 상품주문번호
(Optional)

Response

200

모든 상품주문 수거완료처리 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 수거완료처리성공 & 일부주문 수거완료처리실패포트원에서 네이버페이에 수거완료처리 요청시 product_order_id 개별로 수거완료요청이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 수거완료처리실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/place

(주문형-네이버페이) 상품발주처리 API

(주문형-네이버페이) 네이버페이 상품주문들을 발주처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 발주처리할 수 있습니다. 시도된 상품주문 중 발주처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
네이버페이 상품주문번호
(Optional)

Response

200

모든 상품주문 발주처리 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 발주처리성공 & 일부주문 발주처리실패포트원에서 네이버페이에 발주처리 요청시 product_order_id 개별로 발주요청이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 발주처리실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/request-return

(주문형-네이버페이) 상품반품요청 API

(주문형-네이버페이) 네이버페이 상품주문들을 반품요청합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 반품요청할 수 있습니다. 시도된 상품주문 중 반품요청에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
네이버페이 상품주문번호
(Optional)
reason?: string
반품사유코드
(Optional)
delivery_method: string
배송방법 코드
delivery_company?: string
택배사 코드
(Optional)
tracking_number?: string
송장번호
(Optional)

Response

200

모든 상품주문 반품요청 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 반품요청성공 & 일부주문 반품요청실패 포트원에서 네이버페이에 반품요청시 product_order_id 개별로 반품요청이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

400

delivery_method 파라메터가 누락되거나 올바르지 않은 경우

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 반품요청실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/approve-return

(주문형-네이버페이) 상품 반품승인 처리 API

(주문형-네이버페이) 네이버페이 상품주문들을 반품승인처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 반품승인 처리할 수 있습니다. 반품시 배송비 제외, 혹은 추가 청구액이 필요한 경우 반품보류 처리(POST 반품요청상품 반품보류 처리 API) 사용합니다.
시도된 상품주문 중 반품승인 처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
네이버페이 상품주문번호
(Optional)
memo?: string
메모
(Optional)

Response

200

모든 상품주문 반품승인 처리 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 반품승인 처리성공 & 일부주문 반품승인 처리실패 포트원에서 네이버페이에 반품승인 처리시 product_order_id 개별로 반품승인 처리이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 반품승인 처리실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/reject-return

(주문형-네이버페이) 상품 반품거절 처리 API

(주문형-네이버페이) 네이버페이 반품요청 상품주문들을 반품거절처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 반품거절 처리할 수 있습니다. 시도된 상품주문 중 반품거절 처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
네이버페이 상품주문번호
(Optional)
memo: string
메모

Response

200

모든 상품주문 반품거절 처리 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 반품거절 처리성공 & 일부주문 반품거절 처리실패 포트원에서 네이버페이에 반품거절 처리시 product_order_id 개별로 반품거절 처리이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

400

memo 파라미터가 누락되거나 올바르지 않은 경우

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 반품거절 처리실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/withhold-return

(주문형-네이버페이) 상품 반품보류 처리 API

(주문형-네이버페이) 반품요청 상품주문들을 반품보류처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 반품보류 처리할 수 있습니다. 시도된 상품주문 중 반품보류 처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
네이버페이 상품주문번호
(Optional)
reason?: string
반품보류사유 코드
(Optional)
memo: string
메모
extra_charge?: integer
기타 비용 청구액
(Optional)

Response

200

모든 상품주문 반품보류 처리 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 반품보류 처리성공 & 일부주문 반품보류 처리실패 포트원에서 네이버페이에 반품보류 처리시 product_order_id 개별로 반품보류 처리이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

400

memo 파라미터가 누락되거나 올바르지 않은 경우

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 반품보류 처리실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/resolve-return

(주문형-네이버페이) 반품보류상품 반품보류해제 처리 API

(주문형-네이버페이) 반품보류 상품주문들을 반품보류해제처리합니다.
주문상품의 종류가 여러 개인 경우, 한 건의 포트원 거래건(imp_uid)에 여러 개의 네이버페이 상품주문이 존재하며 일부 또는 전체를 반품보류해제 처리할 수 있습니다. 시도된 상품주문 중 반품보류해제 처리에 성공한 상품주문에 대한 최종 정보만 제공됩니다.

Request

Path

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

Body

product_order_id?: string[]
네이버페이 상품주문번호
(Optional)

Response

200

모든 상품주문 반품보류해제 처리 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

207

일부 상품주문 반품보류해제 처리성공 & 일부주문 반품보류해제 처리실패 포트원에서 네이버페이에 반품보류해제 처리시 product_order_id 개별로 반품보류해제 처리이 진행되어야 합니다. 일부 건만 성공하는 경우 207 응답이 내려갑니다. (모두 성공인 경우 200응답 / 모두 실패인 경우 500응답)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

모든 상품주문 반품보류해제 처리실패

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/point

(결제형-네이버페이) 네이버페이 포인트 적립 API

(결제형-네이버페이) 네이버페이 포인트 적립 API

Request

Path

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

Response

200

네이버페이 포인트 적립 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

네이버페이 포인트 적립 실패. 응답 BODY의 message 확인 필요

try
Request
Request Sample
N/A
post/payments/{imp_uid}/naver/confirm

(결제형-네이버페이) 에스크로 주문 확정 API

(결제형-네이버페이) 에스크로 주문 확정

Request

Path

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

Body

requester?: string
구매확정 요청자
(Optional)

Response

200

네이버페이 구매확정 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

500

네이버페이 구매확정 실패. 응답 BODY의 message 확인 필요

try
Request
Request Sample
N/A
get/payments/{imp_uid}/naver/product-orders

(주문형-네이버페이) 포트원 거래고유번호 기준 네이버페이 상품주문 조회 API

(주문형-네이버페이) 포트원 거래번호 기준으로 네이버페이 상품주문 목록을 조회합니다. (배열 반환)

네이버페이의 경우 주문하는 상품의 종류별로 주문번호(product_order_id)를 관리합니다. 포트원 거래건 당 1개 이상의 네이버페이 상품주문이 연결되므로, 포트원 거래고유번호(imp_uid)에 매핑된 1개 이상의 네이버페이 상품주문번호(product_order_id) 및 상세 내역을 조회할 수 있습니다.

응답 안내

product_order_status

  • PAYMENT_WAITING : 입금 대기
  • PAYED : 결제 완료
  • DELIVERING : 배송 중
  • DELIVERED : 배송 완료
  • PURCHASE_DECIDED : 구매 확정
  • EXCHANGED : 교환 완료
  • CANCELED : 취소 완료
  • RETURNED : 반품 완료
  • CANCELED_BY_NOPAYMENT : 미입금 취소

claim_type

  • CANCEL : 취소
  • RETURN : 반품
  • EXCHANGE : 교환
  • PURCHASE_DECISION_HOLDBACK : 구매 확정 보류
  • ADMIN_CANCEL : 직권 취소

claim_status

[ claim_type : CANCEL 일 때 ]

  • CANCEL_REQUEST : 취소 요청
  • CANCELING : 취소 처리 중
  • CANCEL_DONE : 취소 처리 완료
  • CANCEL_REJECT : 취소 철회

[ claim_type : RETURN 일 때 ]

  • RETURN_REQUEST : 반품 요청
  • COLLECTING : 수거 처리 중
  • COLLECT_DONE : 수거 완료
  • RETURN_DONE : 반품 완료
  • RETURN_REJECT : 반품 철회

[ claim_type : EXCHANGE 일 때 ]

  • EXCHANGE_REQUEST : 교환 요청
  • COLLECTING : 수거 처리 중
  • COLLECT_DONE : 수거 완료(교환)
  • EXCHANGE_REDELIVERING : 교환 재배송 중
  • EXCHANGE_DONE : 교환 완료
  • EXCHANGE_REJECT : 교환 거부

[ claim_type : PURCHASE_DECISION_HOLDBACK 일 때 ]

  • PURCHASE_DECISION_HOLDBACK : 구매 확정 보류
  • PURCHASE_DECISION_HOLDBACK_REDELIVERING : 구매 확정 보류 재배송 중
  • PURCHASE_DECISION_REQUEST : 구매 확정 요청
  • PURCHASE_DECISION_HOLDBACK_RELEASE : 구매 확정 보류 해제

[ claim_type : ADMIN_CANCEL 일 때 ]

  • ADMIN_CANCELING : 직권 취소 중
  • ADMIN_CANCEL_DONE : 직권 취소 완료

Request

Path

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

Response

200

네이버페이 상품주문 조회 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)
delivery_amount?: integer
상품 배송비
(Optional)
quantity: integer
상품 수량
orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)
shipping_due?: integer
배송기한
(Optional)
individual_code?: string
개인통관고유부호
(Optional)

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우

try
Request
Request Sample
N/A
get/naver/product-orders/{product_order_id}

(주문형-네이버페이) 네이버페이 상품주문번호로 상품주문 상세 조회 API

(주문형-네이버페이) 네이버페이 상품주문번호 기준 네이버페이 상품주문을 조회합니다. (단건 반환)

네이버페이 상품주문번호(product_order_id)를 통해 해당되는 상품주문정보 단건을 조회할 수 있습니다.

product_order_status

  • PAYMENT_WAITING : 입금 대기
  • PAYED : 결제 완료
  • DELIVERING : 배송 중
  • DELIVERED : 배송 완료
  • PURCHASE_DECIDED : 구매 확정
  • EXCHANGED : 교환 완료
  • CANCELED : 취소 완료
  • RETURNED : 반품 완료
  • CANCELED_BY_NOPAYMENT : 미입금 취소

claim_type

  • CANCEL : 취소
  • RETURN : 반품
  • EXCHANGE : 교환
  • PURCHASE_DECISION_HOLDBACK : 구매 확정 보류
  • ADMIN_CANCEL : 직권 취소

claim_status

[ claim_type : CANCEL 일 때 ]

  • CANCEL_REQUEST : 취소 요청
  • CANCELING : 취소 처리 중
  • CANCEL_DONE : 취소 처리 완료
  • CANCEL_REJECT : 취소 철회

[ claim_type : RETURN 일 때 ]

  • RETURN_REQUEST : 반품 요청
  • COLLECTING : 수거 처리 중
  • COLLECT_DONE : 수거 완료
  • RETURN_DONE : 반품 완료
  • RETURN_REJECT : 반품 철회

[ claim_type : EXCHANGE 일 때 ]

  • EXCHANGE_REQUEST : 교환 요청
  • COLLECTING : 수거 처리 중
  • COLLECT_DONE : 수거 완료(교환)
  • EXCHANGE_REDELIVERING : 교환 재배송 중
  • EXCHANGE_DONE : 교환 완료
  • EXCHANGE_REJECT : 교환 거부

[ claim_type : PURCHASE_DECISION_HOLDBACK 일 때 ]

  • PURCHASE_DECISION_HOLDBACK : 구매 확정 보류
  • PURCHASE_DECISION_HOLDBACK_REDELIVERING : 구매 확정 보류 재배송 중
  • PURCHASE_DECISION_REQUEST : 구매 확정 요청
  • PURCHASE_DECISION_HOLDBACK_RELEASE : 구매 확정 보류 해제

[ claim_type : ADMIN_CANCEL 일 때 ]

  • ADMIN_CANCELING : 직권 취소 중
  • ADMIN_CANCEL_DONE : 직권 취소 완료

Request

Path

product_order_id: string
네이버페이 상품주문번호

Response

200

네이버페이 상품주문 조회 성공

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
product_order_id: string
상품주문번호
product_order_status: string
상품주문상태
claim_type?: string
클레임 타입
(Optional)
claim_status?: string
클레임 처리 상태
(Optional)
product_id: string
상품 고유 번호
product_name: string
상품명
product_option_id: string
상품 옵션 번호
product_option_name: string
상품옵션명
product_amount?: integer
상품금액
(Optional)