PortOne REST API - V1
결제완료된 정보, 결제취소, 상태별 결제목록 조회 등의 기능을 하는 REST API를 제공합니다.
비인증 결제, 정기 자동결제 등 부가기능을 위한 REST API도 제공합니다.
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
사전 등록하는 결제금액과 관련된 기능을 제공합니다.
put/payments/prepare
결제금액 단건 수정 API
POST 결제금액 사전등록 API 로 이미 등록된 결제사전정보에 대해 금액을 수정하는 기능입니다.
Request
Body
merchant_uid: string
고객사 주문번호
이미 사전등록한 고객사 주문번호
amount: number
결제 예정금액
수정 할 결제건의 결제예정금액
Response
200
정상 조회
code?: integer
응답코드
(Optional)
0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다
message?: string
응답메세지
(Optional)
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
사전 등록한 고객사의 주문번호
amount?: number
결제 예정 금액
(Optional)
사전 등록한 결제 예정 금액
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
404
요청된 merchant_uid 로 등록된 결제사전정보를 찾을 수 없는 경우
try
Request
Request Sample
post/payments/prepare
결제금액 사전등록 API
(포트원 javascript사용)인증방식의 결제를 진행할 때 결제금액 위변조시 결제진행자체를 block하기 위해 결제예정금액을 사전등록하는 기능입니다.
이 API를 통해 사전등록된 고객사 주문번호(merchant_uid)에 대해, IMP.request_pay()에 전달된 merchant_uid가 일치하는 주문의 결제금액이 다른 경우 PG사 결제창 호출이 중단됩니다.
이 API를 통해 사전등록된 고객사 주문번호(merchant_uid)에 대해, IMP.request_pay()에 전달된 merchant_uid가 일치하는 주문의 결제금액이 다른 경우 PG사 결제창 호출이 중단됩니다.
Request
Body
merchant_uid: string
고객사 주문번호
결제금액을 사전 등록할 결제건의 고객사 주문번호
amount: number
결제예정금액
사전 등록할 결제예정금액
Response
200
정상 조회
code?: integer
응답코드
(Optional)
0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다
message?: string
응답메세지
(Optional)
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
사전 등록한 고객사의 주문번호
amount?: number
결제 예정 금액
(Optional)
사전 등록한 결제 예정 금액
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
try
Request
Request Sample
get/payments/prepare/{merchant_uid}
결제금액 단건조회 API
POST 결제금액 사전등록 API 로 이미 등록되어있는 사전등록 결제정보를 조회합니다
Request
Path
merchant_uid: string
고객사 주문번호
결제금액을 조회할 결제건의 고객사 주문번호
Response
200
정상 조회
code?: integer
응답코드
(Optional)
0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다
message?: string
응답메세지
(Optional)
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
(Optional)
merchant_uid?: string
고객사 주문번호
(Optional)
사전 등록한 고객사의 주문번호
amount?: number
결제 예정 금액
(Optional)
사전 등록한 결제 예정 금액
401
인증 Token이 전달되지 않았거나 유효하지 않은 경우
try
Request
Request Sample
비인증 결제 관련 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)와 관련된 기능을 제공합니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AuthAnnotationAuthResponseBenepiaPointAnnotationBenepiaPointResponseCertificationAnnotationCertificationOTPAnnotationCertificationOTPResponseCertificationResponseCustomerAnnotationCustomerResponseEscrowLogisAnnotationEscrowLogisInfoAnnotationEscrowLogisProductsAnnotationEscrowLogisReceiverAnnotationEscrowLogisResponseEscrowLogisSenderAnnotationExternalReceiptAnnotationExternalReceiptResponseKcpQuickMemberAnnotationKcpQuickMemberResponseMultipleCustomersResponseMultiplePaymentsResponseMultiplePgSettingResponseNaverAddressNaverCashAmountAnnotationNaverCashAmountResponseNaverOrdererNaverProductOrderAnnotationNaverProductOrderArrayResponseNaverProductOrderResponseNaverReviewAnnotationNaverReviewsResponsePagedPaymentAnnotationPartnerReceiptResponsePartnerReceiptResultAnnotationPartnerReceiptsAnnotationPaycoStatusAnnotationPaycoStatusResponsePaymentAnnotationPaymentBalanceAnnotationPaymentBalanceHistoriesAnnotationPaymentBalanceResponsePaymentBalanceResponseAnnotationPaymentCancelAnnotationPaymentListResponsePaymentPrepareAnnotationPaymentPrepareResponsePaymentResponsePaymentwallDeliveryAnnotationPaymentwallDeliveryDetailAnnotationPgSettingAnnotationReceiptAnnotationReceiptResponseResponseAnnotationScheduleAnnotationScheduleResponseScheduleResultAnnotationSingleScheduleResponseStandardCodeAnnotationStandardCodeListResponseStandardCodeResponseSubscribePaymentExtraTierAnnotationTierResponseVbankHolderAnnotationVbankHolderResponse