portone_server_sdk.platform.partner_settlement

Contents

portone_server_sdk.platform.partner_settlement#

Classes

GetPlatformPartnerSettlementsBody

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

GetPlatformPartnerSettlementsResponse

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

PlatformPartnerManualSettlement

PlatformPartnerOrderCancelSettlement

PlatformPartnerOrderSettlement

PlatformPartnerSettlementFilterInput

PlatformPartnerSettlementFilterKeywordInput

PlatformPartnerSettlementStatusStats

PartnerSettlementClient

class portone_server_sdk.platform.partner_settlement.GetPlatformPartnerSettlementsBody#

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

filter: PlatformPartnerSettlementFilterInput#

조회할 정산내역 조건 필터

is_for_test: bool#
page: PageInput | None#

요청할 페이지 정보

class portone_server_sdk.platform.partner_settlement.GetPlatformPartnerSettlementsResponse#

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

items: list[PlatformPartnerManualSettlement | PlatformPartnerOrderSettlement | PlatformPartnerOrderCancelSettlement]#

조회된 정산내역 리스트

page: PageInfo#

조회된 페이지 정보

counts: PlatformPartnerSettlementStatusStats#

정산내역 상태 별 갯수

class portone_server_sdk.platform.partner_settlement.PlatformPartnerManualSettlement#
type: Literal['MANUAL']#
id: str#

정산내역 아이디

graphql_id: str#
partner: PlatformPartner#

파트너

settlement_date: str#

정산 일

날짜를 나타내는 문자열로, 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']#

정산 통화

status: Literal['PAYOUT_SCHEDULED', 'PAYOUT_PREPARED', 'PAYOUT_WITHHELD', 'PAYOUT_FAILED', 'IN_PAYOUT', 'PAID_OUT']#

정산 상태

amount: int#

정산 금액 (int64)

is_for_test: bool#

테스트 모드 여부

memo: str | None#

메모

class portone_server_sdk.platform.partner_settlement.PlatformPartnerOrderCancelSettlement#
type: Literal['ORDER_CANCEL']#
id: str#

정산내역 아이디

graphql_id: str#
partner: PlatformPartner#

파트너

settlement_date: str#

정산 일

날짜를 나타내는 문자열로, 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']#

정산 통화

status: Literal['PAYOUT_SCHEDULED', 'PAYOUT_PREPARED', 'PAYOUT_WITHHELD', 'PAYOUT_FAILED', 'IN_PAYOUT', 'PAID_OUT']#

정산 상태

contract: PlatformContract#

계약

settlement_start_date_range: DateRange#

정산 시작 일 범위

amount: PlatformOrderSettlementAmount#

금액 정보

is_for_test: bool#

테스트 모드 여부

memo: str | None#

메모

class portone_server_sdk.platform.partner_settlement.PlatformPartnerOrderSettlement#
type: Literal['ORDER']#
id: str#

정산내역 아이디

graphql_id: str#
partner: PlatformPartner#

파트너

settlement_date: str#

정산 일

날짜를 나타내는 문자열로, 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']#

정산 통화

status: Literal['PAYOUT_SCHEDULED', 'PAYOUT_PREPARED', 'PAYOUT_WITHHELD', 'PAYOUT_FAILED', 'IN_PAYOUT', 'PAID_OUT']#

정산 상태

contract: PlatformContract#

계약

settlement_start_date_range: DateRange#

정산 시작 일 범위

amount: PlatformOrderSettlementAmount#

금액 정보

is_for_test: bool#

테스트 모드 여부

memo: str | None#

메모

class portone_server_sdk.platform.partner_settlement.PlatformPartnerSettlementFilterInput#
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']] | None#

통화 단위

statuses: list[Literal['PAYOUT_SCHEDULED', 'PAYOUT_PREPARED', 'PAYOUT_WITHHELD', 'PAYOUT_FAILED', 'IN_PAYOUT', 'PAID_OUT']] | None#

정산 상태

partner_ids: list[str] | None#
settlement_types: list[Literal['MANUAL', 'ORDER', 'ORDER_CANCEL']] | None#

정산 유형

keyword: PlatformPartnerSettlementFilterKeywordInput | None#
class portone_server_sdk.platform.partner_settlement.PlatformPartnerSettlementFilterKeywordInput#
partner_settlement_id: str | None#
payout_id: str | None#
bulk_payout_id: str | None#
class portone_server_sdk.platform.partner_settlement.PlatformPartnerSettlementStatusStats#
payout_scheduled: int#

(int64)

payout_prepared: int#

(int64)

payout_withheld: int#

(int64)

payout_failed: int#

(int64)

in_payout: int#

(int64)

paid_out: int#

(int64)

class portone_server_sdk.platform.partner_settlement.PartnerSettlementClient#
get_platform_partner_settlements(*, page: PageInput | None = None, filter: PlatformPartnerSettlementFilterInput, is_for_test: bool) → GetPlatformPartnerSettlementsResponse#

정산 내역 다건 조회

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

Parameters:
Raises:

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

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

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

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

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

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

정산 내역 다건 조회

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

Parameters:
Raises:

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

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

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

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

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

Contents