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 Platform API

The Platform API from PortOne — 44 operation(s) for platform.

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

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

This API exposes 66 operations across 44 paths, and defines 437 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.

66 operations 44 paths 437 schemas 5 DELETE25 GET5 PATCH27 POST4 PUT

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 Platform 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 66

Across 44 paths, the API surfaces 66 operations — 5 DELETE, 25 GET, 5 PATCH, 27 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Platform 66
GET
/platform/account-transfers
이체 내역 다건 조회
getPlatformAccountTransfers 2 params → 200400401403
POST
/platform/additional-fee-policies/{id}/archive
추가 수수료 정책 보관
archivePlatformAdditionalFeePolicy 2 params → 200400401403404409
POST
/platform/additional-fee-policies/{id}/recover
추가 수수료 정책 복원
recoverPlatformAdditionalFeePolicy 2 params → 200400401403404
GET
/platform/additional-fee-policies/{id}/schedule
주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 조회합니다.
getPlatformAdditionalFeePolicySchedule 2 params → 200400401403404
PUT
/platform/additional-fee-policies/{id}/schedule
rescheduleAdditionalFeePolicy 2 params body → 200400401403404
POST
/platform/additional-fee-policies/{id}/schedule
주어진 아이디에 대응되는 추가 수수료 정책에 업데이트를 예약합니다.
scheduleAdditionalFeePolicy 2 params body → 200400401403404409
DELETE
/platform/additional-fee-policies/{id}/schedule
주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 취소합니다.
cancelPlatformAdditionalFeePolicySchedule 2 params → 200400401403404
GET
/platform/additional-fee-policies/{id}
추가 수수료 정책 조회
getPlatformAdditionalFeePolicy 2 params → 200400401403404
PATCH
/platform/additional-fee-policies/{id}
추가 수수료 정책 수정
updatePlatformAdditionalFeePolicy 2 params body → 200400401403404409
GET
/platform/additional-fee-policies
추가 수수료 정책 다건 조회
getPlatformAdditionalFeePolicies 2 params → 200400401403
POST
/platform/additional-fee-policies
추가 수수료 정책 생성
createPlatformAdditionalFeePolicy 1 param body → 200400401403409
GET
/platform/bank-accounts/{bank}/{accountNumber}/holder
예금주 조회
getPlatformAccountHolder 5 params → 200400401403503
GET
/platform/bulk-account-transfers
일괄 이체 내역 다건 조회
getPlatformBulkAccountTransfers 2 params → 200400401403
GET
/platform/bulk-payouts
일괄 지급 내역 다건 조회
getPlatformBulkPayouts 2 params → 200400401403
GET
/platform/companies/{businessRegistrationNumber}/state
사업자 조회
getPlatformCompanyState 2 params → 200400401403404503
POST
/platform/contracts/{id}/archive
계약 보관
archivePlatformContract 2 params → 200400401403404409
POST
/platform/contracts/{id}/recover
계약 복원
recoverPlatformContract 2 params → 200400401403404
GET
/platform/contracts/{id}/schedule
주어진 아이디에 대응되는 계약의 예약 업데이트를 조회합니다.
getPlatformContractSchedule 2 params → 200400401403404
PUT
/platform/contracts/{id}/schedule
주어진 아이디에 대응되는 계약에 예약 업데이트를 재설정합니다.
rescheduleContract 2 params body → 200400401403404
POST
/platform/contracts/{id}/schedule
주어진 아이디에 대응되는 계약에 업데이트를 예약합니다.
scheduleContract 2 params body → 200400401403404409
DELETE
/platform/contracts/{id}/schedule
주어진 아이디에 대응되는 계약의 예약 업데이트를 취소합니다.
cancelPlatformContractSchedule 2 params → 200400401403404
GET
/platform/contracts/{id}
계약 조회
getPlatformContract 2 params → 200400401403404
PATCH
/platform/contracts/{id}
계약 수정
updatePlatformContract 2 params body → 200400401403404409
GET
/platform/contracts
계약 다건 조회
getPlatformContracts 2 params → 200400401403
POST
/platform/contracts
계약 생성
createPlatformContract 1 param body → 200400401403409
POST
/platform/discount-share-policies/{id}/archive
할인 분담 정책 보관
archivePlatformDiscountSharePolicy 2 params → 200400401403404409
POST
/platform/discount-share-policies/{id}/recover
할인 분담 정책 복원
recoverPlatformDiscountSharePolicy 2 params → 200400401403404
GET
/platform/discount-share-policies/{id}/schedule
주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 조회합니다.
getPlatformDiscountSharePolicySchedule 2 params → 200400401403404
PUT
/platform/discount-share-policies/{id}/schedule
주어진 아이디에 대응되는 할인 분담에 예약 업데이트를 재설정합니다.
rescheduleDiscountSharePolicy 2 params body → 200400401403404
POST
/platform/discount-share-policies/{id}/schedule
주어진 아이디에 대응되는 할인 분담에 업데이트를 예약합니다.
scheduleDiscountSharePolicy 2 params body → 200400401403404409
DELETE
/platform/discount-share-policies/{id}/schedule
주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 취소합니다.
cancelPlatformDiscountSharePolicySchedule 2 params → 200400401403404
GET
/platform/discount-share-policies/{id}
할인 분담 정책 조회
getPlatformDiscountSharePolicy 2 params → 200400401403404
PATCH
/platform/discount-share-policies/{id}
할인 분담 정책 수정
updatePlatformDiscountSharePolicy 2 params body → 200400401403404409
GET
/platform/discount-share-policies
할인 분담 정책 다건 조회
getPlatformDiscountSharePolicies 2 params → 200400401403
POST
/platform/discount-share-policies
할인 분담 정책 생성
createPlatformDiscountSharePolicy 1 param body → 200400401403409
GET
/platform/discount-share-policy-filter-options
할인 분담 정책 다건 조회 시 필요한 필터 옵션을 조회합니다.
getPlatformDiscountSharePolicyFilterOptions 2 params → 200400401403
GET
/platform/partner-filter-options
파트너 다건 조회 시 필요한 필터 옵션을 조회합니다.
getPlatformPartnerFilterOptions 2 params → 200400401403
POST
/platform/partner-settlements/complete-payout
일괄 지급 완료 처리
completePlatformPayoutByPartnerSettlementIds 1 param body → 200400401403404409
POST
/platform/partner-settlements/delete
정산내역 삭제
deletePlatformPartnerSettlements 1 param body → 200400401403404
GET
/platform/partner-settlements
정산 내역 다건 조회
getPlatformPartnerSettlements 2 params → 200400401403
POST
/platform/partners/batch
파트너 다건 생성
createPlatformPartners 1 param body → 200400401403404409
POST
/platform/partners/counterparty-connect/{id}
파트너 거래처 연동
connectPartnerCounterparty 2 params → 200400401403404409503
POST
/platform/partners/counterparty-connect
파트너 일괄 거래처 연동
connectBulkPartnerCounterparty 1 param body → 200400401403404503
POST
/platform/partners/counterparty-disconnect/{id}
파트너 거래처 연동 해제
disconnectPartnerCounterparty 2 params → 200400401403404409503
POST
/platform/partners/counterparty-disconnect
파트너 일괄 거래처 연동 해제
disconnectBulkPartnerCounterparty 1 param body → 200400401403404503
POST
/platform/partners/schedule
schedulePlatformPartners 1 param body → 200400401403404409
POST
/platform/partners/{id}/archive
파트너 보관
archivePlatformPartner 2 params → 200400401403404409
POST
/platform/partners/{id}/recover
파트너 복원
recoverPlatformPartner 2 params → 200400401403404409
GET
/platform/partners/{id}/schedule
주어진 아이디에 대응되는 파트너의 예약 업데이트를 조회합니다.
getPlatformPartnerSchedule 2 params → 200400401403404
PUT
/platform/partners/{id}/schedule
주어진 아이디에 대응되는 파트너에 예약 업데이트를 재설정합니다.
reschedulePartner 2 params body → 200400401403404409
POST
/platform/partners/{id}/schedule
주어진 아이디에 대응되는 파트너에 업데이트를 예약합니다.
schedulePartner 2 params body → 200400401403404409
DELETE
/platform/partners/{id}/schedule
주어진 아이디에 대응되는 파트너의 예약 업데이트를 취소합니다.
cancelPlatformPartnerSchedule 2 params → 200400401403404
GET
/platform/partners/{id}
파트너 조회
getPlatformPartner 2 params → 200400401403404
PATCH
/platform/partners/{id}
파트너 수정
updatePlatformPartner 2 params body → 200400401403404409
GET
/platform/partners
파트너 다건 조회
getPlatformPartners 2 params → 200400401403
POST
/platform/partners
파트너 생성
createPlatformPartner 1 param body → 200400401403404409
GET
/platform/payouts
지급 내역 다건 조회
getPlatformPayouts 2 params → 200400401403
GET
/platform/setting
플랫폼 설정 조회
getPlatformSetting 1 param → 200400401403
PATCH
/platform/setting
플랫폼 설정 업데이트
updatePlatformSetting 1 param body → 200400401403
GET
/platform/transfer-summaries/sheet-file
정산 상세 내역 다운로드
downloadPlatformTransferSheet 2 params → 200400401
GET
/platform/transfer-summaries
정산건 다건 조회
getPlatformTransferSummaries 2 params → 200400401403
POST
/platform/transfers/manual
수기 정산건 생성
createPlatformManualTransfer 1 param body → 200400401403404409
POST
/platform/transfers/order-cancel
주문 취소 정산건 생성
createPlatformOrderCancelTransfer 1 param body → 200400401403404409
POST
/platform/transfers/order
주문 정산건 생성
createPlatformOrderTransfer 1 param body → 200400401403404409
GET
/platform/transfers/{id}
정산건 조회
getPlatformTransfer 2 params → 200400401403404
DELETE
/platform/transfers/{id}
정산건 삭제
deletePlatformTransfer 2 params → 200400401403404

Schemas 437

The contract defines 437 schemas that model the data the API accepts and returns. The most detailed are PlatformWithdrawalAccountTransfer (32 properties), PlatformPayout (29 properties), PlatformOrderCancelTransfer (21 properties), PlatformOrderTransfer (20 properties). Each schema is shown below with its type and property counts.

PlatformOrderTransferOrderLine
object
주문 항목
5 properties 5 required
CreatePlatformContractBody
object
계약 객체 생성을 위한 입력 정보
7 properties 5 required
MonthDay
object
월 및 일자 정보
2 properties 2 required
PlatformTransferType
string
GetPlatformContractsResponse
object
계약 다건 조회 성공 응답
2 properties 2 required
GetPlatformContractScheduleError
ReschedulePlatformPartnerResponse
object
파트너 예약 업데이트 재설정 성공 응답
1 property 1 required
PlatformContractNotFoundError
object
2 properties 1 required
GetPlatformTransferSummariesResponse
object
2 properties 2 required
PlatformPartnerIdsDuplicatedError
object
4 properties 3 required
UpdatePlatformDiscountSharePolicyResponse
object
할인 분담 정책 업데이트 성공 응답
1 property 1 required
PlatformContractScheduleAlreadyExistsError
object
2 properties 1 required
CreatePlatformOrderCancelTransferBody
object
주문 취소 정산 등록을 위한 입력 정보 하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다. 하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다.…
14 properties 2 required
RescheduleContractError
CompletePlatformPayoutByPartnerSettlementIdsError
PlatformPartnerTypeIsNotBusinessError
object
파트너 유형이 사업자가 아닌 경우
2 properties 1 required
PlatformCannotSpecifyTransferError
object
정산 건 식별에 실패한 경우
2 properties 1 required
GetPlatformDiscountSharePolicyFilterOptionsError
PlatformMemberCompanyConnectedPartnerTypeUnchangeableError
object
연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우
2 properties 1 required
CreatePlatformPartnerBody
object
파트너 생성을 위한 입력 정보
9 properties 6 required
DayOfWeek
string
요일
PlatformPayout
object
29 properties 23 required
ConnectPartnerCounterpartyError
PlatformTransferDiscountSharePolicyNotFoundError
object
5 properties 3 required
PlatformPartnerSettlementFilterKeywordInput
object
3 properties
PlatformBulkAccountTransferStats
object
2 properties 2 required
PlatformCancelOrderTransfersExistsError
object
2 properties 1 required
PlatformPartnerOrderCancelSettlement
object
13 properties 11 required
UnauthorizedError
object
인증 정보가 올바르지 않은 경우
2 properties 1 required
PlatformPartnerSettlementsNotFoundError
object
요청한 정산건 목록을 찾을 수 없는 경우
4 properties 3 required
CreateManualTransferResponse
object
1 property 1 required
CreatePlatformDiscountSharePolicyResponse
object
할인 분담 정책 생성 성공 응답
1 property 1 required
GetPlatformAdditionalFeePoliciesError
CancelPlatformContractScheduleError
PlatformOrderTransferDiscount
object
할인 정보
5 properties 5 required
PlatformDiscountSharePolicyAlreadyExistsError
object
2 properties 1 required
PlatformBulkPayoutIdAlreadyExistsError
object
일괄 지급 아이디가 이미 존재하는 경우
2 properties 1 required
CreatePlatformOrderTransferBodyOrderLine
object
주문 항목
4 properties 4 required
PlatformAccountTransfer
계좌 이체 송금 대행을 통해 일어난 정산 금액 지급, 인출 목적의 계좌 이체 결과 정보입니다.
PageInfo
object
반환된 페이지 결과 정보
3 properties 3 required
PlatformPartnerContractSummary
object
파트너 계약 요약 정보
2 properties 2 required
PlatformSettlementParameterNotFoundError
object
정산 파라미터가 존재하지 않는 경우
2 properties 1 required
SchedulePlatformAdditionalFeePolicyBody
object
추가 수수료 정책 업데이트 예약을 위한 입력 정보
2 properties 2 required
UpdatePlatformPartnerResponse
object
파트너 업데이트 성공 응답
1 property 1 required
PlatformTransferNonDeletableStatusError
object
2 properties 1 required
PlatformPortOnePaymentCancelAmountType
string
금액 타입
PlatformPayoutAccount
object
3 properties 3 required
PlatformPaymentMethodMobileInput
object
PlatformPayoutStatus
string
PlatformSettlementCancelAmountExceededPortOneCancelError
object
정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우
6 properties 5 required
CreatePlatformOrderCancelTransferBodyOrderDetail
object
주문 취소 정보 orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.
3 properties
PlatformCancellableDiscountTaxFreeAmountExceededError
object
7 properties 5 required
PlatformCompanyVerificationAlreadyUsedError
object
파트너 사업자 검증 아이디를 이미 사용한 경우
2 properties 1 required
GetPlatformAdditionalFeePolicyError
TransferParameters
object
DisconnectBulkPartnerCounterpartyBody
object
파트너 일괄 거래처 연동 해제 요청 정보 파트너들을 일괄 거래처 연동 해제합니다.
1 property
CreatePlatformDiscountSharePolicyBody
object
할인 분담 정책 생성을 위한 입력 정보
4 properties 2 required
GetPlatformBulkAccountTransfersResponse
object
3 properties 3 required
PlatformSettlementDateEarlierThanSettlementStartDateError
object
정산일이 정산 시작일보다 빠른 경우
4 properties 3 required
RecoverPlatformAdditionalFeePolicyError
PlatformCannotArchiveScheduledContractError
object
예약된 업데이트가 있는 계약을 보관하려고 하는 경우
2 properties 1 required
CancelPlatformContractScheduleResponse
object
계약 예약 업데이트 취소 성공 응답
PlatformSettlementTaxFreeAmountExceededPortOnePaymentError
object
정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우
5 properties 4 required
UpdatePlatformPartnerError
CreatePlatformAdditionalFeePolicyError
PlatformSettlementCycle
object
정산 주기 지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
3 properties 3 required
PlatformBulkTaskType
string
PlatformArchivedAdditionalFeePolicyError
object
보관된 추가 수수료 정책을 업데이트하려고 하는 경우
2 properties 1 required
PlatformBulkPayoutStatusStats
object
6 properties 6 required
EasyPayMethodType
string
간편 결제 수단
CreatePlatformPartnerBodyContact
object
파트너 담당자 정보
3 properties 2 required
PlatformOrderCancelTransfer
object
주문 취소 정산건
21 properties 18 required
PlatformSettlementPaymentAmountExceededPortOnePaymentError
object
정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우
5 properties 4 required
CancelPlatformPartnerScheduleError
PlatformOrderTransfer
object
주문 정산건
20 properties 17 required
PlatformBankAccountProvider
string
제공자
PlatformCompanyNotFoundError
object
사업자 정보를 찾을 수 없는 경우
2 properties 1 required
PlatformPartnerManualSettlement
object
12 properties 10 required
GetPlatformPartnersError
CompletePlatformPayoutByPartnerSettlementIdsResponse
object
일괄 지급 완료 처리 결과
4 properties 2 required
GetPlatformPartnerError
PlatformCounterpartyOngoingTaxInvoiceExistsError
object
연동된 거래처에 진행 중인 세금계산서가 있는 경우
2 properties 1 required
PlatformSettlementCycleMethodDailyInput
object
ArchivePlatformPartnerError
PlatformSettlementCycleMethodManualDates
object
정해진 날짜(월, 일)에 정산
2 properties 2 required
ForbiddenError
object
요청이 거절된 경우
2 properties 1 required
PlatformAccount
object
플랫폼 정산 계좌 currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.
5 properties 5 required
GetPlatformPartnerSettlementsBody
object
정산내역 다건 조회를 위한 입력 정보
3 properties 1 required
PlatformCounterpartyNotConnectableStatusError
object
파트너 거래처 연동 상태가 연동 가능한 상태가 아닌 경우
2 properties 1 required
PlatformUserDefinedFormulaResults
object
PlatformPayer
string
금액 부담 주체 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PlatformPayoutSettlementStatementStatus
string
정산 내역서 발송 상태
PlatformTransferSummaryPortOnePayment
object
5 properties 4 required
UpdatePlatformPartnerBodyTypeWhtPayer
object
1 property
GetPlatformPayoutsError
PlatformAdditionalFeePolicyNotFoundError
object
2 properties 1 required
PlatformCancellableDiscountAmountExceededError
object
7 properties 5 required
CreatePlatformContractError
PlatformArchivedPartnersCannotBeScheduledError
object
보관된 파트너들을 예약 업데이트하려고 하는 경우
2 properties 1 required
PlatformPaymentMethodEasyPay
object
간편 결제
3 properties 1 required
PlatformOrderTransferCancellation
object
주문 취소 정보
2 properties 2 required
PlatformPaymentMethodTransfer
object
계좌이체
1 property 1 required
ConnectBulkPartnerCounterpartyBody
object
파트너 일괄 거래처 연동 요청 정보 파트너들을 일괄 거래처 연동합니다.
1 property
SettlementAmountType
string
RecoverPlatformContractError
GetPlatformPartnerSettlementsError
PlatformBulkTaskProgressStats
object
5 properties 5 required
PlatformArchivedContractError
object
보관된 계약을 업데이트하려고 하는 경우
2 properties 1 required
GetPlatformTransferSummariesBody
object
정산건 요약 다건 조회를 위한 입력 정보
2 properties
GetPlatformBulkPayoutsResponse
object
3 properties 3 required
PageInput
object
다건 조회 API 에 사용되는 페이지 입력 정보
2 properties
Bank
string
은행
DeletePlatformTransferResponse
object
PlatformCannotArchiveScheduledAdditionalFeePolicyError
object
예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우
2 properties 1 required
ReschedulePlatformPartnerBody
object
파트너 예약 업데이트 재설정을 위한 입력 정보
2 properties 2 required
PlatformArchivedPartnerError
object
보관된 파트너를 업데이트하려고 하는 경우
2 properties 1 required
PlatformSettlementCycleMethodWeeklyInput
object
1 property 1 required
UpdatePlatformPartnerBodyTypeNonWhtPayer
object
1 property
SchedulePlatformPartnersResponse
object
PlatformPaymentMethodTransferInput
object
PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
object
6 properties 5 required
PlatformManualTransferSummary
object
13 properties 12 required
PlatformSettlementParameterValue
object
플랫폼 정산 파라미터 값
2 properties 1 required
PlatformPaymentMethodMobile
object
모바일
1 property 1 required
PlatformTransferIdAlreadyUsedError
object
2 properties 1 required
SchedulePlatformContractBody
object
계약 업데이트 예약을 위한 입력 정보
2 properties 2 required
PlatformBulkAccountTransfer
object
12 properties 11 required
PlatformFixedRateFee
object
정률 수수료 총 금액에 정해진 비율을 곱한 만큼의 수수료를 책정합니다.
2 properties 2 required
SchedulePlatformDiscountSharePolicyBody
object
할인 분담 정책 업데이트 예약을 위한 입력 정보
2 properties 2 required
GetPlatformPayoutsResponse
object
3 properties 3 required
CreatePlatformPartnersError
PlatformPartnerTaxationType
string
플랫폼 파트너 과세 유형
CreatePlatformPartnerBodyTypeWhtPayer
object
1 property
UpdatePlatformSettingResponse
object
플랫폼 설정 업데이트 결과
1 property 1 required
SchedulePlatformDiscountSharePolicyResponse
object
할인 분담 정책 업데이트 예약 성공 응답
1 property 1 required
PlatformTransferFilterInputKeyword
object
정산건 검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.
11 properties
PlatformTransferSummary
PlatformExternalApiFailedError
object
외부 api 오류
2 properties 1 required
PlatformCannotArchiveScheduledPartnerError
object
예약된 업데이트가 있는 파트너를 보관하려고 하는 경우
2 properties 1 required
RecoverPlatformContractResponse
object
계약 복원 성공 응답
1 property 1 required
PlatformTransferSummaryPartnerType
string
파트너 유형
ArchivePlatformContractResponse
object
계약 보관 성공 응답
1 property 1 required
InvalidRequestError
object
요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
2 properties 1 required
PlatformBankAccountDetail
object
계좌 상세 정보
4 properties 3 required
PlatformSettlementCycleType
string
플랫폼 정산 주기 계산 방식
PlatformAdditionalFeePolicyFilterInput
object
추가 수수료 정책 다건 조회를 위한 필터 조건
3 properties
PlatformPaymentMethodEasyPayInput
object
간편 결제 입력 정보
2 properties
PlatformBulkPayoutStats
object
2 properties 2 required
SchedulePlatformPartnersError
DeletePlatformPartnerSettlementsError
PlatformPayoutStatusStats
object
8 properties 8 required
UpdatePlatformDiscountSharePolicyError
PlatformCompanyState
object
4 properties 2 required
PlatformPartner
object
파트너 파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.
14 properties 13 required
ArchivePlatformDiscountSharePolicyResponse
object
할인 분담 보관 성공 응답
1 property 1 required
DownloadPlatformTransferSheetError
SchedulePlatformPartnersBodyUpdateContact
object
파트너 업데이트를 위한 유형별 추가 정보
3 properties
DeletePlatformPartnerSettlementsBody
object
2 properties 1 required
RecoverPlatformDiscountSharePolicyError
GetPlatformPartnersResponse
object
파트너 다건 조회 성공 응답 정보
2 properties 2 required
PlatformPartnerTypeBusiness
object
사업자 파트너 정보 사업자 유형의 파트너 추가 정보 입니다.
11 properties 7 required
PlatformCancellableAmountExceededError
object
취소 가능한 금액이 초과한 경우
5 properties 4 required
PlatformPartnerStatus
string
플랫폼 파트너 상태
GetPlatformAdditionalFeePoliciesResponse
object
추가 수수료 정책 다건 조회 성공 응답 정보
2 properties 2 required
CreatePlatformOrderTransferBodyExternalPaymentDetail
object
외부 결제 상세 정보
4 properties 1 required
PlatformSettlementCycleMethodWeekly
object
매주 정해진 요일에 정산
2 properties 2 required
ReschedulePlatformDiscountSharePolicyResponse
object
할인 분담 정책 예약 업데이트 재설정 성공 응답
1 property 1 required
GetPlatformBulkAccountTransfersError
GetPlatformContractsBody
object
계약 다건 조회를 위한 입력 정보
2 properties
PlatformMemberCompanyConnectedPartnersCannotBeScheduledError
object
연동 사업자로 연동된 파트너들을 예약 수정하려고 시도한 경우
4 properties 3 required
PlatformTransferStatus
string
정산 상태
GetPlatformPartnersBody
object
파트너 다건 조회를 위한 입력 정보
2 properties
PlatformDiscountSharePolicyFilterInput
object
할인 분담 정책 다건 조회를 위한 필터 조건
3 properties
PlatformAccountVerificationAlreadyUsedError
object
파트너 계좌 검증 아이디를 이미 사용한 경우
2 properties 1 required
PlatformUserDefinedPropertyKeyValue
object
사용자 정의 속성
2 properties 2 required
PlatformAccountTransferFilter
object
15 properties
GetPlatformAccountTransfersError
PlatformFeeInput
object
수수료 계산 방식을 특정하기 위한 입력 정보 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.
2 properties
PlatformPaymentMethodVirtualAccount
object
가상계좌
1 property 1 required
PlatformBulkTaskStatus
string
CreatePlatformPartnersResponse
object
파트너 다건 생성 성공 응답
1 property 1 required
CompletePlatformPayoutByPartnerSettlementIdsBody
object
5 properties 2 required
PlatformAdditionalFeePolicyAlreadyExistsError
object
2 properties 1 required
PlatformCurrencyNotSupportedError
object
지원 되지 않는 통화를 선택한 경우
2 properties 1 required
EasyPayProvider
string
간편 결제사
GetPlatformPartnerSettlementsResponse
object
정산내역 다건 조회 성공 응답 정보
3 properties 3 required
PlatformDiscountSharePoliciesNotFoundError
object
4 properties 3 required
PlatformTransferPropertyExactMatchInput
object
사용자 정의 속성 key/value exact match
2 properties 2 required
UpdatePlatformDiscountSharePolicyBody
object
할인 분담 정책 업데이트를 위한 입력 정보 값이 명시되지 않은 필드는 업데이트하지 않습니다.
3 properties
PlatformSettlementCycleMethodMonthly
object
매월 정해진 날(일)에 정산
2 properties 2 required
PlatformPartnerSchedulesAlreadyExistError
object
4 properties 3 required
SchedulePlatformPartnersBodyUpdateTypeWhtPayer
object
1 property
GetPlatformTransferError
PlatformCannotArchiveScheduledDiscountSharePolicyError
object
예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우
2 properties 1 required
GetPlatformBulkPayoutsError
PlatformPartnerOrderSettlement
object
13 properties 11 required
CreatePlatformPartnerError
PlatformProperties
object
PlatformNegativePayoutAmountPartnersError
object
지급 금액의 총합이 음수인 파트너가 존재하는 경우
2 properties 1 required
SchedulePlatformPartnersBody
object
3 properties 2 required
PlatformPayment
결제 정보
CancelPlatformPartnerScheduleResponse
object
파트너 예약 업데이트 취소 성공 응답
PlatformNonDeletablePartnerSettlementsError
object
삭제할 수 없는 정산건이 포함된 경우
4 properties 3 required
PlatformPartnerSettlementStatus
string
정산 상태
PlatformNotSupportedBankError
object
지원하지 않는 은행인 경우
2 properties 1 required
PlatformOrderCancelTransferSummary
object
16 properties 15 required
PlatformPartnerFilterInput
object
파트너 필터 입력 정보
12 properties
UpdatePlatformPartnerBodyTypeBusiness
object
8 properties
PlatformUserDefinedPropertyValue
object
1 property 1 required
PlatformSettlementAmountExceededError
object
정산 가능한 금액을 초과한 경우
5 properties 4 required
PlatformPartnerSettlement
CreatePlatformDiscountSharePolicyError
GetPlatformAccountHolderError
PlatformPartnerTaxationTypeIsSimpleError
object
파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우
2 properties 1 required
GetPlatformCompanyStatePayload
object
사업자 조회 성공 응답 정보
2 properties 2 required
PlatformPaymentMethod
결제 수단
CreatePlatformOrderTransferBodyAdditionalFee
object
추가 수수료 정보
1 property 1 required
PlatformPartnerTypeNonWhtPayer
object
원천징수 비대상자 파트너 정보 비사업자 유형의 파트너 추가 정보 입니다.
2 properties 1 required
PlatformAdditionalFeePolicy
object
추가 수수료 정책 추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.
9 properties 8 required
DownloadPlatformTransferSheetBody
object
2 properties
PlatformBtxNotEnabledError
object
BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
2 properties 1 required
PlatformAmountExceededType
string
PlatformCancellationNotFoundError
object
2 properties 1 required
DateTimeRange
object
시간 범위
2 properties 2 required
PlatformPaymentNotFoundError
object
2 properties 1 required
GetPlatformPartnerScheduleError
SchedulePlatformAdditionalFeePolicyResponse
object
추가 수수료 정책 업데이트 예약 성공 응답
1 property 1 required
PlatformDiscountSharePolicy
object
할인 분담 정책 할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.
8 properties 7 required
RecoverPlatformPartnerError
PlatformPartnerIdsAlreadyExistError
object
4 properties 3 required
ReschedulePlatformAdditionalFeePolicyBody
object
추가 수수료 정책 예약 업데이트 재설정을 위한 입력 정보
2 properties 2 required
SchedulePlatformPartnersBodyUpdateType
object
파트너 유형별 정보 업데이트를 위한 입력 정보 파트너 유형별 추가 정보를 수정합니다. 최초 생성된 유형 내에서 세부 정보만 수정할 수 있고 파트너의 유형 자체를 수정할 수는 없습니다.
3 properties
SchedulePlatformPartnerResponse
object
파트너 업데이트 예약 성공 응답
1 property 1 required
PlatformPaymentMethodInput
object
결제 수단 입력 정보
6 properties
PlatformSettlementCycleDatePolicy
string
플랫폼 정산 기준일
PlatformPaymentMethodGiftCertificate
object
상품권
1 property 1 required
RescheduleDiscountSharePolicyError
PlatformOrderTransferSummary
object
16 properties 15 required
DisconnectBulkPartnerCounterpartyResponse
object
파트너 일괄 거래처 연동 해제 응답
1 property 1 required
GetPlatformDiscountSharePolicyScheduleError
UpdatePlatformContractBody
object
계약 업데이트를 위한 입력 정보. 값이 명시되지 않은 필드는 업데이트되지 않습니다. 값이 명시되지 않은 필드는 업데이트되지 않습니다.
6 properties
ConnectBulkPartnerCounterpartyError
PlatformSettlementCycleMethodManualDatesInput
object
1 property 1 required
PlatformContact
object
플랫폼 파트너 담당자 연락 정보 파트너 담당자에게 연락하기 위한 정보들 입니다.
3 properties 2 required
PlatformNegativeAmountNotAllowedError
object
정산 건별 옵션이 켜진 플랫폼에서 음수 금액 수기 정산 생성을 시도한 경우
2 properties 1 required
PlatformContractFilterInputKeyword
object
검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 계약만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.
2 properties
PlatformOrderTransferAlreadyCancelledError
object
2 properties 1 required
PaymentMethodType
string
ScheduleDiscountSharePolicyError
PlatformSettlementCycleMethodInput
object
플랫폼 정산 주기 계산 방식 입력 정보 하나의 하위 필드에만 값을 명시하여 요청합니다.
4 properties
PlatformCancellableProductQuantityExceededError
object
4 properties 3 required
PlatformNoSelectedPartnerSettlementsError
object
선택된 정산건이 없는 경우
2 properties 1 required
DateRange
object
2 properties 2 required
PlatformArchivedPartnerNtsNotAllowedError
object
보관된 파트너는 국세청 연동/연동해제를 할 수 없는 경우
2 properties 1 required
PlatformAccountStatus
string
플랫폼 계좌 상태
SchedulePartnerError
CreatePlatformOrderTransferBodyOrderDetail
object
주문 정보 주문 금액 또는 주문 항목 하나만 입력 가능합니다.
2 properties
PlatformAccountTransferStatusStats
object
8 properties 8 required
PlatformInsufficientDataToChangePartnerTypeError
object
파트너 타입 수정에 필요한 데이터가 부족한 경우
2 properties 1 required
ReschedulePlatformAdditionalFeePolicyResponse
object
추가 수수료 정책 예약 업데이트 재설정 성공 응답
1 property 1 required
PlatformBulkAccountTransferStatusStats
object
4 properties 4 required
PlatformDiscountSharePolicyFilterOptions
object
할인 분담 정책 필터 옵션 조회 성공 응답 정보
1 property 1 required
CreatePlatformOrderTransferBodyDiscount
object
할인 정보
3 properties 2 required
SchedulePlatformPartnerBody
object
파트너 업데이트 예약을 위한 입력 정보
2 properties 2 required
DisconnectBulkPartnerCounterpartyError
PlatformTransferNotFoundError
object
2 properties 1 required
UpdatePlatformPartnerBodyAccount
object
파트너 계좌 업데이트를 위한 입력 정보
5 properties 4 required
CreateOrderTransferResponse
object
1 property 1 required
PlatformDepositAccountTransfer
object
15 properties 13 required
PlatformSettlementCycleMethod
플랫폼 정산 주기 계산 방식
PlatformPartnerSettlementStatusStats
object
9 properties 9 required
PlatformMemberCompanyConnectedPartnerBrnUnchangeableError
object
연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우
2 properties 1 required
PlatformDuplicatedPartnerSettlementIdsError
object
선택된 정산건 아이디에 중복이 있는 경우
2 properties 1 required
PlatformPartnerScheduleAlreadyExistsError
object
2 properties 1 required
PlatformSettlementCycleMethodDaily
object
매일 정산
1 property 1 required
PlatformBulkAccountTransferFilterInputCriteria
object
3 properties
PlatformTransferSummaryPartner
object
6 properties 5 required
PlatformPaymentMethodGiftCertificateInput
object
ConnectPartnerCounterpartyResponse
object
파트너 거래처 연동 응답
1 property 1 required
CreatePlatformOrderCancelTransferBodyExternalCancellationDetail
object
외부 결제 상세 정보
1 property
GetPlatformSettingError
ScheduleAdditionalFeePolicyError
PlatformMemberCompanyConnectedPartnerCannotBeScheduledError
object
연동 사업자로 연동된 파트너를 예약 수정하려고 시도한 경우
2 properties 1 required
GetAccountTransfersBody1
object
3 properties
PlatformBulkPayoutStatus
string
PlatformCancellationAndPaymentTypeMismatchedError
object
2 properties 1 required
SchedulePlatformPartnersBodyUpdateTypeBusiness
object
8 properties
ArchivePlatformAdditionalFeePolicyResponse
object
추가 수수료 정책 보관 성공 응답
1 property 1 required
CreatePlatformPartnerResponse
object
파트너 생성 성공 응답
1 property 1 required
GetPlatformDiscountSharePoliciesResponse
object
할인 분담 정책 다건 조회 성공 응답 정보
2 properties 2 required
CreateOrderCancelTransferResponse
object
1 property 1 required
CreatePlatformOrderTransferError
CreatePlatformPartnerBodyTypeBusiness
object
8 properties 3 required
CreatePlatformOrderCancelTransferBodyDiscount
object
할인 정보
3 properties 2 required
PlatformCancellableAmountType
string
금액 타입
PlatformTransferFilterInput
object
정산건 필터 입력 정보 정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.
13 properties
PlatformProductIdDuplicatedError
object
3 properties 2 required
DisconnectPartnerCounterpartyError
CreatePlatformManualTransferBody
object
수기 정산건 생성을 위한 입력 정보
9 properties 3 required
RescheduleAdditionalFeePolicyError
PlatformAccountHolder
object
예금주 조회 성공 응답 정보
2 properties 2 required
SchedulePlatformPartnersBodyUpdateAccount
object
파트너 계좌 업데이트를 위한 입력 정보
5 properties 4 required
CreatePlatformOrderTransferBody
object
주문 정산건 생성을 위한 입력 정보
15 properties 5 required
PlatformContractsNotFoundError
object
4 properties 3 required
CancelPlatformDiscountSharePolicyScheduleResponse
object
할인 분담 정책 예약 업데이트 취소 성공 응답
UpdatePlatformPartnerBodyContact
object
파트너 담당자 업데이트를 위한 정보
3 properties
PlatformDiscountSharePolicyNotFoundError
object
2 properties 1 required
PlatformAdditionalFeePolicyScheduleAlreadyExistsError
object
2 properties 1 required
CreatePlatformOrderCancelTransferError
PlatformBulkPayoutFilterInputCriteria
object
3 properties
PlatformAccountTransferType
string
계좌 이체 유형
PlatformPayoutFilterInput
object
지급 내역 필터 입력 정보
11 properties 1 required
SchedulePlatformPartnersBodyUpdate
object
8 properties
CreatePlatformOrderCancelTransferBodyOrderDetailAll
object
전체 금액 취소
ScheduleContractError
PlatformArchivedDiscountSharePolicyError
object
보관된 할인 분담 정책을 업데이트하려고 하는 경우
2 properties 1 required
PlatformTransferSummaryPayment
PlatformPartnerFilterInputKeyword
object
파트너 검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 파트너만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.
8 properties
GetPlatformPartnerFilterOptionsError
DeletePlatformTransferError
GetPlatformBulkAccountTransfersBody
object
3 properties
SchedulePlatformPartnersBodyUpdateTypeNonWhtPayer
object
1 property
UpdatePlatformPartnerBodyType
object
파트너 업데이트를 위한 유형별 추가 정보 파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.
3 properties
PlatformPartnerSettlementType
string
정산 유형
GetPlatformAccountTransfersResponse
object
이체내역 다건 조회 성공 응답 정보
3 properties 3 required
PlatformOrderTransferAdditionalFee
object
추가 수수료 정보
3 properties 3 required
RecoverPlatformDiscountSharePolicyResponse
object
할인 분담 복원 성공 응답
1 property 1 required
PlatformPartnerBusinessStatus
string
플랫폼 파트너 사업자 상태
UpdatePlatformAdditionalFeePolicyError
PlatformPartnerIdAlreadyExistsError
object
2 properties 1 required
PlatformContract
object
계약 계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.
11 properties 10 required
PlatformBulkAccountTransferFilterInput
object
2 properties
CreatePlatformOrderCancelTransferBodyOrderLine
object
주문 취소 항목 리스트
3 properties 3 required
SchedulePlatformContractResponse
object
계약 업데이트 예약 성공 응답
1 property 1 required
ArchivePlatformDiscountSharePolicyError
RecoverPlatformAdditionalFeePolicyResponse
object
추가 수수료 정책 복원 성공 응답
1 property 1 required
CancelPlatformAdditionalFeePolicyScheduleError
PlatformPartnerScheduleExistsError
object
파트너 수정 예약 건이 존재하는 경우
2 properties 1 required
CreatePlatformContractResponse
object
계약 객체 생성 성공 응답
1 property 1 required
GetPlatformContractError
PlatformUserDefinedPropertyNotFoundError
object
사용자 정의 속성이 존재 하지 않는 경우
2 properties 1 required
DeletePlatformPartnerSettlementsResponse
object
정산내역 삭제 결과
UpdatePlatformSettingError
ReschedulePlatformDiscountSharePolicyBody
object
할인 분담 정책 예약 업데이트 재설정을 위한 입력 정보
2 properties 2 required
PlatformAccountVerificationFailedError
object
파트너 계좌 인증이 실패한 경우
2 properties 1 required
ConnectBulkPartnerCounterpartyResponse
object
파트너 일괄 거래처 연동 응답
1 property 1 required
PlatformAccountTransferStatus
string
계좌 이체 상태
PlatformPartnerNotFoundError
object
2 properties 1 required
PlatformOrderTransferProduct
object
상품
5 properties 4 required
PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
object
6 properties 5 required
PlatformWithdrawalAccountTransfer
object
32 properties 16 required
RecoverPlatformPartnerResponse
object
파트너 복원 성공 응답
1 property 1 required
PlatformPartnerSettlementFilterInput
object
8 properties
PlatformFixedAmountFee
object
정액 수수료 총 금액에 무관하게 정해진 수수료 금액을 책정합니다.
2 properties 2 required
PlatformBusinessStatus
string
플랫폼 사업자 상태
PlatformAccountVerificationNotFoundError
object
파트너 계좌 검증 아이디를 찾을 수 없는 경우
2 properties 1 required
PlatformPartnerTypeName
string
플랫폼 파트너 유형 이름
PlatformOngoingTaxInvoiceExistsError
object
진행 중인 세금계산서가 존재하는 경우
2 properties 1 required
GetPlatformDiscountSharePolicyError
ReschedulePlatformContractBody
object
계약 예약 업데이트 재설정을 위한 입력 정보
2 properties 2 required
PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError
object
정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우
5 properties 4 required
PlatformOrderSettlementAmount
object
정산 금액 정보 정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.
18 properties 18 required
PlatformAdditionalFeePolicyFilterInputKeyword
object
검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 추가 수수료 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.
3 properties
Currency
string
통화
CreatePlatformPartnerBodyTypeNonWhtPayer
object
1 property
PlatformDiscountSharePolicyScheduleAlreadyExistsError
object
2 properties 1 required
GetPlatformDiscountSharePoliciesBody
object
할인 분담 정책 다건 조회를 위한 입력 정보
2 properties
PlatformExternalApiTemporarilyFailedError
object
외부 api의 일시적인 오류
2 properties 1 required
GetPlatformTransferSummariesError
GetPlatformBulkPayoutsBody
object
3 properties
PlatformTaxationType
string
플랫폼 과세 유형
GetPlatformCompanyStateError
ArchivePlatformAdditionalFeePolicyError
GetPlatformContractsError
PlatformNonPayablePartnerSettlementsError
object
지급할 수 없는 정산건이 포함된 경우
4 properties 3 required
PlatformPartnerType
파트너 유형별 추가 정보
CreatePlatformPartnerBodyAccount
object
파트너 계좌 등록을 위한 정보
5 properties 4 required
PlatformSettlementCycleInput
object
플랫폼 정산 주기 입력 정보
3 properties 3 required
CancelPlatformDiscountSharePolicyScheduleError
CancelPlatformAdditionalFeePolicyScheduleResponse
object
추가 수수료 정책 예약 업데이트 취소 성공 응답
PlatformTransferSummaryExternalPayment
object
5 properties 3 required
PlatformDiscountSharePolicyIdDuplicatedError
object
4 properties 3 required
CreatePlatformAdditionalFeePolicyBody
object
추가 수수료 정책 생성을 위한 입력 정보
5 properties 3 required
PlatformPayoutMethod
string
PlatformPortOnePayment
object
포트원 결제 정보
8 properties 7 required
PlatformNotEnabledError
object
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
2 properties 1 required
PlatformPaymentMethodVirtualAccountInput
object
CreatePlatformManualTransferError
PlatformSetting
object
플랫폼 설정
8 properties 6 required
PlatformReferencedCancelOrderTransfersExistError
object
취소 정산건이 참조 중인 정산건이 포함된 경우
3 properties 2 required
PlatformDiscountSharePolicyFilterInputKeyword
object
검색 키워드 입력 정보 검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 할인 분담 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.
2 properties
GetPlatformAdditionalFeePolicyScheduleError
PlatformSettlementCycleMethodMonthlyInput
object
1 property 1 required
PlatformTransferAlreadyExistsError
object
4 properties 3 required
DisconnectPartnerCounterpartyResponse
object
파트너 거래처 연동 해제 응답
1 property 1 required
PlatformAdditionalFeePoliciesNotFoundError
object
4 properties 3 required
GetPlatformPayoutsBody
object
3 properties
PlatformPayoutSettlementStatementSummary
object
정산 내역서 요약 정보
3 properties 1 required
ArchivePlatformPartnerResponse
object
파트너 보관 성공 응답
1 property 1 required
ReschedulePlatformContractResponse
object
계약 예약 업데이트 재설정 성공 응답
1 property 1 required
PlatformContractAlreadyExistsError
object
2 properties 1 required
UpdatePlatformContractError
PlatformCounterpartyNotConnectedError
object
파트너가 거래처로 연동 되어있지 않은 경우
2 properties 1 required
CreatePlatformOrderTransferBodyProduct
object
상품
5 properties 3 required
ReschedulePartnerError
PlatformOrderDetailMismatchedError
object
2 properties 1 required
PlatformProductIdNotFoundError
object
3 properties 2 required
UpdatePlatformContractResponse
object
계약 객체 업데이트 성공 응답
1 property 1 required
PlatformPaymentMethodCard
object
카드
1 property 1 required
PlatformBulkTask
object
9 properties 9 required
PlatformFee
플랫폼 중개수수료 정보
PlatformPartnerFilterOptions
object
파트너 필터 옵션 조회 성공 응답 정보
2 properties 2 required
PlatformPayoutTaxInvoiceStatus
string
UpdatePlatformAdditionalFeePolicyResponse
object
추가 수수료 정책 업데이트 성공 응답
1 property 1 required
PlatformBulkPayoutFilterInput
object
3 properties
PlatformPartnerTypeWhtPayer
object
원천징수 대상자 파트너 정보 비사업자 유형의 파트너 추가 정보 입니다.
2 properties 1 required
PlatformTransfer
정산건 정산건은 파트너에 정산해줄 정산 금액과 정산 방식 등이 포함되어 있는 정산 정보입니다. 정산 방식은은 주문 정산, 주문 취소 정산, 수기 정산이 있습니다.
Type
string
PlatformBulkAccountTransferStatus
string
PlatformPartnerPendingNtsOperationError
object
파트너의 국세청 연동/해제가 진행 중인 경우
2 properties 1 required
GetPlatformAdditionalFeePoliciesBody
object
추가 수수료 정책 다건 조회를 위한 입력 정보
2 properties
PlatformPaymentMethodCardInput
object
CreatePlatformPartnersBody
object
파트너 다건 생성을 위한 입력 정보
1 property 1 required
PlatformManualTransfer
object
수기 정산건
14 properties 11 required
PlatformBulkPayout
object
12 properties 12 required
ArchivePlatformContractError
PlatformTargetPartnerNotFoundError
object
처리 대상 파트너가 존재하지 않는 경우
2 properties 1 required
UpdatePlatformAdditionalFeePolicyBody
object
추가 수수료 정책 업데이트를 위한 입력 정보 값이 명시하지 않은 필드는 업데이트되지 않습니다.
4 properties
PlatformPayoutFilterInputCriteria
object
검색 기준 입력 정보
8 properties
UpdatePlatformSettingBody
object
플랫폼 설정 업데이트를 위한 입력 정보
7 properties
CreatePlatformAdditionalFeePolicyResponse
object
플랫폼 생성 성공 응답 정보
1 property 1 required
PlatformContractFilterInput
object
계약 다건 조회를 위한 필터 조건
5 properties
PlatformExternalPayment
object
외부 결제 정보
6 properties 3 required
UpdatePlatformPartnerBody
object
파트너 업데이트를 위한 입력 정보 값이 명시되지 않은 필드는 업데이트되지 않습니다.
8 properties
PlatformPartnerMemberCompanyConnectionStatus
string
플랫폼 파트너 연동 사업자 연결 상태
CreatePlatformPartnerBodyType
object
파트너 생성을 위한 유형별 추가 정보
3 properties
GetPlatformDiscountSharePoliciesError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portone-platform-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 Platform 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.