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
본인인증 요청 및 결과 조회와 관련된 기능을 제공합니다.
get/certifications/{imp_uid}
본인인증 결과조회 API
본인인증된 결과를 imp_uid를 이용하여 조회합니다.
Request
Path
imp_uid: string
포트원 인증 고유번호
Response
200
본인인증결과 조회 성공
code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
imp_uid: string
포트원 인증 고유번호
merchant_uid?: string
고객사 주문번호
(Optional)
pg_tid?: string
PG사 본인인증결과 고유번호
(Optional)
pg_provider: string
pg사 구분코드
name?: string
성명
(Optional)
gender?: string
성별
(Optional)
birthday?: string
생년월일
(Optional)
foreigner: boolean
외국인 여부
인증된 사용자의 외국인 여부
phone?: string
휴대폰번호
(Optional)
인증에 사용된 휴대폰 번호 (신용카드 본인인증의 경우 해당사항 없음)
carrier?: string
통신사
(Optional)
인증에 사용된 휴대폰번호의 통신사 (신용카드 본인인증의 경우 해당사항없음)
certified?: boolean
인증성공여부
(Optional)
certified_at?: integer
인증처리시각
(Optional)
unique_key?: string
개인 고유구분 식별키
(Optional)
unique_in_site?: string
고객사 내 개인 고유구분 식별키
(Optional)
고객사 내 개인별로 고유하게 부여하는 개인 식별키(DI)
origin?: string
웹 페이지 URL
(Optional)
foreigner_v2?: boolean
외국인 여부(nullable)
(Optional)
본인인증 결과 외국인 여부(nullable)
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
본인인증결과를 찾을 수 없음
try
Request
Request Sample
delete/certifications/{imp_uid}
본인인증 정보삭제 API
본인인증 결과를 삭제합니다.
본인인증 결과정보를 포트원 서버내에서 완전히 삭제하고 싶을 때 요청합니다.
본인인증 결과정보를 포트원 서버내에서 완전히 삭제하고 싶을 때 요청합니다.
Request
Path
imp_uid: string
포트원 인증 고유번호
Response
200
본인인증결과 삭제 완료
code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
imp_uid: string
포트원 인증 고유번호
merchant_uid?: string
고객사 주문번호
(Optional)
pg_tid?: string
PG사 본인인증결과 고유번호
(Optional)
pg_provider: string
pg사 구분코드
name?: string
성명
(Optional)
gender?: string
성별
(Optional)
birthday?: string
생년월일
(Optional)
foreigner: boolean
외국인 여부
인증된 사용자의 외국인 여부
phone?: string
휴대폰번호
(Optional)
인증에 사용된 휴대폰 번호 (신용카드 본인인증의 경우 해당사항 없음)
carrier?: string
통신사
(Optional)
인증에 사용된 휴대폰번호의 통신사 (신용카드 본인인증의 경우 해당사항없음)
certified?: boolean
인증성공여부
(Optional)
certified_at?: integer
인증처리시각
(Optional)
unique_key?: string
개인 고유구분 식별키
(Optional)
unique_in_site?: string
고객사 내 개인 고유구분 식별키
(Optional)
고객사 내 개인별로 고유하게 부여하는 개인 식별키(DI)
origin?: string
웹 페이지 URL
(Optional)
foreigner_v2?: boolean
외국인 여부(nullable)
(Optional)
본인인증 결과 외국인 여부(nullable)
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
본인인증결과를 찾을 수 없음
500
DB삭제도중 서버 장애 발생
try
Request
Request Sample
post/certifications/otp/request
본인인증 요청 API
사용자 개인정보를 API로 전달하여, 통신사로부터 확인되는 경우 OTP(6자리 인증번호)를 사용자에게 SMS로 전달합니다.
통신사 승인을 받은 일부 고객사에 한해 사용하실 수 있으며, 현재 다날을 통해서만 서비스되고 있습니다.
본인인증 대상자의 성명, 생년월일 + 주민등록 뒷부분 첫 자리, 휴대폰번호, 통신사 정보를 고객사에서 직접 입력받아 API요청하면 됩니다. 전달된 개인정보가 올바를 경우 해당 휴대폰으로 인증번호 SMS가 전송됩니다.
200응답 시 imp_uid 가 응답데이터로 전달되며, SMS전송된 인증번호를 본인인증 완료 API 로 요청주시면 최종 본인인증 프로세스가 완료됩니다.
통신사 승인을 받은 일부 고객사에 한해 사용하실 수 있으며, 현재 다날을 통해서만 서비스되고 있습니다.
본인인증 대상자의 성명, 생년월일 + 주민등록 뒷부분 첫 자리, 휴대폰번호, 통신사 정보를 고객사에서 직접 입력받아 API요청하면 됩니다. 전달된 개인정보가 올바를 경우 해당 휴대폰으로 인증번호 SMS가 전송됩니다.
200응답 시 imp_uid 가 응답데이터로 전달되며, SMS전송된 인증번호를 본인인증 완료 API 로 요청주시면 최종 본인인증 프로세스가 완료됩니다.
Request
Body
name: string
성명
phone: string
휴대폰번호
본인인증 대상자 전화번호
birth: string
생년월일
본인인증 대상자 생년월일
gender_digit: string
성별구분코드
본인인증 대상자 주민등록번호 뒷부분 첫자리
carrier: string
통신사구분코드
본인인증 대상자 통신자 코드
is_mvno?: boolean
알뜰폰 사용 여부
(Optional)
company?: string
고객사 서비스명칭
(Optional)
고객사 서비스명칭 또는 domain URL
merchant_uid?: string
고객사 주문번호
(Optional)
pg?: string
PG사 구분코드
(Optional)
본인인증을 요청하고자 하는 PG사 구분자
Response
200
본인인증을 위한 대상자 정보 검증 완료(인증번호 SMS전송요청 중)
code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
imp_uid: string
포트원 인증 고유번호
400
대상자 개인정보 중 일부가 누락되었거나 올바르지 않은 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
500
처리 중 다날서버 응답오류 등 오류가 발생한 경우
try
Request
Request Sample
post/certifications/otp/confirm/{imp_uid}
본인인증 완료 API
본인인증 요청 API를 통해 SMS로 전송된 인증번호를 전달하여 본인인증을 완료합니다.
본인인증이 완료되면 대상자의 이름, 전화번호, 통신사, 성별, 외국인 여부, 생년월일, CI, DI 값을 응답받을 수 있습니다.
본인인증이 완료되면 대상자의 이름, 전화번호, 통신사, 성별, 외국인 여부, 생년월일, CI, DI 값을 응답받을 수 있습니다.
Request
Path
imp_uid: string
포트원 인증 고유번호
Body
otp: string
본인인증 번호
Response
200
본인인증완료
code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
imp_uid: string
포트원 인증 고유번호
merchant_uid?: string
고객사 주문번호
(Optional)
pg_tid?: string
PG사 본인인증결과 고유번호
(Optional)
pg_provider: string
pg사 구분코드
name?: string
성명
(Optional)
gender?: string
성별
(Optional)
birthday?: string
생년월일
(Optional)
foreigner: boolean
외국인 여부
인증된 사용자의 외국인 여부
phone?: string
휴대폰번호
(Optional)
인증에 사용된 휴대폰 번호 (신용카드 본인인증의 경우 해당사항 없음)
carrier?: string
통신사
(Optional)
인증에 사용된 휴대폰번호의 통신사 (신용카드 본인인증의 경우 해당사항없음)
certified?: boolean
인증성공여부
(Optional)
certified_at?: integer
인증처리시각
(Optional)
unique_key?: string
개인 고유구분 식별키
(Optional)
unique_in_site?: string
고객사 내 개인 고유구분 식별키
(Optional)
고객사 내 개인별로 고유하게 부여하는 개인 식별키(DI)
origin?: string
웹 페이지 URL
(Optional)
foreigner_v2?: boolean
외국인 여부(nullable)
(Optional)
본인인증 결과 외국인 여부(nullable)
400
인증번호를 누락하였거나 이미 인증처리가 완료된 건에 대해 재요청하는 경우
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
imp_uid 에 해당되는 요청건이 없는 경우
500
처리 중 다날서버 응답오류 등 오류가 발생한 경우
try
Request
Request Sample
현금영수증 관련 API
포트원 결제건 및 외부 결제 건의 현금영수증 관리와 관련된 기능을 제공합니다.
에스크로 관련 API
에스크로 결제 건의 배송 정보와 관련된 기능을 제공합니다.
고객사 정보 관련 API
고객사 정보를 관리하는 기능을 제공합니다.
고객사의 하위 상점 관련 API
하위 상점 관련 API
하위 상점과 관련된 기능을 제공합니다.
기타 API
부가적인 기능을 제공합니다.
베네피아 포인트 관련 API
베네피아 포인트(복지 포인트)와 관련된 기능을 제공합니다.
결제기관 관련 API
금융결제원 기준 카드사, 은행의 표준 코드와 기관정보 조회 기능을 제공합니다.
편의점 결제 관련 API
편의점 결제를 위한 수납 번호(barcode)와 관련된 기능을 제공합니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AuthAnnotationAuthResponseBenepiaPointAnnotationBenepiaPointResponseCertificationAnnotationCertificationOTPAnnotationCertificationOTPResponseCertificationResponseCustomerAnnotationCustomerResponseEscrowLogisAnnotationEscrowLogisInfoAnnotationEscrowLogisProductsAnnotationEscrowLogisReceiverAnnotationEscrowLogisResponseEscrowLogisSenderAnnotationExternalReceiptAnnotationExternalReceiptResponseKcpQuickMemberAnnotationKcpQuickMemberResponseMultipleCustomersResponseMultiplePaymentsResponseMultiplePgSettingResponseNaverAddressNaverCashAmountAnnotationNaverCashAmountResponseNaverOrdererNaverProductOrderAnnotationNaverProductOrderArrayResponseNaverProductOrderResponseNaverReviewAnnotationNaverReviewsResponsePagedPaymentAnnotationPartnerReceiptResponsePartnerReceiptResultAnnotationPartnerReceiptsAnnotationPaycoStatusAnnotationPaycoStatusResponsePaymentAnnotationPaymentBalanceAnnotationPaymentBalanceHistoriesAnnotationPaymentBalanceResponsePaymentBalanceResponseAnnotationPaymentCancelAnnotationPaymentListResponsePaymentPrepareAnnotationPaymentPrepareResponsePaymentResponsePaymentwallDeliveryAnnotationPaymentwallDeliveryDetailAnnotationPgSettingAnnotationReceiptAnnotationReceiptResponseResponseAnnotationScheduleAnnotationScheduleResponseScheduleResultAnnotationSingleScheduleResponseStandardCodeAnnotationStandardCodeListResponseStandardCodeResponseSubscribePaymentExtraTierAnnotationTierResponseVbankHolderAnnotationVbankHolderResponse