portone_server_sdk.platform.partner_settlement

portone_server_sdk.platform.partner_settlement#

Classes

`GetPlatformPartnerSettlementsBody`	정산내역 다건 조회를 위한 입력 정보
`GetPlatformPartnerSettlementsResponse`	정산내역 다건 조회 성공 응답 정보
`PlatformPartnerManualSettlement`
`PlatformPartnerOrderCancelSettlement`
`PlatformPartnerOrderSettlement`
`PlatformPartnerSettlementFilterInput`
`PlatformPartnerSettlementFilterKeywordInput`
`PlatformPartnerSettlementStatusStats`
`PartnerSettlementClient`

Exceptions

GetPlatformPartnerSettlementsError

exception portone_server_sdk.platform.partner_settlement.GetPlatformPartnerSettlementsError#

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.partner_settlement.GetPlatformPartnerSettlementsBody#

Bases: object

정산내역 다건 조회를 위한 입력 정보

filter: PlatformPartnerSettlementFilterInput#: 조회할 정산내역 조건 필터

page: PageInput | None#: 요청할 페이지 정보

is_for_test: bool | None#

테스트 모드 여부

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

class portone_server_sdk.platform.partner_settlement.GetPlatformPartnerSettlementsResponse#

Bases: object

정산내역 다건 조회 성공 응답 정보

items: list[PlatformPartnerManualSettlement | PlatformPartnerOrderSettlement | PlatformPartnerOrderCancelSettlement | dict]#: 조회된 정산내역 리스트

page: PageInfo#: 조회된 페이지 정보

counts: PlatformPartnerSettlementStatusStats#: 정산내역 상태 별 갯수

class portone_server_sdk.platform.partner_settlement.PlatformPartnerManualSettlement#

Bases: object

id: str#: 정산내역 아이디

graphql_id: str#

partner: PlatformPartner#: 파트너

settlement_date: str#

정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다. (yyyy-MM-dd)

settlement_currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'] | str#: 정산 통화

status: Literal['PAYOUT_SCHEDULED', 'PAYOUT_PREPARED', 'PAYOUT_WITHHELD', 'PAYOUT_FAILED', 'IN_PAYOUT', 'PAID_OUT', 'CANCELLED', 'CONFIRMED'] | str#: 정산 상태

amount: int#: 정산 금액 (int64)

tax_free_amount: int#: 정산 면세 금액 (int64)

is_for_test: bool#: 테스트 모드 여부

memo: str | None#: 메모

class portone_server_sdk.platform.partner_settlement.PlatformPartnerOrderCancelSettlement#

Bases: object

id: str#: 정산내역 아이디

graphql_id: str#

partner: PlatformPartner#: 파트너

settlement_date: str#

정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다. (yyyy-MM-dd)

settlement_currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'] | str#: 정산 통화

status: Literal['PAYOUT_SCHEDULED', 'PAYOUT_PREPARED', 'PAYOUT_WITHHELD', 'PAYOUT_FAILED', 'IN_PAYOUT', 'PAID_OUT', 'CANCELLED', 'CONFIRMED'] | str#: 정산 상태

contract: PlatformContract#: 계약

settlement_start_date_range: DateRange#: 정산 시작 일 범위

amount: PlatformOrderSettlementAmount#: 금액 정보

is_for_test: bool#: 테스트 모드 여부

memo: str | None#: 메모

class portone_server_sdk.platform.partner_settlement.PlatformPartnerOrderSettlement#

Bases: object

id: str#: 정산내역 아이디

graphql_id: str#

partner: PlatformPartner#: 파트너

settlement_date: str#

정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다. (yyyy-MM-dd)

settlement_currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'] | str#: 정산 통화

status: Literal['PAYOUT_SCHEDULED', 'PAYOUT_PREPARED', 'PAYOUT_WITHHELD', 'PAYOUT_FAILED', 'IN_PAYOUT', 'PAID_OUT', 'CANCELLED', 'CONFIRMED'] | str#: 정산 상태

contract: PlatformContract#: 계약

settlement_start_date_range: DateRange#: 정산 시작 일 범위

amount: PlatformOrderSettlementAmount#: 금액 정보

is_for_test: bool#: 테스트 모드 여부

memo: str | None#: 메모

class portone_server_sdk.platform.partner_settlement.PlatformPartnerSettlementFilterInput#

Bases: object

settlement_dates: list[str] | None#

contract_ids: list[str] | None#

partner_tags: list[str] | None#

settlement_currencies: list[Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'] | str] | None#: 통화 단위

statuses: list[Literal['PAYOUT_SCHEDULED', 'PAYOUT_PREPARED', 'PAYOUT_WITHHELD', 'PAYOUT_FAILED', 'IN_PAYOUT', 'PAID_OUT', 'CANCELLED', 'CONFIRMED'] | str] | None#: 정산 상태

partner_ids: list[str] | None#

settlement_types: list[Literal['MANUAL', 'ORDER', 'ORDER_CANCEL'] | str] | None#: 정산 유형

keyword: PlatformPartnerSettlementFilterKeywordInput | None#

class portone_server_sdk.platform.partner_settlement.PlatformPartnerSettlementFilterKeywordInput#

Bases: object

partner_settlement_id: str | None#

payout_id: str | None#

bulk_payout_id: str | None#

class portone_server_sdk.platform.partner_settlement.PlatformPartnerSettlementStatusStats#

Bases: object

payout_scheduled: int#: (int64)

payout_prepared: int#: (int64)

payout_withheld: int#: (int64)

payout_failed: int#: (int64)

payout_cancelled: int#: (int64)

payout_confirmed: int#: (int64)

in_payout: int#: (int64)

paid_out: int#: (int64)

class portone_server_sdk.platform.partner_settlement.PartnerSettlementClient#

Bases: object

get_platform_partner_settlements(*, test: bool | None = None, page: PageInput | None = None, filter: PlatformPartnerSettlementFilterInput, is_for_test: bool | None = None) → GetPlatformPartnerSettlementsResponse#

정산 내역 다건 조회

여러 정산 내역을 조회합니다.

Parameters:

test (bool, optional) –
테스트 모드 여부

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformPartnerSettlementFilterInput) – 조회할 정산내역 조건 필터
is_for_test (bool, optional) –
테스트 모드 여부

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

Raises:

GetPlatformPartnerSettlementsError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_platform_partner_settlements_async(*, test: bool | None = None, page: PageInput | None = None, filter: PlatformPartnerSettlementFilterInput, is_for_test: bool | None = None) → GetPlatformPartnerSettlementsResponse#

정산 내역 다건 조회

여러 정산 내역을 조회합니다.

Parameters:

test (bool, optional) –
테스트 모드 여부

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformPartnerSettlementFilterInput) – 조회할 정산내역 조건 필터
is_for_test (bool, optional) –
테스트 모드 여부

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

Raises:

GetPlatformPartnerSettlementsError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

portone_server_sdk.platform.partner_settlement

Contents

portone_server_sdk.platform.partner_settlement#