portone_server_sdk.platform

portone_server_sdk.platform#

Classes

`CancelPlatformAdditionalFeePolicyScheduleResponse`	추가 수수료 정책 예약 업데이트 취소 성공 응답
`CancelPlatformContractScheduleResponse`	계약 예약 업데이트 취소 성공 응답
`CancelPlatformDiscountSharePolicyScheduleResponse`	할인 분담 정책 예약 업데이트 취소 성공 응답
`CancelPlatformPartnerScheduleResponse`	파트너 예약 업데이트 취소 성공 응답
`DateRange`
`MonthDay`	월 및 일자 정보
`Platform`	고객사의 플랫폼 기능 관련 정보
`PlatformAccount`	플랫폼 정산 계좌
`PlatformAdditionalFeePolicy`	추가 수수료 정책
`PlatformContact`	플랫폼 파트너 담당자 연락 정보
`PlatformContract`	계약
`PlatformDiscountSharePolicy`	할인 분담 정책
`PlatformDiscountSharePolicyFilterOptions`	할인 분담 정책 필터 옵션 조회 성공 응답 정보
`PlatformFeeInput`	수수료 계산 방식을 특정하기 위한 입력 정보
`PlatformFixedAmountFee`	정액 수수료
`PlatformFixedRateFee`	정률 수수료
`PlatformOrderSettlementAmount`	정산 금액 정보
`PlatformPartner`	파트너
`PlatformPartnerContractSummary`	파트너 계약 요약 정보
`PlatformPartnerFilterInput`	파트너 필터 입력 정보
`PlatformPartnerFilterInputKeyword`	파트너 검색 키워드 입력 정보
`PlatformPartnerFilterOptions`	파트너 필터 옵션 조회 성공 응답 정보
`PlatformPartnerTypeBusiness`	사업자 파트너 정보
`PlatformPartnerTypeNonWhtPayer`	원천징수 비대상자 파트너 정보
`PlatformPartnerTypeWhtPayer`	원천징수 대상자 파트너 정보
`PlatformPayoutStatusStats`
`PlatformProperties`
`PlatformSetting`	플랫폼 설정
`PlatformSettlementCycle`	정산 주기
`PlatformSettlementCycleInput`	플랫폼 정산 주기 입력 정보
`PlatformSettlementCycleMethodDaily`	매일 정산
`PlatformSettlementCycleMethodDailyInput`
`PlatformSettlementCycleMethodInput`	플랫폼 정산 주기 계산 방식 입력 정보
`PlatformSettlementCycleMethodManualDates`	정해진 날짜(월, 일)에 정산
`PlatformSettlementCycleMethodManualDatesInput`
`PlatformSettlementCycleMethodMonthly`	매월 정해진 날(일)에 정산
`PlatformSettlementCycleMethodMonthlyInput`
`PlatformSettlementCycleMethodWeekly`	매주 정해진 요일에 정산
`PlatformSettlementCycleMethodWeeklyInput`
`PlatformSettlementFormula`	플랫폼 내 발생하는 여러 수수료 및 할인 분담에 관한 계산식 정보
`PlatformSettlementFormulaInvalidFunction`
`PlatformSettlementFormulaInvalidOperator`
`PlatformSettlementFormulaInvalidSyntax`
`PlatformSettlementFormulaInvalidVariable`
`PlatformSettlementFormulaPosition`
`PlatformSettlementFormulaUnexpectedFunctionArguments`
`PlatformSettlementFormulaUnknownError`
`PlatformSettlementFormulaUnsupportedVariable`
`PlatformSettlementRule`	플랫폼 정산건 처리 방식에 관한 규칙
`PlatformUserDefinedPropertyValue`
`ReschedulePlatformAdditionalFeePolicyBody`	추가 수수료 정책 예약 업데이트 재설정을 위한 입력 정보
`ReschedulePlatformAdditionalFeePolicyResponse`	추가 수수료 정책 예약 업데이트 재설정 성공 응답
`ReschedulePlatformContractBody`	계약 예약 업데이트 재설정을 위한 입력 정보
`ReschedulePlatformContractResponse`	계약 예약 업데이트 재설정 성공 응답
`ReschedulePlatformDiscountSharePolicyBody`	할인 분담 정책 예약 업데이트 재설정을 위한 입력 정보
`ReschedulePlatformDiscountSharePolicyResponse`	할인 분담 정책 예약 업데이트 재설정 성공 응답
`ReschedulePlatformPartnerBody`	파트너 예약 업데이트 재설정을 위한 입력 정보
`ReschedulePlatformPartnerResponse`	파트너 예약 업데이트 재설정 성공 응답
`SchedulePlatformAdditionalFeePolicyBody`	추가 수수료 정책 업데이트 예약을 위한 입력 정보
`SchedulePlatformAdditionalFeePolicyResponse`	추가 수수료 정책 업데이트 예약 성공 응답
`SchedulePlatformContractBody`	계약 업데이트 예약을 위한 입력 정보
`SchedulePlatformContractResponse`	계약 업데이트 예약 성공 응답
`SchedulePlatformDiscountSharePolicyBody`	할인 분담 정책 업데이트 예약을 위한 입력 정보
`SchedulePlatformDiscountSharePolicyResponse`	할인 분담 정책 업데이트 예약 성공 응답
`SchedulePlatformPartnerBody`	파트너 업데이트 예약을 위한 입력 정보
`SchedulePlatformPartnerResponse`	파트너 업데이트 예약 성공 응답
`SchedulePlatformPartnersBody`
`SchedulePlatformPartnersBodyUpdate`
`SchedulePlatformPartnersBodyUpdateAccount`	파트너 계좌 업데이트를 위한 입력 정보
`SchedulePlatformPartnersBodyUpdateContact`	파트너 업데이트를 위한 유형별 추가 정보
`SchedulePlatformPartnersBodyUpdateType`	파트너 유형별 정보 업데이트를 위한 입력 정보
`SchedulePlatformPartnersBodyUpdateTypeBusiness`
`SchedulePlatformPartnersBodyUpdateTypeNonWhtPayer`
`SchedulePlatformPartnersBodyUpdateTypeWhtPayer`
`SchedulePlatformPartnersResponse`
`UpdatePlatformAdditionalFeePolicyBody`	추가 수수료 정책 업데이트를 위한 입력 정보
`UpdatePlatformBody`	플랫폼 업데이트를 위한 입력 정보
`UpdatePlatformBodySettlementFormula`	플랫폼 업데이트 시 변경할 계산식 정보
`UpdatePlatformBodySettlementRule`	플랫폼 업데이트 시 변경할 정산 규칙 정보
`UpdatePlatformContractBody`	계약 업데이트를 위한 입력 정보.
`UpdatePlatformDiscountSharePolicyBody`	할인 분담 정책 업데이트를 위한 입력 정보
`UpdatePlatformPartnerBody`	파트너 업데이트를 위한 입력 정보
`UpdatePlatformPartnerBodyAccount`	파트너 계좌 업데이트를 위한 입력 정보
`UpdatePlatformPartnerBodyContact`	파트너 담당자 업데이트를 위한 정보
`UpdatePlatformPartnerBodyType`	파트너 업데이트를 위한 유형별 추가 정보
`UpdatePlatformPartnerBodyTypeBusiness`
`UpdatePlatformPartnerBodyTypeNonWhtPayer`
`UpdatePlatformPartnerBodyTypeWhtPayer`
`UpdatePlatformResponse`	플랫폼 업데이트 결과 정보
`UpdatePlatformSettingBody`	플랫폼 설정 업데이트를 위한 입력 정보
`UpdatePlatformSettingResponse`	플랫폼 설정 업데이트 결과
`PlatformClient`

Exceptions

exception portone_server_sdk.platform.CancelPlatformAdditionalFeePolicyScheduleError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.CancelPlatformContractScheduleError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.CancelPlatformDiscountSharePolicyScheduleError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.CancelPlatformPartnerScheduleError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.GetPlatformAdditionalFeePolicyScheduleError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.GetPlatformContractScheduleError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.GetPlatformDiscountSharePolicyFilterOptionsError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.GetPlatformDiscountSharePolicyScheduleError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.GetPlatformError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.GetPlatformPartnerFilterOptionsError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.GetPlatformPartnerScheduleError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.GetPlatformSettingError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.RescheduleAdditionalFeePolicyError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.RescheduleContractError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.RescheduleDiscountSharePolicyError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.ReschedulePartnerError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.ScheduleAdditionalFeePolicyError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.ScheduleContractError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.ScheduleDiscountSharePolicyError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.SchedulePartnerError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.SchedulePlatformPartnersError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.UpdatePlatformError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.platform.UpdatePlatformSettingError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

class portone_server_sdk.platform.CancelPlatformAdditionalFeePolicyScheduleResponse#

Bases: object

추가 수수료 정책 예약 업데이트 취소 성공 응답

class portone_server_sdk.platform.CancelPlatformContractScheduleResponse#

Bases: object

계약 예약 업데이트 취소 성공 응답

class portone_server_sdk.platform.CancelPlatformDiscountSharePolicyScheduleResponse#

Bases: object

할인 분담 정책 예약 업데이트 취소 성공 응답

class portone_server_sdk.platform.CancelPlatformPartnerScheduleResponse#

Bases: object

파트너 예약 업데이트 취소 성공 응답

class portone_server_sdk.platform.DateRange#

Bases: object

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

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

class portone_server_sdk.platform.MonthDay#

Bases: object

월 및 일자 정보

month: int#: (int32)

day: int#: (int32)

class portone_server_sdk.platform.Platform#

Bases: object

고객사의 플랫폼 기능 관련 정보

merchant_id: str#: 해당 플랫폼의 고객사 아이디

graphql_id: str#

round_type: Literal['OFF', 'DOWN', 'UP'] | str#: 파트너 정산금액의 소수점 처리 방식

settlement_formula: PlatformSettlementFormula#: 수수료 및 할인 분담 정책 관련 계산식

settlement_rule: PlatformSettlementRule#: 정산 규칙

class portone_server_sdk.platform.PlatformAccount#

Bases: object

플랫폼 정산 계좌

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

bank: Literal['BANK_OF_KOREA', 'KDB', 'IBK', 'KOOKMIN', 'SUHYUP', 'KEXIM', 'NONGHYUP', 'LOCAL_NONGHYUP', 'WOORI', 'STANDARD_CHARTERED', 'CITI', 'DAEGU', 'BUSAN', 'KWANGJU', 'JEJU', 'JEONBUK', 'KYONGNAM', 'KFCC', 'SHINHYUP', 'SAVINGS_BANK', 'MORGAN_STANLEY', 'HSBC', 'DEUTSCHE', 'JPMC', 'MIZUHO', 'MUFG', 'BANK_OF_AMERICA', 'BNP_PARIBAS', 'ICBC', 'BANK_OF_CHINA', 'NFCF', 'UOB', 'BOCOM', 'CCB', 'POST', 'KODIT', 'KIBO', 'HANA', 'SHINHAN', 'K_BANK', 'KAKAO', 'TOSS', 'MISC_FOREIGN', 'SGI', 'KCIS', 'YUANTA_SECURITIES', 'KB_SECURITIES', 'SANGSANGIN_SECURITIES', 'HANYANG_SECURITIES', 'LEADING_SECURITIES', 'BNK_SECURITIES', 'IBK_SECURITIES', 'DAOL_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'SAMSUNG_SECURITIES', 'KOREA_SECURITIES', 'NH_SECURITIES', 'KYOBO_SECURITIES', 'HI_SECURITIES', 'HYUNDAI_MOTOR_SECURITIES', 'KIWOOM_SECURITIES', 'EBEST_SECURITIES', 'SK_SECURITIES', 'DAISHIN_SECURITIES', 'HANHWA_SECURITIES', 'HANA_SECURITIES', 'TOSS_SECURITIES', 'SHINHAN_SECURITIES', 'DB_SECURITIES', 'EUGENE_SECURITIES', 'MERITZ_SECURITIES', 'KAKAO_PAY_SECURITIES', 'BOOKOOK_SECURITIES', 'SHINYOUNG_SECURITIES', 'CAPE_SECURITIES', 'KOREA_SECURITIES_FINANCE', 'KOREA_FOSS_SECURITIES', 'WOORI_INVESTMENT_BANK'] | str#: 은행

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'] | str#: 정산에 사용할 통화

number: str#: 계좌번호

holder: str#: 예금주명

status: Literal['VERIFIED', 'VERIFY_FAILED', 'VERIFY_ERROR', 'NOT_VERIFIED', 'UNKNOWN'] | str#: 계좌 상태

class portone_server_sdk.platform.PlatformAdditionalFeePolicy#

Bases: object

추가 수수료 정책

추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.

id: str#: 추가 수수료 정책 고유 아이디

graphql_id: str#

name: str#: 추가 수수료 정책 이름

fee: PlatformFixedAmountFee | PlatformFixedRateFee | dict#: 책정 수수료

vat_payer: Literal['PARTNER', 'MERCHANT'] | str#: 부가세를 부담할 주체

is_archived: bool#: 보관 여부

applied_at: str#: 변경 적용 시점 (RFC 3339 date-time)

memo: str | None#: 해당 추가 수수료 정책에 대한 메모

class portone_server_sdk.platform.PlatformContact#

Bases: object

플랫폼 파트너 담당자 연락 정보

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

name: str#: 담당자 이름

email: str#: 담당자 이메일

phone_number: str | None#: 담당자 휴대폰 번호

class portone_server_sdk.platform.PlatformContract#

Bases: object

계약

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

id: str#: 계약 고유 아이디

graphql_id: str#

name: str#: 계약 이름

platform_fee: PlatformFixedAmountFee | PlatformFixedRateFee | dict#: 중개수수료

settlement_cycle: PlatformSettlementCycle#: 정산 주기

platform_fee_vat_payer: Literal['PARTNER', 'MERCHANT'] | str#: 중개수수료에 대한 부가세 부담 주체

subtract_payment_vat_amount: bool#

정산 시 결제금액 부가세 감액 여부

false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다.

is_archived: bool#: 보관 여부

applied_at: str#: 변경 적용 시점 (RFC 3339 date-time)

memo: str | None#: 계약 내부 표기를 위한 메모

class portone_server_sdk.platform.PlatformDiscountSharePolicy#

Bases: object

할인 분담 정책

할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.

id: str#

graphql_id: str#

name: str#: 할인 분담 정책 이름

partner_share_rate: int#

할인 분담율

파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다. (int32)

is_archived: bool#: 보관 여부

applied_at: str#: 변경 적용 시점 (RFC 3339 date-time)

memo: str | None#: 해당 할인 분담에 대한 메모

class portone_server_sdk.platform.PlatformDiscountSharePolicyFilterOptions#

Bases: object

할인 분담 정책 필터 옵션 조회 성공 응답 정보

partner_share_rates: list[int]#: 조회된 파트너 분담율 리스트

class portone_server_sdk.platform.PlatformFeeInput#

Bases: object

수수료 계산 방식을 특정하기 위한 입력 정보

정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

fixed_rate: int | None#: 정률 수수료 (int32)

fixed_amount: int | None#: 정액 수수료 (int64)

class portone_server_sdk.platform.PlatformFixedAmountFee#

Bases: object

정액 수수료

총 금액에 무관하게 정해진 수수료 금액을 책정합니다.

amount: int#: 고정된 수수료 금액 (int64)

class portone_server_sdk.platform.PlatformFixedRateFee#

Bases: object

정률 수수료

총 금액에 정해진 비율을 곱한 만큼의 수수료를 책정합니다.

rate: int#

수수료율

총 금액 대비 수수료 비율을 의미하며, 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수입니다. 총 금액 * rate * 10^5 (rate * 10^3 %) 만큼 수수료를 책정합니다. (int32)

class portone_server_sdk.platform.PlatformOrderSettlementAmount#

Bases: object

정산 금액 정보

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

settlement: int#: 정산 금액 (int64)

payment: int#: 결제 금액 (int64)

payment_vat: int#: 결제 금액 부가세 (int64)

payment_vat_burden: int#

결제 금액 부가세 부담금액

참조된 계약의 결제 금액 부가세 감액 여부에 따라 false인 경우 0원, true인 경우 결제 금액 부가세입니다. (int64)

tax_free: int#

결제 면세 금액

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

supply: int#

결제 공급가액

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

payment_tax_free: int#: 결제 면세 금액 (int64)

payment_supply: int#: 결제 공급가액 (int64)

order: int#: 주문 금액 (int64)

order_tax_free: int#: 면세 주문 금액 (int64)

platform_fee: int#: 중개 수수료 (int64)

platform_fee_vat: int#: 중개 수수료 부가세 (int64)

additional_fee: int#: 추가 수수료 (int64)

additional_fee_vat: int#: 추가 수수료 부가세 (int64)

discount: int#: 할인 금액 (int64)

discount_tax_free: int#: 면세 할인 금액 (int64)

discount_share: int#: 할인 분담 금액 (int64)

discount_share_tax_free: int#: 면세 할인 분담 금액 (int64)

class portone_server_sdk.platform.PlatformPartner#

Bases: object

파트너

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

id: str#: 파트너 고유 아이디

graphql_id: str#

name: str#: 파트너 법인명 혹은 이름

contact: PlatformContact#: 파트너 담당자 연락 정보

account: PlatformAccount#: 정산 계좌

status: Literal['PENDING', 'APPROVED', 'REJECTED'] | str#: 파트너의 상태

default_contract_id: str#: 파트너에 설정된 기본 계약 아이디

tags: list[str]#: 파트너의 태그 리스트

type: PlatformPartnerTypeBusiness | PlatformPartnerTypeNonWhtPayer | PlatformPartnerTypeWhtPayer | dict#: 파트너 유형별 정보

is_archived: bool#: 보관 여부

applied_at: str#: 변경 적용 시점 (RFC 3339 date-time)

user_defined_properties: PlatformProperties#: 사용자 정의 속성

memo: str | None#: 파트너에 대한 메모

class portone_server_sdk.platform.PlatformPartnerContractSummary#

Bases: object

파트너 계약 요약 정보

id: str#: 계약 고유 아이디

name: str#: 계약 이름

class portone_server_sdk.platform.PlatformPartnerFilterInput#

Bases: object

파트너 필터 입력 정보

is_archived: bool | None#

보관 조회 여부

true 이면 보관된 파트너를 조회하고, false 이면 보관되지 않은 파트너를 조회합니다. 기본값은 false 입니다.

tags: list[str] | None#: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 태그를 하나 이상 가지는 파트너만 조회합니다.

banks: list[Literal['BANK_OF_KOREA', 'KDB', 'IBK', 'KOOKMIN', 'SUHYUP', 'KEXIM', 'NONGHYUP', 'LOCAL_NONGHYUP', 'WOORI', 'STANDARD_CHARTERED', 'CITI', 'DAEGU', 'BUSAN', 'KWANGJU', 'JEJU', 'JEONBUK', 'KYONGNAM', 'KFCC', 'SHINHYUP', 'SAVINGS_BANK', 'MORGAN_STANLEY', 'HSBC', 'DEUTSCHE', 'JPMC', 'MIZUHO', 'MUFG', 'BANK_OF_AMERICA', 'BNP_PARIBAS', 'ICBC', 'BANK_OF_CHINA', 'NFCF', 'UOB', 'BOCOM', 'CCB', 'POST', 'KODIT', 'KIBO', 'HANA', 'SHINHAN', 'K_BANK', 'KAKAO', 'TOSS', 'MISC_FOREIGN', 'SGI', 'KCIS', 'YUANTA_SECURITIES', 'KB_SECURITIES', 'SANGSANGIN_SECURITIES', 'HANYANG_SECURITIES', 'LEADING_SECURITIES', 'BNK_SECURITIES', 'IBK_SECURITIES', 'DAOL_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'SAMSUNG_SECURITIES', 'KOREA_SECURITIES', 'NH_SECURITIES', 'KYOBO_SECURITIES', 'HI_SECURITIES', 'HYUNDAI_MOTOR_SECURITIES', 'KIWOOM_SECURITIES', 'EBEST_SECURITIES', 'SK_SECURITIES', 'DAISHIN_SECURITIES', 'HANHWA_SECURITIES', 'HANA_SECURITIES', 'TOSS_SECURITIES', 'SHINHAN_SECURITIES', 'DB_SECURITIES', 'EUGENE_SECURITIES', 'MERITZ_SECURITIES', 'KAKAO_PAY_SECURITIES', 'BOOKOOK_SECURITIES', 'SHINYOUNG_SECURITIES', 'CAPE_SECURITIES', 'KOREA_SECURITIES_FINANCE', 'KOREA_FOSS_SECURITIES', 'WOORI_INVESTMENT_BANK'] | str] | None#

은행

하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 계좌 은행을 가진 파트너만 조회합니다.

account_currencies: list[Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'] | str] | None#

통화 단위

하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 계좌 통화를 가진 파트너만 조회합니다.

ids: list[str] | None#: 하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 아이디를 가진 파트너만 조회합니다.

contract_ids: list[str] | None#: 하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 기본 계약 id를 가진 파트너만 조회합니다.

account_statuses: list[Literal['VERIFIED', 'VERIFY_FAILED', 'VERIFY_ERROR', 'NOT_VERIFIED', 'UNKNOWN'] | str] | None#

플랫폼 계좌 상태

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 계좌 상태를 가진 파트너만 조회합니다.

business_statuses: list[Literal['NOT_VERIFIED', 'VERIFY_ERROR', 'NOT_FOUND', 'IN_BUSINESS', 'CLOSED', 'SUSPENDED'] | str] | None#

플랫폼 파트너 사업자 상태

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 사업자 상태를 가진 파트너만 조회합니다.

types: list[Literal['BUSINESS', 'WHT_PAYER', 'NON_WHT_PAYER'] | str] | None#

플랫폼 파트너 유형 이름

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 사업자 유형을 가진 파트너만 조회합니다.

taxation_types: list[Literal['NORMAL', 'SIMPLE_TAX_INVOICE_ISSUER', 'SIMPLE', 'TAX_FREE'] | str] | None#

플랫폼 파트너 과세 유형

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 과세 유형을 가진 파트너만 조회합니다.

member_company_connection_statuses: list[Literal['NOT_CONNECTED', 'CONNECT_PENDING', 'CONNECTED', 'CONNECT_FAILED', 'DISCONNECT_PENDING'] | str] | None#

플랫폼 파트너 연동 사업자 연결 상태

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 연동 사업자 연결 상태를 가진 파트너만 조회합니다.

keyword: PlatformPartnerFilterInputKeyword | None#: 검색 키워드

class portone_server_sdk.platform.PlatformPartnerFilterInputKeyword#

Bases: object

파트너 검색 키워드 입력 정보

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

id: str | None#: 해당 값이 포함된 id 를 가진 파트너만 조회합니다.

name: str | None#: 해당 값이 포함된 이름 을 가진 파트너만 조회합니다.

email: str | None#: 해당 값이 포함된 이메일 주소를 가진 파트너만 조회합니다.

business_registration_number: str | None#: 해당 값이 포함된 사업자등록번호를 가진 파트너만 조회합니다.

default_contract_id: str | None#: 해당 값이 포함된 기본 계약 아이디를 가진 파트너만 조회합니다.

memo: str | None#: 해당 값이 포함된 메모를 가진 파트너만 조회합니다.

account_number: str | None#: 해당 값이 포함된 계좌번호를 가진 파트너만 조회합니다.

account_holder: str | None#: 해당 값이 포함된 계좌 예금주명을 가진 파트너만 조회합니다.

class portone_server_sdk.platform.PlatformPartnerFilterOptions#

Bases: object

파트너 필터 옵션 조회 성공 응답 정보

tags: list[str]#: 조회된 태그 리스트

contract_summary: list[PlatformPartnerContractSummary]#: 조회된 파트너 계약 요약 정보 리스트

class portone_server_sdk.platform.PlatformPartnerTypeBusiness#

Bases: object

사업자 파트너 정보

사업자 유형의 파트너 추가 정보 입니다.

company_name: str#: 상호명

taxation_type: Literal['NORMAL', 'SIMPLE_TAX_INVOICE_ISSUER', 'SIMPLE', 'TAX_FREE'] | str#: 과세 유형

business_status: Literal['NOT_VERIFIED', 'VERIFY_ERROR', 'NOT_FOUND', 'IN_BUSINESS', 'CLOSED', 'SUSPENDED'] | str#: 사업자 상태

business_registration_number: str#: 사업자등록번호

representative_name: str#: 대표자 이름

member_company_connection_status: Literal['NOT_CONNECTED', 'CONNECT_PENDING', 'CONNECTED', 'CONNECT_FAILED', 'DISCONNECT_PENDING'] | str#: 연동사업자 연동 상태

company_address: str | None#: 사업장 주소

business_type: str | None#: 업태

business_class: str | None#: 업종

member_company_connection_failed_reason: str | None#: 연동사업자 연동 실패 사유

class portone_server_sdk.platform.PlatformPartnerTypeNonWhtPayer#

Bases: object

원천징수 비대상자 파트너 정보

비사업자 유형의 파트너 추가 정보 입니다.

birthdate: str | None#

생년월일

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

class portone_server_sdk.platform.PlatformPartnerTypeWhtPayer#

Bases: object

원천징수 대상자 파트너 정보

비사업자 유형의 파트너 추가 정보 입니다.

birthdate: str | None#

생년월일

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

class portone_server_sdk.platform.PlatformPayoutStatusStats#

Bases: object

prepared: int#: (int64)

cancelled: int#: (int64)

stopped: int#: (int64)

processing: int#: (int64)

succeeded: int#: (int64)

failed: int#: (int64)

scheduled: int#: (int64)

class portone_server_sdk.platform.PlatformProperties#

Bases: PlatformUserDefinedPropertyValue

string: str#

class portone_server_sdk.platform.PlatformSetting#

Bases: object

플랫폼 설정

default_withdrawal_memo: str | None#: 기본 보내는 이 통장 메모

default_deposit_memo: str | None#: 기본 받는 이 통장 메모

class portone_server_sdk.platform.PlatformSettlementCycle#

Bases: object

정산 주기

지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.

lag_days: int#

지체일 (d+n 의 n)

정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다. (int32)

date_policy: Literal['HOLIDAY_BEFORE', 'HOLIDAY_AFTER', 'CALENDAR_DAY'] | str#: 기준일로, 정산일 계산 시 공휴일을 고려하기 위한 정보입니다.

method: PlatformSettlementCycleMethodDaily | PlatformSettlementCycleMethodManualDates | PlatformSettlementCycleMethodMonthly | PlatformSettlementCycleMethodWeekly | dict#: 정산 주기 계산 방식

class portone_server_sdk.platform.PlatformSettlementCycleInput#

Bases: object

플랫폼 정산 주기 입력 정보

lag_days: int#

지체일 (d+n 의 n)

정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다. (int32)

date_policy: Literal['HOLIDAY_BEFORE', 'HOLIDAY_AFTER', 'CALENDAR_DAY'] | str#: 기준일로, 정산일 계산 시 공휴일을 고려하기 위한 정보입니다.

method: PlatformSettlementCycleMethodInput#: 정산 주기 계산 방식

class portone_server_sdk.platform.PlatformSettlementCycleMethodDaily#

Bases: object

매일 정산

class portone_server_sdk.platform.PlatformSettlementCycleMethodDailyInput#: Bases: object

class portone_server_sdk.platform.PlatformSettlementCycleMethodInput#

Bases: object

플랫폼 정산 주기 계산 방식 입력 정보

하나의 하위 필드에만 값을 명시하여 요청합니다.

daily: PlatformSettlementCycleMethodDailyInput | None#: 매일 정산

weekly: PlatformSettlementCycleMethodWeeklyInput | None#: 매주 정해진 요일에 정산

monthly: PlatformSettlementCycleMethodMonthlyInput | None#: 매월 정해진 날(일)에 정산

manual_dates: PlatformSettlementCycleMethodManualDatesInput | None#: 정해진 날짜(월, 일)에 정산

class portone_server_sdk.platform.PlatformSettlementCycleMethodManualDates#

Bases: object

정해진 날짜(월, 일)에 정산

dates: list[MonthDay]#: 월 및 일자 정보

class portone_server_sdk.platform.PlatformSettlementCycleMethodManualDatesInput#

Bases: object

dates: list[MonthDay]#: 월 및 일자 정보

class portone_server_sdk.platform.PlatformSettlementCycleMethodMonthly#

Bases: object

매월 정해진 날(일)에 정산

days_of_month: list[int]#

class portone_server_sdk.platform.PlatformSettlementCycleMethodMonthlyInput#

Bases: object

days_of_month: list[int]#

class portone_server_sdk.platform.PlatformSettlementCycleMethodWeekly#

Bases: object

매주 정해진 요일에 정산

days_of_week: list[Literal['SUN', 'MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT'] | str]#: 요일

class portone_server_sdk.platform.PlatformSettlementCycleMethodWeeklyInput#

Bases: object

days_of_week: list[Literal['SUN', 'MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT'] | str]#: 요일

class portone_server_sdk.platform.PlatformSettlementFormula#

Bases: object

플랫폼 내 발생하는 여러 수수료 및 할인 분담에 관한 계산식 정보

platform_fee: str#: 플랫폼 수수료 계산식

discount_share: str#: 할인 분담액 계산식

additional_fee: str#: 추가 수수료 계산식

class portone_server_sdk.platform.PlatformSettlementFormulaInvalidFunction#

Bases: object

name: str#

position: PlatformSettlementFormulaPosition#

class portone_server_sdk.platform.PlatformSettlementFormulaInvalidOperator#

Bases: object

operator: str#

position: PlatformSettlementFormulaPosition#

class portone_server_sdk.platform.PlatformSettlementFormulaInvalidSyntax#

Bases: object

syntax: str#

position: PlatformSettlementFormulaPosition#

class portone_server_sdk.platform.PlatformSettlementFormulaInvalidVariable#

Bases: object

name: str#

position: PlatformSettlementFormulaPosition#

class portone_server_sdk.platform.PlatformSettlementFormulaPosition#

Bases: object

start_line: int#: (int32)

start_index: int#: (int32)

end_line: int#: (int32)

end_index: int#: (int32)

class portone_server_sdk.platform.PlatformSettlementFormulaUnexpectedFunctionArguments#

Bases: object

function_name: str#

expected_count: int#: (int32)

current_count: int#: (int32)

position: PlatformSettlementFormulaPosition#

class portone_server_sdk.platform.PlatformSettlementFormulaUnknownError#: Bases: object

class portone_server_sdk.platform.PlatformSettlementFormulaUnsupportedVariable#

Bases: object

name: str#

position: PlatformSettlementFormulaPosition#

class portone_server_sdk.platform.PlatformSettlementRule#

Bases: object

플랫폼 정산건 처리 방식에 관한 규칙

supports_multiple_order_transfers_per_partner: bool#: paymentId, storeId, partnerId가 같은 주문 정산건에 대한 중복 정산 지원 여부

adjust_settlement_date_after_holiday_if_earlier: bool#: 정산일이 정산시작일보다 작거나 같을 경우 공휴일 후 영업일로 정산일 다시 계산 여부

subtract_wht_in_payout_amount: bool#: 지급 금액에서 원천징수세 차감 여부

class portone_server_sdk.platform.PlatformUserDefinedPropertyValue#

Bases: object

string: str#

class portone_server_sdk.platform.ReschedulePlatformAdditionalFeePolicyBody#

Bases: object

추가 수수료 정책 예약 업데이트 재설정을 위한 입력 정보

update: UpdatePlatformAdditionalFeePolicyBody#: 반영할 업데이트 내용

applied_at: str#: 업데이트 적용 시점 (RFC 3339 date-time)

class portone_server_sdk.platform.ReschedulePlatformAdditionalFeePolicyResponse#

Bases: object

추가 수수료 정책 예약 업데이트 재설정 성공 응답

scheduled_additional_fee_policy: PlatformAdditionalFeePolicy#: 예약된 추가 수수료 정책

class portone_server_sdk.platform.ReschedulePlatformContractBody#

Bases: object

계약 예약 업데이트 재설정을 위한 입력 정보

update: UpdatePlatformContractBody#: 반영할 업데이트 내용

applied_at: str#: 업데이트 적용 시점 (RFC 3339 date-time)

class portone_server_sdk.platform.ReschedulePlatformContractResponse#

Bases: object

계약 예약 업데이트 재설정 성공 응답

scheduled_contract: PlatformContract#: 예약된 계약 정보

class portone_server_sdk.platform.ReschedulePlatformDiscountSharePolicyBody#

Bases: object

할인 분담 정책 예약 업데이트 재설정을 위한 입력 정보

update: UpdatePlatformDiscountSharePolicyBody#: 반영할 업데이트 내용

applied_at: str#: 업데이트 적용 시점 (RFC 3339 date-time)

class portone_server_sdk.platform.ReschedulePlatformDiscountSharePolicyResponse#

Bases: object

할인 분담 정책 예약 업데이트 재설정 성공 응답

scheduled_discount_share_policy: PlatformDiscountSharePolicy#: 예약된 할인 분담 정보

class portone_server_sdk.platform.ReschedulePlatformPartnerBody#

Bases: object

파트너 예약 업데이트 재설정을 위한 입력 정보

update: UpdatePlatformPartnerBody#: 반영할 업데이트 내용

applied_at: str#: 업데이트 적용 시점 (RFC 3339 date-time)

class portone_server_sdk.platform.ReschedulePlatformPartnerResponse#

Bases: object

파트너 예약 업데이트 재설정 성공 응답

scheduled_partner: PlatformPartner#: 예약된 파트너 정보

class portone_server_sdk.platform.SchedulePlatformAdditionalFeePolicyBody#

Bases: object

추가 수수료 정책 업데이트 예약을 위한 입력 정보

update: UpdatePlatformAdditionalFeePolicyBody#: 반영할 업데이트 내용

applied_at: str#: 업데이트 적용 시점 (RFC 3339 date-time)

class portone_server_sdk.platform.SchedulePlatformAdditionalFeePolicyResponse#

Bases: object

추가 수수료 정책 업데이트 예약 성공 응답

scheduled_additional_fee_policy: PlatformAdditionalFeePolicy#: 예약된 추가 수수료 정책

class portone_server_sdk.platform.SchedulePlatformContractBody#

Bases: object

계약 업데이트 예약을 위한 입력 정보

update: UpdatePlatformContractBody#: 반영할 업데이트 내용

applied_at: str#: 업데이트 적용 시점 (RFC 3339 date-time)

class portone_server_sdk.platform.SchedulePlatformContractResponse#

Bases: object

계약 업데이트 예약 성공 응답

scheduled_contract: PlatformContract#: 예약된 계약 정보

class portone_server_sdk.platform.SchedulePlatformDiscountSharePolicyBody#

Bases: object

할인 분담 정책 업데이트 예약을 위한 입력 정보

update: UpdatePlatformDiscountSharePolicyBody#: 반영할 업데이트 내용

applied_at: str#: 업데이트 적용 시점 (RFC 3339 date-time)

class portone_server_sdk.platform.SchedulePlatformDiscountSharePolicyResponse#

Bases: object

할인 분담 정책 업데이트 예약 성공 응답

scheduled_discount_share_policy: PlatformDiscountSharePolicy#: 예약된 할인 분담 정보

class portone_server_sdk.platform.SchedulePlatformPartnerBody#

Bases: object

파트너 업데이트 예약을 위한 입력 정보

update: UpdatePlatformPartnerBody#: 반영할 업데이트 내용

applied_at: str#: 업데이트 적용 시점 (RFC 3339 date-time)

class portone_server_sdk.platform.SchedulePlatformPartnerResponse#

Bases: object

파트너 업데이트 예약 성공 응답

scheduled_partner: PlatformPartner#: 예약된 파트너 정보

class portone_server_sdk.platform.SchedulePlatformPartnersBody#

Bases: object

update: SchedulePlatformPartnersBodyUpdate#

applied_at: str#: (RFC 3339 date-time)

filter: PlatformPartnerFilterInput | None#

class portone_server_sdk.platform.SchedulePlatformPartnersBodyUpdate#

Bases: object

name: str | None#

contact: SchedulePlatformPartnersBodyUpdateContact | None#

type: SchedulePlatformPartnersBodyUpdateType | None#

account: SchedulePlatformPartnersBodyUpdateAccount | None#

default_contract_id: str | None#

memo: str | None#

tags: list[str] | None#

user_defined_properties: PlatformProperties | None#

class portone_server_sdk.platform.SchedulePlatformPartnersBodyUpdateAccount#

Bases: object

파트너 계좌 업데이트를 위한 입력 정보

bank: Literal['BANK_OF_KOREA', 'KDB', 'IBK', 'KOOKMIN', 'SUHYUP', 'KEXIM', 'NONGHYUP', 'LOCAL_NONGHYUP', 'WOORI', 'STANDARD_CHARTERED', 'CITI', 'DAEGU', 'BUSAN', 'KWANGJU', 'JEJU', 'JEONBUK', 'KYONGNAM', 'KFCC', 'SHINHYUP', 'SAVINGS_BANK', 'MORGAN_STANLEY', 'HSBC', 'DEUTSCHE', 'JPMC', 'MIZUHO', 'MUFG', 'BANK_OF_AMERICA', 'BNP_PARIBAS', 'ICBC', 'BANK_OF_CHINA', 'NFCF', 'UOB', 'BOCOM', 'CCB', 'POST', 'KODIT', 'KIBO', 'HANA', 'SHINHAN', 'K_BANK', 'KAKAO', 'TOSS', 'MISC_FOREIGN', 'SGI', 'KCIS', 'YUANTA_SECURITIES', 'KB_SECURITIES', 'SANGSANGIN_SECURITIES', 'HANYANG_SECURITIES', 'LEADING_SECURITIES', 'BNK_SECURITIES', 'IBK_SECURITIES', 'DAOL_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'SAMSUNG_SECURITIES', 'KOREA_SECURITIES', 'NH_SECURITIES', 'KYOBO_SECURITIES', 'HI_SECURITIES', 'HYUNDAI_MOTOR_SECURITIES', 'KIWOOM_SECURITIES', 'EBEST_SECURITIES', 'SK_SECURITIES', 'DAISHIN_SECURITIES', 'HANHWA_SECURITIES', 'HANA_SECURITIES', 'TOSS_SECURITIES', 'SHINHAN_SECURITIES', 'DB_SECURITIES', 'EUGENE_SECURITIES', 'MERITZ_SECURITIES', 'KAKAO_PAY_SECURITIES', 'BOOKOOK_SECURITIES', 'SHINYOUNG_SECURITIES', 'CAPE_SECURITIES', 'KOREA_SECURITIES_FINANCE', 'KOREA_FOSS_SECURITIES', 'WOORI_INVESTMENT_BANK'] | str#: 은행

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'] | str#: 정산에 사용할 통화

number: str#: 계좌번호

holder: str#: 예금주명

account_verification_id: str | None#: 계좌 검증 아이디

class portone_server_sdk.platform.SchedulePlatformPartnersBodyUpdateContact#

Bases: object

파트너 업데이트를 위한 유형별 추가 정보

name: str | None#: 담당자 이름

phone_number: str | None#: 담당자 휴대폰 번호

email: str | None#: 담당자 이메일

class portone_server_sdk.platform.SchedulePlatformPartnersBodyUpdateType#

Bases: object

파트너 유형별 정보 업데이트를 위한 입력 정보

파트너 유형별 추가 정보를 수정합니다. 최초 생성된 유형 내에서 세부 정보만 수정할 수 있고 파트너의 유형 자체를 수정할 수는 없습니다.

business: SchedulePlatformPartnersBodyUpdateTypeBusiness | None#: 사업자 추가 정보

wht_payer: SchedulePlatformPartnersBodyUpdateTypeWhtPayer | None#: 원천징수 대상자 추가 정보

non_wht_payer: SchedulePlatformPartnersBodyUpdateTypeNonWhtPayer | None#: 원천징수 비대상자 추가 정보

class portone_server_sdk.platform.SchedulePlatformPartnersBodyUpdateTypeBusiness#

Bases: object

company_name: str | None#: 상호명

taxation_type: Literal['NORMAL', 'SIMPLE_TAX_INVOICE_ISSUER', 'SIMPLE', 'TAX_FREE'] | str | None#: 사업자 유형

business_registration_number: str | None#: 사업자등록번호

representative_name: str | None#: 대표자 이름

company_address: str | None#: 사업장 주소

business_type: str | None#: 업태

business_class: str | None#: 업종

company_verification_id: str | None#: 사업자 조회 검증 아이디

class portone_server_sdk.platform.SchedulePlatformPartnersBodyUpdateTypeNonWhtPayer#

Bases: object

birthdate: str | None#

생년월일

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

class portone_server_sdk.platform.SchedulePlatformPartnersBodyUpdateTypeWhtPayer#

Bases: object

birthdate: str | None#

생년월일

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

class portone_server_sdk.platform.SchedulePlatformPartnersResponse#: Bases: object

class portone_server_sdk.platform.UpdatePlatformAdditionalFeePolicyBody#

Bases: object

추가 수수료 정책 업데이트를 위한 입력 정보

값이 명시하지 않은 필드는 업데이트되지 않습니다.

fee: PlatformFeeInput | None#: 책정 수수료

name: str | None#: 추가 수수료 정책 이름

memo: str | None#: 해당 추가 수수료 정책에 대한 메모

vat_payer: Literal['PARTNER', 'MERCHANT'] | str | None#: 부가세를 부담할 주체

class portone_server_sdk.platform.UpdatePlatformBody#

Bases: object

플랫폼 업데이트를 위한 입력 정보

값이 명시되지 않은 필드는 업데이트하지 않습니다.

round_type: Literal['OFF', 'DOWN', 'UP'] | str | None#: 파트너 정산금액의 소수점 처리 방식

settlement_formula: UpdatePlatformBodySettlementFormula | None#: 수수료 및 할인 분담 정책 관련 계산식

settlement_rule: UpdatePlatformBodySettlementRule | None#: 정산 규칙

class portone_server_sdk.platform.UpdatePlatformBodySettlementFormula#

Bases: object

플랫폼 업데이트 시 변경할 계산식 정보

값이 명시되지 않은 필드는 업데이트하지 않습니다.

platform_fee: str | None#: 플랫폼 수수료 계산식

discount_share: str | None#: 할인 분담액 계산식

additional_fee: str | None#: 추가 수수료 계산식

class portone_server_sdk.platform.UpdatePlatformBodySettlementRule#

Bases: object

플랫폼 업데이트 시 변경할 정산 규칙 정보

값이 명시되지 않은 필드는 업데이트하지 않습니다.

supports_multiple_order_transfers_per_partner: bool | None#: paymentId, storeId, partnerId가 같은 주문 정산건에 대한 중복 정산 지원 여부

adjust_settlement_date_after_holiday_if_earlier: bool | None#: 정산일이 정산시작일보다 작거나 같을 경우 공휴일 후 영업일로 정산일 다시 계산 여부

subtract_wht_in_payout_amount: bool | None#: 지급 금액에서 원천징수세 차감 여부

class portone_server_sdk.platform.UpdatePlatformContractBody#

Bases: object

계약 업데이트를 위한 입력 정보. 값이 명시되지 않은 필드는 업데이트되지 않습니다.

값이 명시되지 않은 필드는 업데이트되지 않습니다.

name: str | None#: 계약 이름

memo: str | None#: 계약 내부 표기를 위한 메모

platform_fee: PlatformFeeInput | None#: 중개수수료

settlement_cycle: PlatformSettlementCycleInput | None#: 정산 주기

platform_fee_vat_payer: Literal['PARTNER', 'MERCHANT'] | str | None#: 중개수수료에 대한 부가세 부담 주체

subtract_payment_vat_amount: bool | None#: 정산 시 결제금액 부가세 감액 여부

class portone_server_sdk.platform.UpdatePlatformDiscountSharePolicyBody#

Bases: object

할인 분담 정책 업데이트를 위한 입력 정보

값이 명시되지 않은 필드는 업데이트하지 않습니다.

name: str | None#: 할인 분담 정책 이름

partner_share_rate: int | None#

할인 분담율

memo: str | None#: 해당 할인 분담에 대한 메모

class portone_server_sdk.platform.UpdatePlatformPartnerBody#

Bases: object

파트너 업데이트를 위한 입력 정보

값이 명시되지 않은 필드는 업데이트되지 않습니다.

name: str | None#: 파트너 법인명 혹은 이름

contact: UpdatePlatformPartnerBodyContact | None#: 파트너 담당자 연락 정보

account: UpdatePlatformPartnerBodyAccount | None#: 정산 계좌

default_contract_id: str | None#: 파트너에 설정된 기본 계약 아이디

memo: str | None#: 파트너에 대한 메모

tags: list[str] | None#: 파트너의 태그 리스트

type: UpdatePlatformPartnerBodyType | None#: 파트너 유형별 정보

user_defined_properties: PlatformProperties | None#: 사용자 정의 속성

class portone_server_sdk.platform.UpdatePlatformPartnerBodyAccount#

Bases: object

파트너 계좌 업데이트를 위한 입력 정보

bank: Literal['BANK_OF_KOREA', 'KDB', 'IBK', 'KOOKMIN', 'SUHYUP', 'KEXIM', 'NONGHYUP', 'LOCAL_NONGHYUP', 'WOORI', 'STANDARD_CHARTERED', 'CITI', 'DAEGU', 'BUSAN', 'KWANGJU', 'JEJU', 'JEONBUK', 'KYONGNAM', 'KFCC', 'SHINHYUP', 'SAVINGS_BANK', 'MORGAN_STANLEY', 'HSBC', 'DEUTSCHE', 'JPMC', 'MIZUHO', 'MUFG', 'BANK_OF_AMERICA', 'BNP_PARIBAS', 'ICBC', 'BANK_OF_CHINA', 'NFCF', 'UOB', 'BOCOM', 'CCB', 'POST', 'KODIT', 'KIBO', 'HANA', 'SHINHAN', 'K_BANK', 'KAKAO', 'TOSS', 'MISC_FOREIGN', 'SGI', 'KCIS', 'YUANTA_SECURITIES', 'KB_SECURITIES', 'SANGSANGIN_SECURITIES', 'HANYANG_SECURITIES', 'LEADING_SECURITIES', 'BNK_SECURITIES', 'IBK_SECURITIES', 'DAOL_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'SAMSUNG_SECURITIES', 'KOREA_SECURITIES', 'NH_SECURITIES', 'KYOBO_SECURITIES', 'HI_SECURITIES', 'HYUNDAI_MOTOR_SECURITIES', 'KIWOOM_SECURITIES', 'EBEST_SECURITIES', 'SK_SECURITIES', 'DAISHIN_SECURITIES', 'HANHWA_SECURITIES', 'HANA_SECURITIES', 'TOSS_SECURITIES', 'SHINHAN_SECURITIES', 'DB_SECURITIES', 'EUGENE_SECURITIES', 'MERITZ_SECURITIES', 'KAKAO_PAY_SECURITIES', 'BOOKOOK_SECURITIES', 'SHINYOUNG_SECURITIES', 'CAPE_SECURITIES', 'KOREA_SECURITIES_FINANCE', 'KOREA_FOSS_SECURITIES', 'WOORI_INVESTMENT_BANK'] | str#: 은행

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'] | str#: 정산에 사용할 통화

number: str#: 계좌번호

holder: str#: 예금주명

account_verification_id: str | None#: 계좌 검증 아이디

class portone_server_sdk.platform.UpdatePlatformPartnerBodyContact#

Bases: object

파트너 담당자 업데이트를 위한 정보

name: str | None#: 담당자 이름

phone_number: str | None#: 담당자 휴대폰 번호

email: str | None#: 담당자 이메일

class portone_server_sdk.platform.UpdatePlatformPartnerBodyType#

Bases: object

파트너 업데이트를 위한 유형별 추가 정보

파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.

business: UpdatePlatformPartnerBodyTypeBusiness | None#: 사업자 추가 정보

wht_payer: UpdatePlatformPartnerBodyTypeWhtPayer | None#: 원천징수 대상자 추가 정보

non_wht_payer: UpdatePlatformPartnerBodyTypeNonWhtPayer | None#: 원천징수 비대상자 추가 정보

class portone_server_sdk.platform.UpdatePlatformPartnerBodyTypeBusiness#

Bases: object

company_name: str | None#: 상호명

taxation_type: Literal['NORMAL', 'SIMPLE_TAX_INVOICE_ISSUER', 'SIMPLE', 'TAX_FREE'] | str | None#: 사업자 유형

business_registration_number: str | None#: 사업자등록번호

representative_name: str | None#: 대표자 이름

company_address: str | None#: 사업장 주소

business_type: str | None#: 업태

business_class: str | None#: 업종

company_verification_id: str | None#: 사업자 조회 검증 아이디

class portone_server_sdk.platform.UpdatePlatformPartnerBodyTypeNonWhtPayer#

Bases: object

birthdate: str | None#

생년월일

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

class portone_server_sdk.platform.UpdatePlatformPartnerBodyTypeWhtPayer#

Bases: object

birthdate: str | None#

생년월일

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

class portone_server_sdk.platform.UpdatePlatformResponse#

Bases: object

플랫폼 업데이트 결과 정보

platform: Platform#: 업데이트된 플랫폼 정보

class portone_server_sdk.platform.UpdatePlatformSettingBody#

Bases: object

플랫폼 설정 업데이트를 위한 입력 정보

default_withdrawal_memo: str | None#: 기본 보내는 이 통장 메모

default_deposit_memo: str | None#: 기본 받는 이 통장 메모

class portone_server_sdk.platform.UpdatePlatformSettingResponse#

Bases: object

플랫폼 설정 업데이트 결과

setting: PlatformSetting#

class portone_server_sdk.platform.PlatformClient#

Bases: object

policy: PolicyClient#

partner: PartnerClient#

transfer: TransferClient#

partner_settlement: PartnerSettlementClient#

payout: PayoutClient#

bulk_payout: BulkPayoutClient#

account: AccountClient#

company: CompanyClient#

account_transfer: AccountTransferClient#

get_platform() → Platform#

고객사의 플랫폼 정보를 조회합니다. 요청된 Authorization header 를 통해 자동으로 요청자의 고객사를 특정합니다.

Raises:: GetPlatformError –

async get_platform_async() → Platform#

고객사의 플랫폼 정보를 조회합니다. 요청된 Authorization header 를 통해 자동으로 요청자의 고객사를 특정합니다.

Raises:: GetPlatformError –

update_platform(*, round_type: Literal['OFF', 'DOWN', 'UP'] | str | None = None, settlement_formula: UpdatePlatformBodySettlementFormula | None = None, settlement_rule: UpdatePlatformBodySettlementRule | None = None) → UpdatePlatformResponse#

고객사의 플랫폼 관련 정보를 업데이트합니다. 요청된 Authorization header 를 통해 자동으로 요청자의 고객사를 특정합니다.

Parameters:

round_type (PlatformRoundType, optional) – 파트너 정산금액의 소수점 처리 방식
settlement_formula (UpdatePlatformBodySettlementFormula, optional) – 수수료 및 할인 분담 정책 관련 계산식
settlement_rule (UpdatePlatformBodySettlementRule, optional) – 정산 규칙

Raises:

UpdatePlatformError –

async update_platform_async(*, round_type: Literal['OFF', 'DOWN', 'UP'] | str | None = None, settlement_formula: UpdatePlatformBodySettlementFormula | None = None, settlement_rule: UpdatePlatformBodySettlementRule | None = None) → UpdatePlatformResponse#

고객사의 플랫폼 관련 정보를 업데이트합니다. 요청된 Authorization header 를 통해 자동으로 요청자의 고객사를 특정합니다.

Parameters:

round_type (PlatformRoundType, optional) – 파트너 정산금액의 소수점 처리 방식
settlement_formula (UpdatePlatformBodySettlementFormula, optional) – 수수료 및 할인 분담 정책 관련 계산식
settlement_rule (UpdatePlatformBodySettlementRule, optional) – 정산 규칙

Raises:

UpdatePlatformError –

get_platform_discount_share_policy_filter_options(*, is_archived: bool | None = None) → PlatformDiscountSharePolicyFilterOptions#

할인 분담 정책 다건 조회 시 필요한 필터 옵션을 조회합니다.

Parameters:

is_archived (bool, optional) –

보관 조회 여부

true 이면 보관된 할인 분담의 필터 옵션을 조회하고, false 이면 보관되지 않은 할인 분담의 필터 옵션을 조회합니다. 기본값은 false 입니다.

Raises:

GetPlatformDiscountSharePolicyFilterOptionsError –

async get_platform_discount_share_policy_filter_options_async(*, is_archived: bool | None = None) → PlatformDiscountSharePolicyFilterOptions#

할인 분담 정책 다건 조회 시 필요한 필터 옵션을 조회합니다.

Parameters:

is_archived (bool, optional) –

보관 조회 여부

true 이면 보관된 할인 분담의 필터 옵션을 조회하고, false 이면 보관되지 않은 할인 분담의 필터 옵션을 조회합니다. 기본값은 false 입니다.

Raises:

GetPlatformDiscountSharePolicyFilterOptionsError –

get_platform_discount_share_policy_schedule(*, id: str) → PlatformDiscountSharePolicy#

주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 조회합니다.

Parameters:: id (str) – 할인 분담 정책 아이디
Raises:: GetPlatformDiscountSharePolicyScheduleError –

async get_platform_discount_share_policy_schedule_async(*, id: str) → PlatformDiscountSharePolicy#

주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 조회합니다.

Parameters:: id (str) – 할인 분담 정책 아이디
Raises:: GetPlatformDiscountSharePolicyScheduleError –

reschedule_discount_share_policy(*, id: str, update: UpdatePlatformDiscountSharePolicyBody, applied_at: str) → ReschedulePlatformDiscountSharePolicyResponse#

주어진 아이디에 대응되는 할인 분담에 예약 업데이트를 재설정합니다.

Parameters:

id (str) – 할인 분담 정책 아이디
update (UpdatePlatformDiscountSharePolicyBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

RescheduleDiscountSharePolicyError –

async reschedule_discount_share_policy_async(*, id: str, update: UpdatePlatformDiscountSharePolicyBody, applied_at: str) → ReschedulePlatformDiscountSharePolicyResponse#

주어진 아이디에 대응되는 할인 분담에 예약 업데이트를 재설정합니다.

Parameters:

id (str) – 할인 분담 정책 아이디
update (UpdatePlatformDiscountSharePolicyBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

RescheduleDiscountSharePolicyError –

schedule_discount_share_policy(*, id: str, update: UpdatePlatformDiscountSharePolicyBody, applied_at: str) → SchedulePlatformDiscountSharePolicyResponse#

주어진 아이디에 대응되는 할인 분담에 업데이트를 예약합니다.

Parameters:

id (str) – 할인 분담 정책 아이디
update (UpdatePlatformDiscountSharePolicyBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

ScheduleDiscountSharePolicyError –

async schedule_discount_share_policy_async(*, id: str, update: UpdatePlatformDiscountSharePolicyBody, applied_at: str) → SchedulePlatformDiscountSharePolicyResponse#

주어진 아이디에 대응되는 할인 분담에 업데이트를 예약합니다.

Parameters:

id (str) – 할인 분담 정책 아이디
update (UpdatePlatformDiscountSharePolicyBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

ScheduleDiscountSharePolicyError –

cancel_platform_discount_share_policy_schedule(*, id: str) → CancelPlatformDiscountSharePolicyScheduleResponse#

주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 취소합니다.

Parameters:: id (str) – 할인 분담 정책 아이디
Raises:: CancelPlatformDiscountSharePolicyScheduleError –

async cancel_platform_discount_share_policy_schedule_async(*, id: str) → CancelPlatformDiscountSharePolicyScheduleResponse#

주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 취소합니다.

Parameters:: id (str) – 할인 분담 정책 아이디
Raises:: CancelPlatformDiscountSharePolicyScheduleError –

get_platform_additional_fee_policy_schedule(*, id: str) → PlatformAdditionalFeePolicy#

주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 조회합니다.

Parameters:: id (str) – 추가 수수료 정책 아이디
Raises:: GetPlatformAdditionalFeePolicyScheduleError –

async get_platform_additional_fee_policy_schedule_async(*, id: str) → PlatformAdditionalFeePolicy#

주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 조회합니다.

Parameters:: id (str) – 추가 수수료 정책 아이디
Raises:: GetPlatformAdditionalFeePolicyScheduleError –

reschedule_additional_fee_policy(*, id: str, update: UpdatePlatformAdditionalFeePolicyBody, applied_at: str) → ReschedulePlatformAdditionalFeePolicyResponse#

Parameters:

id (str) – 추가 수수료 정책 아이디
update (UpdatePlatformAdditionalFeePolicyBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

RescheduleAdditionalFeePolicyError –

async reschedule_additional_fee_policy_async(*, id: str, update: UpdatePlatformAdditionalFeePolicyBody, applied_at: str) → ReschedulePlatformAdditionalFeePolicyResponse#

Parameters:

id (str) – 추가 수수료 정책 아이디
update (UpdatePlatformAdditionalFeePolicyBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

RescheduleAdditionalFeePolicyError –

schedule_additional_fee_policy(*, id: str, update: UpdatePlatformAdditionalFeePolicyBody, applied_at: str) → SchedulePlatformAdditionalFeePolicyResponse#

주어진 아이디에 대응되는 추가 수수료 정책에 업데이트를 예약합니다.

Parameters:

id (str) – 추가 수수료 정책 아이디
update (UpdatePlatformAdditionalFeePolicyBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

ScheduleAdditionalFeePolicyError –

async schedule_additional_fee_policy_async(*, id: str, update: UpdatePlatformAdditionalFeePolicyBody, applied_at: str) → SchedulePlatformAdditionalFeePolicyResponse#

주어진 아이디에 대응되는 추가 수수료 정책에 업데이트를 예약합니다.

Parameters:

id (str) – 추가 수수료 정책 아이디
update (UpdatePlatformAdditionalFeePolicyBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

ScheduleAdditionalFeePolicyError –

cancel_platform_additional_fee_policy_schedule(*, id: str) → CancelPlatformAdditionalFeePolicyScheduleResponse#

주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 취소합니다.

Parameters:: id (str) – 추가 수수료 정책 아이디
Raises:: CancelPlatformAdditionalFeePolicyScheduleError –

async cancel_platform_additional_fee_policy_schedule_async(*, id: str) → CancelPlatformAdditionalFeePolicyScheduleResponse#

주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 취소합니다.

Parameters:: id (str) – 추가 수수료 정책 아이디
Raises:: CancelPlatformAdditionalFeePolicyScheduleError –

get_platform_partner_filter_options(*, is_archived: bool | None = None) → PlatformPartnerFilterOptions#

파트너 다건 조회 시 필요한 필터 옵션을 조회합니다.

Parameters:

is_archived (bool, optional) –

보관 조회 여부

true 이면 보관된 파트너의 필터 옵션을 조회하고, false 이면 보관되지 않은 파트너의 필터 옵션을 조회합니다. 기본값은 false 입니다.

Raises:

GetPlatformPartnerFilterOptionsError –

async get_platform_partner_filter_options_async(*, is_archived: bool | None = None) → PlatformPartnerFilterOptions#

파트너 다건 조회 시 필요한 필터 옵션을 조회합니다.

Parameters:

is_archived (bool, optional) –

보관 조회 여부

true 이면 보관된 파트너의 필터 옵션을 조회하고, false 이면 보관되지 않은 파트너의 필터 옵션을 조회합니다. 기본값은 false 입니다.

Raises:

GetPlatformPartnerFilterOptionsError –

get_platform_partner_schedule(*, id: str) → PlatformPartner#

주어진 아이디에 대응되는 파트너의 예약 업데이트를 조회합니다.

Parameters:: id (str) – 파트너 아이디
Raises:: GetPlatformPartnerScheduleError –

async get_platform_partner_schedule_async(*, id: str) → PlatformPartner#

주어진 아이디에 대응되는 파트너의 예약 업데이트를 조회합니다.

Parameters:: id (str) – 파트너 아이디
Raises:: GetPlatformPartnerScheduleError –

reschedule_partner(*, id: str, update: UpdatePlatformPartnerBody, applied_at: str) → ReschedulePlatformPartnerResponse#

주어진 아이디에 대응되는 파트너에 예약 업데이트를 재설정합니다.

Parameters:

id (str) – 파트너 아이디
update (UpdatePlatformPartnerBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

ReschedulePartnerError –

async reschedule_partner_async(*, id: str, update: UpdatePlatformPartnerBody, applied_at: str) → ReschedulePlatformPartnerResponse#

주어진 아이디에 대응되는 파트너에 예약 업데이트를 재설정합니다.

Parameters:

id (str) – 파트너 아이디
update (UpdatePlatformPartnerBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

ReschedulePartnerError –

schedule_partner(*, id: str, update: UpdatePlatformPartnerBody, applied_at: str) → SchedulePlatformPartnerResponse#

주어진 아이디에 대응되는 파트너에 업데이트를 예약합니다.

Parameters:

id (str) – 파트너 아이디
update (UpdatePlatformPartnerBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

SchedulePartnerError –

async schedule_partner_async(*, id: str, update: UpdatePlatformPartnerBody, applied_at: str) → SchedulePlatformPartnerResponse#

주어진 아이디에 대응되는 파트너에 업데이트를 예약합니다.

Parameters:

id (str) – 파트너 아이디
update (UpdatePlatformPartnerBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

SchedulePartnerError –

cancel_platform_partner_schedule(*, id: str) → CancelPlatformPartnerScheduleResponse#

주어진 아이디에 대응되는 파트너의 예약 업데이트를 취소합니다.

Parameters:: id (str) – 파트너 아이디
Raises:: CancelPlatformPartnerScheduleError –

async cancel_platform_partner_schedule_async(*, id: str) → CancelPlatformPartnerScheduleResponse#

주어진 아이디에 대응되는 파트너의 예약 업데이트를 취소합니다.

Parameters:: id (str) – 파트너 아이디
Raises:: CancelPlatformPartnerScheduleError –

schedule_platform_partners(*, filter: PlatformPartnerFilterInput | None = None, update: SchedulePlatformPartnersBodyUpdate, applied_at: str) → SchedulePlatformPartnersResponse#

Parameters:

filter (PlatformPartnerFilterInput, optional)
update (SchedulePlatformPartnersBodyUpdate)
applied_at (str)

Raises:

SchedulePlatformPartnersError –

async schedule_platform_partners_async(*, filter: PlatformPartnerFilterInput | None = None, update: SchedulePlatformPartnersBodyUpdate, applied_at: str) → SchedulePlatformPartnersResponse#

Parameters:

filter (PlatformPartnerFilterInput, optional)
update (SchedulePlatformPartnersBodyUpdate)
applied_at (str)

Raises:

SchedulePlatformPartnersError –

get_platform_contract_schedule(*, id: str) → PlatformContract#

주어진 아이디에 대응되는 계약의 예약 업데이트를 조회합니다.

Parameters:: id (str) – 계약 아이디
Raises:: GetPlatformContractScheduleError –

async get_platform_contract_schedule_async(*, id: str) → PlatformContract#

주어진 아이디에 대응되는 계약의 예약 업데이트를 조회합니다.

Parameters:: id (str) – 계약 아이디
Raises:: GetPlatformContractScheduleError –

reschedule_contract(*, id: str, update: UpdatePlatformContractBody, applied_at: str) → ReschedulePlatformContractResponse#

주어진 아이디에 대응되는 계약에 예약 업데이트를 재설정합니다.

Parameters:

id (str) – 계약 아이디
update (UpdatePlatformContractBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

RescheduleContractError –

async reschedule_contract_async(*, id: str, update: UpdatePlatformContractBody, applied_at: str) → ReschedulePlatformContractResponse#

주어진 아이디에 대응되는 계약에 예약 업데이트를 재설정합니다.

Parameters:

id (str) – 계약 아이디
update (UpdatePlatformContractBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

RescheduleContractError –

schedule_contract(*, id: str, update: UpdatePlatformContractBody, applied_at: str) → SchedulePlatformContractResponse#

주어진 아이디에 대응되는 계약에 업데이트를 예약합니다.

Parameters:

id (str) – 계약 아이디
update (UpdatePlatformContractBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

ScheduleContractError –

async schedule_contract_async(*, id: str, update: UpdatePlatformContractBody, applied_at: str) → SchedulePlatformContractResponse#

주어진 아이디에 대응되는 계약에 업데이트를 예약합니다.

Parameters:

id (str) – 계약 아이디
update (UpdatePlatformContractBody) – 반영할 업데이트 내용
applied_at (str) – 업데이트 적용 시점

Raises:

ScheduleContractError –

cancel_platform_contract_schedule(*, id: str) → CancelPlatformContractScheduleResponse#

주어진 아이디에 대응되는 계약의 예약 업데이트를 취소합니다.

Parameters:: id (str) – 계약 아이디
Raises:: CancelPlatformContractScheduleError –

async cancel_platform_contract_schedule_async(*, id: str) → CancelPlatformContractScheduleResponse#

주어진 아이디에 대응되는 계약의 예약 업데이트를 취소합니다.

Parameters:: id (str) – 계약 아이디
Raises:: CancelPlatformContractScheduleError –

get_platform_setting() → PlatformSetting#

플랫폼 설정 조회

설정 정보를 조회합니다.

Raises:: GetPlatformSettingError –

async get_platform_setting_async() → PlatformSetting#

플랫폼 설정 조회

설정 정보를 조회합니다.

Raises:: GetPlatformSettingError –

update_platform_setting(*, default_withdrawal_memo: str | None = None, default_deposit_memo: str | None = None) → UpdatePlatformSettingResponse#

플랫폼 설정 업데이트

설정 정보를 업데이트합니다.

Parameters:

default_withdrawal_memo (str, optional) – 기본 보내는 이 통장 메모
default_deposit_memo (str, optional) – 기본 받는 이 통장 메모

Raises:

UpdatePlatformSettingError –

async update_platform_setting_async(*, default_withdrawal_memo: str | None = None, default_deposit_memo: str | None = None) → UpdatePlatformSettingResponse#

플랫폼 설정 업데이트

설정 정보를 업데이트합니다.

Parameters:

default_withdrawal_memo (str, optional) – 기본 보내는 이 통장 메모
default_deposit_memo (str, optional) – 기본 받는 이 통장 메모

Raises:

UpdatePlatformSettingError –

Modules

`policy`
`partner`
`transfer`
`partner_settlement`
`payout`
`bulk_payout`
`account`
`company`
`account_transfer`

`CancelPlatformAdditionalFeePolicyScheduleError`
`CancelPlatformContractScheduleError`
`CancelPlatformDiscountSharePolicyScheduleError`
`CancelPlatformPartnerScheduleError`
`GetPlatformAdditionalFeePolicyScheduleError`
`GetPlatformContractScheduleError`
`GetPlatformDiscountSharePolicyFilterOptionsError`
`GetPlatformDiscountSharePolicyScheduleError`
`GetPlatformError`
`GetPlatformPartnerFilterOptionsError`
`GetPlatformPartnerScheduleError`
`GetPlatformSettingError`
`RescheduleAdditionalFeePolicyError`
`RescheduleContractError`
`RescheduleDiscountSharePolicyError`
`ReschedulePartnerError`
`ScheduleAdditionalFeePolicyError`
`ScheduleContractError`
`ScheduleDiscountSharePolicyError`
`SchedulePartnerError`
`SchedulePlatformPartnersError`
`UpdatePlatformError`
`UpdatePlatformSettingError`

portone_server_sdk.platform

Contents

portone_server_sdk.platform#