개발자센터
V1
V2
원 페이먼트 인프라파트너 정산 자동화
API & SDK
리소스

PortOne REST API - V2

API 결제, 결제 정보 조회, 결제 취소 등의 기능을 제공하는 REST API입니다.

V2 API hostname: api.portone.io

OpenAPI JSON 내려받기Postman 등에서 import하여 활용할 수 있습니다.

요청 및 응답 형식

요청과 응답의 본문은 JSON 형식입니다.

API 매개 변수 중 URL 경로에 들어가는 문자열 값이 있는 경우, URL 경로에 들어갈 수 없는 문자열은 이스케이프하여야 합니다. 자바스크립트의 encodeURIComponent 함수 등을 사용할 수 있습니다.

인증 방식

V2 API를 사용하기 위해서는 V2 API Secret이 필요하며, 포트원 관리자콘솔 내 결제연동 탭에서 발급받으실 수 있습니다.

인증 관련 API를 제외한 모든 API는 HTTP Authorization 헤더로 아래 형식의 인증 정보를 전달해주셔야 합니다.

  • Authorization: PortOne MY_API_SECRET

GET 요청 시 Body 대신 Query 사용하기

GET 요청 시에 Body를 전달해야 하는 경우, Body 대신 Query를 사용할 수 있습니다.

이 경우, Body 객체를 requestBody Query 필드에 넣어주시면 됩니다.

하위호환성

포트원이 제공하는 모든 Stable API에 대해 아래와 같은 하위호환성이 보장됩니다.

  1. 현재 사용 가능한 입력 형식은 앞으로도 사용할 수 있습니다.

    • 입력 형식 내 필드 정의가 삭제되지 않습니다.

    • 필수 입력 정보가 추가되거나, 선택 입력 정보가 필수로 변경되지 않습니다.

      • 오로지 선택 입력 정보만 추가될 수 있습니다.
    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
    • enum 타입의 값이 삭제되지 않습니다.

  2. 출력 형식이 확장될 수 있지만, 축소되지 않습니다.

    • 출력 형식 내 필드 정의가 삭제되지 않습니다.

    • 사용 중인 필수 출력 정보가 선택사항으로 변경되거나 출력 시 누락되지 않습니다.

      • 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
      • 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.
    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.

    • 단, 새로운 필드 또는 enum 값, oneOf 케이스가 추가될 수 있습니다.

      • 알지 못하는 필드 및 값이 주어지더라도 crash가 발생하지 않도록 유의하여 개발해주세요.

UNSTABLE이 표기된 일부 API의 경우, 위 하위호환성 정책과 무관하게 변경 및 지원 종료될 수 있으니 이용에 유의하세요.

인증 관련 API

인증과 관련된 API 기능을 제공합니다.

결제 관련 API

결제와 관련된 API 기능을 제공합니다.

목차

결제 정보 사전 등록
post/payments/{paymentId}/pre-register
결제 단건 조회
get/payments/{paymentId}
결제 다건 조회(페이지 기반)
get/payments
결제 대용량 다건 조회(커서 기반)
get/payments-by-cursor
결제 취소
post/payments/{paymentId}/cancel
빌링키 결제
post/payments/{paymentId}/billing-key
수기 결제
post/payments/{paymentId}/instant
가상계좌 말소
post/payments/{paymentId}/virtual-account/close
에스크로 배송 정보 등록
post/payments/{paymentId}/escrow/logistics
에스크로 배송 정보 수정
patch/payments/{paymentId}/escrow/logistics
에스크로 구매 확정
post/payments/{paymentId}/escrow/complete
웹훅 재발송
post/payments/{paymentId}/resend-webhook
영수증 내 하위 상점 거래 등록
post/payments/{paymentId}/register-store-receipt

결제 예약 관련 API

결제 예약과 관련된 API 기능을 제공합니다.

빌링키 관련 API

빌링키와 관련된 API 기능을 제공합니다.

현금 영수증 관련 API

현금 영수증과 관련된 API 기능을 제공합니다.

프로모션 관련 API

프로모션과 관련된 API 기능을 제공합니다.

본인인증 관련 API

본인인증과 관련된 API 기능을 제공합니다.

파트너 정산 관련 API

파트너 정산 서비스 API 기능을 제공합니다.

정책 관련 API

파트너 정산에 적용할 정책에 관한 API 입니다.

목차

할인 분담 정책 다건 조회
get/platform/discount-share-policies
할인 분담 정책 생성
post/platform/discount-share-policies
할인 분담 정책 조회
get/platform/discount-share-policies/{id}
할인 분담 정책 수정
patch/platform/discount-share-policies/{id}
할인 분담 정책 보관
post/platform/discount-share-policies/{id}/archive
할인 분담 정책 복원
post/platform/discount-share-policies/{id}/recover
추가 수수료 정책 다건 조회
get/platform/additional-fee-policies
추가 수수료 정책 생성
post/platform/additional-fee-policies
추가 수수료 정책 조회
get/platform/additional-fee-policies/{id}
추가 수수료 정책 수정
patch/platform/additional-fee-policies/{id}
추가 수수료 정책 보관
post/platform/additional-fee-policies/{id}/archive
추가 수수료 정책 복원
post/platform/additional-fee-policies/{id}/recover
계약 다건 조회
get/platform/contracts
계약 생성
post/platform/contracts
계약 조회
get/platform/contracts/{id}
계약 수정
patch/platform/contracts/{id}
계약 보관
post/platform/contracts/{id}/archive
계약 복원
post/platform/contracts/{id}/recover

파트너 관련 API

파트너 정산에 적용할 파트너에 관한 API 입니다.

정산 상세내역 관련 API

파트너 정산 서비스의 정산 상세내역과 관련된 API 입니다.
get/platform/transfers/{id}

정산건 조회

정산건을 조회합니다.

Request

Path

id: string
조회하고 싶은 정산건 아이디

조회하고 싶은 정산건 아이디

Response

200

성공 응답으로 정산건 객체가 반환됩니다.

type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformManualTransfer 입니다.
id: string
정산건 아이디
graphqlId: string
partner: PlatformPartner
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

id: string
파트너 고유 아이디
graphqlId: string
name: string
파트너 법인명 혹은 이름
contact: PlatformContact
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

account: PlatformAccount
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

status: PlatformPartnerStatus
플랫폼 파트너 상태

플랫폼 파트너 상태

defaultContractId: string
파트너에 설정된 기본 계약 아이디
memo?: string
파트너에 대한 메모
(Optional)
tags: string[]
파트너의 태그 리스트
type: PlatformPartnerType
파트너 유형별 추가 정보

파트너 유형별 추가 정보

isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
userDefinedProperties: PlatformProperties
PlatformProperties
status: PlatformTransferStatus
정산 상태

정산 상태

SETTLED정산 완료
SCHEDULED정산 예약
PAID_OUT지급 완료
IN_PROCESS정산 중
IN_PAYOUT지급 중
memo?: string
메모
(Optional)
settlementDate: string
정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

settlementCurrency: Currency
통화 단위

통화 단위

OMRRial Omani
CUCPeso Convertible
BBDBarbados Dollar
PLNZloty
SVCEl Salvador Colon
BMDBermudian Dollar
TJSSomoni
TNDTunisian Dinar
GNFGuinean Franc
SDGSudanese Pound
MRUOuguiya
XBBBond Markets Unit European Monetary Unit (E.M.U.-6)
PKRPakistan Rupee
FKPFalkland Islands Pound
MURMauritius Rupee
XAFCFA Franc BEAC
SARSaudi Riyal
CADCanadian Dollar
HKDHong Kong Dollar
PYGGuarani
MGAMalagasy Ariary
UYIUruguay Peso en Unidades Indexadas (UI)
AUDAustralian Dollar
AMDArmenian Dram
YERYemeni Rial
CHEWIR Euro
MMKKyat
SEKSwedish Krona
TRYTurkish Lira
XBCBond Markets Unit European Unit of Account 9 (E.U.A.-9)
KESKenyan Shilling
GELLari
GTQQuetzal
TZSTanzanian Shilling
CUPCuban Peso
ALLLek
ERNNakfa
BRLBrazilian Real
UGXUganda Shilling
XUAADB Unit of Account
GIPGibraltar Pound
MZNMozambique Metical
KRW대한민국 원화
JODJordanian Dinar
IQDIraqi Dinar
VUVVatu
XXXThe codes assigned for transactions where no currency is involved
UZSUzbekistan Sum
BOVMvdol
UAHHryvnia
PENSol
KMFComorian Franc
DOPDominican Peso
BDTTaka
LKRSri Lanka Rupee
FJDFiji Dollar
LSLLoti
BSDBahamian Dollar
SRDSurinam Dollar
XTSCodes specifically reserved for testing purposes
SHPSaint Helena Pound
LRDLiberian Dollar
QARQatari Rial
BNDBrunei Dollar
CDFCongolese Franc
SLELeone
USNUS Dollar (Next day)
VESBolívar Soberano
TMTTurkmenistan New Manat
CHWWIR Franc
BGNBulgarian Lev
JMDJamaican Dollar
SZLLilangeni
CZKCzech Koruna
ZMWZambian Kwacha
UYUPeso Uruguayo
NPRNepalese Rupee
EGPEgyptian Pound
AZNAzerbaijan Manat
CLPChilean Peso
MOPPataca
SCRSeychelles Rupee
HTGGourde
VNDDong
LAKLao Kip
BTNNgultrum
GBPPound Sterling
SSPSouth Sudanese Pound
XPDPalladium
TWDNew Taiwan Dollar
DZDAlgerian Dinar
MXNMexican Peso
XDRSDR (Special Drawing Right)
ZWLZimbabwe Dollar
AWGAruban Florin
THBBaht
ISKIceland Krona
LBPLebanese Pound
SGDSingapore Dollar
MWKMalawi Kwacha
KZTTenge
CRCCosta Rican Colon
WSTTala
DJFDjibouti Franc
LYDLibyan Dinar
NGNNaira
BIFBurundi Franc
AEDUAE Dirham
CHFSwiss Franc
RWFRwanda Franc
XBDBond Markets Unit European Unit of Account 17 (E.U.A.-17)
INRIndian Rupee
CLFUnidad de Fomento
XOFCFA Franc BCEAO
COUUnidad de Valor Real
MXVMexican Unidad de Inversion (UDI)
PGKKina
CNYYuan Renminbi
SYPSyrian Pound
VEDBolívar Soberano
RONRomanian Leu
AFNAfghani
PHPPhilippine Peso
MDLMoldovan Leu
KHRRiel
XPTPlatinum
COPColombian Peso
DKKDanish Krone
KYDCayman Islands Dollar
XPFCFP Franc
GMDDalasi
MVRRufiyaa
STNDobra
TTDTrinidad and Tobago Dollar
PABBalboa
XAUGold
XAGSilver
JPY일본 엔화
TOPPa’anga
BWPPula
MKDDenar
ARSArgentine Peso
HUFForint
MYRMalaysian Ringgit
USD미국 달러
SLLLeone
MADMoroccan Dirham
RUBRussian Ruble
MNTTugrik
BOBBoliviano
GYDGuyana Dollar
SBDSolomon Islands Dollar
XBABond Markets Unit European Composite Unit (EURCO)
BHDBahraini Dinar
HNLLempira
UYWUnidad Previsional
NZDNew Zealand Dollar
XCDEast Caribbean Dollar
XSUSucre
KGSSom
AOAKwanza
BZDBelize Dollar
IDRRupiah
SOSSomali Shilling
NIOCordoba Oro
GHSGhana Cedi
ANGNetherlands Antillean Guilder
RSDSerbian Dinar
ILSNew Israeli Sheqel
NOKNorwegian Krone
KWDKuwaiti Dinar
NADNamibia Dollar
ETBEthiopian Birr
BYNBelarusian Ruble
KPWNorth Korean Won
EUREuro
CVECabo Verde Escudo
ZARRand
IRRIranian Rial
HRKKuna (Replaced by EUR)
BAMConvertible Mark
payoutId?: string
(Optional)
payoutGraphqlId?: string
(Optional)
isForTest: boolean
테스트 모드 여부
userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
key: string
사용자 정의 속성 키
value: PlatformUserDefinedPropertyValue
PlatformUserDefinedPropertyValue
settlementAmount: integer (64 bit)
정산 금액

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)

401

  • UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)

403

  • PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
  • ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

404

  • PlatformTransferNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformTransferNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
delete/platform/transfers/{id}

정산건 삭제

scheduled, in_process 상태의 정산건만 삭제가능합니다.

Request

Path

id: string
정산건 아이디

정산건 아이디

Response

200

400

  • PlatformCancelOrderTransfersExistsError
  • PlatformTransferNonDeletableStatusError
  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)

401

  • UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)

403

  • PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
  • ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

404

  • PlatformTransferNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformTransferNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
get/platform/transfer-summaries

정산건 다건 조회

성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다.

Request

body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기

Body

page?: PageInput
다건 조회 API 에 사용되는 페이지 입력 정보
(Optional)

다건 조회 API 에 사용되는 페이지 입력 정보

number?: integer (32 bit)
0부터 시작하는 페이지 번호
(Optional)
size?: integer (32 bit)
각 페이지 당 포함할 객체 수
(Optional)
filter?: PlatformTransferFilterInput
정산건 필터 입력 정보
(Optional)

정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.

settlementStartDateRange?: DateRange
DateRange
(Optional)
settlementDateRange?: DateRange
DateRange
(Optional)
partnerTags?: string[]
파트너 태그 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 태그를 하나 이상 가지는 파트너에 대한 정산건만 조회합니다.

contractIds?: string[]
계약 아이디 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 계약 아이디를 가지는 정산건만 조회합니다.

discountSharePolicyIds?: string[]
할인 분담 정책 아이디 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 할인 분담 정책 아이디를 하나 이상 가지는 정산건만 조회합니다.

additionalFeePolicyIds?: string[]
추가 수수료 정책 아이디 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 추가 수수료 아이디를 하나 이상 가지는 정산건만 조회합니다.

paymentMethodTypes?: PaymentMethodType[]
결제 수단 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 결제 수단을 가지는 파트너만 조회합니다.

channelKeys?: string[]
채널 키 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 채널 키를 가지는 정산건만 조회합니다.

types?: PlatformTransferType[]
정산 방식 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 방식의 정산건만 조회합니다.

statuses?: PlatformTransferStatus[]
정산 상태 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 상태인 정산건만 조회합니다.

keyword?: PlatformTransferFilterInputKeyword
정산건 검색 키워드 입력 정보
(Optional)

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

isForTest?: boolean
테스트 모드 여부
(Optional)

Response

200

transferSummaries: PlatformTransferSummary[]
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformManualTransferSummary 입니다.
id: string
graphqlId: string
partner: PlatformTransferSummaryPartner
PlatformTransferSummaryPartner
status: PlatformTransferStatus
정산 상태

정산 상태

memo?: string
(Optional)
settlementDate: string

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

settlementCurrency: Currency
통화 단위

통화 단위

isForTest: boolean
partnerUserDefinedProperties: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
settlementAmount: integer (64 bit)
page: PageInfo
반환된 페이지 결과 정보

반환된 페이지 결과 정보

number: integer (32 bit)
요청된 페이지 번호
size: integer (32 bit)
요청된 페이지 당 객체 수
totalCount: integer (32 bit)
실제 반환된 객체 수

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)

401

  • UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)

403

  • PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
  • ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
post/platform/transfers/order

주문 정산건 생성

성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.

Request

Body

partnerId: string
파트너 아이디
contractId?: string
계약 아이디
(Optional)

기본값은 파트너의 기본 계약 아이디 입니다.

memo?: string
메모
(Optional)
paymentId: string
결제 아이디

주문 금액 또는 주문 항목 하나만 입력 가능합니다.

orderAmount?: integer (64 bit)
주문 금액
(Optional)
orderLines?: CreatePlatformOrderTransferBodyOrderLine[]
주문 항목 리스트
(Optional)
taxFreeAmount?: integer (64 bit)
주문 면세 금액
(Optional)

주문 항목과 면세 금액을 같이 전달하시면 최종 면세 금액은 주문 항목의 면세 금액이 아닌 전달해주신 면세 금액으로 적용됩니다.

settlementStartDate?: string
정산 시작일
(Optional)

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

sharePolicyId: string
할인 분담 정책 아이디
amount: integer (64 bit)
할인 금액
taxFreeAmount?: integer (64 bit)
면세 할인 금액
(Optional)
additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[]
추가 수수료 정보
policyId: string
추가 수수료 정책 아이디
externalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail
외부 결제 상세 정보
(Optional)

외부 결제 상세 정보

currency: Currency
통화 단위

통화 단위

orderName?: string
주문 명
(Optional)
paidAt?: string (RFC 3339 date-time)
결제 일시
(Optional)
method?: PlatformPaymentMethodInput
결제 수단 입력 정보
(Optional)

결제 수단 입력 정보

isForTest?: boolean
테스트 모드 여부
(Optional)

기본값은 false 입니다.

parameters?: TransferParameters
TransferParameters
(Optional)
[key: string]?: PlatformSettlementParameterValue
플랫폼 정산 파라미터 값
(Optional)

플랫폼 정산 파라미터 값

userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
(Optional)
key: string
사용자 정의 속성 키
value: PlatformUserDefinedPropertyValue
PlatformUserDefinedPropertyValue

Response

200

transfer: PlatformOrderTransfer
주문 정산건

주문 정산건

type: string
id: string
정산건 아이디
graphqlId: string
partner: PlatformPartner
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

status: PlatformTransferStatus
정산 상태

정산 상태

memo?: string
메모
(Optional)
settlementDate: string
정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

settlementCurrency: Currency
통화 단위

통화 단위

payoutId?: string
(Optional)
payoutGraphqlId?: string
(Optional)
isForTest: boolean
테스트 모드 여부
userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
amount: PlatformOrderSettlementAmount
정산 금액 정보

정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.

contract: PlatformContract
계약

계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.

payment: PlatformPayment
결제 정보

결제 정보

settlementStartDate: string
정산 시작일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

orderLines: PlatformOrderTransferOrderLine[]
주문 항목 리스트
additionalFees: PlatformOrderTransferAdditionalFee[]
정산 금액 계산 시 사용된 추가 수수료 정보
discounts: PlatformOrderTransferDiscount[]
정산 금액 계산 시 사용된 할인 정보
parameters: TransferParameters
TransferParameters

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
  • PlatformProductIdDuplicatedError
  • PlatformSettlementPaymentAmountExceededPortOnePaymentError: 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우
  • PlatformSettlementTaxFreeAmountExceededPortOnePaymentError: 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우
  • PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError: 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우
  • PlatformSettlementAmountExceededError: 정산 가능한 금액을 초과한 경우
  • PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
  • PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
  • PlatformCurrencyNotSupportedError: 지원 되지 않는 통화를 선택한 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)

401

  • UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)

403

  • PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
  • ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

404

  • PlatformPartnerNotFoundError
  • PlatformContractNotFoundError
  • PlatformAdditionalFeePoliciesNotFoundError
  • PlatformDiscountSharePoliciesNotFoundError
  • PlatformPaymentNotFoundError
  • PlatformUserDefinedPropertyNotFoundError: 사용자 정의 속성이 존재 하지 않는 경우
  • PlatformSettlementParameterNotFoundError: 정산 파라미터가 존재하지 않는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAdditionalFeePoliciesNotFoundError 입니다.
ids: string[]
graphqlIds: string[]
message?: string
(Optional)

409

  • PlatformTransferAlreadyExistsError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformTransferAlreadyExistsError 입니다.
transferId: string
transferGraphqlId: string
message?: string
(Optional)
try
Request
Request Sample
N/A
post/platform/transfers/order-cancel

주문 취소 정산건 생성

성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.

Request

Body

partnerId?: string
파트너 아이디
(Optional)
paymentId?: string
결제 아이디
(Optional)
transferId?: string
정산건 아이디
(Optional)
cancellationId: string
취소 내역 아이디
memo?: string
메모
(Optional)
orderDetail?: CreatePlatformOrderCancelTransferBodyOrderDetail
주문 취소 정보
(Optional)

orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.

orderAmount?: integer (64 bit)
주문 취소 금액
(Optional)
orderLines?: CreatePlatformOrderCancelTransferBodyOrderLine[]
주문 취소 항목 리스트
(Optional)
(Optional)

전체 금액 취소

taxFreeAmount?: integer (64 bit)
주문 취소 면세 금액
(Optional)

주문 취소 항목과 취소 면세 금액을 같이 전달하시면 최종 취소 면세 금액은 주문 취소 항목의 면세 금액이 아닌 전달해주신 취소 면세 금액으로 적용됩니다.

sharePolicyId: string
할인 분담 정책 아이디
amount: integer (64 bit)
할인 금액
taxFreeAmount?: integer (64 bit)
면세 할인 금액
(Optional)
settlementStartDate?: string
정산 시작일
(Optional)

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

externalCancellationDetail?: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail
외부 결제 상세 정보
(Optional)

외부 결제 상세 정보

cancelledAt?: string (RFC 3339 date-time)
취소 일시
(Optional)
isForTest?: boolean
테스트 모드 여부
(Optional)

기본값은 false 입니다.

userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
(Optional)
key: string
사용자 정의 속성 키
value: PlatformUserDefinedPropertyValue
PlatformUserDefinedPropertyValue

Response

200

transfer: PlatformOrderCancelTransfer
주문 취소 정산건

주문 취소 정산건

type: string
id: string
정산건 아이디
graphqlId: string
partner: PlatformPartner
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

status: PlatformTransferStatus
정산 상태

정산 상태

memo?: string
메모
(Optional)
settlementDate: string
정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

settlementCurrency: Currency
통화 단위

통화 단위

payoutId?: string
(Optional)
payoutGraphqlId?: string
(Optional)
isForTest: boolean
테스트 모드 여부
userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
amount: PlatformOrderSettlementAmount
정산 금액 정보

정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.

contract: PlatformContract
계약

계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.

payment: PlatformPayment
결제 정보

결제 정보

settlementStartDate: string
정산 시작일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

orderLines: PlatformOrderTransferOrderLine[]
주문 항목 리스트
additionalFees: PlatformOrderTransferAdditionalFee[]
정산 금액 계산 시 사용된 추가 수수료 정보
discounts: PlatformOrderTransferDiscount[]
정산 금액 계산 시 사용된 할인 정보
cancellation: PlatformOrderTransferCancellation
주문 취소 정보

주문 취소 정보

parameters: TransferParameters
TransferParameters

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
  • PlatformOrderDetailMismatchedError
  • PlatformDiscountSharePolicyIdDuplicatedError
  • PlatformCancellableAmountExceededError: 취소 가능한 금액이 초과한 경우
  • PlatformCancellableDiscountAmountExceededError
  • PlatformCancellableDiscountTaxFreeAmountExceededError
  • PlatformProductIdDuplicatedError
  • PlatformCancellableProductQuantityExceededError
  • PlatformOrderTransferAlreadyCancelledError
  • PlatformSettlementAmountExceededError: 정산 가능한 금액을 초과한 경우
  • PlatformCancellationAndPaymentTypeMismatchedError
  • PlatformSettlementCancelAmountExceededPortOneCancelError: 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우
  • PlatformCannotSpecifyTransferError: 정산 건 식별에 실패한 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)

401

  • UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)

403

  • PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
  • ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

404

  • PlatformTransferNotFoundError
  • PlatformCancellationNotFoundError
  • PlatformPaymentNotFoundError
  • PlatformProductIdNotFoundError
  • PlatformTransferDiscountSharePolicyNotFoundError
  • PlatformUserDefinedPropertyNotFoundError: 사용자 정의 속성이 존재 하지 않는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformCancellationNotFoundError 입니다.
message?: string
(Optional)

409

  • PlatformTransferAlreadyExistsError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformTransferAlreadyExistsError 입니다.
transferId: string
transferGraphqlId: string
message?: string
(Optional)
try
Request
Request Sample
N/A
post/platform/transfers/manual

수기 정산건 생성

성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.

Request

Body

partnerId: string
파트너 아이디
memo?: string
메모
(Optional)
settlementAmount: integer (64 bit)
정산 금액
settlementDate: string
정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

isForTest?: boolean
테스트 모드 여부
(Optional)

기본값은 false 입니다.

userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
(Optional)
key: string
사용자 정의 속성 키
value: PlatformUserDefinedPropertyValue
PlatformUserDefinedPropertyValue

Response

200

transfer: PlatformManualTransfer
수기 정산건

수기 정산건

type: string
id: string
정산건 아이디
graphqlId: string
partner: PlatformPartner
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

status: PlatformTransferStatus
정산 상태

정산 상태

memo?: string
메모
(Optional)
settlementDate: string
정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

settlementCurrency: Currency
통화 단위

통화 단위

payoutId?: string
(Optional)
payoutGraphqlId?: string
(Optional)
isForTest: boolean
테스트 모드 여부
userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]
사용자 정의 속성
settlementAmount: integer (64 bit)
정산 금액

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)

401

  • UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)

403

  • PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
  • ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

404

  • PlatformPartnerNotFoundError
  • PlatformUserDefinedPropertyNotFoundError: 사용자 정의 속성이 존재 하지 않는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformPartnerNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
get/platform/transfer-summaries/sheet-file

정산 상세 내역 다운로드

정산 상세 내역을 csv 파일로 다운로드 합니다.

Request

body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기

Body

filter?: PlatformTransferFilterInput
정산건 필터 입력 정보
(Optional)

정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.

settlementStartDateRange?: DateRange
DateRange
(Optional)
settlementDateRange?: DateRange
DateRange
(Optional)
partnerTags?: string[]
파트너 태그 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 태그를 하나 이상 가지는 파트너에 대한 정산건만 조회합니다.

contractIds?: string[]
계약 아이디 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 계약 아이디를 가지는 정산건만 조회합니다.

discountSharePolicyIds?: string[]
할인 분담 정책 아이디 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 할인 분담 정책 아이디를 하나 이상 가지는 정산건만 조회합니다.

additionalFeePolicyIds?: string[]
추가 수수료 정책 아이디 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 추가 수수료 아이디를 하나 이상 가지는 정산건만 조회합니다.

paymentMethodTypes?: PaymentMethodType[]
결제 수단 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 결제 수단을 가지는 파트너만 조회합니다.

channelKeys?: string[]
채널 키 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 채널 키를 가지는 정산건만 조회합니다.

types?: PlatformTransferType[]
정산 방식 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 방식의 정산건만 조회합니다.

statuses?: PlatformTransferStatus[]
정산 상태 리스트
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 상태인 정산건만 조회합니다.

keyword?: PlatformTransferFilterInputKeyword
정산건 검색 키워드 입력 정보
(Optional)

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

isForTest?: boolean
테스트 모드 여부
(Optional)
fields?: PlatformTransferSheetField[]
다운로드 할 시트 컬럼
(Optional)
TAXATION_TYPE_OR_INCOME_TYPE과세 유형 또는 소득 유형

파트너 유형이 사업자인 경우 과세 유형, 원천징수 대상자인 소득 유형입니다.

SETTLEMENT_DISCOUNT_SHARE_AMOUNT할인 분담금
PAYMENT_ID결제 내역 아이디
SETTLEMENT_DISCOUNT_AMOUNT할인 금액
INCOME_TYPE소득 유형
SETTLEMENT_PAYMENT_SUPPLY_AMOUNT결제 공급가액
STATUS정산 건 상태
SETTLEMENT_DISCOUNT_SHARE_TAX_FREE_AMOUNT면세 할인 분담금
SETTLEMENT_ORDER_AMOUNT주문 금액
TRANSFER_ID정산 건 아이디
PARTNER_TYPE파트너 유형
SETTLEMENT_DISCOUNT_TAX_FREE_AMOUNT면세 할인 금액
ORDER_NAME주문 명
SETTLEMENT_TAX_FREE_AMOUNT결제 면세액

해당 필드는 deprecated되어 9월까지만 유지되고 이후 삭제될 예정입니다. 대신 SETTLEMENT_PAYMENT_TAX_FREE_AMOUNT 필드를 사용해주세요.

SETTLEMENT_ADDITIONAL_FEE_VAT_AMOUNT추가 수수료 부가세
SETTLEMENT_CURRENCY정산 통화
PARTNER_NAME파트너 이름
SETTLEMENT_PLATFORM_FEE_VAT_AMOUNT중개 수수료 부가세
PAYMENT_METHOD결제 수단
SETTLEMENT_PAYMENT_AMOUNT결제 금액
SETTLEMENT_START_DATE정산 시작 일
SETTLEMENT_ORDER_TAX_FREE_AMOUNT면세 주문 금액
SETTLEMENT_PAYMENT_VAT_BURDEN_AMOUNT결제 금액 부가세 부담금
SETTLEMENT_PAYMENT_TAX_FREE_AMOUNT결제 면세액
SETTLEMENT_DATE정산 일
SETTLEMENT_SUPPLY_AMOUNT결제 공급가액

해당 필드는 deprecated되어 9월까지만 유지되고 이후 삭제될 예정입니다. 대신 SETTLEMENT_PAYMENT_SUPPLY_AMOUNT 필드를 사용해주세요.

SETTLEMENT_ADDITIONAL_FEE_AMOUNT추가 수수료
SETTLEMENT_PAYMENT_VAT_AMOUNT결제 금액 부가세
SETTLEMENT_AMOUNT정산 금액
SETTLEMENT_PLATFORM_FEE_AMOUNT중개 수수료
TAXATION_TYPE과세 유형
TYPE정산 구분
transferUserDefinedPropertyKeys?: string[]
(Optional)
partnerUserDefinedPropertyKeys?: string[]
(Optional)

Response

200

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)

401

  • UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A

계좌 관련 API

파트너 정산 서비스의 계좌와 관련된 API 입니다.

정산 내역 관련 API

파트너 정산 서비스의 정산 내역과 관련된 API 입니다.

지급 내역 관련 API

파트너 정산 서비스의 지급 내역과 관련된 API 입니다.

일괄 지급 내역 관련 API

파트너 정산 서비스의 일괄 지급 내역과 관련된 API 입니다.

이체 내역 관련 API

파트너 정산 서비스의 이체 내역과 관련된 API 입니다.

특정 PG사 관련 API

특정 PG사에 국한된 API 기능을 제공합니다.

대사 서비스 API

거래 대사 및 정산 대사 관련 API 기능을 제공합니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AddressAlreadyPaidErrorAlreadyPaidOrWaitingErrorAmountExceededTypeApplyEscrowLogisticsErrorApplyEscrowLogisticsResponseArchivePlatformAdditionalFeePolicyErrorArchivePlatformAdditionalFeePolicyResponseArchivePlatformContractErrorArchivePlatformContractResponseArchivePlatformDiscountSharePolicyErrorArchivePlatformDiscountSharePolicyResponseArchivePlatformPartnerErrorArchivePlatformPartnerResponseBankBeforeRegisteredPaymentEscrowBillingKeyAlreadyDeletedErrorBillingKeyFailureBillingKeyFilterInputBillingKeyInfoBillingKeyInfoSummaryBillingKeyNotFoundErrorBillingKeyNotIssuedErrorBillingKeyPaymentInputBillingKeyPaymentMethodBillingKeyPaymentMethodCardBillingKeyPaymentMethodEasyPayBillingKeyPaymentMethodEasyPayChargeBillingKeyPaymentMethodEasyPayMethodBillingKeyPaymentMethodMobileBillingKeyPaymentMethodPaypalBillingKeyPaymentMethodTransferBillingKeyPaymentMethodTypeBillingKeyPaymentSummaryBillingKeySortByBillingKeySortInputBillingKeyStatusBillingKeyTextSearchBillingKeyTextSearchFieldBillingKeyTimeRangeFieldCancelAmountExceedsCancellableAmountErrorCancelCashReceiptErrorCancelCashReceiptResponseCancelPaymentBodyRefundAccountCancelPaymentErrorCancelPaymentResponseCancelRequesterCancelTaxAmountExceedsCancellableTaxAmountErrorCancelTaxFreeAmountExceedsCancellableTaxFreeAmountErrorCancellableAmountConsistencyBrokenErrorCancelledCashReceiptCancelledPaymentCancelledPaymentCashReceiptCancelledPaymentEscrowCardCardBrandCardCredentialCardOwnerTypeCardPromotionCardTypeCashReceiptCashReceiptAlreadyIssuedErrorCashReceiptInputCashReceiptInputTypeCashReceiptNotFoundErrorCashReceiptNotIssuedErrorCashReceiptSummaryCashReceiptTypeChannelGroupSummaryChannelNotFoundErrorChannelSpecificErrorChannelSpecificFailureChannelSpecificFailureInvalidRequestChannelSpecificFailurePgProviderCloseVirtualAccountErrorCloseVirtualAccountResponseConfirmEscrowErrorConfirmEscrowResponseConfirmIdentityVerificationErrorConfirmIdentityVerificationResponseConfirmedPaymentEscrowCountryCreateManualTransferResponseCreateOrderCancelTransferResponseCreateOrderTransferResponseCreatePaymentScheduleErrorCreatePaymentScheduleResponseCreatePlatformAdditionalFeePolicyErrorCreatePlatformAdditionalFeePolicyResponseCreatePlatformContractErrorCreatePlatformContractResponseCreatePlatformDiscountSharePolicyErrorCreatePlatformDiscountSharePolicyResponseCreatePlatformManualTransferErrorCreatePlatformOrderCancelTransferBodyDiscountCreatePlatformOrderCancelTransferBodyExternalCancellationDetailCreatePlatformOrderCancelTransferBodyOrderDetailCreatePlatformOrderCancelTransferBodyOrderDetailAllCreatePlatformOrderCancelTransferBodyOrderLineCreatePlatformOrderCancelTransferErrorCreatePlatformOrderTransferBodyAdditionalFeeCreatePlatformOrderTransferBodyDiscountCreatePlatformOrderTransferBodyExternalPaymentDetailCreatePlatformOrderTransferBodyOrderDetailCreatePlatformOrderTransferBodyOrderLineCreatePlatformOrderTransferBodyProductCreatePlatformOrderTransferErrorCreatePlatformPartnerBodyCreatePlatformPartnerBodyAccountCreatePlatformPartnerBodyContactCreatePlatformPartnerBodyTypeCreatePlatformPartnerBodyTypeBusinessCreatePlatformPartnerBodyTypeNonWhtPayerCreatePlatformPartnerBodyTypeWhtPayerCreatePlatformPartnerErrorCreatePlatformPartnerResponseCreatePlatformPartnersErrorCreatePlatformPartnersResponseCurrencyCustomerCustomerInputCustomerNameInputCustomerSeparatedNameDateRangeDateTimeRangeDayOfWeekDeleteBillingKeyErrorDeleteBillingKeyResponseDeletePlatformTransferErrorDeletePlatformTransferResponseDeletedBillingKeyInfoDeliveredPaymentEscrowDiscountAmountExceedsTotalAmountErrorDownloadPlatformTransferSheetErrorEasyPayMethodTypeEasyPayProviderFailedIdentityVerificationFailedPaymentFailedPaymentCancellationFailedPaymentScheduleFailedPgBillingKeyIssueResponseForbiddenErrorGenderGetAllPaymentsByCursorResponseGetAllPaymentsErrorGetBillingKeyInfoErrorGetBillingKeyInfosErrorGetBillingKeyInfosResponseGetCashReceiptErrorGetIdentityVerificationErrorGetKakaopayPaymentOrderErrorGetKakaopayPaymentOrderResponseGetPaymentErrorGetPaymentScheduleErrorGetPaymentSchedulesErrorGetPaymentSchedulesResponseGetPaymentsErrorGetPaymentsResponseGetPlatformAccountHolderErrorGetPlatformAccountTransfersErrorGetPlatformAccountTransfersResponseGetPlatformAdditionalFeePoliciesErrorGetPlatformAdditionalFeePoliciesResponseGetPlatformAdditionalFeePolicyErrorGetPlatformBulkPayoutsErrorGetPlatformBulkPayoutsResponseGetPlatformContractErrorGetPlatformContractsErrorGetPlatformContractsResponseGetPlatformDiscountSharePoliciesErrorGetPlatformDiscountSharePoliciesResponseGetPlatformDiscountSharePolicyErrorGetPlatformPartnerErrorGetPlatformPartnerSettlementsErrorGetPlatformPartnerSettlementsResponseGetPlatformPartnersErrorGetPlatformPartnersResponseGetPlatformPayoutsErrorGetPlatformPayoutsResponseGetPlatformTransferErrorGetPlatformTransferSummariesErrorGetPlatformTransferSummariesResponseGetPromotionErrorIdentityVerificationIdentityVerificationAlreadySentErrorIdentityVerificationAlreadyVerifiedErrorIdentityVerificationFailureIdentityVerificationMethodIdentityVerificationNotFoundErrorIdentityVerificationNotSentErrorIdentityVerificationOperatorIdentityVerificationRequestedCustomerIdentityVerificationVerifiedCustomerInstantBillingKeyPaymentMethodInputInstantBillingKeyPaymentMethodInputCardInstantPaymentMethodInputInstantPaymentMethodInputCardInstantPaymentMethodInputVirtualAccountInstantPaymentMethodInputVirtualAccountCashReceiptInfoInstantPaymentMethodInputVirtualAccountExpiryInstantPaymentMethodInputVirtualAccountOptionInstantPaymentMethodInputVirtualAccountOptionFixedInstantPaymentMethodInputVirtualAccountOptionTypeInstantPaymentSummaryInvalidRequestErrorIssueBillingKeyErrorIssueBillingKeyResponseIssueCashReceiptCustomerInputIssueCashReceiptErrorIssueCashReceiptResponseIssueFailedCashReceiptIssuedBillingKeyInfoIssuedCashReceiptIssuedPaymentCashReceiptIssuedPgBillingKeyIssueResponseLoginViaApiSecretErrorLoginViaApiSecretResponseMaxTransactionCountReachedErrorMaxWebhookRetryCountReachedErrorModifyEscrowLogisticsErrorModifyEscrowLogisticsResponseMonthDayOneLineAddressPageInfoPageInputPaidPaymentPartialCancelledPaymentPayInstantlyErrorPayInstantlyResponsePayPendingPaymentPayWithBillingKeyErrorPayWithBillingKeyResponsePaymentPaymentAlreadyCancelledErrorPaymentAmountPaymentAmountInputPaymentCancellationPaymentCashReceiptPaymentCashReceiptStatusPaymentClientTypePaymentEscrowPaymentEscrowReceiverInputPaymentEscrowSenderInputPaymentFailurePaymentFilterInputPaymentFilterInputEscrowStatusPaymentInstallmentPaymentLogisticsPaymentLogisticsCompanyPaymentMethodPaymentMethodCardPaymentMethodEasyPayPaymentMethodEasyPayMethodPaymentMethodEasyPayMethodChargePaymentMethodGiftCertificatePaymentMethodGiftCertificateTypePaymentMethodMobilePaymentMethodTransferPaymentMethodTypePaymentMethodVirtualAccountPaymentMethodVirtualAccountRefundStatusPaymentMethodVirtualAccountTypePaymentNotFoundErrorPaymentNotPaidErrorPaymentNotWaitingForDepositErrorPaymentProductPaymentProductTypePaymentSchedulePaymentScheduleAlreadyExistsErrorPaymentScheduleAlreadyProcessedErrorPaymentScheduleAlreadyRevokedErrorPaymentScheduleFilterInputPaymentScheduleNotFoundErrorPaymentScheduleSortByPaymentScheduleSortInputPaymentScheduleStatusPaymentScheduleSummaryPaymentSortByPaymentStatusPaymentTextSearchPaymentTextSearchFieldPaymentTimestampTypePaymentWebhookPaymentWebhookPaymentStatusPaymentWebhookRequestPaymentWebhookResponsePaymentWebhookStatusPaymentWebhookTriggerPaymentWithCursorPendingPaymentSchedulePgBillingKeyIssueResponsePgCompanyPgProviderPgProviderErrorPlatformAccountPlatformAccountHolderPlatformAccountStatusPlatformAccountTransferPlatformAccountTransferFilterPlatformAccountTransferTypePlatformAccountVerificationAlreadyUsedErrorPlatformAccountVerificationFailedErrorPlatformAccountVerificationNotFoundErrorPlatformAdditionalFeePoliciesNotFoundErrorPlatformAdditionalFeePolicyPlatformAdditionalFeePolicyAlreadyExistsErrorPlatformAdditionalFeePolicyFilterInputPlatformAdditionalFeePolicyFilterInputKeywordPlatformAdditionalFeePolicyNotFoundErrorPlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorPlatformArchivedAdditionalFeePolicyErrorPlatformArchivedContractErrorPlatformArchivedDiscountSharePolicyErrorPlatformArchivedPartnerErrorPlatformBulkPayoutPlatformBulkPayoutFilterInputPlatformBulkPayoutFilterInputCriteriaPlatformBulkPayoutStatsPlatformBulkPayoutStatusPlatformBulkPayoutStatusStatsPlatformCancelOrderTransfersExistsErrorPlatformCancellableAmountExceededErrorPlatformCancellableAmountTypePlatformCancellableDiscountAmountExceededErrorPlatformCancellableDiscountTaxFreeAmountExceededErrorPlatformCancellableProductQuantityExceededErrorPlatformCancellationAndPaymentTypeMismatchedErrorPlatformCancellationNotFoundErrorPlatformCannotArchiveScheduledAdditionalFeePolicyErrorPlatformCannotArchiveScheduledContractErrorPlatformCannotArchiveScheduledDiscountSharePolicyErrorPlatformCannotArchiveScheduledPartnerErrorPlatformCannotSpecifyTransferErrorPlatformContactPlatformContractPlatformContractAlreadyExistsErrorPlatformContractFilterInputPlatformContractFilterInputKeywordPlatformContractNotFoundErrorPlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorPlatformContractsNotFoundErrorPlatformCurrencyNotSupportedErrorPlatformDepositAccountTransferPlatformDiscountSharePoliciesNotFoundErrorPlatformDiscountSharePolicyPlatformDiscountSharePolicyAlreadyExistsErrorPlatformDiscountSharePolicyFilterInputPlatformDiscountSharePolicyFilterInputKeywordPlatformDiscountSharePolicyIdDuplicatedErrorPlatformDiscountSharePolicyNotFoundErrorPlatformExternalApiFailedErrorPlatformExternalApiTemporarilyFailedErrorPlatformExternalPaymentPlatformFeePlatformFeeInputPlatformFixedAmountFeePlatformFixedRateFeePlatformInsufficientDataToChangePartnerTypeErrorPlatformManualTransferPlatformManualTransferSummaryPlatformNotEnabledErrorPlatformNotSupportedBankErrorPlatformOrderCancelTransferPlatformOrderCancelTransferSummaryPlatformOrderDetailMismatchedErrorPlatformOrderSettlementAmountPlatformOrderTransferPlatformOrderTransferAdditionalFeePlatformOrderTransferAlreadyCancelledErrorPlatformOrderTransferCancellationPlatformOrderTransferDiscountPlatformOrderTransferOrderLinePlatformOrderTransferProductPlatformOrderTransferSummaryPlatformPartnerPlatformPartnerBusinessStatusPlatformPartnerFilterInputPlatformPartnerFilterInputKeywordPlatformPartnerIdAlreadyExistsErrorPlatformPartnerIdsAlreadyExistErrorPlatformPartnerIdsDuplicatedErrorPlatformPartnerManualSettlementPlatformPartnerNotFoundErrorPlatformPartnerOrderCancelSettlementPlatformPartnerOrderSettlementPlatformPartnerPayoutAccountTransferPlatformPartnerSettlementPlatformPartnerSettlementFilterInputPlatformPartnerSettlementFilterKeywordInputPlatformPartnerSettlementStatusPlatformPartnerSettlementStatusStatsPlatformPartnerSettlementTypePlatformPartnerStatusPlatformPartnerTaxationTypePlatformPartnerTypePlatformPartnerTypeBusinessPlatformPartnerTypeNonWhtPayerPlatformPartnerTypeWhtPayerPlatformPayerPlatformPaymentPlatformPaymentMethodPlatformPaymentMethodCardPlatformPaymentMethodCardInputPlatformPaymentMethodEasyPayPlatformPaymentMethodEasyPayInputPlatformPaymentMethodGiftCertificatePlatformPaymentMethodGiftCertificateInputPlatformPaymentMethodInputPlatformPaymentMethodMobilePlatformPaymentMethodMobileInputPlatformPaymentMethodTransferPlatformPaymentMethodTransferInputPlatformPaymentMethodVirtualAccountPlatformPaymentMethodVirtualAccountInputPlatformPaymentNotFoundErrorPlatformPayoutPlatformPayoutAccountPlatformPayoutFilterInputPlatformPayoutFilterInputCriteriaPlatformPayoutMethodPlatformPayoutStatusPlatformPayoutStatusStatsPlatformPortOnePaymentPlatformPortOnePaymentCancelAmountTypePlatformProductIdDuplicatedErrorPlatformProductIdNotFoundErrorPlatformPropertiesPlatformRemitAccountTransferPlatformSettlementAmountExceededErrorPlatformSettlementCancelAmountExceededPortOneCancelErrorPlatformSettlementCyclePlatformSettlementCycleDatePolicyPlatformSettlementCycleInputPlatformSettlementCycleMethodPlatformSettlementCycleMethodDailyPlatformSettlementCycleMethodDailyInputPlatformSettlementCycleMethodInputPlatformSettlementCycleMethodManualDatesPlatformSettlementCycleMethodManualDatesInputPlatformSettlementCycleMethodMonthlyPlatformSettlementCycleMethodMonthlyInputPlatformSettlementCycleMethodWeeklyPlatformSettlementCycleMethodWeeklyInputPlatformSettlementCycleTypePlatformSettlementParameterNotFoundErrorPlatformSettlementParameterValuePlatformSettlementPaymentAmountExceededPortOnePaymentErrorPlatformSettlementSupplyWithVatAmountExceededPortOnePaymentErrorPlatformSettlementTaxFreeAmountExceededPortOnePaymentErrorPlatformTransferPlatformTransferAlreadyExistsErrorPlatformTransferDiscountSharePolicyNotFoundErrorPlatformTransferFilterInputPlatformTransferFilterInputKeywordPlatformTransferNonDeletableStatusErrorPlatformTransferNotFoundErrorPlatformTransferSheetFieldPlatformTransferStatusPlatformTransferSummaryPlatformTransferSummaryExternalPaymentPlatformTransferSummaryPartnerPlatformTransferSummaryPartnerTypePlatformTransferSummaryPaymentPlatformTransferSummaryPortOnePaymentPlatformTransferTypePlatformUserDefinedPropertyKeyValuePlatformUserDefinedPropertyNotFoundErrorPlatformUserDefinedPropertyValuePortOneVersionPreRegisterPaymentErrorPreRegisterPaymentResponsePromotionPromotionAmountDiscountPromotionCardCompanyPromotionDiscountPromotionNotFoundErrorPromotionPayMethodDoesNotMatchErrorPromotionPercentDiscountPromotionStatusReadyIdentityVerificationReadyPaymentRecoverPlatformAdditionalFeePolicyErrorRecoverPlatformAdditionalFeePolicyResponseRecoverPlatformContractErrorRecoverPlatformContractResponseRecoverPlatformDiscountSharePolicyErrorRecoverPlatformDiscountSharePolicyResponseRecoverPlatformPartnerErrorRecoverPlatformPartnerResponseRefreshTokenErrorRefreshTokenResponseRegisterStoreReceiptBodyItemRegisterStoreReceiptErrorRegisterStoreReceiptResponseRegisteredPaymentEscrowRejectConfirmedPaymentEscrowRejectedPaymentEscrowRemainedAmountLessThanPromotionMinPaymentAmountErrorRequestedPaymentCancellationResendIdentityVerificationErrorResendIdentityVerificationResponseResendWebhookErrorResendWebhookResponseRevokePaymentSchedulesErrorRevokePaymentSchedulesResponseRevokedPaymentScheduleScheduledPaymentScheduleSelectedChannelSelectedChannelTypeSendIdentityVerificationBodyCustomerSendIdentityVerificationErrorSendIdentityVerificationResponseSeparatedAddressSeparatedAddressInputSortOrderStartedPaymentScheduleSucceededPaymentCancellationSucceededPaymentScheduleSumOfPartsExceedsCancelAmountErrorSumOfPartsExceedsTotalAmountErrorTransferParametersUnauthorizedErrorUpdatePlatformAdditionalFeePolicyErrorUpdatePlatformAdditionalFeePolicyResponseUpdatePlatformContractErrorUpdatePlatformContractResponseUpdatePlatformDiscountSharePolicyErrorUpdatePlatformDiscountSharePolicyResponseUpdatePlatformPartnerBodyAccountUpdatePlatformPartnerBodyContactUpdatePlatformPartnerBodyTypeUpdatePlatformPartnerBodyTypeBusinessUpdatePlatformPartnerBodyTypeNonWhtPayerUpdatePlatformPartnerBodyTypeWhtPayerUpdatePlatformPartnerErrorUpdatePlatformPartnerResponseVerifiedIdentityVerificationVirtualAccountIssuedPaymentWebhookNotFoundError