portone_server_sdk.platform.partner#
Classes
파트너 보관 성공 응답 |
|
파트너 생성을 위한 입력 정보 |
|
파트너 계좌 등록을 위한 정보 |
|
파트너 담당자 정보 |
|
파트너 생성을 위한 유형별 추가 정보 |
|
파트너 생성 성공 응답 |
|
파트너 다건 생성을 위한 입력 정보 |
|
파트너 다건 생성 성공 응답 |
|
파트너 다건 조회를 위한 입력 정보 |
|
파트너 다건 조회 성공 응답 정보 |
|
파트너 복원 성공 응답 |
|
파트너 업데이트 성공 응답 |
|
- class portone_server_sdk.platform.partner.ArchivePlatformPartnerResponse#
파트너 보관 성공 응답
- partner: PlatformPartner#
보관된 파트너
- class portone_server_sdk.platform.partner.CreatePlatformPartnerBody#
파트너 생성을 위한 입력 정보
- 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#
파트너 계좌 등록을 위한 정보
- 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']#
은행
- 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']#
정산에 사용할 통화
- number: str#
계좌번호
- holder: str#
예금주명
- account_verification_id: str | None#
계좌 검증 아이디
- class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyContact#
파트너 담당자 정보
- name: str#
담당자 이름
- email: str#
담당자 이메일
- phone_number: str | None#
담당자 휴대폰 번호
- class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyType#
파트너 생성을 위한 유형별 추가 정보
- business: CreatePlatformPartnerBodyTypeBusiness | None#
사업자 추가 정보
- wht_payer: CreatePlatformPartnerBodyTypeWhtPayer | None#
원천징수 대상자 추가 정보
- non_wht_payer: CreatePlatformPartnerBodyTypeNonWhtPayer | None#
원천징수 비대상자 추가 정보
- class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyTypeBusiness#
- company_name: str#
상호명
- business_registration_number: str#
사업자등록번호
- representative_name: str#
대표자 이름
- taxation_type: Literal['NORMAL', 'SIMPLE_TAX_INVOICE_ISSUER', 'SIMPLE', 'TAX_FREE'] | None#
사업자 유형
값을 입력하지 않으면 일반 과세로 설정됩니다.
- company_address: str | None#
사업장 주소
- business_type: str | None#
업태
- business_class: str | None#
업종
- class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyTypeNonWhtPayer#
- birthdate: str | None#
생년월일
날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
- class portone_server_sdk.platform.partner.CreatePlatformPartnerBodyTypeWhtPayer#
- birthdate: str | None#
생년월일
날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
- class portone_server_sdk.platform.partner.CreatePlatformPartnerResponse#
파트너 생성 성공 응답
- partner: PlatformPartner#
생성된 파트너
- class portone_server_sdk.platform.partner.CreatePlatformPartnersBody#
파트너 다건 생성을 위한 입력 정보
- partners: list[CreatePlatformPartnerBody]#
생성할 파트너 리스트 정보
- class portone_server_sdk.platform.partner.CreatePlatformPartnersResponse#
파트너 다건 생성 성공 응답
- partners: list[PlatformPartner]#
생성된 파트너 리스트
- class portone_server_sdk.platform.partner.GetPlatformPartnersBody#
파트너 다건 조회를 위한 입력 정보
- filter: PlatformPartnerFilterInput | None#
조회할 파트너 조건 필터
- class portone_server_sdk.platform.partner.GetPlatformPartnersResponse#
파트너 다건 조회 성공 응답 정보
- items: list[PlatformPartner]#
조회된 파트너 리스트
- class portone_server_sdk.platform.partner.RecoverPlatformPartnerResponse#
파트너 복원 성공 응답
- partner: PlatformPartner#
복원된 파트너
- class portone_server_sdk.platform.partner.UpdatePlatformPartnerResponse#
파트너 업데이트 성공 응답
- partner: PlatformPartner#
업데이트된 파트너
- class portone_server_sdk.platform.partner.PartnerClient#
- get_platform_partners(*, page: PageInput | None = None, filter: PlatformPartnerFilterInput | None = None) GetPlatformPartnersResponse #
파트너 다건 조회
여러 파트너를 조회합니다.
- Parameters:
page (
PageInput, optional
) – 요청할 페이지 정보filter (
PlatformPartnerFilterInput, optional
) – 조회할 파트너 조건 필터
- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- async get_platform_partners_async(*, page: PageInput | None = None, filter: PlatformPartnerFilterInput | None = None) GetPlatformPartnersResponse #
파트너 다건 조회
여러 파트너를 조회합니다.
- Parameters:
page (
PageInput, optional
) – 요청할 페이지 정보filter (
PlatformPartnerFilterInput, optional
) – 조회할 파트너 조건 필터
- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- 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:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAccountVerificationAlreadyUsedError – 파트너 계좌 검증 아이디를 이미 사용한 경우 파트너 계좌 검증 아이디를 이미 사용한 경우
PlatformAccountVerificationFailedError – 파트너 계좌 인증이 실패한 경우 파트너 계좌 인증이 실패한 경우
PlatformAccountVerificationNotFoundError – 파트너 계좌 검증 아이디를 찾을 수 없는 경우 파트너 계좌 검증 아이디를 찾을 수 없는 경우
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformCurrencyNotSupportedError – 지원 되지 않는 통화를 선택한 경우 지원 되지 않는 통화를 선택한 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerIdAlreadyExistsError – PlatformPartnerIdAlreadyExistsError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- 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:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAccountVerificationAlreadyUsedError – 파트너 계좌 검증 아이디를 이미 사용한 경우 파트너 계좌 검증 아이디를 이미 사용한 경우
PlatformAccountVerificationFailedError – 파트너 계좌 인증이 실패한 경우 파트너 계좌 인증이 실패한 경우
PlatformAccountVerificationNotFoundError – 파트너 계좌 검증 아이디를 찾을 수 없는 경우 파트너 계좌 검증 아이디를 찾을 수 없는 경우
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformCurrencyNotSupportedError – 지원 되지 않는 통화를 선택한 경우 지원 되지 않는 통화를 선택한 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerIdAlreadyExistsError – PlatformPartnerIdAlreadyExistsError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- get_platform_partner(*, id: str) PlatformPartner #
파트너 조회
파트너 객체를 조회합니다.
- Parameters:
id (
str
) – 조회하고 싶은 파트너 아이디- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- async get_platform_partner_async(*, id: str) PlatformPartner #
파트너 조회
파트너 객체를 조회합니다.
- Parameters:
id (
str
) – 조회하고 싶은 파트너 아이디- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- 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:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAccountVerificationAlreadyUsedError – 파트너 계좌 검증 아이디를 이미 사용한 경우 파트너 계좌 검증 아이디를 이미 사용한 경우
PlatformAccountVerificationFailedError – 파트너 계좌 인증이 실패한 경우 파트너 계좌 인증이 실패한 경우
PlatformAccountVerificationNotFoundError – 파트너 계좌 검증 아이디를 찾을 수 없는 경우 파트너 계좌 검증 아이디를 찾을 수 없는 경우
PlatformArchivedPartnerError – 보관된 파트너를 업데이트하려고 하는 경우 보관된 파트너를 업데이트하려고 하는 경우
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformInsufficientDataToChangePartnerTypeError – 파트너 타입 수정에 필요한 데이터가 부족한 경우 파트너 타입 수정에 필요한 데이터가 부족한 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- 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:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAccountVerificationAlreadyUsedError – 파트너 계좌 검증 아이디를 이미 사용한 경우 파트너 계좌 검증 아이디를 이미 사용한 경우
PlatformAccountVerificationFailedError – 파트너 계좌 인증이 실패한 경우 파트너 계좌 인증이 실패한 경우
PlatformAccountVerificationNotFoundError – 파트너 계좌 검증 아이디를 찾을 수 없는 경우 파트너 계좌 검증 아이디를 찾을 수 없는 경우
PlatformArchivedPartnerError – 보관된 파트너를 업데이트하려고 하는 경우 보관된 파트너를 업데이트하려고 하는 경우
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformInsufficientDataToChangePartnerTypeError – 파트너 타입 수정에 필요한 데이터가 부족한 경우 파트너 타입 수정에 필요한 데이터가 부족한 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- create_platform_partners(*, partners: list[CreatePlatformPartnerBody]) CreatePlatformPartnersResponse #
파트너 다건 생성
새로운 파트너를 다건 생성합니다.
- Parameters:
partners (
list[CreatePlatformPartnerBody]
) – 생성할 파트너 리스트 정보- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformContractsNotFoundError – PlatformContractsNotFoundError
PlatformCurrencyNotSupportedError – 지원 되지 않는 통화를 선택한 경우 지원 되지 않는 통화를 선택한 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerIdsAlreadyExistError – PlatformPartnerIdsAlreadyExistError
PlatformPartnerIdsDuplicatedError – PlatformPartnerIdsDuplicatedError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- async create_platform_partners_async(*, partners: list[CreatePlatformPartnerBody]) CreatePlatformPartnersResponse #
파트너 다건 생성
새로운 파트너를 다건 생성합니다.
- Parameters:
partners (
list[CreatePlatformPartnerBody]
) – 생성할 파트너 리스트 정보- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformContractsNotFoundError – PlatformContractsNotFoundError
PlatformCurrencyNotSupportedError – 지원 되지 않는 통화를 선택한 경우 지원 되지 않는 통화를 선택한 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerIdsAlreadyExistError – PlatformPartnerIdsAlreadyExistError
PlatformPartnerIdsDuplicatedError – PlatformPartnerIdsDuplicatedError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- archive_platform_partner(*, id: str) ArchivePlatformPartnerResponse #
파트너 복원
주어진 아이디에 대응되는 파트너를 보관합니다.
- Parameters:
id (
str
) – 파트너 아이디- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCannotArchiveScheduledPartnerError – 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- async archive_platform_partner_async(*, id: str) ArchivePlatformPartnerResponse #
파트너 복원
주어진 아이디에 대응되는 파트너를 보관합니다.
- Parameters:
id (
str
) – 파트너 아이디- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCannotArchiveScheduledPartnerError – 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- recover_platform_partner(*, id: str) RecoverPlatformPartnerResponse #
파트너 복원
주어진 아이디에 대응되는 파트너를 복원합니다.
- Parameters:
id (
str
) – 파트너 아이디- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우
- async recover_platform_partner_async(*, id: str) RecoverPlatformPartnerResponse #
파트너 복원
주어진 아이디에 대응되는 파트너를 복원합니다.
- Parameters:
id (
str
) – 파트너 아이디- Raises:
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우