portone_server_sdk.platform.account

portone_server_sdk.platform.account#

Classes

PlatformAccountHolder

예금주 조회 성공 응답 정보

AccountClient

class portone_server_sdk.platform.account.PlatformAccountHolder#

예금주 조회 성공 응답 정보

holder_name: str#

계좌 예금주 이름

account_verification_id: str#

계좌 검증 아이디

class portone_server_sdk.platform.account.AccountClient#
get_platform_account_holder(*, 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'], account_number: str, birthdate: str | None = None, business_registration_number: str | None = None) → PlatformAccountHolder#

예금주 조회

계좌의 예금주를 조회합니다.

Parameters:

  • bank (Bank) – 은행

  • account_number (str) – ‘-‘를 제외한 계좌 번호

  • birthdate (str, optional) –

    생년월일

    실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.

  • business_registration_number (str, optional) –

    사업자등록번호

    실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.

Raises:

  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • PlatformExternalApiFailedError – 외부 api 오류 외부 api 오류

  • PlatformExternalApiTemporarilyFailedError – 외부 api의 일시적인 오류 외부 api의 일시적인 오류

  • PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

  • PlatformNotSupportedBankError – 지원하지 않는 은행인 경우 지원하지 않는 은행인 경우

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_platform_account_holder_async(*, 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'], account_number: str, birthdate: str | None = None, business_registration_number: str | None = None) → PlatformAccountHolder#

예금주 조회

계좌의 예금주를 조회합니다.

Parameters:

  • bank (Bank) – 은행

  • account_number (str) – ‘-‘를 제외한 계좌 번호

  • birthdate (str, optional) –

    생년월일

    실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.

  • business_registration_number (str, optional) –

    사업자등록번호

    실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.

Raises:

  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • PlatformExternalApiFailedError – 외부 api 오류 외부 api 오류

  • PlatformExternalApiTemporarilyFailedError – 외부 api의 일시적인 오류 외부 api의 일시적인 오류

  • PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

  • PlatformNotSupportedBankError – 지원하지 않는 은행인 경우 지원하지 않는 은행인 경우

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

Contents