portone_server_sdk.platform.policy

portone_server_sdk.platform.policy#

Classes

`ArchivePlatformAdditionalFeePolicyResponse`	추가 수수료 정책 보관 성공 응답
`ArchivePlatformContractResponse`	계약 보관 성공 응답
`ArchivePlatformDiscountSharePolicyResponse`	할인 분담 보관 성공 응답
`CreatePlatformAdditionalFeePolicyBody`	추가 수수료 정책 생성을 위한 입력 정보
`CreatePlatformAdditionalFeePolicyResponse`	플랫폼 생성 성공 응답 정보
`CreatePlatformContractBody`	계약 객체 생성을 위한 입력 정보
`CreatePlatformContractResponse`	계약 객체 생성 성공 응답
`CreatePlatformDiscountSharePolicyBody`	할인 분담 정책 생성을 위한 입력 정보
`CreatePlatformDiscountSharePolicyResponse`	할인 분담 정책 생성 성공 응답
`GetPlatformAdditionalFeePoliciesBody`	추가 수수료 정책 다건 조회를 위한 입력 정보
`GetPlatformAdditionalFeePoliciesResponse`	추가 수수료 정책 다건 조회 성공 응답 정보
`GetPlatformContractsBody`	계약 다건 조회를 위한 입력 정보
`GetPlatformContractsResponse`	계약 다건 조회 성공 응답
`GetPlatformDiscountSharePoliciesBody`	할인 분담 정책 다건 조회를 위한 입력 정보
`GetPlatformDiscountSharePoliciesResponse`	할인 분담 정책 다건 조회 성공 응답 정보
`PlatformAdditionalFeePolicyFilterInput`	추가 수수료 정책 다건 조회를 위한 필터 조건
`PlatformAdditionalFeePolicyFilterInputKeyword`	검색 키워드 입력 정보
`PlatformContractFilterInput`	계약 다건 조회를 위한 필터 조건
`PlatformContractFilterInputKeyword`	검색 키워드 입력 정보
`PlatformDiscountSharePolicyFilterInput`	할인 분담 정책 다건 조회를 위한 필터 조건
`PlatformDiscountSharePolicyFilterInputKeyword`	검색 키워드 입력 정보
`RecoverPlatformAdditionalFeePolicyResponse`	추가 수수료 정책 복원 성공 응답
`RecoverPlatformContractResponse`	계약 복원 성공 응답
`RecoverPlatformDiscountSharePolicyResponse`	할인 분담 복원 성공 응답
`UpdatePlatformAdditionalFeePolicyResponse`	추가 수수료 정책 업데이트 성공 응답
`UpdatePlatformContractResponse`	계약 객체 업데이트 성공 응답
`UpdatePlatformDiscountSharePolicyResponse`	할인 분담 정책 업데이트 성공 응답
`PolicyClient`

class portone_server_sdk.platform.policy.ArchivePlatformAdditionalFeePolicyResponse#

추가 수수료 정책 보관 성공 응답

additional_fee_policy: PlatformAdditionalFeePolicy#: 보관된 추가 수수료 정책

class portone_server_sdk.platform.policy.ArchivePlatformContractResponse#

계약 보관 성공 응답

contract: PlatformContract#: 보관된 계약

class portone_server_sdk.platform.policy.ArchivePlatformDiscountSharePolicyResponse#

할인 분담 보관 성공 응답

discount_share_policy: PlatformDiscountSharePolicy#: 보관된 할인 분담

class portone_server_sdk.platform.policy.CreatePlatformAdditionalFeePolicyBody#

추가 수수료 정책 생성을 위한 입력 정보

name: str#: 이름

fee: PlatformFeeInput#: 수수료 정보

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

id: str | None#

생성할 추가 수수료 정책 아이디

명시하지 않으면 id 가 임의로 생성됩니다.

memo: str | None#: 메모

class portone_server_sdk.platform.policy.CreatePlatformAdditionalFeePolicyResponse#

플랫폼 생성 성공 응답 정보

additional_fee_policy: PlatformAdditionalFeePolicy#: 생성된 추가 수수료 정책

class portone_server_sdk.platform.policy.CreatePlatformContractBody#

계약 객체 생성을 위한 입력 정보

name: str#: 계약 이름

platform_fee: PlatformFeeInput#: 중개수수료

settlement_cycle: PlatformSettlementCycleInput#: 정산 주기

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

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

id: str | None#

계약에 부여할 고유 아이디

명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

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

class portone_server_sdk.platform.policy.CreatePlatformContractResponse#

계약 객체 생성 성공 응답

contract: PlatformContract#: 생성된 계약 객체

class portone_server_sdk.platform.policy.CreatePlatformDiscountSharePolicyBody#

할인 분담 정책 생성을 위한 입력 정보

name: str#: 할인 분담에 부여할 이름

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

id: str | None#

할인 분담에 부여할 고유 아이디

명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

memo: str | None#: 해당 할인 분담에 대한 메모 ex) 파트너 브랜드 쿠폰

class portone_server_sdk.platform.policy.CreatePlatformDiscountSharePolicyResponse#

할인 분담 정책 생성 성공 응답

discount_share_policy: PlatformDiscountSharePolicy#: 생성된 할인 분담 정책

class portone_server_sdk.platform.policy.GetPlatformAdditionalFeePoliciesBody#

추가 수수료 정책 다건 조회를 위한 입력 정보

page: PageInput | None#: 요청할 페이지 정보

filter: PlatformAdditionalFeePolicyFilterInput | None#: 조회할 추가 수수료 정책 조건 필터

class portone_server_sdk.platform.policy.GetPlatformAdditionalFeePoliciesResponse#

추가 수수료 정책 다건 조회 성공 응답 정보

items: list[PlatformAdditionalFeePolicy]#: 조회된 추가 수수료 정책 리스트

page: PageInfo#: 조회된 페이지 정보

class portone_server_sdk.platform.policy.GetPlatformContractsBody#

계약 다건 조회를 위한 입력 정보

page: PageInput | None#: 요청할 페이지 정보

filter: PlatformContractFilterInput | None#: 조회할 계약 조건 필터

class portone_server_sdk.platform.policy.GetPlatformContractsResponse#

계약 다건 조회 성공 응답

items: list[PlatformContract]#: 조회된 계약 리스트

page: PageInfo#: 조회된 페이지 정보

class portone_server_sdk.platform.policy.GetPlatformDiscountSharePoliciesBody#

할인 분담 정책 다건 조회를 위한 입력 정보

page: PageInput | None#: 요청할 페이지 정보

filter: PlatformDiscountSharePolicyFilterInput | None#: 조회할 할인 분담 정책 조건 필터

class portone_server_sdk.platform.policy.GetPlatformDiscountSharePoliciesResponse#

할인 분담 정책 다건 조회 성공 응답 정보

items: list[PlatformDiscountSharePolicy]#: 조회된 할인 분담 정책 리스트

page: PageInfo#: 조회된 페이지 정보

class portone_server_sdk.platform.policy.PlatformAdditionalFeePolicyFilterInput#

추가 수수료 정책 다건 조회를 위한 필터 조건

is_archived: bool | None#

보관 조회 여부

true 이면 보관된 추가 수수료 정책의 필터 옵션을 조회하고, false 이면 보관되지 않은 추가 수수료 정책의 필터 옵션을 조회합니다. 기본값은 false 입니다.

vat_payers: list[Literal['PARTNER', 'MERCHANT']] | None#

금액 부담 주체

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 부가세 부담 주체에 해당하는 추가 수수료 정책만 조회합니다.

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

class portone_server_sdk.platform.policy.PlatformAdditionalFeePolicyFilterInputKeyword#

검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 추가 수수료 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.

name: str | None#: 해당 값이 포함된 name 을 가진 추가 수수료 정책만 조회합니다.

id: str | None#: 해당 값이 포함된 id 를 가진 추가 수수료 정책만 조회합니다.

fee: str | None#: 해당 값과 같은 수수료 를 가진 추가 수수료 정책만 조회합니다.

class portone_server_sdk.platform.policy.PlatformContractFilterInput#

계약 다건 조회를 위한 필터 조건

platform_fee_payers: list[Literal['PARTNER', 'MERCHANT']] | None#

금액 부담 주체

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 수수료 부담 주체를 가진 계약만 조회합니다.

cycle_types: list[Literal['DAILY', 'WEEKLY', 'MONTHLY', 'MANUAL_DATES']] | None#

플랫폼 정산 주기 계산 방식

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 주기 계산 방식을 가진 계약만 조회합니다.

date_policies: list[Literal['HOLIDAY_BEFORE', 'HOLIDAY_AFTER', 'CALENDAR_DAY']] | None#

플랫폼 정산 기준일

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 기준일을 가진 계약만 조회합니다.

is_archived: bool | None#

보관 조회 여부

true 이면 보관된 계약을 조회하고, false 이면 보관되지 않은 계약을 조회합니다. 기본값은 false 입니다.

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

class portone_server_sdk.platform.policy.PlatformContractFilterInputKeyword#

검색 키워드 입력 정보

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

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

name: str | None#: 해당 값이 포함된 name 을 가진 계약만 조회합니다.

class portone_server_sdk.platform.policy.PlatformDiscountSharePolicyFilterInput#

할인 분담 정책 다건 조회를 위한 필터 조건

is_archived: bool | None#

보관 조회 여부

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

partner_share_rates: list[int] | None#: 하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 파트너 분담율을 가진 할인 분담 정책만 조회합니다.

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

class portone_server_sdk.platform.policy.PlatformDiscountSharePolicyFilterInputKeyword#

검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 할인 분담 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.

id: str | None#: 해당 값이 포함된 id 를 가진 할인 분담 정책만 조회합니다.

name: str | None#: 해당 값이 포함된 name 을 가진 할인 분담만 조회합니다.

class portone_server_sdk.platform.policy.RecoverPlatformAdditionalFeePolicyResponse#

추가 수수료 정책 복원 성공 응답

additional_fee_policy: PlatformAdditionalFeePolicy#: 복원된 추가 수수료 정책

class portone_server_sdk.platform.policy.RecoverPlatformContractResponse#

계약 복원 성공 응답

contract: PlatformContract#: 복원된 계약

class portone_server_sdk.platform.policy.RecoverPlatformDiscountSharePolicyResponse#

할인 분담 복원 성공 응답

discount_share_policy: PlatformDiscountSharePolicy#: 복원된 할인 분담

class portone_server_sdk.platform.policy.UpdatePlatformAdditionalFeePolicyResponse#

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

additional_fee_policy: PlatformAdditionalFeePolicy#: 업데이트된 추가 수수료 정책

class portone_server_sdk.platform.policy.UpdatePlatformContractResponse#

계약 객체 업데이트 성공 응답

contract: PlatformContract#: 업데이트된 계약 객체

class portone_server_sdk.platform.policy.UpdatePlatformDiscountSharePolicyResponse#

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

discount_share_policy: PlatformDiscountSharePolicy#: 업데이트된 할인 분담 정책

class portone_server_sdk.platform.policy.PolicyClient#

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

할인 분담 정책 다건 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

할인 분담 정책 다건 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformDiscountSharePolicyAlreadyExistsError – PlatformDiscountSharePolicyAlreadyExistsError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformDiscountSharePolicyAlreadyExistsError – PlatformDiscountSharePolicyAlreadyExistsError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

get_platform_discount_share_policy(*, id: str) → PlatformDiscountSharePolicy#

할인 분담 정책 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformDiscountSharePolicyNotFoundError – PlatformDiscountSharePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

할인 분담 정책 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformDiscountSharePolicyNotFoundError – PlatformDiscountSharePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformArchivedDiscountSharePolicyError – 보관된 할인 분담 정책을 업데이트하려고 하는 경우 보관된 할인 분담 정책을 업데이트하려고 하는 경우
PlatformDiscountSharePolicyNotFoundError – PlatformDiscountSharePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformArchivedDiscountSharePolicyError – 보관된 할인 분담 정책을 업데이트하려고 하는 경우 보관된 할인 분담 정책을 업데이트하려고 하는 경우
PlatformDiscountSharePolicyNotFoundError – PlatformDiscountSharePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

archive_platform_discount_share_policy(*, id: str) → ArchivePlatformDiscountSharePolicyResponse#

할인 분담 정책 보관

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

Parameters:

id (str) – 할인 분담 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCannotArchiveScheduledDiscountSharePolicyError – 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우
PlatformDiscountSharePolicyNotFoundError – PlatformDiscountSharePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

할인 분담 정책 보관

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

Parameters:

id (str) – 할인 분담 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCannotArchiveScheduledDiscountSharePolicyError – 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우
PlatformDiscountSharePolicyNotFoundError – PlatformDiscountSharePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

recover_platform_discount_share_policy(*, id: str) → RecoverPlatformDiscountSharePolicyResponse#

할인 분담 정책 복원

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

Parameters:

id (str) – 할인 분담 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformDiscountSharePolicyNotFoundError – PlatformDiscountSharePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

할인 분담 정책 복원

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

Parameters:

id (str) – 할인 분담 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformDiscountSharePolicyNotFoundError – PlatformDiscountSharePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

추가 수수료 정책 다건 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

추가 수수료 정책 다건 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

추가 수수료 정책 생성

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

Parameters:

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

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyAlreadyExistsError – PlatformAdditionalFeePolicyAlreadyExistsError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

추가 수수료 정책 생성

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

Parameters:

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

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyAlreadyExistsError – PlatformAdditionalFeePolicyAlreadyExistsError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

get_platform_additional_fee_policy(*, id: str) → PlatformAdditionalFeePolicy#

추가 수수료 정책 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyNotFoundError – PlatformAdditionalFeePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

추가 수수료 정책 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyNotFoundError – PlatformAdditionalFeePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

추가 수수료 정책 수정

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyNotFoundError – PlatformAdditionalFeePolicyNotFoundError
PlatformArchivedAdditionalFeePolicyError – 보관된 추가 수수료 정책을 업데이트하려고 하는 경우 보관된 추가 수수료 정책을 업데이트하려고 하는 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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'] | None = None) → UpdatePlatformAdditionalFeePolicyResponse#

추가 수수료 정책 수정

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyNotFoundError – PlatformAdditionalFeePolicyNotFoundError
PlatformArchivedAdditionalFeePolicyError – 보관된 추가 수수료 정책을 업데이트하려고 하는 경우 보관된 추가 수수료 정책을 업데이트하려고 하는 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

archive_platform_additional_fee_policy(*, id: str) → ArchivePlatformAdditionalFeePolicyResponse#

추가 수수료 정책 보관

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

Parameters:

id (str) – 추가 수수료 정책 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyNotFoundError – PlatformAdditionalFeePolicyNotFoundError
PlatformCannotArchiveScheduledAdditionalFeePolicyError – 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

추가 수수료 정책 보관

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

Parameters:

id (str) – 추가 수수료 정책 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyNotFoundError – PlatformAdditionalFeePolicyNotFoundError
PlatformCannotArchiveScheduledAdditionalFeePolicyError – 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

recover_platform_additional_fee_policy(*, id: str) → RecoverPlatformAdditionalFeePolicyResponse#

추가 수수료 정책 복원

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

Parameters:

id (str) – 추가 수수료 정책 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyNotFoundError – PlatformAdditionalFeePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

추가 수수료 정책 복원

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

Parameters:

id (str) – 추가 수수료 정책 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePolicyNotFoundError – PlatformAdditionalFeePolicyNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

계약 다건 조회

여러 계약을 조회합니다.

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

계약 다건 조회

여러 계약을 조회합니다.

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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'], 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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformContractAlreadyExistsError – PlatformContractAlreadyExistsError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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'], 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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformContractAlreadyExistsError – PlatformContractAlreadyExistsError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

get_platform_contract(*, id: str) → PlatformContract#

계약 조회

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

Parameters:

id (str) – 조회할 계약 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

계약 조회

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

Parameters:

id (str) – 조회할 계약 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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'] | 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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformArchivedContractError – 보관된 계약을 업데이트하려고 하는 경우 보관된 계약을 업데이트하려고 하는 경우
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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'] | 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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformArchivedContractError – 보관된 계약을 업데이트하려고 하는 경우 보관된 계약을 업데이트하려고 하는 경우
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

archive_platform_contract(*, id: str) → ArchivePlatformContractResponse#

계약 보관

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

Parameters:

id (str) – 계약 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCannotArchiveScheduledContractError – 예약된 업데이트가 있는 계약을 보관하려고 하는 경우 예약된 업데이트가 있는 계약을 보관하려고 하는 경우
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

계약 보관

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

Parameters:

id (str) – 계약 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCannotArchiveScheduledContractError – 예약된 업데이트가 있는 계약을 보관하려고 하는 경우 예약된 업데이트가 있는 계약을 보관하려고 하는 경우
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

recover_platform_contract(*, id: str) → RecoverPlatformContractResponse#

계약 복원

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

Parameters:

id (str) – 계약 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

계약 복원

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

Parameters:

id (str) – 계약 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

portone_server_sdk.platform.policy

Contents

portone_server_sdk.platform.policy#