PortOne REST API - V1
결제완료된 정보, 결제취소, 상태별 결제목록 조회 등의 기능을 하는 REST API를 제공합니다.
비인증 결제, 정기 자동결제 등 부가기능을 위한 REST API도 제공합니다.
2024년 9월 1일부로 포트원 V1 API에 대해 일부 보안 규격이 지원 종료됩니다.
자세한 사항은TLS 지원 범위를 참고해주세요.
자세한 사항은TLS 지원 범위를 참고해주세요.
V1 API hostname: api.iamport.kr
인증 관련 API
포트원 API를 호출할 때는 액세스 토큰을 Authorization 헤더에 넣어주어야 합니다.
액세스 토큰은 access_token 발급 API post/users/getToken를 호출해서 발급받을 수 있습니다.
액세스 토큰 발급 API를 호출하려면 API 키와 API 시크릿을 인자로 넣어주어야 합니다.
결제 관련 API
결제 건과 관련된 기능을 제공합니다.
목차
결제 상세내역 조회 API
get/payments/{imp_uid}/balance결제내역 단건조회 API
get/payments/{imp_uid}결제내역 복수조회 API
get/payments결제 단건조회(고유 고객사 주문번호 조회) API
get/payments/find/{merchant_uid}/{payment_status}결제 복수조회(고객사 주문번호 중복 포함) API
get/payments/findAll/{merchant_uid}/{payment_status}결제상태기준 복수조회 API
get/payments/status/{payment_status}결제취소 API
post/payments/cancel결제 금액 사전 등록 관련 API
사전 등록하는 결제금액과 관련된 기능을 제공합니다.
비인증 결제 관련 API
별도 결제창 호출없이 결제를 진행할 수 있는 비인증 결제 기능을 제공합니다.
정기 결제 관련 API
비인증 결제 중 정기 결제를 관리하는 기능을 제공합니다.
목차
결제예약 복수조회 API
get/subscribe/payments/schedule결제 예약 API
post/subscribe/payments/schedule결제 예약취소 API
post/subscribe/payments/unschedule결제예약 단건조회 API
get/subscribe/payments/schedule/{merchant_uid}결제요청 예약시각 수정 API
put/subscribe/payments/schedule/{merchant_uid}결제 실패 재예약 API
post/subscribe/payments/schedule/{merchant_uid}/reschedule결제 실패 재시도 API
post/subscribe/payments/schedule/{merchant_uid}/retry결제예약 복수조회(빌링키) API
get/subscribe/payments/schedule/customers/{customer_uid}빌링키 관련 API
빌링키 관리와 관련된 기능을 제공합니다.
목차
빌링키 정보 복수조회 API
get/subscribe/customers빌링키 정보 단건조회 API
get/subscribe/customers/{customer_uid}빌링키 발급 API
post/subscribe/customers/{customer_uid}빌링키 삭제 API
delete/subscribe/customers/{customer_uid}빌링키 결제 복수조회 API (빌링키 결제 내역 확인)
get/subscribe/customers/{customer_uid}/payments빌링키 결제예약 조회 API
get/subscribe/customers/{customer_uid}/schedules가상계좌 관련 API
PG사 관련 API
PG사 별 추가로 지원하는 기능을 제공합니다.
카카오 관련 API
카카오페이에서 지원하는 기능을 제공합니다.
KCP 퀵페이 관련 API
KCP 퀵페이에서 지원하는 기능을 제공합니다.
페이코 관련 API
페이코에서 지원하는 기능을 제공합니다.
페이먼트월 관련 API
페이먼트월에서 지원하는 기능을 제공합니다.
본인인증 관련 API
현금영수증 관련 API
포트원 결제건 및 외부 결제 건의 현금영수증 관리와 관련된 기능을 제공합니다.
에스크로 관련 API
에스크로 결제 건의 배송 정보와 관련된 기능을 제공합니다.
고객사 정보 관련 API
고객사 정보를 관리하는 기능을 제공합니다.
고객사의 하위 상점 관련 API
하위 상점 관련 API
하위 상점과 관련된 기능을 제공합니다.
기타 API
부가적인 기능을 제공합니다.
베네피아 포인트 관련 API
베네피아 포인트(복지 포인트)와 관련된 기능을 제공합니다.
결제기관 관련 API
금융결제원 기준 카드사, 은행의 표준 코드와 기관정보 조회 기능을 제공합니다.
편의점 결제 관련 API
편의점 결제를 위한 수납 번호(barcode)와 관련된 기능을 제공합니다.
post/cvs
수납번호 발급 API
편의점결제를 위한 수납번호(barcode)를 사전 발급 또는 등록합니다. 고객은 발급 또는 등록된 수납번호(barcode)에 해당되는 바코드 이미지 또는 수납번호를 편의점 방문시 제시함으로써 현장 결제가 이뤄지게 됩니다.
Request
Body
merchant_uid: string
고객사 주문번호
고객사 거래 고유번호
amount: number
결제금액
barcode?: string
바코드
(Optional)
expired_at?: integer
편의점 수납가능한 결제기한
(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)
pg?: string
PG 구분코드
(Optional)
confirm_url?: string
수납가능여부 체크 URL
(Optional)
notice_url?: array
Notification URL(Webhook URL)
(Optional)
custom_data?: string
추가정보
(Optional)
Response
200
편의점결제 수납번호(barcode) 생성 완료
code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(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)
취소 내역
(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)
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
try
Request
Request Sample
delete/cvs/{imp_uid}
수납취소 API
고객에게 이미 발급/등록된 편의점결제 수납번호(barcode)가 아직 수납 전일 때, 재고소진 등에 상황에 따라 해당 수납번호(barcode)로 결제가 이뤄지지 않도록 말소처리하는 API입니다.
Request
Path
imp_uid: string
포트원 거래고유번호
Response
200
편의점결제 수납번호(barcode) 말소 완료
code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(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)
취소 내역
(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)
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
try
Request
Request Sample
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AuthAnnotationAuthResponseBenepiaPointAnnotationBenepiaPointResponseCertificationAnnotationCertificationOTPAnnotationCertificationOTPResponseCertificationResponseCustomerAnnotationCustomerResponseEscrowLogisAnnotationEscrowLogisInfoAnnotationEscrowLogisProductsAnnotationEscrowLogisReceiverAnnotationEscrowLogisResponseEscrowLogisSenderAnnotationExternalReceiptAnnotationExternalReceiptResponseKcpQuickMemberAnnotationKcpQuickMemberResponseMultipleCustomersResponseMultiplePaymentsResponseMultiplePgSettingResponseNaverAddressNaverCashAmountAnnotationNaverCashAmountResponseNaverOrdererNaverProductOrderAnnotationNaverProductOrderArrayResponseNaverProductOrderResponseNaverReviewAnnotationNaverReviewsResponsePagedPaymentAnnotationPartnerReceiptResponsePartnerReceiptResultAnnotationPartnerReceiptsAnnotationPaycoStatusAnnotationPaycoStatusResponsePaymentAnnotationPaymentBalanceAnnotationPaymentBalanceHistoriesAnnotationPaymentBalanceResponsePaymentBalanceResponseAnnotationPaymentCancelAnnotationPaymentListResponsePaymentPrepareAnnotationPaymentPrepareResponsePaymentResponsePaymentwallDeliveryAnnotationPaymentwallDeliveryDetailAnnotationPgSettingAnnotationReceiptAnnotationReceiptResponseResponseAnnotationScheduleAnnotationScheduleResponseScheduleResultAnnotationSingleScheduleResponseStandardCodeAnnotationStandardCodeListResponseStandardCodeResponseSubscribePaymentExtraTierAnnotationTierResponseVbankHolderAnnotationVbankHolderResponse