개발자센터

PortOne REST API - V1

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

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

V1 API hostname: api.iamport.kr

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


하위호환성

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

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

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

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

      • 오로지 선택 입력 정보만 추가될 수 있습니다.
    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
    • enum 타입의 값이 삭제되지 않습니다.

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

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

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

      • 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
      • 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.
    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.

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

      • 알지 못하는 필드 및 값이 주어지더라도 crash가 발생하지 않도록 유의하여 개발해주세요.
      • 새로운 필드 및 값이 추가되는 경우 사전 공지를 통해 안내드립니다.

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

인증 관련 API

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

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

결제 관련 API

결제 건과 관련된 기능을 제공합니다.

결제 금액 사전 등록 관련 API

사전 등록하는 결제금액과 관련된 기능을 제공합니다.

비인증 결제 관련 API

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

정기 결제 관련 API

비인증 결제 중 정기 결제를 관리하는 기능을 제공합니다.
get/subscribe/payments/schedule

결제예약 복수조회 API

기간범위를 지정하여 결제예약목록을 조회할 수 있습니다. 결제예약정보가 (페이징된)목록으로 전달되며, 최대 3개월 단위로 조회가 가능합니다.

Request

Query

schedule_from: integer
조회 시작시각
schedule_to: integer
조회 종료시각
schedule_status?: string
예약상태
(Optional)
page?: integer
조회목록 페이징
(Optional)
limit?: integer
페이지당 조회건수
(Optional)
sorting?: string
정렬방식
(Optional)

Response

200

결제예약목록 조회완료

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
imp_uid?: string
포트원 거래고유번호
(Optional)

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

customer_id?: string
구매자 ID
(Optional)
schedule_at?: integer
결제 예정 시각
(Optional)
executed_at?: integer
결제 실행 시각
(Optional)
revoked_at?: integer
결제 실행 철회 시각
(Optional)
amount?: number
결제금액
(Optional)
currency?: string
결제 통화 코드
(Optional)
name?: string
제품명
(Optional)
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
schedule_status?: string
예약상태
(Optional)
payment_status?: string
결제상태
(Optional)
fail_reason?: string
실패사유
(Optional)
promotion_id?: string
프로모션 아이디
(Optional)

400

검색 파라메터가 유효하지 않은 경우

401

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

try
Request
Request Sample
N/A
post/subscribe/payments/schedule

결제 예약 API

customer__uid를 이용하여 비인증 결제 요청을 예약할 수 있는 API입니다.
비 인증 결제(빌링키) API를 포트원이 대신 수행하는 개념)
결제 요청에 대한 결과는 notice_url에 설정한 EndPoint URL로 웹훅을 통해 수신(POST request)받을 수 있습니다.

  • 기존에 빌링키가 등록된 customer_uid가 존재하는 경우 해당 customer_uid와 해당되는 빌링키로 schedule정보가 예약됩니다.(카드정보 선택사항)
  • 등록된 customer_uid가 없는 경우 빌링키 신규 발급을 먼저 진행한 후 schedule정보를 예약합니다.(카드정보 필수사항)
  • 예약건 별로 고유의 merchant_uid를 전달해주셔야 합니다.
  • schedules의 상세정보(선택정보) buyer_name, buyer_email, buyer_tel, buyer_addr, buyer_postcode 누락시,
    customer_uid에 해당되는 customer_name, customer_email, customer_tel, customer_addr, customer_postcode 정보로 대체됩니다.(둘 다 입력시 buyer_* 정보를 우선합니다)

Request

Body

customer_uid: string
구매자의 결제 수단 식별 고유번호
customer_id?: string
구매자 ID
(Optional)
checking_amount?: integer
유효카드 체크 승인금액
(Optional)

결제 예약을 위해 카드정상결제여부를 체크하는 승인 금액

card_number?: string
카드번호
(Optional)
expiry?: string
카드 유효기간
(Optional)
birth?: string
생년월일 6자리
(Optional)
pwd_2digit?: string
카드비밀번호 앞 2자리
(Optional)
cvc?: string
카드 인증번호
(Optional)
pg?: string
pg 구분코드
(Optional)

결제 예약을 요청할 PG사 구분코드

schedules: ScheduleAnnotation[]
결제예약 스케쥴
merchant_uid: string
고객사의 주문번호
schedule_at: integer
예약시각
currency: string
결제 통화 코드
amount: number
결제금액
tax_free?: number
면세공급가액
(Optional)
vat_amount?: number
부가세
(Optional)
name: string
제품명
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
notice_url?: string
Notification URL(Webhook URL)
(Optional)

예약된 결제가 수행된 후 웹훅(Notification)이 발송될 URL을 직접 지정

product_type?: string
주문 상품구분
(Optional)
cash_receipt_type?: string
현금영수증 발행대상
(Optional)
card_quota?: number
카드 할부 개월 수
(Optional)
interest_free_by_merchant?: boolean
상점분담 무이자 할부여부
(Optional)

카드 할부이자를 고객사에서 부담하는 지 여부

use_card_point?: boolean
카드포인트 사용여부
(Optional)

승인요청시 카드사 포인트 차감하며 결제승인처리할지 여부

product_count?: integer
결제 상품의 개수
(Optional)
extra?: object
추가 파라미터
(Optional)
bypass?: string
bypass 데이터
(Optional)

JSON string 형식의 PG사별로 특화된 파라미터

promotion_id?: string
프로모션 아이디
(Optional)

Response

200

정상적으로 예약 등록이 완료되었습니다

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
imp_uid?: string
포트원 거래고유번호
(Optional)

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

customer_id?: string
구매자 ID
(Optional)
schedule_at?: integer
결제 예정 시각
(Optional)
executed_at?: integer
결제 실행 시각
(Optional)
revoked_at?: integer
결제 실행 철회 시각
(Optional)
amount?: number
결제금액
(Optional)
currency?: string
결제 통화 코드
(Optional)
name?: string
제품명
(Optional)
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
schedule_status?: string
예약상태
(Optional)
payment_status?: string
결제상태
(Optional)
fail_reason?: string
실패사유
(Optional)
promotion_id?: string
프로모션 아이디
(Optional)

401

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

try
Request
Request Sample
N/A
post/subscribe/payments/unschedule

결제 예약취소 API

예약된 결제가 실행되기전에 해당 예약을 취소할 수 있는 API입니다.

Request

Body

customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)

결제 예약 취소할 결제건의 고객사 거래 고유번호

Response

200

정상적으로 예약 취소가 완료되었습니다

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
imp_uid?: string
포트원 거래고유번호
(Optional)

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

customer_id?: string
구매자 ID
(Optional)
schedule_at?: integer
결제 예정 시각
(Optional)
executed_at?: integer
결제 실행 시각
(Optional)
revoked_at?: integer
결제 실행 철회 시각
(Optional)
amount?: number
결제금액
(Optional)
currency?: string
결제 통화 코드
(Optional)
name?: string
제품명
(Optional)
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
schedule_status?: string
예약상태
(Optional)
payment_status?: string
결제상태
(Optional)
fail_reason?: string
실패사유
(Optional)
promotion_id?: string
프로모션 아이디
(Optional)

401

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

try
Request
Request Sample
N/A
get/subscribe/payments/schedule/{merchant_uid}

결제예약 단건조회 API

예약 거래주문번호(merchant_uid)로 결제예약정보를 조회할 수 있습니다. 결제예약 등록시 사용된 merchant_uid로 예약 상태 등 정보를 조회할 수 있습니다.

Request

Path

merchant_uid: string
고객사 주문번호

Response

200

정상적으로 예약 취소가 완료되었습니다

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
imp_uid?: string
포트원 거래고유번호
(Optional)

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

customer_id?: string
구매자 ID
(Optional)
schedule_at?: integer
결제 예정 시각
(Optional)
executed_at?: integer
결제 실행 시각
(Optional)
revoked_at?: integer
결제 실행 철회 시각
(Optional)
amount?: number
결제금액
(Optional)
currency?: string
결제 통화 코드
(Optional)
name?: string
제품명
(Optional)
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
schedule_status?: string
예약상태
(Optional)
payment_status?: string
결제상태
(Optional)
fail_reason?: string
실패사유
(Optional)
promotion_id?: string
프로모션 아이디
(Optional)

401

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

404

merchant_uid로 조회되는 예약결제건이 존재하지 않는 경우

try
Request
Request Sample
N/A
put/subscribe/payments/schedule/{merchant_uid}

결제요청 예약시각 수정 API

결제예약 시 사용한 거래주문번호(merchant_uid)를 이용하여 해당하는 예약 건의 결제요청 예약시각을 수정할 수 있습니다.

Request

Path

merchant_uid: string
고객사 주문번호

Body

schedule_at: integer
수정할 예약시각

Response

200

정상적으로 예약 변경이 완료되었습니다.

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
imp_uid?: string
포트원 거래고유번호
(Optional)

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

customer_id?: string
구매자 ID
(Optional)
schedule_at?: integer
결제 예정 시각
(Optional)
executed_at?: integer
결제 실행 시각
(Optional)
revoked_at?: integer
결제 실행 철회 시각
(Optional)
amount?: number
결제금액
(Optional)
currency?: string
결제 통화 코드
(Optional)
name?: string
제품명
(Optional)
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
schedule_status?: string
예약상태
(Optional)
payment_status?: string
결제상태
(Optional)
fail_reason?: string
실패사유
(Optional)
promotion_id?: string
프로모션 아이디
(Optional)

400

필수 파라미터 누락, 이미 실행 혹은 취소된 결제예약, 예약시각이 현재 시각보다 과거인 경우

404

존재하지 않는 결제예약

500

포트원 내부 이슈로 인한 API 호출 실패

try
Request
Request Sample
N/A
post/subscribe/payments/schedule/{merchant_uid}/reschedule

결제 실패 재예약 API

결제 예약 실행 시 실패했던 건, 혹은 예약 취소했던 건에 대해 다른 시각으로 다시 결제 예약을 할 수 있습니다.

Request

Path

merchant_uid: string
고객사 주문번호

Body

schedule_at: integer
예약 시각

Response

200

정상적으로 재예약이 완료되었습니다.

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
imp_uid?: string
포트원 거래고유번호
(Optional)

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

customer_id?: string
구매자 ID
(Optional)
schedule_at?: integer
결제 예정 시각
(Optional)
executed_at?: integer
결제 실행 시각
(Optional)
revoked_at?: integer
결제 실행 철회 시각
(Optional)
amount?: number
결제금액
(Optional)
currency?: string
결제 통화 코드
(Optional)
name?: string
제품명
(Optional)
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
schedule_status?: string
예약상태
(Optional)
payment_status?: string
결제상태
(Optional)
fail_reason?: string
실패사유
(Optional)
promotion_id?: string
프로모션 아이디
(Optional)

400

필수 파라미터 누락, 아직 실행되지 않거나 이미 실행 중 혹은 승인된 결제예약, 예약시각이 현재 시각보다 과거인 경우

404

존재하지 않는 결제예약

500

포트원 내부 이슈로 인한 API 호출 실패

try
Request
Request Sample
N/A
post/subscribe/payments/schedule/{merchant_uid}/retry

결제 실패 재시도 API

결제 예약 실행 시 실패했던 건, 혹은 예약 취소했던 건을 즉시 결제 재시도 할 수 있습니다.

Request

Path

merchant_uid: string
고객사 주문번호

Response

200

정상적으로 재시도가 완료되었습니다. (결제 성공/실패 여부는 결제 상태(status)로 확인 필요)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
response?: PaymentAnnotation
(Optional)
imp_uid: string
포트원 거래고유번호
merchant_uid: string
고객사 주문번호
pay_method?: string
결제수단 구분코드
(Optional)
channel?: string
결제환경 구분코드
(Optional)
pg_provider?: string
PG사 구분코드
(Optional)
emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)
pg_tid?: string
PG사 거래번호
(Optional)
pg_id?: string
PG사 상점아이디
(Optional)
escrow?: boolean
에스크로결제 여부
(Optional)
apply_num?: string
승인번호
(Optional)
bank_code?: string
은행 표준코드
(Optional)
bank_name?: string
은행명
(Optional)
card_code?: string
카드사 코드번호
(Optional)
card_name?: string
카드사명
(Optional)
card_issuer_code?: string
카드 발급사 코드
(Optional)
card_issuer_name?: string
카드 발급사명
(Optional)
card_publisher_code?: string
카드 발행사 코드
(Optional)
card_publisher_name?: string
카드 발행사명
(Optional)
card_quota?: integer
할부개월 수
(Optional)
card_number?: string
카드번호
(Optional)

결제에 사용된 마스킹된 카드번호

card_type?: integer
카드 구분코드
(Optional)

결제건에 사용된 카드 구분코드

vbank_code?: string
가상계좌 은행 표준코드
(Optional)
vbank_name?: string
가상계좌 은행명
(Optional)
vbank_num?: string
가상계좌 계좌번호
(Optional)
vbank_holder?: string
가상계좌 예금주
(Optional)
vbank_date?: integer
가상계좌 입금기한
(Optional)
vbank_issued_at?: integer
가상계좌 생성시각
(Optional)
name?: string
제품명
(Optional)
amount: number
결제금액
cancel_amount: number
취소금액
currency: string
결제통화 구분코드
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
user_agent?: string
단말기의 UserAgent 문자열
(Optional)
status: string
결제상태
started_at?: integer
요청 시각
(Optional)
paid_at?: integer
결제 시각
(Optional)

결제건의 결제완료 시각 UNIX timestamp

failed_at?: integer
실패시각
(Optional)

결제건의 결제실패시각 UNIX timestamp

cancelled_at?: integer
취소시각
(Optional)

결제건의 결제취소시각 UNIX timestamp

fail_reason?: string
결제실패 사유
(Optional)

결제건의 결제실패 사유

cancel_reason?: string
결제취소 사유
(Optional)

결제건의 결제취소 사유

receipt_url?: string
매출전표 URL
(Optional)
cancel_history?: PaymentCancelAnnotation[]
취소 내역
(Optional)
cancel_receipt_urls?: string[]
(Optional)

(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨

cash_receipt_issued?: boolean
현금영수증 발급 여부
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
customer_uid_usage?: string
구매자의 결제 수단 식별 고유번호 사용 구분코드
(Optional)
promotion?: object
프로모션 정보
(Optional)

400

필수 파라미터 누락, 아직 실행되지 않거나 이미 실행중 혹은 승인된 결제예약

404

존재하지 않는 결제예약 혹은 빌링키

500

미지원 PG사, 포트원 내부 이슈 등으로 인한 API 호출 실패

try
Request
Request Sample
N/A
get/subscribe/payments/schedule/customers/{customer_uid}

결제예약 복수조회(빌링키) API

빌링키 결제예약 조회 API 와 동일한 동작을 하는 API입니다.

customer_uid별 결제예약목록을 조회할 수 있습니다. 결제예약정보가 (페이징된)목록으로 전달되며, 최대 3개월 단위로 조회가 가능합니다.

결제예약정보가 예약된 시각 기준으로 최신순으로 정렬되어 전달됩니다.

Request

Path

customer_uid: string
빌링키

Query

page?: integer
조회목록 페이징
(Optional)
from: integer
조회 시작시각
to: integer
조회 종료시각
schedule-status?: string
예약상태
(Optional)

Response

200

결제예약목록 조회완료

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
imp_uid?: string
포트원 거래고유번호
(Optional)

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

customer_id?: string
구매자 ID
(Optional)
schedule_at?: integer
결제 예정 시각
(Optional)
executed_at?: integer
결제 실행 시각
(Optional)
revoked_at?: integer
결제 실행 철회 시각
(Optional)
amount?: number
결제금액
(Optional)
currency?: string
결제 통화 코드
(Optional)
name?: string
제품명
(Optional)
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
schedule_status?: string
예약상태
(Optional)
payment_status?: string
결제상태
(Optional)
fail_reason?: string
실패사유
(Optional)
promotion_id?: string
프로모션 아이디
(Optional)

400

검색 파라메터가 유효하지 않은 경우

401

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

try
Request
Request Sample
N/A

빌링키 관련 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 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AuthAnnotationAuthResponseBenepiaPointAnnotationBenepiaPointResponseCertificationAnnotationCertificationOTPAnnotationCertificationOTPResponseCertificationResponseCustomerAnnotationCustomerResponseEscrowLogisAnnotationEscrowLogisInfoAnnotationEscrowLogisProductsAnnotationEscrowLogisReceiverAnnotationEscrowLogisResponseEscrowLogisSenderAnnotationExternalReceiptAnnotationExternalReceiptResponseKcpQuickMemberAnnotationKcpQuickMemberResponseMultipleCustomersResponseMultiplePaymentsResponseMultiplePgSettingResponseNaverAddressNaverCashAmountAnnotationNaverCashAmountResponseNaverOrdererNaverProductOrderAnnotationNaverProductOrderArrayResponseNaverProductOrderResponseNaverReviewAnnotationNaverReviewsResponsePagedPaymentAnnotationPartnerReceiptResponsePartnerReceiptResultAnnotationPartnerReceiptsAnnotationPaycoStatusAnnotationPaycoStatusResponsePaymentAnnotationPaymentBalanceAnnotationPaymentBalanceHistoriesAnnotationPaymentBalanceResponsePaymentBalanceResponseAnnotationPaymentCancelAnnotationPaymentListResponsePaymentPrepareAnnotationPaymentPrepareResponsePaymentResponsePaymentwallDeliveryAnnotationPaymentwallDeliveryDetailAnnotationPgSettingAnnotationReceiptAnnotationReceiptResponseResponseAnnotationScheduleAnnotationScheduleResponseScheduleResultAnnotationSingleScheduleResponseStandardCodeAnnotationStandardCodeListResponseStandardCodeResponseSubscribePaymentExtraTierAnnotationTierResponseVbankHolderAnnotationVbankHolderResponse