portone_server_sdk.PlatformClient

Contents

portone_server_sdk.PlatformClient#

class portone_server_sdk.PlatformClient#

Bases: object

__init__(*, secret: str, base_url: str = 'https://api.portone.io', store_id: str | None = None)#

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Methods

__init__(*, secret[, base_url, store_id])

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

cancel_platform_additional_fee_policy_schedule(*, id)

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

cancel_platform_additional_fee_policy_schedule_async(*, id)

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

cancel_platform_contract_schedule(*, id)

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

cancel_platform_contract_schedule_async(*, id)

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

cancel_platform_discount_share_policy_schedule(*, id)

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

cancel_platform_discount_share_policy_schedule_async(*, id)

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

cancel_platform_partner_schedule(*, id)

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

cancel_platform_partner_schedule_async(*, id)

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

get_platform()

고객사의 플랫폼 정보를 조회합니다.

get_platform_additional_fee_policy_schedule(*, id)

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

get_platform_additional_fee_policy_schedule_async(*, id)

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

get_platform_async()

고객사의 플랫폼 정보를 조회합니다.

get_platform_contract_schedule(*, id)

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

get_platform_contract_schedule_async(*, id)

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

get_platform_discount_share_policy_filter_options(*)

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

get_platform_discount_share_policy_filter_options_async(*)

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

get_platform_discount_share_policy_schedule(*, id)

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

get_platform_discount_share_policy_schedule_async(*, id)

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

get_platform_partner_filter_options(*[, ...])

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

get_platform_partner_filter_options_async(*)

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

get_platform_partner_schedule(*, id)

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

get_platform_partner_schedule_async(*, id)

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

get_platform_setting()

플랫폼 설정 조회

get_platform_setting_async()

플랫폼 설정 조회

reschedule_additional_fee_policy(*, id, ...)

reschedule_additional_fee_policy_async(*, ...)

reschedule_contract(*, id, update, applied_at)

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

reschedule_contract_async(*, id, update, ...)

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

reschedule_discount_share_policy(*, id, ...)

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

reschedule_discount_share_policy_async(*, ...)

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

reschedule_partner(*, id, update, applied_at)

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

reschedule_partner_async(*, id, update, ...)

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

schedule_additional_fee_policy(*, id, ...)

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

schedule_additional_fee_policy_async(*, id, ...)

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

schedule_contract(*, id, update, applied_at)

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

schedule_contract_async(*, id, update, ...)

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

schedule_discount_share_policy(*, id, ...)

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

schedule_discount_share_policy_async(*, id, ...)

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

schedule_partner(*, id, update, applied_at)

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

schedule_partner_async(*, id, update, applied_at)

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

schedule_platform_partners(*[, filter])

schedule_platform_partners_async(*[, filter])

update_platform(*[, round_type, ...])

고객사의 플랫폼 관련 정보를 업데이트합니다.

update_platform_async(*[, round_type, ...])

고객사의 플랫폼 관련 정보를 업데이트합니다.

update_platform_setting(*[, ...])

플랫폼 설정 업데이트

update_platform_setting_async(*[, ...])

플랫폼 설정 업데이트

Attributes

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