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

관리자 콘솔 상점・계정 관리 화면 접속
내 식별코드・API Keys 버튼 클릭

API 키와 API 시크릿은 관리자 콘솔 → 상점・계정 관리 메뉴 → 내 식별코드・API Keys 모달을 열어서 확인하실 수 있습니다

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

액세스 토큰 발급 받기

access_token 발급 API post/users/getToken 호출

/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

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

페이먼트월 관련 API

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

본인인증 관련 API

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

현금영수증 관련 API

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

에스크로 관련 API

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

가맹점 정보 관련 API

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

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

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

하위 상점 관련 API

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

기타 API

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

베네피아 포인트 관련 API

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

포인트 단건조회 API

API를 통해 베네피아 포인트(복지포인트)조회합니다.
사용자로부터 베네피아 계정 아이디, 비밀번호를 전달받아 보유중인 베네피아 포인트를 조회할 수 있습니다.
KCP를 통해서만 진행되므로 KCP사이트코드 발급이 필요합니다.

Request

Body

benepia_user: string

계정 아이디

베네피아 계정 아이디

benepia_password: string

계정 비밀번호

베네피아 계정 비밀번호

pg?: string

PG 구분코드

(Optional)

사용하고자 하는 PG사 구분코드

Response

200

베네피아 포인트 조회 완료

code?: integer

응답코드

(Optional)

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

message?: string

응답메세지

(Optional)

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

response?: BenepiaPointAnnotation

(Optional)

point?: integer

포인트

(Optional)

베네피아 보유 포인트

401

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

500

베네피아 포인트 조회 실패

try

Request

Request Sample

N/A

post/benepia/payment

포인트 결제 요청 API

API를 통해 베네피아 포인트(복지포인트)사용 결제요청합니다.
사용자로부터 전달받은 베네피아 계정 아이디, 비밀번호와 함께 결제정보를 요청하여 베네피아 포인트 사용처리합니다.
KCP를 통해서만 진행되므로 KCP사이트코드 발급이 필요합니다.

Request

Body

benepia_user: string

계정 아이디

베네피아 계정 아이디

benepia_password: string

계정 비밀번호

베네피아 계정 비밀번호

merchant_uid: string

가맹점 주문번호

이미 결제가 이뤄진 적이 있는 merchant_uid로는 결제요청이 불가능합니다.

amount: number

결제요청금액

결제 요청하고자 하는 금액

name: string

주문명

buyer_name?: string

주문자명

(Optional)

주문자명

buyer_email?: string

주문자 Email 주소

(Optional)

주문자 Email주소

buyer_tel?: string

주문자 전화번호

(Optional)

주문자 전화번호

buyer_addr?: string

주문자 주소

(Optional)

주문자 주소

buyer_postcode?: string

주문자 우편번호

(Optional)

주문자 우편번호

pg?: string

PG 구분코드

(Optional)

사용하고자 하는 PG사 구분코드

notice_url?: array

Notification URL(Webhook URL)

(Optional)

웹훅을 수신하고자 하는 URL

custom_data?: string

추가정보

(Optional)

객체로 전달되는 경우 JSON 문자열로 저장

Response

200

베네피아 포인트 결제 완료

code?: integer

응답코드

(Optional)

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

message?: string

응답메세지

(Optional)

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

response?: PaymentAnnotation

(Optional)

imp_uid: string

포트원 거래고유번호

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

merchant_uid: string

가맹점 주문번호

결제건의 가맹점 주문번호

pay_method?: string

결제수단 구분코드

(Optional)

결제건의 결제수단을 구분하는 코드

channel?: string

결제환경 구분코드

(Optional)

결제건을 생성한 환경을 구분하는 코드

pg_provider?: string

PG사 구분코드

(Optional)

결제건의 PG사 구분코드

emb_pg_provider?: string

허브형결제 PG사 구분코드

(Optional)

허브형 결제인 경우 결제건의 허브형 결제 PG사를 구분하는 코드

pg_tid?: string

PG사 거래번호

(Optional)

결제건의 PG사 거래번호

pg_id?: string

PG사 상점아이디

(Optional)

결제건의 PG사 상점아이디

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)

결제건의 카드 발급사 코드번호 (금융결제원 표준코드 번호) - 카드 결제 건의 경우

발급사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- 토스페이먼츠 브랜드페이
- (신) 토스페이

card_issuer_name?: string

카드 발급사명

(Optional)

결제한 카드의 발급사명 - 카드 결제 건의 경우

발급사 코드를 지원하는 pg사에 한해 제공됩니다.

card_publisher_code?: string

카드 발행사 코드

(Optional)

결제건의 카드 발행사 코드번호(금융결제원 표준코드번호) - 카드 결제 건의 경우

발행사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET사
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- 토스페이먼츠 브랜드페이
- (신) 토스페이

card_publisher_name?: string

카드 발행사명

(Optional)

결제 한 카드의 발행사명 - (카드 결제 건의 경우)

발행사 코드를 지원하는 pg사에 한해 제공됩니다.

card_quota?: integer

할부개월 수

(Optional)

결제건의 할부개월 수(일시불은 0으로 표기) - 신용카드 결제 건의 경우

card_number?: string

카드번호

(Optional)

7~12번째 자리를 마스킹하는 것이 일반적이지만, PG사의 정책/설정에 따라 상이할 수 있습니다.

card_type?: integer

카드 구분코드

(Optional)

주의 : 해당 정보를 제공하지 않는 일부 PG사의 경우 null로 응답됩니다.(ex. JTNet, 이니시스-빌링)

0 : 신용카드
1 : 체크카드

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)

결제건의 가상계좌 생성시각 UNIX timestamp - 가상계좌 결제 건의 경우

name?: string

제품명

(Optional)

결제건의 제품명

amount: number

결제금액

결제건의 결제금액

cancel_amount: number

취소금액

결제건의 누적 취소금액

currency: string

결제통화 구분코드

외환분호 e.g) KRW, USD, VND, ... Default: KRW

buyer_name?: string

주문자명

(Optional)

결제건의 주문자명

buyer_email?: string

주문자 Email주소

(Optional)

결제건의 주문자의 Email주소

buyer_tel?: string

주문자 전화번호

(Optional)

결제건의 주문자 전화번호

buyer_addr?: string

주문자 주소

(Optional)

결제건의 주문자 주소

buyer_postcode?: string

주문자 우편번호

(Optional)

결제건의 주문자 우편번호

custom_data?: string

추가정보

(Optional)

결제 요청시 가맹점에서 전달한 추가정보 (JSON string으로 전달)

user_agent?: string

단말기의 UserAgent 문자열

(Optional)

구매자가 결제시 사용한 단말기의 UserAgent 문자열

status: string

결제상태

결제건의 결제상태

started_at?: integer

요청 시각

(Optional)

결제건의 결제요청 시각 UNIX timestamp

paid_at?: integer

결제 시각

(Optional)

결제상태가 결제완료(paid)가 아닌 경우 0으로 표시됩니다.

failed_at?: integer

실패시각

(Optional)

결제상태가 결제실패(failed)가 아닌경우 0으로 표시됩니다.

cancelled_at?: integer

취소시각

(Optional)

결제상태가 결제취소(cancelled)가 아닐 경우 0으로 표시됩니다.

fail_reason?: string

결제실패 사유

(Optional)

결제상태가 결제실패(failed)가 아닐 경우 null로 표시됩니다.

cancel_reason?: string

결제취소 사유

(Optional)

결제상태가 결제취소(cancelled)가 아닐 경우 null로 표시됩니다.

receipt_url?: string

매출전표 URL

(Optional)

결제건의 매출전표 URL로 PG사 또는 결제 수단에 따라 매출전표가 없을 수 있습니다.

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)

결제처리에 사용된 구매자의 결제 수단 식별 고유번호의 사용 구분코드

401

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

500

베네피아 포인트 결제 실패

try

Request

Request Sample

N/A

결제기관 관련 API

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

편의점 결제 관련 API

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

타입 정의

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

AuthAnnotation AuthResponse BenepiaPointAnnotation BenepiaPointResponse CertificationAnnotation CertificationOTPAnnotation CertificationOTPResponse CertificationResponse CustomerAnnotation CustomerResponse EscrowLogisAnnotation EscrowLogisInfoAnnotation EscrowLogisProductsAnnotation EscrowLogisReceiverAnnotation EscrowLogisResponse EscrowLogisSenderAnnotation ExternalReceiptAnnotation ExternalReceiptResponse KakaoOrderAnnotation KakaoOrderResponse KcpQuickMemberAnnotation KcpQuickMemberResponse MultipleCustomersResponse MultiplePaymentsResponse MultiplePgSettingResponse NaverAddress NaverCashAmountAnnotation NaverCashAmountResponse NaverOrderer NaverProductOrderAnnotation NaverProductOrderArrayResponse NaverProductOrderResponse NaverReviewAnnotation NaverReviewsResponse PagedPaymentAnnotation PartnerReceiptResponse PartnerReceiptResultAnnotation PartnerReceiptsAnnotation PaycoStatusAnnotation PaycoStatusResponse PaymentAnnotation PaymentBalanceAnnotation PaymentBalanceHistoriesAnnotation PaymentBalanceResponse PaymentBalanceResponseAnnotation PaymentCancelAnnotation PaymentListResponse PaymentPrepareAnnotation PaymentPrepareResponse PaymentResponse PaymentwallDeliveryAnnotation PaymentwallDeliveryDetailAnnotation PgSettingAnnotation ReceiptAnnotation ReceiptResponse ResponseAnnotation ScheduleAnnotation ScheduleResponse ScheduleResultAnnotation SingleScheduleResponse StandardCodeAnnotation StandardCodeListResponse StandardCodeResponse SubscribePaymentExtra TierAnnotation TierResponse VbankHolderAnnotation VbankHolderResponse

PortOne REST API - V1

인증 관련 API

목차

결제 관련 API

목차

결제 금액 사전 등록 관련 API

목차

비인증 결제 관련 API

목차

정기 결제 관련 API

목차

빌링키 관련 API

목차

가상계좌 관련 API

목차

PG사 관련 API

카카오 관련 API

목차

KCP 퀵페이 관련 API

목차

네이버페이 관련 API

목차

페이코 관련 API

목차

페이먼트월 관련 API

목차

본인인증 관련 API

목차

현금영수증 관련 API

목차

에스크로 관련 API

목차

가맹점 정보 관련 API

목차

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

목차

하위 상점 관련 API

목차

기타 API

베네피아 포인트 관련 API

목차

포인트 단건조회 API

Request

Body

Response

200

401

500

포인트 결제 요청 API

Request

Body

Response

200

401

500

결제기관 관련 API

목차

편의점 결제 관련 API

목차

타입 정의