개발자센터
V1
V2
API & SDK
릴리즈 노트 기술 블로그

PortOne REST API - V1

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

V1 API hostname: api.iamport.kr

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

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

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

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

Request

Path

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

네이버페이 환불할 거래건의 포트원 거래고유번호

Body

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

네이버페이 환불할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 환불합니다.

reason?: string
취소 사유 코드
(Optional)

취소 사유 코드로 올바르지 않은 코드인 경우 기본값(PRODUCT_UNSATISFIED)을 적용합니다.

Response

200

모든주문환불성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

401

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

404

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

500

모든주문 환불실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/approve-cancel

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

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

Request

Path

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

네이버페이 환불승인할 거래건의 포트원 거래고유번호

Body

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

환불승인할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 환불승인합니다.

Response

200

주문환불승인성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

401

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

404

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

500

모든주문 환불승인실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/ship

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

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

Request

Path

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

네이버페이 발송처리할 거래건의 포트원 거래고유번호

Body

product_order_id?: string[]
발송처리할 거래건의 네이버페이 상품주문번호
(Optional)

발송처리할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 발송처리합니다.

delivery_method: string
배송방법 코드

배송방법을 나타내는 코드

dispatched_at: integer
발송일

발송일 (unix timestamp)

delivery_company?: string
택배사 코드
(Optional)

택배사 코드(delivery_method == DELIVERY 인 경우 필수로 입력해야하는 파라메터)

tracking_number?: string
송장번호
(Optional)

송장번호(delivery_method == DELIVERY 인 경우 필수 파라미터)

Response

200

모든 상품주문 발송처리 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

400

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

401

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

404

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

500

모든 상품주문 발송처리실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/ship-exchanged

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

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

Request

Path

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

네이버페이 재발송처리할 거래건의 포트원 거래고유번호

Body

product_order_id?: string[]
재발송처리할 거래건의 네이버페이 상품주문번호
(Optional)

재발송처리할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 재발송처리합니다.

delivery_method: string
배송방법 코드

배송방법을 나타내는 코드

delivery_company?: string
택배사 코드
(Optional)

택배사 코드(delivery_method == DELIVERY 인 경우 필수로 입력해야하는 파라메터)

tracking_number?: string
송장번호
(Optional)

송장번호(delivery_method == DELIVERY 인 경우 필수로 입력해야하는 파라메터)

Response

200

모든 상품주문 재발송처리 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

400

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

401

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

404

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

500

모든 상품주문 재발송처리실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/collect-exchanged

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

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

Request

Path

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

네이버페이 수거완료처리 할 거래건의 포트원 거래고유번호

Body

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

수거완료처리 할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 수거완료처리합니다.

Response

200

모든 상품주문 수거완료처리 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

401

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

404

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

500

모든 상품주문 수거완료처리실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/place

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

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

Request

Path

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

네이버페이 발주처리할 거래건의 포트원 거래고유번호

Body

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

네이버페이 발주처리할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 발주처리합니다.

Response

200

모든 상품주문 발주처리 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

401

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

404

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

500

모든 상품주문 발주처리실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/request-return

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

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

Request

Path

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

네이버페이 반품요청할 거래건의 포트원 거래고유번호

Body

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

반품요청할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 반품요청합니다.

reason?: string
반품사유코드
(Optional)

반품사유코드로 올바르지 않은 사유코드인 경우 기본값(INTENT_CHANGED)을 적용합니다.

delivery_method: string
배송방법 코드

반품 배송방법 코드

delivery_company?: string
택배사 코드
(Optional)

택배사 코드(delivery_method == RETURN_DELIVERY 인 경우 필수로 입력해야하는 파라메터)

tracking_number?: string
송장번호
(Optional)

송장번호(delivery_method == RETURN_DELIVERY 인 경우 필수로 입력해야하는 파라메터)

Response

200

모든 상품주문 반품요청 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

400

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

401

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

404

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

500

모든 상품주문 반품요청실패
try
Request
Response Status: N/A
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)

반품승인 처리할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 반품승인 처리합니다.

memo?: string
메모
(Optional)

반품승인 후 구매자에게 전달하는 메모

Response

200

모든 상품주문 반품승인 처리 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

401

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

404

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

500

모든 상품주문 반품승인 처리실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/reject-return

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

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

Request

Path

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

네이버페이 반품거절 처리할 거래건의 포트원 거래고유번호

Body

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

네이버페이 반품거절 처리할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 반품거절 처리합니다.

memo: string
메모

반품거절 후 구매자에게 전달하는 메모

Response

200

모든 상품주문 반품거절 처리 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

400

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

401

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

404

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

500

모든 상품주문 반품거절 처리실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/withhold-return

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

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

Request

Path

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

네이버페이 반품보류 처리할 거래건의 포트원 거래고유번호

Body

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

반품보류 처리할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 반품보류 처리합니다.

reason?: string
반품보류사유 코드
(Optional)

반품보류사유 코드로 올바르지 않은 보류사유코드인 경우 기본값(ETC)를 적용합니다.

memo: string
메모

반품보류에 대하여 구매자에게 전달하는 메모

extra_charge?: integer
기타 비용 청구액
(Optional)

기타 비용 청구액으로 기본값은 0원입니다.

Response

200

모든 상품주문 반품보류 처리 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

400

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

401

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

404

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

500

모든 상품주문 반품보류 처리실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/resolve-return

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

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

Request

Path

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

네이버페이 반품보류해제 처리할 거래건의 포트원 거래고유번호

Body

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

반품보류해제 처리할 거래건의 네이버페이 상품주문번호로 생략되면 imp_uid 에 해당되는 모든 상품주문을 반품보류해제 처리합니다.

Response

200

모든 상품주문 반품보류해제 처리 성공
code?: integer
응답코드
(Optional)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

207

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

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

401

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

404

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

500

모든 상품주문 반품보류해제 처리실패
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/point

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

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

Request

Path

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

네이버페이 포인트 적립할 거래건의 포트원 거래고유번호

Response

200

네이버페이 포인트 적립 성공
code?: integer
응답코드
(Optional)

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

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

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

401

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

404

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

500

네이버페이 포인트 적립 실패. 응답 BODY의 message 확인 필요
try
Request
Response Status: N/A
N/A
post/payments/{imp_uid}/naver/confirm

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

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

Request

Path

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

네이버페이 구매확정할 거래건의 포트원 거래고유번호

Body

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

구매확정 요청자 (admin : 가맹점 관리자 (기본값), customer : 구매자)

Response

200

네이버페이 구매확정 성공
code?: integer
응답코드
(Optional)

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

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

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

401

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

404

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

500

네이버페이 구매확정 실패. 응답 BODY의 message 확인 필요
try
Request
Response Status: N/A
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)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

401

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

404

imp_uid에 해당되는 거래건을 찾을 수 없거나 접근 권한이 없는 계정인 경우
try
Request
Response Status: N/A
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)

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

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

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

(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)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

400

요청 파라메터에 product_order_id 가 누락된 경우

401

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

404

product_order_id에 해당되는 네이버 상품주문을 찾을 수 없거나 접근 권한이 없는 계정인 경우
try
Request
Response Status: N/A
N/A
get/naver/reviews

(주문형-네이버페이) 네이버페이 구매평 조회 API

(주문형-네이버페이) 네이버페이 구매평 조회 API

Request

Query

from: integer
조회기간 시작

조회기간 시작 unix timestamp

to: integer
조회기간 종료

조회기간 종료 unix timestamp

review_type: string
구매평 유형

조회할 구매평의 유형

Response

200

네이버페이 상품주문 조회 성공
code?: integer
응답코드
(Optional)

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

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

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

(Optional)
review_id: string
구매평 고유 ID

네이버페이 구매평 고유 ID

score: string
구매 만족도
  • 일반 구매평 : 불만족 (0), 보통 (1), 만족 (2)
  • 프리미엄 구매평 : 추천 안 함(10), 보통(11), 추천(12), 적극추천(13)
title: string
구매평 내용 or 제목

네이버페이 일반 구매평 내용 또는 프리미엄 구매평 제목

content?: string
구매평 내용
(Optional)

네이버페이 프리미엄 구매평 내용으로 일반 구매평인 경우 없습니다.

product_order_id: string
상품 주문 번호

네이버페이 상품 주문 번호

product_id: string
상품 고유 번호

네이버페이 상품의 고유 번호

product_name: string
상품명

네이버페이 상품명

product_option_name?: string
상품 옵션
(Optional)

네이버페이 상품 옵션(옵션명)

writer: string
구매평 작성자 아이디

암호화된 네이버페이 구매평 작성자 아이디

created_at: integer
작성시각

네이버페이 구매평 작성시각 UNIX timestamp

modified_at?: integer
수정시각
(Optional)

네이버페이 구매평 수정시각 UNIX timestamp

400

요청 파라메터에 from, to, review_type 가 누락되거나 올바르지 않은 경우

401

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

500

네이버페이 구매평 조회시 네이버응답이 올바르지 않은 경우
try
Request
Response Status: N/A
N/A
get/payments/{imp_uid}/naver/cash-amount

(결제형-네이버페이) 현금영수증 발급 가용액 조회 API

(결제형-네이버페이) 현금영수증 발급 가용액 조회 API

Request

Path

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

네이버페이 현금영수증 발급가능 금액 조회를 위한 포트원 거래 고유번호

Response

200

네이버페이 현금영수증 발급가능 금액 조회 성공
code?: integer
응답코드
(Optional)

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

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

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

(Optional)
amount_total: integer
총액

현금영수증 발급 가능한 총액

amount_by_npoint: integer
포인트 금액

현금영수증 발급가능한 총액 중 Npoint에 의한 금액

amount_by_primary: integer
메인 결제수단 금액

현금영수증 발급 가능한 총액 중 주 결제수단(신용카드, 계좌이체 등)에 의한 금액

amount_supply: integer
공급가액

현금영수증 발급 가능한 총액 중 공급가액

amount_vat: integer
부가세

현금영수증 발급 가능한 총액 중 부가세

400

네이버페이 결제형 거래가 아닌 건에 대해 요청하는 경우

401

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

500

네이버페이 현금영수증 발급가능 금액 조회시 네이버응답이 올바르지 않은 경우
try
Request
Response Status: N/A
N/A

페이코 관련 API

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

페이먼트월 관련 API

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

본인인증 관련 API

본인인증 요청 및 결과 조회와 관련된 기능을 제공합니다.

현금영수증 관련 API

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

에스크로 관련 API

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

가맹점 정보 관련 API

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

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

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

하위 상점 관련 API

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

기타 API

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

베네피아 포인트 관련 API

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

결제기관 관련 API

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

편의점 결제 관련 API

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

타입 정의

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