How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PortOne Payment Schedules API

The Payment Schedules API from PortOne — 2 operation(s) for payment schedules.

PortOne Payment Schedules API is one of 20 APIs that PortOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Schedules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 37 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.

3 operations 2 paths 37 schemas 1 DELETE2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.16.0
Base URL
https://api.portone.io
Authentication
HTTP Bearer, HTTP Portone
Resource Areas
1

Authentication & Security 2

PortOne Payment Schedules 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 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 2 GET. Each is listed below with its method, path, parameters, and response codes.

Payment Schedules 3
GET
/payment-schedules/{paymentScheduleId}
결제 예약 단건 조회
getPaymentSchedule 2 params → 200400401403404
GET
/payment-schedules
결제 예약 다건 조회
getPaymentSchedules 1 param → 200400401403
DELETE
/payment-schedules
결제 예약 취소
revokePaymentSchedules 1 param → 200400401403404409

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are PendingPaymentSchedule (22 properties), FailedPaymentSchedule (22 properties), SucceededPaymentSchedule (22 properties), StartedPaymentSchedule (21 properties). Each schema is shown below with its type and property counts.

Currency
string
통화
ScheduledPaymentSchedule
object
결제 예약 완료 상태
20 properties 15 required
UnauthorizedError
object
인증 정보가 올바르지 않은 경우
2 properties 1 required
RevokePaymentSchedulesError
PaymentScheduleSortInput
object
결제 예약 건 다건 조회 시 정렬 조건
2 properties
SeparatedAddress
object
분리 형식 주소 한 줄 형식 주소와 분리 형식 주소 모두 존재합니다. 한 줄 형식 주소는 분리 형식 주소를 이어 붙인 형태로 생성됩니다.
7 properties 4 required
PageInput
object
다건 조회 API 에 사용되는 페이지 입력 정보
2 properties
GetPaymentScheduleError
PaymentScheduleFilterInput
object
결제 예약 건 다건 조회를 위한 입력 정보
6 properties
Customer
object
고객 정보
10 properties
RevokePaymentSchedulesResponse
object
결제 예약 건 취소 성공 응답
2 properties 1 required
PaymentScheduleAlreadyProcessedError
object
결제 예약건이 이미 처리된 경우
2 properties 1 required
ForbiddenError
object
요청이 거절된 경우
2 properties 1 required
InvalidRequestError
object
요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
2 properties 1 required
BillingKeyAlreadyDeletedError
object
빌링키가 이미 삭제된 경우
2 properties 1 required
PaymentScheduleAlreadyRevokedError
object
결제 예약건이 이미 취소된 경우
2 properties 1 required
RevokedPaymentSchedule
object
결제 예약 취소 상태
21 properties 16 required
SortOrder
string
정렬 방식
PendingPaymentSchedule
object
결제 완료 대기 상태
22 properties 17 required
OneLineAddress
object
한 줄 형식 주소 한 줄 형식 주소만 존재합니다.
2 properties 2 required
PageInfo
object
반환된 페이지 결과 정보
3 properties 3 required
PaymentSchedule
결제 예약 건
StartedPaymentSchedule
object
결제 시작 상태
21 properties 16 required
Country
string
국가
Gender
string
성별
RevokePaymentSchedulesBody
object
결제 예약 건 취소 요청 입력 정보
3 properties
GetPaymentSchedulesError
GetPaymentSchedulesResponse
object
결제 예약 다건 조회 성공 응답 정보
2 properties 2 required
Address
분리 형식 주소 oneLine(한 줄 형식 주소) 필드는 항상 존재합니다.
SucceededPaymentSchedule
object
결제 성공 상태
22 properties 17 required
GetPaymentSchedulesBody
object
결제 예약 다건 조회를 위한 입력 정보 조회 결과는 결제 예정 시점(timeToPay) 기준 최신 순으로 정렬됩니다.
3 properties
BillingKeyNotFoundError
object
빌링키가 존재하지 않는 경우
2 properties 1 required
FailedPaymentSchedule
object
결제 실패 상태
22 properties 17 required
PaymentProduct
object
상품 정보
7 properties 4 required
PaymentScheduleNotFoundError
object
결제 예약건이 존재하지 않는 경우
2 properties 1 required
PaymentScheduleStatus
string
결제 예약 건 상태
PaymentScheduleSortBy
string
결제 예약 건 정렬 기준

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portone-payment-schedules-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of PortOne Payment Schedules 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.