portone_server_sdk.platform.bulk_payout

portone_server_sdk.platform.bulk_payout#

Classes

GetPlatformBulkPayoutsBody

GetPlatformBulkPayoutsResponse

PlatformBulkPayout

PlatformBulkPayoutFilterInput

PlatformBulkPayoutFilterInputCriteria

PlatformBulkPayoutStats

PlatformBulkPayoutStatusStats

BulkPayoutClient

class portone_server_sdk.platform.bulk_payout.GetPlatformBulkPayoutsBody#
is_for_test: bool | None#
page: PageInput | None#
filter: PlatformBulkPayoutFilterInput | None#
class portone_server_sdk.platform.bulk_payout.GetPlatformBulkPayoutsResponse#
items: list[PlatformBulkPayout]#
page: PageInfo#
counts: PlatformBulkPayoutStatusStats#
class portone_server_sdk.platform.bulk_payout.PlatformBulkPayout#
id: str#

일괄 지급 고유 아이디

graphql_id: str#
name: str#
creator_id: str#
method: Literal['DIRECT', 'AGENCY']#
are_payouts_generated: bool#
total_payout_amount: int#

(int64)

status: Literal['SCHEDULED', 'PREPARING', 'PREPARED', 'ONGOING', 'CANCELLED', 'STOPPED', 'COMPLETED']#
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)

scheduled_at: str | None#

(RFC 3339 date-time)

class portone_server_sdk.platform.bulk_payout.PlatformBulkPayoutFilterInput#
statuses: list[Literal['SCHEDULED', 'PREPARING', 'PREPARED', 'ONGOING', 'CANCELLED', 'STOPPED', 'COMPLETED']] | None#
methods: list[Literal['DIRECT', 'AGENCY']] | None#
criteria: PlatformBulkPayoutFilterInputCriteria | None#
class portone_server_sdk.platform.bulk_payout.PlatformBulkPayoutFilterInputCriteria#
timestamp_range: DateTimeRange | None#
bulk_payout_id: str | None#
class portone_server_sdk.platform.bulk_payout.PlatformBulkPayoutStats#
amount: PlatformPayoutStatusStats#
count: PlatformPayoutStatusStats#
class portone_server_sdk.platform.bulk_payout.PlatformBulkPayoutStatusStats#
scheduled: int#

(int64)

preparing: int#

(int64)

prepared: int#

(int64)

ongoing: int#

(int64)

stopped: int#

(int64)

cancelled: int#

(int64)

completed: int#

(int64)

class portone_server_sdk.platform.bulk_payout.BulkPayoutClient#
get_platform_bulk_payouts(*, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformBulkPayoutFilterInput | None = None) → GetPlatformBulkPayoutsResponse#

일괄 지급 내역 다건 조회

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

Parameters:

  • is_for_test (bool, optional)

  • page (PageInput, optional)

  • filter (PlatformBulkPayoutFilterInput, optional)

Raises:

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

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

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

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

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

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

일괄 지급 내역 다건 조회

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

Parameters:

  • is_for_test (bool, optional)

  • page (PageInput, optional)

  • filter (PlatformBulkPayoutFilterInput, optional)

Raises:

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

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

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

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

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

Contents