portone_server_sdk.platform.bulk_account_transfer#
Classes
Exceptions
- exception portone_server_sdk.platform.bulk_account_transfer.GetPlatformBulkAccountTransfersError#
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.bulk_account_transfer.GetPlatformBulkAccountTransfersBody#
Bases:
object
- is_for_test: bool | None#
- filter: PlatformBulkAccountTransferFilterInput | None#
- class portone_server_sdk.platform.bulk_account_transfer.GetPlatformBulkAccountTransfersResponse#
Bases:
object
- items: list[PlatformBulkAccountTransfer]#
- class portone_server_sdk.platform.bulk_account_transfer.PlatformBulkAccountTransfer#
Bases:
object
- id: str#
일괄 이체 고유 아이디
- graphql_id: str#
- creator_id: str#
- bank_account_id: str#
출금 계좌 아이디
- bank_account_graphql_id: str#
- total_amount: int#
(int64)
- status: Literal['PREPARED', 'SCHEDULED', 'ONGOING', 'COMPLETED'] | str#
- status_updated_at: str#
(RFC 3339 date-time)
- created_at: str#
(RFC 3339 date-time)
- updated_at: str#
(RFC 3339 date-time)
- scheduled_at: str | None#
(RFC 3339 date-time)
- class portone_server_sdk.platform.bulk_account_transfer.PlatformBulkAccountTransferFilterInput#
Bases:
object
- statuses: list[Literal['PREPARED', 'SCHEDULED', 'ONGOING', 'COMPLETED'] | str] | None#
- criteria: PlatformBulkAccountTransferFilterInputCriteria | None#
- class portone_server_sdk.platform.bulk_account_transfer.PlatformBulkAccountTransferFilterInputCriteria#
Bases:
object
- timestamp_range: DateTimeRange | None#
생성 일시 범위
- status_updated_timestamp_range: DateTimeRange | None#
상태 업데이트 일시 범위
- bulk_account_transfer_id: str | None#
일괄 이체 아이디
- class portone_server_sdk.platform.bulk_account_transfer.PlatformBulkAccountTransferStats#
Bases:
object
- class portone_server_sdk.platform.bulk_account_transfer.PlatformBulkAccountTransferStatusStats#
Bases:
object
- prepared: int#
(int64)
- scheduled: int#
(int64)
- ongoing: int#
(int64)
- completed: int#
(int64)
- class portone_server_sdk.platform.bulk_account_transfer.BulkAccountTransferClient#
Bases:
object
- get_platform_bulk_account_transfers(*, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformBulkAccountTransferFilterInput | None = None) GetPlatformBulkAccountTransfersResponse #
일괄 이체 내역 다건 조회
성공 응답으로 조회된 일괄 이체 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다.
- Parameters:
is_for_test (
bool, optional
)page (
PageInput, optional
)filter (
PlatformBulkAccountTransferFilterInput, optional
)
- Raises:
GetPlatformBulkAccountTransfersError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우
- async get_platform_bulk_account_transfers_async(*, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformBulkAccountTransferFilterInput | None = None) GetPlatformBulkAccountTransfersResponse #
일괄 이체 내역 다건 조회
성공 응답으로 조회된 일괄 이체 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다.
- Parameters:
is_for_test (
bool, optional
)page (
PageInput, optional
)filter (
PlatformBulkAccountTransferFilterInput, optional
)
- Raises:
GetPlatformBulkAccountTransfersError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우