portone_server_sdk.platform.partner

portone_server_sdk.platform.partner#

Classes

`ArchivePlatformPartnerResponse`	파트너 보관 성공 응답
`CreatePlatformPartnerBody`	파트너 생성을 위한 입력 정보
`CreatePlatformPartnerBodyAccount`	파트너 계좌 등록을 위한 정보
`CreatePlatformPartnerBodyContact`	파트너 담당자 정보
`CreatePlatformPartnerBodyType`	파트너 생성을 위한 유형별 추가 정보
`CreatePlatformPartnerBodyTypeBusiness`
`CreatePlatformPartnerBodyTypeNonWhtPayer`
`CreatePlatformPartnerBodyTypeWhtPayer`
`CreatePlatformPartnerResponse`	파트너 생성 성공 응답
`CreatePlatformPartnersBody`	파트너 다건 생성을 위한 입력 정보
`CreatePlatformPartnersResponse`	파트너 다건 생성 성공 응답
`GetPlatformPartnersBody`	파트너 다건 조회를 위한 입력 정보
`GetPlatformPartnersResponse`	파트너 다건 조회 성공 응답 정보
`RecoverPlatformPartnerResponse`	파트너 복원 성공 응답
`UpdatePlatformPartnerResponse`	파트너 업데이트 성공 응답
`PartnerClient`

Exceptions

`ArchivePlatformPartnerError`
`CreatePlatformPartnerError`
`CreatePlatformPartnersError`
`GetPlatformPartnerError`
`GetPlatformPartnersError`
`RecoverPlatformPartnerError`
`UpdatePlatformPartnerError`

exception portone_server_sdk.platform.partner.ArchivePlatformPartnerError#

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.partner.CreatePlatformPartnerError#

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.partner.CreatePlatformPartnersError#

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.partner.GetPlatformPartnerError#

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.partner.GetPlatformPartnersError#

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.partner.RecoverPlatformPartnerError#

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.partner.UpdatePlatformPartnerError#

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.partner.ArchivePlatformPartnerResponse#

Bases: object

파트너 보관 성공 응답

partner: PlatformPartner#: 보관된 파트너

class portone_server_sdk.platform.partner.CreatePlatformPartnerBody#

Bases: object

파트너 생성을 위한 입력 정보

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

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

account: CreatePlatformPartnerBodyAccount#

정산 계좌

파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다.

default_contract_id: str#

기본 계약 아이디

이미 존재하는 계약 아이디를 등록해야 합니다.

tags: list[str]#

파트너에 부여할 태그 리스트

최대 10개까지 입력할 수 있습니다.

type: CreatePlatformPartnerBodyType#

파트너 유형별 추가 정보

사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다.

id: str | None#

파트너에 부여할 고유 아이디

고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

memo: str | None#

파트너에 대한 메모

총 256자까지 입력할 수 있습니다.

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

class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyAccount#

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.partner.CreatePlatformPartnerBodyContact#

Bases: object

파트너 담당자 정보

name: str#: 담당자 이름

email: str#: 담당자 이메일

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

class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyType#

Bases: object

파트너 생성을 위한 유형별 추가 정보

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

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

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

class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyTypeBusiness#

Bases: object

company_name: str#: 상호명

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

representative_name: str#: 대표자 이름

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

사업자 유형

값을 입력하지 않으면 일반 과세로 설정됩니다.

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

business_type: str | None#: 업태

business_class: str | None#: 업종

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

class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyTypeNonWhtPayer#

Bases: object

birthdate: str | None#

생년월일

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

class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyTypeWhtPayer#

Bases: object

birthdate: str | None#

생년월일

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

class portone_server_sdk.platform.partner.CreatePlatformPartnerResponse#

Bases: object

파트너 생성 성공 응답

partner: PlatformPartner#: 생성된 파트너

class portone_server_sdk.platform.partner.CreatePlatformPartnersBody#

Bases: object

파트너 다건 생성을 위한 입력 정보

partners: list[CreatePlatformPartnerBody]#: 생성할 파트너 리스트 정보

class portone_server_sdk.platform.partner.CreatePlatformPartnersResponse#

Bases: object

파트너 다건 생성 성공 응답

partners: list[PlatformPartner]#: 생성된 파트너 리스트

class portone_server_sdk.platform.partner.GetPlatformPartnersBody#

Bases: object

파트너 다건 조회를 위한 입력 정보

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

filter: PlatformPartnerFilterInput | None#: 조회할 파트너 조건 필터

class portone_server_sdk.platform.partner.GetPlatformPartnersResponse#

Bases: object

파트너 다건 조회 성공 응답 정보

items: list[PlatformPartner]#: 조회된 파트너 리스트

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

class portone_server_sdk.platform.partner.RecoverPlatformPartnerResponse#

Bases: object

파트너 복원 성공 응답

partner: PlatformPartner#: 복원된 파트너

class portone_server_sdk.platform.partner.UpdatePlatformPartnerResponse#

Bases: object

파트너 업데이트 성공 응답

partner: PlatformPartner#: 업데이트된 파트너

class portone_server_sdk.platform.partner.PartnerClient#

Bases: object

get_platform_partners(*, page: PageInput | None = None, filter: PlatformPartnerFilterInput | None = None) → GetPlatformPartnersResponse#

파트너 다건 조회

여러 파트너를 조회합니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformPartnerFilterInput, optional) – 조회할 파트너 조건 필터

Raises:

GetPlatformPartnersError –

async get_platform_partners_async(*, page: PageInput | None = None, filter: PlatformPartnerFilterInput | None = None) → GetPlatformPartnersResponse#

파트너 다건 조회

여러 파트너를 조회합니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformPartnerFilterInput, optional) – 조회할 파트너 조건 필터

Raises:

GetPlatformPartnersError –

create_platform_partner(*, id: str | None = None, name: str, contact: CreatePlatformPartnerBodyContact, account: CreatePlatformPartnerBodyAccount, default_contract_id: str, memo: str | None = None, tags: list[str], type: CreatePlatformPartnerBodyType, user_defined_properties: PlatformProperties | None = None) → CreatePlatformPartnerResponse#

파트너 생성

새로운 파트너를 생성합니다.

Parameters:

id (str, optional) –
파트너에 부여할 고유 아이디

고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
name (str) – 파트너 법인명 혹은 이름
contact (CreatePlatformPartnerBodyContact) – 파트너 담당자 연락 정보
account (CreatePlatformPartnerBodyAccount) –
정산 계좌

파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다.
default_contract_id (str) –
기본 계약 아이디

이미 존재하는 계약 아이디를 등록해야 합니다.
memo (str, optional) –
파트너에 대한 메모

총 256자까지 입력할 수 있습니다.
tags (list[str]) –
파트너에 부여할 태그 리스트

최대 10개까지 입력할 수 있습니다.
type (CreatePlatformPartnerBodyType) –
파트너 유형별 추가 정보

사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다.
user_defined_properties (PlatformProperties, optional) – 사용자 정의 속성

Raises:

CreatePlatformPartnerError –

async create_platform_partner_async(*, id: str | None = None, name: str, contact: CreatePlatformPartnerBodyContact, account: CreatePlatformPartnerBodyAccount, default_contract_id: str, memo: str | None = None, tags: list[str], type: CreatePlatformPartnerBodyType, user_defined_properties: PlatformProperties | None = None) → CreatePlatformPartnerResponse#

파트너 생성

새로운 파트너를 생성합니다.

Parameters:

id (str, optional) –
파트너에 부여할 고유 아이디

고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
name (str) – 파트너 법인명 혹은 이름
contact (CreatePlatformPartnerBodyContact) – 파트너 담당자 연락 정보
account (CreatePlatformPartnerBodyAccount) –
정산 계좌

파트너의 사업자등록번호가 존재하는 경우 명시합니다. 별도로 검증하지는 않으며, 번호와 기호 모두 입력 가능합니다.
default_contract_id (str) –
기본 계약 아이디

이미 존재하는 계약 아이디를 등록해야 합니다.
memo (str, optional) –
파트너에 대한 메모

총 256자까지 입력할 수 있습니다.
tags (list[str]) –
파트너에 부여할 태그 리스트

최대 10개까지 입력할 수 있습니다.
type (CreatePlatformPartnerBodyType) –
파트너 유형별 추가 정보

사업자/원천징수 대상자 중 추가할 파트너의 유형에 따른 정보를 입력해야 합니다.
user_defined_properties (PlatformProperties, optional) – 사용자 정의 속성

Raises:

CreatePlatformPartnerError –

get_platform_partner(*, id: str) → PlatformPartner#

파트너 조회

파트너 객체를 조회합니다.

Parameters:: id (str) – 조회하고 싶은 파트너 아이디
Raises:: GetPlatformPartnerError –

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

파트너 조회

파트너 객체를 조회합니다.

Parameters:: id (str) – 조회하고 싶은 파트너 아이디
Raises:: GetPlatformPartnerError –

update_platform_partner(*, id: str, name: str | None = None, contact: UpdatePlatformPartnerBodyContact | None = None, account: UpdatePlatformPartnerBodyAccount | None = None, default_contract_id: str | None = None, memo: str | None = None, tags: list[str] | None = None, type: UpdatePlatformPartnerBodyType | None = None, user_defined_properties: PlatformProperties | None = None) → UpdatePlatformPartnerResponse#

파트너 수정

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

Parameters:

id (str) – 업데이트할 파트너 아이디
name (str, optional) – 파트너 법인명 혹은 이름
contact (UpdatePlatformPartnerBodyContact, optional) – 파트너 담당자 연락 정보
account (UpdatePlatformPartnerBodyAccount, optional) – 정산 계좌
default_contract_id (str, optional) – 파트너에 설정된 기본 계약 아이디
memo (str, optional) – 파트너에 대한 메모
tags (list[str], optional) – 파트너의 태그 리스트
type (UpdatePlatformPartnerBodyType, optional) – 파트너 유형별 정보
user_defined_properties (PlatformProperties, optional) – 사용자 정의 속성

Raises:

UpdatePlatformPartnerError –

async update_platform_partner_async(*, id: str, name: str | None = None, contact: UpdatePlatformPartnerBodyContact | None = None, account: UpdatePlatformPartnerBodyAccount | None = None, default_contract_id: str | None = None, memo: str | None = None, tags: list[str] | None = None, type: UpdatePlatformPartnerBodyType | None = None, user_defined_properties: PlatformProperties | None = None) → UpdatePlatformPartnerResponse#

파트너 수정

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

Parameters:

id (str) – 업데이트할 파트너 아이디
name (str, optional) – 파트너 법인명 혹은 이름
contact (UpdatePlatformPartnerBodyContact, optional) – 파트너 담당자 연락 정보
account (UpdatePlatformPartnerBodyAccount, optional) – 정산 계좌
default_contract_id (str, optional) – 파트너에 설정된 기본 계약 아이디
memo (str, optional) – 파트너에 대한 메모
tags (list[str], optional) – 파트너의 태그 리스트
type (UpdatePlatformPartnerBodyType, optional) – 파트너 유형별 정보
user_defined_properties (PlatformProperties, optional) – 사용자 정의 속성

Raises:

UpdatePlatformPartnerError –

create_platform_partners(*, partners: list[CreatePlatformPartnerBody]) → CreatePlatformPartnersResponse#

파트너 다건 생성

새로운 파트너를 다건 생성합니다.

Parameters:: partners (list[CreatePlatformPartnerBody]) – 생성할 파트너 리스트 정보
Raises:: CreatePlatformPartnersError –

async create_platform_partners_async(*, partners: list[CreatePlatformPartnerBody]) → CreatePlatformPartnersResponse#

파트너 다건 생성

새로운 파트너를 다건 생성합니다.

Parameters:: partners (list[CreatePlatformPartnerBody]) – 생성할 파트너 리스트 정보
Raises:: CreatePlatformPartnersError –

archive_platform_partner(*, id: str) → ArchivePlatformPartnerResponse#

파트너 복원

주어진 아이디에 대응되는 파트너를 보관합니다.

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

async archive_platform_partner_async(*, id: str) → ArchivePlatformPartnerResponse#

파트너 복원

주어진 아이디에 대응되는 파트너를 보관합니다.

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

recover_platform_partner(*, id: str) → RecoverPlatformPartnerResponse#

파트너 복원

주어진 아이디에 대응되는 파트너를 복원합니다.

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

async recover_platform_partner_async(*, id: str) → RecoverPlatformPartnerResponse#

파트너 복원

주어진 아이디에 대응되는 파트너를 복원합니다.

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

portone_server_sdk.platform.partner

Contents

portone_server_sdk.platform.partner#