portone_server_sdk.BulkAccountTransferClient

portone_server_sdk.BulkAccountTransferClient#

class portone_server_sdk.BulkAccountTransferClient#

Bases: object

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

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

Parameters:

  • secret (str) – 포트원 API Secret입니다.

  • base_url (str, optional) – 포트원 REST API 주소입니다. 기본값은 `”https://api.portone.io”`입니다.

  • store_id – 하위 상점에 대해 기능을 사용할 때 필요한 하위 상점의 ID입니다.

Methods

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

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

get_platform_bulk_account_transfers(*[, ...])

일괄 이체 내역 다건 조회

get_platform_bulk_account_transfers_async(*)

일괄 이체 내역 다건 조회
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: