portone_server_sdk.platform.bulk_account_transfer

Contents

portone_server_sdk.platform.bulk_account_transfer#

Classes

GetPlatformBulkAccountTransfersBody

GetPlatformBulkAccountTransfersResponse

PlatformBulkAccountTransfer

PlatformBulkAccountTransferFilterInput

PlatformBulkAccountTransferFilterInputCriteria

PlatformBulkAccountTransferStats

PlatformBulkAccountTransferStatusStats

BulkAccountTransferClient

Exceptions

GetPlatformBulkAccountTransfersError

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#

Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

page: PageInput | None#
filter: PlatformBulkAccountTransferFilterInput | None#
class portone_server_sdk.platform.bulk_account_transfer.GetPlatformBulkAccountTransfersResponse#

Bases: object

items: list[PlatformBulkAccountTransfer]#
page: PageInfo#
counts: PlatformBulkAccountTransferStatusStats#
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#
stats: PlatformBulkAccountTransferStats#
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

amount: PlatformAccountTransferStatusStats#
count: PlatformAccountTransferStatusStats#
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(*, test: bool | None = None, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformBulkAccountTransferFilterInput | None = None) → GetPlatformBulkAccountTransfersResponse#

일괄 이체 내역 다건 조회

성공 응답으로 조회된 일괄 이체 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다.

Parameters:

  • test (bool, optional) –

    테스트 모드 여부

    테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

  • is_for_test (bool, optional) – Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

  • page (PageInput, optional)

  • filter (PlatformBulkAccountTransferFilterInput, optional)

Raises:
async get_platform_bulk_account_transfers_async(*, test: bool | None = None, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformBulkAccountTransferFilterInput | None = None) → GetPlatformBulkAccountTransfersResponse#

일괄 이체 내역 다건 조회

성공 응답으로 조회된 일괄 이체 내역 리스트와 페이지 정보 및 상태 별 개수 정보를 반환합니다.

Parameters:

  • test (bool, optional) –

    테스트 모드 여부

    테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

  • is_for_test (bool, optional) – Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

  • page (PageInput, optional)

  • filter (PlatformBulkAccountTransferFilterInput, optional)

Raises:
Contents