PortOne Payments API
The Payments API from PortOne — 18 operation(s) for payments.
PortOne Payments API is one of 20 APIs that PortOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 19 operations across 18 paths, and defines 213 schemas. It is described by OpenAPI 3.2.0, at version 1.16.0.
Requests are made against a single base URL, https://api.portone.io.
19 operations
18 paths
213 schemas
4 GET1 PATCH14 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
PortOne Payments API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearerJwt).
It uses HTTP portone authentication (portOne).
bearerJwt— Authorization: Bearer 엑세스 토큰portOne— Authorization: PortOne 발급된 API 시크릿
Paths & Operations 19
Across 18 paths, the API surfaces 19 operations — 4 GET, 1 PATCH, 14 POST. Each is listed below with its method, path, parameters, and response codes.
Payments 19
POST
/payments/{paymentId}/billing-key
빌링키 결제
POST
/payments/{paymentId}/cancel
결제 취소
POST
/payments/{paymentId}/cancellations/{cancellationId}/stop
결제 취소 요청 취소
POST
/payments/{paymentId}/capture
수동 매입
POST
/payments/{paymentId}/cash-receipt/cancel
현금 영수증 취소
GET
/payments/{paymentId}/cash-receipt
현금 영수증 단건 조회
POST
/payments/{paymentId}/confirm
인증 결제 수동 승인
POST
/payments/{paymentId}/escrow/complete
에스크로 구매 확정
POST
/payments/{paymentId}/escrow/logistics
에스크로 배송 정보 등록
PATCH
/payments/{paymentId}/escrow/logistics
에스크로 배송 정보 수정
POST
/payments/{paymentId}/instant
수기 결제
POST
/payments/{paymentId}/pre-register
결제 정보 사전 등록
POST
/payments/{paymentId}/register-store-receipt
영수증 내 하위 상점 거래 등록
POST
/payments/{paymentId}/resend-webhook
웹훅 재발송
POST
/payments/{paymentId}/schedule
결제 예약
GET
/payments/{paymentId}/transactions
결제 시도 내역 조회
POST
/payments/{paymentId}/virtual-account/close
가상계좌 말소
GET
/payments/{paymentId}
결제 단건 조회
GET
/payments
결제 다건 조회(페이지 기반)
Schemas 213
The contract defines 213 schemas that model the data the API accepts and returns. The most detailed are PaidPayment (35 properties), PartialCancelledPayment (34 properties), CancelledPayment (34 properties), CancelledPaymentTransaction (33 properties). Each schema is shown below with its type and property counts.
PaymentTimestampType
string
조회 시점 기준 어떤 시점을 기준으로 조회를 할 것인지 선택합니다. CREATEDAT: 결제 건 생성 시점을 기준으로 조회합니다. STATUSCHANGEDAT: 상태 승인 시점을 기준으로 조회합니다. 결제 건의 최종 상태에 따라 검색 기준이 다르게 적용됩니다. ready - 결제 요청…
ModifyEscrowLogisticsResponse
object
에스크로 배송 정보 수정 성공 응답
3 properties
3 required
CashReceiptInputType
string
입력 시 발급 유형
PaymentMethodVirtualAccountRefundStatus
string
가상계좌 환불 상태
ModifyEscrowLogisticsBody
object
에스크로 배송 정보 수정 입력 정보
6 properties
1 required
PageInput
object
다건 조회 API 에 사용되는 페이지 입력 정보
2 properties
Bank
string
은행
Locale
string
결제 언어
CustomerSeparatedName
object
고객 분리형 이름
2 properties
2 required
FailedPayment
object
결제 실패 상태 건
29 properties
16 required
DateTimeRange
object
시간 범위
2 properties
2 required
IssuedCashReceipt
object
발급 완료
17 properties
11 required
StopPaymentCancellationBody
object
결제 취소 요청 취소 입력 정보
1 property
PromotionDiscountRetainOption
string
PortOneVersion
string
포트원 버전
BillingKeyAlreadyDeletedError
object
빌링키가 이미 삭제된 경우
2 properties
1 required
GetPaymentTransactionsError
PaidPaymentTransaction
object
결제 완료 상태 건
32 properties
15 required
CashReceiptInput
object
현금영수증 입력 정보
2 properties
1 required
CancelCashReceiptError
GetPaymentsResponse
object
결제 건 다건 조회 성공 응답 정보
2 properties
2 required
ResendWebhookError
PaymentMethodTransfer
object
계좌 이체 상세 정보
3 properties
1 required
PayPendingPaymentTransaction
object
결제 완료 대기 상태 건
27 properties
14 required
PaymentScheduleSummary
object
결제 예약 건
1 property
1 required
CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError
object
취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우
2 properties
1 required
MaxTransactionCountReachedError
object
결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
2 properties
1 required
PaymentMethodGiftCertificate
object
상품권 상세 정보
3 properties
2 required
PaymentNotFoundError
object
결제 건이 존재하지 않는 경우
2 properties
1 required
ConfirmedPaymentSummary
object
결제 수동 승인 완료된 결제 건 요약 정보
2 properties
2 required
PromotionPayMethodDoesNotMatchError
object
결제수단이 프로모션에 지정된 것과 일치하지 않는 경우
2 properties
1 required
CancelledPaymentEscrow
object
거래 취소
5 properties
3 required
CustomerNameInput
object
고객 이름 입력 정보 두 개의 이름 형식 중 한 가지만 선택하여 입력해주세요.
2 properties
CancelAmountExceedsCancellableAmountError
object
결제 취소 금액이 취소 가능 금액을 초과한 경우
2 properties
1 required
FailedPaymentCancellation
object
취소 실패 상태
11 properties
7 required
InstantPaymentMethodInputVirtualAccountCashReceiptInfo
object
가상계좌 결제 시 현금영수증 정보
2 properties
2 required
PaymentMethodVirtualAccountType
string
가상계좌 유형
PaymentMethodGiftCertificateType
string
상품권 종류
CashReceiptType
string
발급 유형
RegisterStoreReceiptBodyItem
object
하위 상점 거래 정보
7 properties
4 required
BillingKeyNotFoundError
object
빌링키가 존재하지 않는 경우
2 properties
1 required
CancelRequester
string
결제 취소 요청 주체
RegisteredPaymentEscrow
object
배송 정보 등록 완료
5 properties
3 required
PaymentFilterInputEscrowStatus
string
에스크로 상태
PaymentMethodCrypto
object
암호화폐 결제 상세 정보
1 property
1 required
PaymentTransaction
결제 시도
PaymentSortBy
string
결제 건 정렬 기준
PaymentProduct
object
상품 정보
7 properties
4 required
IssueFailedCashReceipt
object
발급 실패
8 properties
6 required
RegisterStoreReceiptBody
object
영수증 내 하위 상점 거래 등록 정보
2 properties
1 required
InvalidPaymentTokenError
object
유효하지 않은 결제 토큰인 경우
2 properties
1 required
RegisterStoreReceiptError
PaymentMethodMobile
object
모바일 상세 정보
2 properties
1 required
PaymentOrigin
object
결제 출처 정보
4 properties
2 required
PaymentCancellationNotFoundError
object
결제 취소 내역이 존재하지 않는 경우
2 properties
1 required
CancellableAmountConsistencyBrokenError
object
취소 가능 잔액 검증에 실패한 경우
2 properties
1 required
Currency
string
통화
InstantPaymentInput
object
수기 결제 요청 정보
20 properties
4 required
UnauthorizedError
object
인증 정보가 올바르지 않은 경우
2 properties
1 required
PaymentMethodType
string
CapturePaymentResponse
object
수동 매입 성공 응답
VirtualAccountIssuedPaymentTransaction
object
가상계좌 발급 완료 상태 건
27 properties
14 required
BillingKeyPaymentSummary
object
빌링키 결제 완료된 결제 건 요약 정보
2 properties
2 required
AlreadyPaidOrWaitingError
object
결제가 이미 완료되었거나 대기중인 경우
2 properties
1 required
GetPaymentsError
PartialCancelledPayment
object
결제 부분 취소 상태 건
34 properties
17 required
PaymentWebhookTrigger
string
웹훅 실행 트리거 수동 웹훅 재발송, 가상계좌 입금, 비동기 취소 승인 시 발생한 웹훅일 때 필드의 값이 존재합니다.
CashReceiptNotFoundError
object
현금영수증이 존재하지 않는 경우
2 properties
1 required
InvalidRequestError
object
요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
2 properties
1 required
CancelledPaymentCashReceipt
object
취소된 현금영수증
10 properties
6 required
PaymentCancellationNotPendingError
object
결제 취소 내역이 취소 요청 상태가 아닌 경우
2 properties
1 required
ConvenienceStoreBrand
string
편의점 브랜드
PayInstantlyResponse
object
수기 결제 성공 응답
1 property
1 required
PaymentNotPaidError
object
결제가 완료되지 않은 경우
2 properties
1 required
PaymentEscrowSenderInput
object
에스크로 발송자 정보
5 properties
CapturePaymentError
PaymentCancellation
결제 취소 내역
PaymentNotWaitingForDepositError
object
결제 건이 입금 대기 상태가 아닌 경우
2 properties
1 required
PageInfo
object
반환된 페이지 결과 정보
3 properties
3 required
PayPendingPayment
object
결제 완료 대기 상태 건
28 properties
15 required
Gender
string
성별
PgProviderError
object
PG사에서 오류를 전달한 경우
4 properties
3 required
PreRegisterPaymentBody
object
결제 정보 사전 등록 입력 정보
4 properties
ApplyEscrowLogisticsError
Address
분리 형식 주소 oneLine(한 줄 형식 주소) 필드는 항상 존재합니다.
DisputeStatus
string
분쟁 상태
ResendWebhookResponse
object
웹훅 재발송 응답 정보
1 property
1 required
ConfirmEscrowResponse
object
에스크로 구매 확정 성공 응답
1 property
1 required
InstantPaymentMethodInputCard
object
카드 수단 정보 입력 정보
5 properties
1 required
RegisterEscrowLogisticsBody
object
에스크로 배송 정보 등록 입력 정보
6 properties
1 required
Trigger
string
PaymentMethodEasyPay
object
간편 결제 상세 정보
3 properties
1 required
RegisterStoreReceiptResponse
object
영수증 내 하위 상점 거래 등록 응답
1 property
PaymentEscrowReceiverInput
object
에스크로 수취인 정보
4 properties
SumOfPartsExceedsCancelAmountError
object
면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우
2 properties
1 required
InstantPaymentMethodInputVirtualAccountOptionType
string
가상계좌 발급 유형
RejectedPaymentEscrow
object
구매 거절
5 properties
3 required
InstantPaymentMethodInputVirtualAccountOptionFixed
object
고정식 가상계좌 발급 유형 pgAccountId, accountNumber 유형 중 한 개의 필드만 입력합니다.
2 properties
PaymentWebhookPaymentStatus
string
웹훅 발송 시 결제 건 상태
StopPaymentCancellationError
FailedPaymentTransaction
object
결제 실패 상태 건
28 properties
15 required
CardCredential
object
카드 인증 관련 정보
5 properties
3 required
InstantPaymentMethodInput
object
수기 결제 수단 입력 정보 하나의 필드만 입력합니다.
2 properties
InstantPaymentMethodInputVirtualAccountExpiry
object
입금 만료 기한 validHours와 dueDate 둘 중 하나의 필드만 입력합니다.
2 properties
PaymentMethodEasyPayMethodCharge
object
충전식 포인트 결제 정보
2 properties
1 required
CreatePaymentScheduleError
CashReceipt
현금영수증 내역
PaymentOriginPlatformType
string
플랫폼 타입
SeparatedAddress
object
분리 형식 주소 한 줄 형식 주소와 분리 형식 주소 모두 존재합니다. 한 줄 형식 주소는 분리 형식 주소를 이어 붙인 형태로 생성됩니다.
7 properties
4 required
InformationMismatchError
object
정보가 일치하지 않는 경우
2 properties
1 required
PayWithBillingKeyResponse
object
빌링키 결제 성공 응답
1 property
1 required
PaidPayment
object
결제 완료 상태 건
35 properties
17 required
CancelCashReceiptResponse
object
현금 영수증 취소 성공 응답
2 properties
2 required
ReadyPayment
object
준비 상태 건
27 properties
14 required
Customer
object
고객 정보
10 properties
BeforeRegisteredPaymentEscrow
object
배송 정보 등록 전
1 property
1 required
PaymentCashReceiptStatus
string
결제건 내 현금영수증 상태
PaymentLogisticsCompany
string
물류 회사
CustomerInput
object
고객 정보 입력 정보
12 properties
PaymentMethodCard
object
결제수단 카드 정보
5 properties
1 required
PaymentMethodConvenienceStore
object
편의점 결제 상세 정보
5 properties
1 required
ConfirmedPaymentEscrow
object
구매 확정
6 properties
4 required
CardType
string
카드 유형
PaymentScheduleAlreadyExistsError
object
결제 예약건이 이미 존재하는 경우
2 properties
1 required
PaymentWebhook
object
성공 웹훅 내역
11 properties
2 required
PaymentFilterInput
object
결제 다건 조회를 위한 입력 정보
27 properties
DeliveredPaymentEscrow
object
배송 완료
5 properties
3 required
Payment
결제 건
CancelledPayment
object
결제 취소 상태 건
34 properties
17 required
PaymentAlreadyCancelledError
object
결제가 이미 취소된 경우
2 properties
1 required
ReadyPaymentTransaction
object
준비 상태 건
26 properties
13 required
CancelPaymentBodyRefundAccount
object
고객 정보 입력 형식
4 properties
3 required
Card
object
카드 상세 정보
8 properties
PaymentEscrow
에스크로 정보 V1 결제 건의 경우 타입이 REGISTERED 로 고정됩니다.
OneLineAddress
object
한 줄 형식 주소 한 줄 형식 주소만 존재합니다.
2 properties
2 required
PaymentTextSearch
object
통합검색 입력 정보
2 properties
2 required
PaymentWebhookStatus
string
웹훅 전송 상태
CreatePaymentScheduleBody
object
결제 예약 요청 입력 정보
2 properties
2 required
Country
string
국가
WebhookNotFoundError
object
웹훅 내역이 존재하지 않는 경우
2 properties
1 required
PaymentFailure
object
결제 실패 정보
3 properties
SelectedChannelType
string
채널 타입
SumOfPartsExceedsTotalAmountError
object
면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우
2 properties
1 required
CashReceiptIssuanceStatus
string
현금영수증 발행여부
CancelTaxAmountExceedsCancellableTaxAmountError
object
취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우
2 properties
1 required
StopPaymentCancellationResponse
object
결제 취소 요청 취소 성공 응답
1 property
1 required
BillingKeyPaymentInput
object
빌링키 결제 요청 입력 정보
22 properties
4 required
CancelPaymentBody
object
결제 취소 요청 입력 정보
11 properties
1 required
CardOwnerType
string
카드 소유주 유형
PaymentLogistics
object
배송정보
5 properties
3 required
SucceededPaymentCancellation
object
취소 완료 상태
12 properties
7 required
ConfirmEscrowError
CloseVirtualAccountError
ConfirmPaymentBody
object
결제 승인 입력 정보
8 properties
1 required
PaymentAmountInput
object
금액 세부 입력 정보
3 properties
1 required
ChannelGroupSummary
object
채널 그룹 정보
3 properties
3 required
PaymentMethodVirtualAccount
object
가상계좌 상세 정보
9 properties
2 required
CloseVirtualAccountResponse
object
가상계좌 말소 성공 응답
1 property
1 required
ConfirmEscrowBody
object
에스크로 구매 확정 입력 정보
2 properties
GetCashReceiptError
PaymentInstallment
object
할부 정보
3 properties
2 required
EasyPayProvider
string
간편 결제사
PgProvider
string
PG사 결제 모듈
DiscountAmountExceedsTotalAmountError
object
프로모션 할인 금액이 결제 시도 금액 이상인 경우
2 properties
1 required
GetPaymentsBody
object
결제 다건 조회를 위한 입력 정보
2 properties
CancelPaymentResponse
object
결제 취소 성공 응답
1 property
1 required
CancelledCashReceipt
object
발급 취소
18 properties
12 required
ModifyEscrowLogisticsError
InstantPaymentSummary
object
수기 결제가 완료된 결제 건 요약 정보
2 properties
2 required
PayWithBillingKeyError
CashReceiptNotIssuedError
object
현금영수증이 발급되지 않은 경우
2 properties
1 required
RequestedPaymentCancellation
object
취소 요청 상태
11 properties
7 required
PreRegisterPaymentResponse
object
결제 사전 등록 성공 응답
CancelledPaymentTransaction
object
결제 취소 상태 건
33 properties
16 required
ResendWebhookBody
object
웹훅 재발송을 위한 입력 정보
2 properties
SeparatedAddressInput
object
분리 형식 주소 입력 정보
5 properties
2 required
ConfirmPaymentError
CreatePaymentScheduleResponse
object
결제 예약 성공 응답
1 property
1 required
GetPaymentError
InstantPaymentMethodInputVirtualAccount
object
가상계좌 수단 정보 입력 정보
5 properties
3 required
PaymentWebhookResponse
object
웹훅 응답 정보
4 properties
4 required
MaxCancelCountReachedError
object
취소 시도 횟수가 초과된 경우
2 properties
1 required
ForbiddenError
object
요청이 거절된 경우
2 properties
1 required
SelectedChannel
object
(결제, 본인인증 등에) 선택된 채널 정보
6 properties
3 required
GetPaymentTransactionsResponse
object
결제 시도 내역 조회 응답 정보
1 property
1 required
CapturePaymentBody
object
수동 매입 입력 정보
1 property
PaymentTextSearchField
string
통합검색 항목
PayInstantlyError
ChannelNotFoundError
object
요청된 채널이 존재하지 않는 경우
2 properties
1 required
BillingKeyPaymentScheduleInput
object
빌링키 결제 예약 요청 입력 정보
21 properties
4 required
PaymentStatus
string
결제 건 상태
PaymentWebhookRequest
object
웹훅 요청 정보
3 properties
1 required
CancelPaymentError
PromotionDiscountRetainOptionShouldNotBeChangedError
object
프로모션 혜택 유지 옵션을 이전 부분 취소와 다른 것으로 입력한 경우
2 properties
1 required
SortOrder
string
정렬 방식
AlreadyPaidError
object
결제가 이미 완료된 경우
2 properties
1 required
PaymentAmount
object
결제 금액 세부 정보
8 properties
6 required
IssuedPaymentCashReceipt
object
발급 완료된 현금영수증
9 properties
5 required
PreRegisterPaymentError
VirtualAccountIssuedPayment
object
가상계좌 발급 완료 상태 건
28 properties
15 required
InstantPaymentMethodInputVirtualAccountOption
object
가상계좌 발급 방식
2 properties
1 required
PaymentMethod
결제수단 정보
CardBrand
string
카드 브랜드
Dispute
object
분쟁 내역
5 properties
3 required
PartialCancelledPaymentTransaction
object
결제 부분 취소 상태 건
33 properties
16 required
PaymentMethodEasyPayMethod
간편 결제 수단
NegativePromotionAdjustedCancelAmountError
object
프로모션에 의해 조정된 취소 금액이 음수인 경우
2 properties
1 required
RejectConfirmedPaymentEscrow
object
구매 거절 확정
5 properties
3 required
PaymentClientType
string
결제가 발생한 클라이언트 환경
ApplyEscrowLogisticsResponse
object
에스크로 배송 정보 등록 성공 응답
3 properties
3 required
MaxWebhookRetryCountReachedError
object
동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우
2 properties
1 required
PaymentCashReceipt
결제 건 내 현금영수증 정보
PaymentProductType
string
상품 유형
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from PortOne 12
Other APIs PortOne publishes across the network.
PortOne REST API (V1, legacy Iamport)
PortOne B2b API
PortOne Banks API
PortOne Billing Keys API
PortOne Cash Receipts API
PortOne Checkout Profiles API
PortOne Identity Verifications API
PortOne Kakaopay API
PortOne Login API
PortOne Payment Events By Cursor API
PortOne Payment Gateways API
PortOne Payment Reconciliations API
#Payments
Where this information came from
This is an independent, third-party profile of PortOne Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.