portone_server_sdk.platform.bulk_payout

Contents

portone_server_sdk.platform.bulk_payout#

Classes

GetPlatformBulkPayoutsBody

GetPlatformBulkPayoutsResponse

PlatformBulkPayout

PlatformBulkPayoutFilterInput

PlatformBulkPayoutFilterInputCriteria

PlatformBulkPayoutStats

PlatformBulkPayoutStatusStats

BulkPayoutClient

Exceptions

GetPlatformBulkPayoutsError

exception portone_server_sdk.platform.bulk_payout.GetPlatformBulkPayoutsError#

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_payout.GetPlatformBulkPayoutsBody#

Bases: object

is_for_test: bool | None#

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

page: PageInput | None#
filter: PlatformBulkPayoutFilterInput | None#
class portone_server_sdk.platform.bulk_payout.GetPlatformBulkPayoutsResponse#

Bases: object

items: list[PlatformBulkPayout]#
page: PageInfo#
counts: PlatformBulkPayoutStatusStats#
class portone_server_sdk.platform.bulk_payout.PlatformBulkPayout#

Bases: object

id: str#

일괄 지급 고유 아이디

graphql_id: str#
name: str#

이름

creator_id: str#

생성자 아이디

method: Literal['DIRECT', 'AGENCY'] | str#

지급 유형

total_payout_amount: int#

총 지급 금액 (int64)

total_settlement_amount: int#

총 정산 금액 (int64)

status: Literal['PREPARING', 'PREPARED', 'ONGOING', 'POST_PROCESS_PENDING', 'CANCELLED', 'COMPLETED'] | str#

상태

payout_stats: PlatformBulkPayoutStats#

지급 통계

status_updated_at: str#

상태 업데이트 일시 (RFC 3339 date-time)

created_at: str#

생성 일시 (RFC 3339 date-time)

updated_at: str#

업데이트 일시 (RFC 3339 date-time)

class portone_server_sdk.platform.bulk_payout.PlatformBulkPayoutFilterInput#

Bases: object

statuses: list[Literal['PREPARING', 'PREPARED', 'ONGOING', 'POST_PROCESS_PENDING', 'CANCELLED', 'COMPLETED'] | str] | None#
methods: list[Literal['DIRECT', 'AGENCY'] | str] | None#
criteria: PlatformBulkPayoutFilterInputCriteria | None#
class portone_server_sdk.platform.bulk_payout.PlatformBulkPayoutFilterInputCriteria#

Bases: object

timestamp_range: DateTimeRange | None#

생성 일시 범위

status_updated_timestamp_range: DateTimeRange | None#

상태 업데이트 일시 범위

bulk_payout_id: str | None#

일괄 지급 아이디

class portone_server_sdk.platform.bulk_payout.PlatformBulkPayoutStats#

Bases: object

amount: PlatformPayoutStatusStats#
count: PlatformPayoutStatusStats#
class portone_server_sdk.platform.bulk_payout.PlatformBulkPayoutStatusStats#

Bases: object

preparing: int#

(int64)

prepared: int#

(int64)

ongoing: int#

(int64)

post_process_pending: int#

(int64)

completed: int#

(int64)

cancelled: int#

(int64)

class portone_server_sdk.platform.bulk_payout.BulkPayoutClient#

Bases: object

get_platform_bulk_payouts(*, test: bool | None = None, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformBulkPayoutFilterInput | None = None) → GetPlatformBulkPayoutsResponse#

일괄 지급 내역 다건 조회

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

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 (PlatformBulkPayoutFilterInput, optional)

Raises:

  • GetPlatformBulkPayoutsError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_platform_bulk_payouts_async(*, test: bool | None = None, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformBulkPayoutFilterInput | None = None) → GetPlatformBulkPayoutsResponse#

일괄 지급 내역 다건 조회

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

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 (PlatformBulkPayoutFilterInput, optional)

Raises:

  • GetPlatformBulkPayoutsError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

Contents