portone_server_sdk.PayoutClient

portone_server_sdk.PayoutClient#

class portone_server_sdk.PayoutClient#

Bases: object

__init__(*, secret: str, base_url: str = 'https://api.portone.io', store_id: str | None = None)#

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Methods

__init__(*, secret[, base_url, store_id])

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

get_platform_payouts(*[, is_for_test, page, ...])

지급 내역 다건 조회

get_platform_payouts_async(*[, is_for_test, ...])

지급 내역 다건 조회
get_platform_payouts(*, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformPayoutFilterInput | None = None) → GetPlatformPayoutsResponse#

지급 내역 다건 조회

여러 지급 내역을 조회합니다.

Parameters:

  • is_for_test (bool, optional)

  • page (PageInput, optional)

  • filter (PlatformPayoutFilterInput, optional)

Raises:

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

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

async get_platform_payouts_async(*, is_for_test: bool | None = None, page: PageInput | None = None, filter: PlatformPayoutFilterInput | None = None) → GetPlatformPayoutsResponse#

지급 내역 다건 조회

여러 지급 내역을 조회합니다.

Parameters:

  • is_for_test (bool, optional)

  • page (PageInput, optional)

  • filter (PlatformPayoutFilterInput, optional)

Raises:

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

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