portone_server_sdk.PolicyClient

portone_server_sdk.PolicyClient#

class portone_server_sdk.PolicyClient#

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 클라이언트를 생성합니다.
`archive_platform_additional_fee_policy`(*, id)	추가 수수료 정책 보관
`archive_platform_additional_fee_policy_async`(*, id)	추가 수수료 정책 보관
`archive_platform_contract`(*, id)	계약 보관
`archive_platform_contract_async`(*, id)	계약 보관
`archive_platform_discount_share_policy`(*, id)	할인 분담 정책 보관
`archive_platform_discount_share_policy_async`(*, id)	할인 분담 정책 보관
`create_platform_additional_fee_policy`(*[, ...])	추가 수수료 정책 생성
`create_platform_additional_fee_policy_async`(*)	추가 수수료 정책 생성
`create_platform_contract`(*[, id, memo])	계약 생성
`create_platform_contract_async`(*[, id, memo])	계약 생성
`create_platform_discount_share_policy`(*[, ...])	할인 분담 정책 생성
`create_platform_discount_share_policy_async`(*)	할인 분담 정책 생성
`get_platform_additional_fee_policies`(*[, ...])	추가 수수료 정책 다건 조회
`get_platform_additional_fee_policies_async`(*)	추가 수수료 정책 다건 조회
`get_platform_additional_fee_policy`(*, id)	추가 수수료 정책 조회
`get_platform_additional_fee_policy_async`(*, id)	추가 수수료 정책 조회
`get_platform_contract`(*, id)	계약 조회
`get_platform_contract_async`(*, id)	계약 조회
`get_platform_contracts`(*[, page, filter])	계약 다건 조회
`get_platform_contracts_async`(*[, page, filter])	계약 다건 조회
`get_platform_discount_share_policies`(*[, ...])	할인 분담 정책 다건 조회
`get_platform_discount_share_policies_async`(*)	할인 분담 정책 다건 조회
`get_platform_discount_share_policy`(*, id)	할인 분담 정책 조회
`get_platform_discount_share_policy_async`(*, id)	할인 분담 정책 조회
`recover_platform_additional_fee_policy`(*, id)	추가 수수료 정책 복원
`recover_platform_additional_fee_policy_async`(*, id)	추가 수수료 정책 복원
`recover_platform_contract`(*, id)	계약 복원
`recover_platform_contract_async`(*, id)	계약 복원
`recover_platform_discount_share_policy`(*, id)	할인 분담 정책 복원
`recover_platform_discount_share_policy_async`(*, id)	할인 분담 정책 복원
`update_platform_additional_fee_policy`(*, id)	추가 수수료 정책 수정
`update_platform_additional_fee_policy_async`(*, id)	추가 수수료 정책 수정
`update_platform_contract`(*, id[, name, ...])	계약 수정
`update_platform_contract_async`(*, id[, ...])	계약 수정
`update_platform_discount_share_policy`(*, id)	할인 분담 정책 수정
`update_platform_discount_share_policy_async`(*, id)	할인 분담 정책 수정

get_platform_discount_share_policies(*, page: PageInput | None = None, filter: PlatformDiscountSharePolicyFilterInput | None = None) → GetPlatformDiscountSharePoliciesResponse#

할인 분담 정책 다건 조회

여러 할인 분담을 조회합니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformDiscountSharePolicyFilterInput, optional) – 조회할 할인 분담 정책 조건 필터

Raises:

GetPlatformDiscountSharePoliciesError –

async get_platform_discount_share_policies_async(*, page: PageInput | None = None, filter: PlatformDiscountSharePolicyFilterInput | None = None) → GetPlatformDiscountSharePoliciesResponse#

할인 분담 정책 다건 조회

여러 할인 분담을 조회합니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformDiscountSharePolicyFilterInput, optional) – 조회할 할인 분담 정책 조건 필터

Raises:

GetPlatformDiscountSharePoliciesError –

create_platform_discount_share_policy(*, id: str | None = None, name: str, partner_share_rate: int, memo: str | None = None) → CreatePlatformDiscountSharePolicyResponse#

할인 분담 정책 생성

새로운 할인 분담을 생성합니다.

Parameters:

id (str, optional) –
할인 분담에 부여할 고유 아이디

명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
name (str) – 할인 분담에 부여할 이름
partner_share_rate (int) – 파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo (str, optional) – 해당 할인 분담에 대한 메모 ex) 파트너 브랜드 쿠폰

Raises:

CreatePlatformDiscountSharePolicyError –

async create_platform_discount_share_policy_async(*, id: str | None = None, name: str, partner_share_rate: int, memo: str | None = None) → CreatePlatformDiscountSharePolicyResponse#

할인 분담 정책 생성

새로운 할인 분담을 생성합니다.

Parameters:

id (str, optional) –
할인 분담에 부여할 고유 아이디

명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
name (str) – 할인 분담에 부여할 이름
partner_share_rate (int) – 파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo (str, optional) – 해당 할인 분담에 대한 메모 ex) 파트너 브랜드 쿠폰

Raises:

CreatePlatformDiscountSharePolicyError –

get_platform_discount_share_policy(*, id: str) → PlatformDiscountSharePolicy#

할인 분담 정책 조회

주어진 아이디에 대응되는 할인 분담을 조회합니다.

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

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

할인 분담 정책 조회

주어진 아이디에 대응되는 할인 분담을 조회합니다.

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

update_platform_discount_share_policy(*, id: str, name: str | None = None, partner_share_rate: int | None = None, memo: str | None = None) → UpdatePlatformDiscountSharePolicyResponse#

할인 분담 정책 수정

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

Parameters:

id (str) – 업데이트할 할인 분담 정책 아이디
name (str, optional) – 할인 분담 정책 이름
partner_share_rate (int, optional) –
할인 분담율

파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo (str, optional) – 해당 할인 분담에 대한 메모

Raises:

UpdatePlatformDiscountSharePolicyError –

async update_platform_discount_share_policy_async(*, id: str, name: str | None = None, partner_share_rate: int | None = None, memo: str | None = None) → UpdatePlatformDiscountSharePolicyResponse#

할인 분담 정책 수정

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

Parameters:

id (str) – 업데이트할 할인 분담 정책 아이디
name (str, optional) – 할인 분담 정책 이름
partner_share_rate (int, optional) –
할인 분담율

파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo (str, optional) – 해당 할인 분담에 대한 메모

Raises:

UpdatePlatformDiscountSharePolicyError –

archive_platform_discount_share_policy(*, id: str) → ArchivePlatformDiscountSharePolicyResponse#

할인 분담 정책 보관

주어진 아이디에 대응되는 할인 분담을 보관합니다.

Parameters:: id (str) – 할인 분담 아이디
Raises:: ArchivePlatformDiscountSharePolicyError –

async archive_platform_discount_share_policy_async(*, id: str) → ArchivePlatformDiscountSharePolicyResponse#

할인 분담 정책 보관

주어진 아이디에 대응되는 할인 분담을 보관합니다.

Parameters:: id (str) – 할인 분담 아이디
Raises:: ArchivePlatformDiscountSharePolicyError –

recover_platform_discount_share_policy(*, id: str) → RecoverPlatformDiscountSharePolicyResponse#

할인 분담 정책 복원

주어진 아이디에 대응되는 할인 분담을 복원합니다.

Parameters:: id (str) – 할인 분담 아이디
Raises:: RecoverPlatformDiscountSharePolicyError –

async recover_platform_discount_share_policy_async(*, id: str) → RecoverPlatformDiscountSharePolicyResponse#

할인 분담 정책 복원

주어진 아이디에 대응되는 할인 분담을 복원합니다.

Parameters:: id (str) – 할인 분담 아이디
Raises:: RecoverPlatformDiscountSharePolicyError –

get_platform_additional_fee_policies(*, page: PageInput | None = None, filter: PlatformAdditionalFeePolicyFilterInput | None = None) → GetPlatformAdditionalFeePoliciesResponse#

추가 수수료 정책 다건 조회

여러 추가 수수료 정책을 조회합니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformAdditionalFeePolicyFilterInput, optional) – 조회할 추가 수수료 정책 조건 필터

Raises:

GetPlatformAdditionalFeePoliciesError –

async get_platform_additional_fee_policies_async(*, page: PageInput | None = None, filter: PlatformAdditionalFeePolicyFilterInput | None = None) → GetPlatformAdditionalFeePoliciesResponse#

추가 수수료 정책 다건 조회

여러 추가 수수료 정책을 조회합니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformAdditionalFeePolicyFilterInput, optional) – 조회할 추가 수수료 정책 조건 필터

Raises:

GetPlatformAdditionalFeePoliciesError –

create_platform_additional_fee_policy(*, id: str | None = None, name: str, fee: PlatformFeeInput, memo: str | None = None, vat_payer: Literal['PARTNER', 'MERCHANT'] | str) → CreatePlatformAdditionalFeePolicyResponse#

추가 수수료 정책 생성

새로운 추가 수수료 정책을 생성합니다.

Parameters:

id (str, optional) –
생성할 추가 수수료 정책 아이디

명시하지 않으면 id 가 임의로 생성됩니다.
name (str) – 이름
fee (PlatformFeeInput) – 수수료 정보
memo (str, optional) – 메모
vat_payer (PlatformPayer) – 부가세 부담 주체

Raises:

CreatePlatformAdditionalFeePolicyError –

async create_platform_additional_fee_policy_async(*, id: str | None = None, name: str, fee: PlatformFeeInput, memo: str | None = None, vat_payer: Literal['PARTNER', 'MERCHANT'] | str) → CreatePlatformAdditionalFeePolicyResponse#

추가 수수료 정책 생성

새로운 추가 수수료 정책을 생성합니다.

Parameters:

id (str, optional) –
생성할 추가 수수료 정책 아이디

명시하지 않으면 id 가 임의로 생성됩니다.
name (str) – 이름
fee (PlatformFeeInput) – 수수료 정보
memo (str, optional) – 메모
vat_payer (PlatformPayer) – 부가세 부담 주체

Raises:

CreatePlatformAdditionalFeePolicyError –

get_platform_additional_fee_policy(*, id: str) → PlatformAdditionalFeePolicy#

추가 수수료 정책 조회

주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.

Parameters:: id (str) – 조회할 추가 수수료 정책 아이디
Raises:: GetPlatformAdditionalFeePolicyError –

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

추가 수수료 정책 조회

주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.

Parameters:: id (str) – 조회할 추가 수수료 정책 아이디
Raises:: GetPlatformAdditionalFeePolicyError –

추가 수수료 정책 수정

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

Parameters:

id (str) – 업데이트할 추가 수수료 정책 아이디
fee (PlatformFeeInput, optional) – 책정 수수료
name (str, optional) – 추가 수수료 정책 이름
memo (str, optional) – 해당 추가 수수료 정책에 대한 메모
vat_payer (PlatformPayer, optional) – 부가세를 부담할 주체

Raises:

UpdatePlatformAdditionalFeePolicyError –

async update_platform_additional_fee_policy_async(*, id: str, fee: PlatformFeeInput | None = None, name: str | None = None, memo: str | None = None, vat_payer: Literal['PARTNER', 'MERCHANT'] | str | None = None) → UpdatePlatformAdditionalFeePolicyResponse#

추가 수수료 정책 수정

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

Parameters:

id (str) – 업데이트할 추가 수수료 정책 아이디
fee (PlatformFeeInput, optional) – 책정 수수료
name (str, optional) – 추가 수수료 정책 이름
memo (str, optional) – 해당 추가 수수료 정책에 대한 메모
vat_payer (PlatformPayer, optional) – 부가세를 부담할 주체

Raises:

UpdatePlatformAdditionalFeePolicyError –

archive_platform_additional_fee_policy(*, id: str) → ArchivePlatformAdditionalFeePolicyResponse#

추가 수수료 정책 보관

주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.

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

async archive_platform_additional_fee_policy_async(*, id: str) → ArchivePlatformAdditionalFeePolicyResponse#

추가 수수료 정책 보관

주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.

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

recover_platform_additional_fee_policy(*, id: str) → RecoverPlatformAdditionalFeePolicyResponse#

추가 수수료 정책 복원

주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.

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

async recover_platform_additional_fee_policy_async(*, id: str) → RecoverPlatformAdditionalFeePolicyResponse#

추가 수수료 정책 복원

주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.

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

get_platform_contracts(*, page: PageInput | None = None, filter: PlatformContractFilterInput | None = None) → GetPlatformContractsResponse#

계약 다건 조회

여러 계약을 조회합니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformContractFilterInput, optional) – 조회할 계약 조건 필터

Raises:

GetPlatformContractsError –

async get_platform_contracts_async(*, page: PageInput | None = None, filter: PlatformContractFilterInput | None = None) → GetPlatformContractsResponse#

계약 다건 조회

여러 계약을 조회합니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformContractFilterInput, optional) – 조회할 계약 조건 필터

Raises:

GetPlatformContractsError –

create_platform_contract(*, id: str | None = None, name: str, memo: str | None = None, platform_fee: PlatformFeeInput, settlement_cycle: PlatformSettlementCycleInput, platform_fee_vat_payer: Literal['PARTNER', 'MERCHANT'] | str, subtract_payment_vat_amount: bool) → CreatePlatformContractResponse#

계약 생성

새로운 계약을 생성합니다.

Parameters:

id (str, optional) –
계약에 부여할 고유 아이디

명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
name (str) – 계약 이름
memo (str, optional) – 계약 내부 표기를 위한 메모
platform_fee (PlatformFeeInput) – 중개수수료
settlement_cycle (PlatformSettlementCycleInput) – 정산 주기
platform_fee_vat_payer (PlatformPayer) – 중개수수료에 대한 부가세 부담 주체
subtract_payment_vat_amount (bool) – 정산 시 결제금액 부가세 감액 여부

Raises:

CreatePlatformContractError –

async create_platform_contract_async(*, id: str | None = None, name: str, memo: str | None = None, platform_fee: PlatformFeeInput, settlement_cycle: PlatformSettlementCycleInput, platform_fee_vat_payer: Literal['PARTNER', 'MERCHANT'] | str, subtract_payment_vat_amount: bool) → CreatePlatformContractResponse#

계약 생성

새로운 계약을 생성합니다.

Parameters:

id (str, optional) –
계약에 부여할 고유 아이디

명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
name (str) – 계약 이름
memo (str, optional) – 계약 내부 표기를 위한 메모
platform_fee (PlatformFeeInput) – 중개수수료
settlement_cycle (PlatformSettlementCycleInput) – 정산 주기
platform_fee_vat_payer (PlatformPayer) – 중개수수료에 대한 부가세 부담 주체
subtract_payment_vat_amount (bool) – 정산 시 결제금액 부가세 감액 여부

Raises:

CreatePlatformContractError –

get_platform_contract(*, id: str) → PlatformContract#

계약 조회

주어진 아이디에 대응되는 계약을 조회합니다.

Parameters:: id (str) – 조회할 계약 아이디
Raises:: GetPlatformContractError –

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

계약 조회

주어진 아이디에 대응되는 계약을 조회합니다.

Parameters:: id (str) – 조회할 계약 아이디
Raises:: GetPlatformContractError –

update_platform_contract(*, id: str, name: str | None = None, memo: str | None = None, platform_fee: PlatformFeeInput | None = None, settlement_cycle: PlatformSettlementCycleInput | None = None, platform_fee_vat_payer: Literal['PARTNER', 'MERCHANT'] | str | None = None, subtract_payment_vat_amount: bool | None = None) → UpdatePlatformContractResponse#

계약 수정

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

Parameters:

id (str) – 업데이트할 계약 아이디
name (str, optional) – 계약 이름
memo (str, optional) – 계약 내부 표기를 위한 메모
platform_fee (PlatformFeeInput, optional) – 중개수수료
settlement_cycle (PlatformSettlementCycleInput, optional) – 정산 주기
platform_fee_vat_payer (PlatformPayer, optional) – 중개수수료에 대한 부가세 부담 주체
subtract_payment_vat_amount (bool, optional) – 정산 시 결제금액 부가세 감액 여부

Raises:

UpdatePlatformContractError –

async update_platform_contract_async(*, id: str, name: str | None = None, memo: str | None = None, platform_fee: PlatformFeeInput | None = None, settlement_cycle: PlatformSettlementCycleInput | None = None, platform_fee_vat_payer: Literal['PARTNER', 'MERCHANT'] | str | None = None, subtract_payment_vat_amount: bool | None = None) → UpdatePlatformContractResponse#

계약 수정

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

Parameters:

id (str) – 업데이트할 계약 아이디
name (str, optional) – 계약 이름
memo (str, optional) – 계약 내부 표기를 위한 메모
platform_fee (PlatformFeeInput, optional) – 중개수수료
settlement_cycle (PlatformSettlementCycleInput, optional) – 정산 주기
platform_fee_vat_payer (PlatformPayer, optional) – 중개수수료에 대한 부가세 부담 주체
subtract_payment_vat_amount (bool, optional) – 정산 시 결제금액 부가세 감액 여부

Raises:

UpdatePlatformContractError –

archive_platform_contract(*, id: str) → ArchivePlatformContractResponse#

계약 보관

주어진 아이디에 대응되는 계약을 보관합니다.

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

async archive_platform_contract_async(*, id: str) → ArchivePlatformContractResponse#

계약 보관

주어진 아이디에 대응되는 계약을 보관합니다.

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

recover_platform_contract(*, id: str) → RecoverPlatformContractResponse#

계약 복원

주어진 아이디에 대응되는 계약을 복원합니다.

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

async recover_platform_contract_async(*, id: str) → RecoverPlatformContractResponse#

계약 복원

주어진 아이디에 대응되는 계약을 복원합니다.

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

portone_server_sdk.PolicyClient

Contents

portone_server_sdk.PolicyClient#