portone_server_sdk.platform.transfer

portone_server_sdk.platform.transfer#

Classes

`CreateManualTransferResponse`
`CreateOrderCancelTransferResponse`
`CreateOrderTransferResponse`
`CreatePlatformManualTransferBody`	수기 정산건 생성을 위한 입력 정보
`CreatePlatformOrderCancelTransferBody`	주문 취소 정산 등록을 위한 입력 정보
`CreatePlatformOrderCancelTransferBodyDiscount`	할인 정보
`CreatePlatformOrderCancelTransferBodyExternalCancellationDetail`	외부 결제 상세 정보
`CreatePlatformOrderCancelTransferBodyOrderDetail`	주문 취소 정보
`CreatePlatformOrderCancelTransferBodyOrderDetailAll`	전체 금액 취소
`CreatePlatformOrderCancelTransferBodyOrderLine`	주문 취소 항목 리스트
`CreatePlatformOrderTransferBody`	주문 정산건 생성을 위한 입력 정보
`CreatePlatformOrderTransferBodyAdditionalFee`	추가 수수료 정보
`CreatePlatformOrderTransferBodyDiscount`	할인 정보
`CreatePlatformOrderTransferBodyExternalPaymentDetail`	외부 결제 상세 정보
`CreatePlatformOrderTransferBodyOrderDetail`	주문 정보
`CreatePlatformOrderTransferBodyOrderLine`	주문 항목
`CreatePlatformOrderTransferBodyProduct`	상품
`DeletePlatformTransferResponse`
`DownloadPlatformTransferSheetBody`
`GetPlatformTransferSummariesBody`	정산건 요약 다건 조회를 위한 입력 정보
`GetPlatformTransferSummariesResponse`
`PlatformExternalPayment`	외부 결제 정보
`PlatformManualTransfer`	수기 정산건
`PlatformManualTransferSummary`
`PlatformOrderCancelTransfer`	주문 취소 정산건
`PlatformOrderCancelTransferSummary`
`PlatformOrderTransfer`	주문 정산건
`PlatformOrderTransferAdditionalFee`	추가 수수료 정보
`PlatformOrderTransferCancellation`	주문 취소 정보
`PlatformOrderTransferDiscount`	할인 정보
`PlatformOrderTransferOrderLine`	주문 항목
`PlatformOrderTransferProduct`	상품
`PlatformOrderTransferSummary`
`PlatformPaymentMethodCard`	카드
`PlatformPaymentMethodCardInput`
`PlatformPaymentMethodEasyPay`	간편 결제
`PlatformPaymentMethodEasyPayInput`	간편 결제 입력 정보
`PlatformPaymentMethodGiftCertificate`	상품권
`PlatformPaymentMethodGiftCertificateInput`
`PlatformPaymentMethodInput`	결제 수단 입력 정보
`PlatformPaymentMethodMobile`	모바일
`PlatformPaymentMethodMobileInput`
`PlatformPaymentMethodTransfer`	계좌이체
`PlatformPaymentMethodTransferInput`
`PlatformPaymentMethodVirtualAccount`	가상계좌
`PlatformPaymentMethodVirtualAccountInput`
`PlatformPortOnePayment`	포트원 결제 정보
`PlatformSettlementParameterValue`	플랫폼 정산 파라미터 값
`PlatformTransferFilterInput`	정산건 필터 입력 정보
`PlatformTransferFilterInputKeyword`	정산건 검색 키워드 입력 정보
`PlatformTransferSummaryExternalPayment`
`PlatformTransferSummaryPartner`
`PlatformTransferSummaryPortOnePayment`
`PlatformUserDefinedPropertyKeyValue`	사용자 정의 속성
`TransferParameters`
`TransferClient`

class portone_server_sdk.platform.transfer.CreateManualTransferResponse#

transfer: PlatformManualTransfer#

class portone_server_sdk.platform.transfer.CreateOrderCancelTransferResponse#

transfer: PlatformOrderCancelTransfer#

class portone_server_sdk.platform.transfer.CreateOrderTransferResponse#

transfer: PlatformOrderTransfer#

class portone_server_sdk.platform.transfer.CreatePlatformManualTransferBody#

수기 정산건 생성을 위한 입력 정보

partner_id: str#: 파트너 아이디

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

settlement_date: str#

정산 일

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

memo: str | None#: 메모

is_for_test: bool | None#

테스트 모드 여부

기본값은 false 입니다.

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None#: 사용자 정의 속성

class portone_server_sdk.platform.transfer.CreatePlatformOrderCancelTransferBody#

주문 취소 정산 등록을 위한 입력 정보

하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다. 하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다. transferId를 입력한 경우 (partnerId, paymentId)는 생략 가능합니다.

cancellation_id: str#: 취소 내역 아이디

discounts: list[CreatePlatformOrderCancelTransferBodyDiscount]#: 할인 정보

partner_id: str | None#: 파트너 아이디

payment_id: str | None#: 결제 아이디

transfer_id: str | None#: 정산건 아이디

memo: str | None#: 메모

order_detail: CreatePlatformOrderCancelTransferBodyOrderDetail | None#: 주문 취소 정보

tax_free_amount: int | None#

주문 취소 면세 금액

주문 취소 항목과 취소 면세 금액을 같이 전달하시면 최종 취소 면세 금액은 주문 취소 항목의 면세 금액이 아닌 전달해주신 취소 면세 금액으로 적용됩니다. (int64)

settlement_start_date: str | None#

정산 시작일

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

external_cancellation_detail: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail | None#

외부 결제 상세 정보

해당 정보가 존재하는 경우 외부 결제 취소 정산건으로 등록되고, 존재하지않은 경우 포트원 결제 취소 정산건으로 등록됩니다.

is_for_test: bool | None#

테스트 모드 여부

기본값은 false 입니다.

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None#: 사용자 정의 속성

class portone_server_sdk.platform.transfer.CreatePlatformOrderCancelTransferBodyDiscount#

할인 정보

share_policy_id: str#: 할인 분담 정책 아이디

amount: int#: 할인 금액 (int64)

tax_free_amount: int | None#: 면세 할인 금액 (int64)

class portone_server_sdk.platform.transfer.CreatePlatformOrderCancelTransferBodyExternalCancellationDetail#

외부 결제 상세 정보

cancelled_at: str | None#: 취소 일시 (RFC 3339 date-time)

class portone_server_sdk.platform.transfer.CreatePlatformOrderCancelTransferBodyOrderDetail#

주문 취소 정보

orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.

order_amount: int | None#: 주문 취소 금액 (int64)

order_lines: list[CreatePlatformOrderCancelTransferBodyOrderLine] | None#: 주문 취소 항목 리스트

all: CreatePlatformOrderCancelTransferBodyOrderDetailAll | None#: 전체 금액 취소

class portone_server_sdk.platform.transfer.CreatePlatformOrderCancelTransferBodyOrderDetailAll#: 전체 금액 취소

class portone_server_sdk.platform.transfer.CreatePlatformOrderCancelTransferBodyOrderLine#

주문 취소 항목 리스트

product_id: str#: 상품 아이디

quantity: int#: 상품 수량 (int32)

discounts: list[CreatePlatformOrderCancelTransferBodyDiscount]#: 상품 할인 정보

class portone_server_sdk.platform.transfer.CreatePlatformOrderTransferBody#

주문 정산건 생성을 위한 입력 정보

partner_id: str#: 파트너 아이디

payment_id: str#: 결제 아이디

order_detail: CreatePlatformOrderTransferBodyOrderDetail#: 주문 정보

discounts: list[CreatePlatformOrderTransferBodyDiscount]#: 할인 정보

additional_fees: list[CreatePlatformOrderTransferBodyAdditionalFee]#: 추가 수수료 정보

contract_id: str | None#

계약 아이디

기본값은 파트너의 기본 계약 아이디 입니다.

memo: str | None#: 메모

tax_free_amount: int | None#

주문 면세 금액

주문 항목과 면세 금액을 같이 전달하시면 최종 면세 금액은 주문 항목의 면세 금액이 아닌 전달해주신 면세 금액으로 적용됩니다. (int64)

settlement_start_date: str | None#

정산 시작일

기본값은 결제 일시 입니다.

external_payment_detail: CreatePlatformOrderTransferBodyExternalPaymentDetail | None#

외부 결제 상세 정보

해당 정보가 존재하는 경우 외부 결제 정산건 으로 등록되고, 존재하지않은 경우 포트원 결제 정산건으로 등록됩니다.

is_for_test: bool | None#

테스트 모드 여부

기본값은 false 입니다.

parameters: TransferParameters | None#: 정산 파라미터 (실험기능)

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None#: 사용자 정의 속성

class portone_server_sdk.platform.transfer.CreatePlatformOrderTransferBodyAdditionalFee#

추가 수수료 정보

policy_id: str#: 추가 수수료 정책 아이디

class portone_server_sdk.platform.transfer.CreatePlatformOrderTransferBodyDiscount#

할인 정보

share_policy_id: str#: 할인 분담 정책 아이디

amount: int#: 할인 금액 (int64)

tax_free_amount: int | None#: 면세 할인 금액 (int64)

class portone_server_sdk.platform.transfer.CreatePlatformOrderTransferBodyExternalPaymentDetail#

외부 결제 상세 정보

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']#: 통화

order_name: str | None#: 주문 명

paid_at: str | None#: 결제 일시 (RFC 3339 date-time)

method: PlatformPaymentMethodInput | None#: 결제 수단

class portone_server_sdk.platform.transfer.CreatePlatformOrderTransferBodyOrderDetail#

주문 정보

주문 금액 또는 주문 항목 하나만 입력 가능합니다.

order_amount: int | None#: 주문 금액 (int64)

order_lines: list[CreatePlatformOrderTransferBodyOrderLine] | None#: 주문 항목 리스트

class portone_server_sdk.platform.transfer.CreatePlatformOrderTransferBodyOrderLine#

주문 항목

product: CreatePlatformOrderTransferBodyProduct#: 상품

quantity: int#: 상품 수량 (int32)

discounts: list[CreatePlatformOrderTransferBodyDiscount]#: 상품 할인 정보

additional_fees: list[CreatePlatformOrderTransferBodyAdditionalFee]#: 상품 추가 수수료 정보

class portone_server_sdk.platform.transfer.CreatePlatformOrderTransferBodyProduct#

상품

id: str#: 상품 아이디

name: str#: 상품 이름

amount: int#: 상품 금액 (int64)

tax_free_amount: int | None#: 상품 면세 금액 (int64)

tag: str | None#: 태그

class portone_server_sdk.platform.transfer.DeletePlatformTransferResponse#

class portone_server_sdk.platform.transfer.DownloadPlatformTransferSheetBody#

filter: PlatformTransferFilterInput | None#

fields: list[Literal['STATUS', 'TRANSFER_ID', 'PARTNER_NAME', 'SETTLEMENT_DATE', 'SETTLEMENT_START_DATE', 'TYPE', 'PAYMENT_ID', 'ORDER_NAME', 'PAYMENT_METHOD', 'SETTLEMENT_AMOUNT', 'SETTLEMENT_ORDER_AMOUNT', 'SETTLEMENT_ORDER_TAX_FREE_AMOUNT', 'SETTLEMENT_PAYMENT_AMOUNT', 'SETTLEMENT_PAYMENT_VAT_AMOUNT', 'SETTLEMENT_PAYMENT_VAT_BURDEN_AMOUNT', 'SETTLEMENT_SUPPLY_AMOUNT', 'SETTLEMENT_TAX_FREE_AMOUNT', 'SETTLEMENT_PAYMENT_SUPPLY_AMOUNT', 'SETTLEMENT_PAYMENT_TAX_FREE_AMOUNT', 'SETTLEMENT_PLATFORM_FEE_AMOUNT', 'SETTLEMENT_PLATFORM_FEE_VAT_AMOUNT', 'SETTLEMENT_DISCOUNT_AMOUNT', 'SETTLEMENT_DISCOUNT_TAX_FREE_AMOUNT', 'SETTLEMENT_DISCOUNT_SHARE_AMOUNT', 'SETTLEMENT_DISCOUNT_SHARE_TAX_FREE_AMOUNT', 'SETTLEMENT_ADDITIONAL_FEE_AMOUNT', 'SETTLEMENT_ADDITIONAL_FEE_VAT_AMOUNT', 'SETTLEMENT_CURRENCY', 'PARTNER_TYPE', 'TAXATION_TYPE', 'INCOME_TYPE', 'TAXATION_TYPE_OR_INCOME_TYPE']] | None#: 다운로드 할 시트 컬럼

transfer_user_defined_property_keys: list[str] | None#

partner_user_defined_property_keys: list[str] | None#

class portone_server_sdk.platform.transfer.GetPlatformTransferSummariesBody#

정산건 요약 다건 조회를 위한 입력 정보

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

filter: PlatformTransferFilterInput | None#: 조회할 정산건 조건 필터

class portone_server_sdk.platform.transfer.GetPlatformTransferSummariesResponse#

transfer_summaries: list[PlatformManualTransferSummary | PlatformOrderTransferSummary | PlatformOrderCancelTransferSummary]#

page: PageInfo#

class portone_server_sdk.platform.transfer.PlatformExternalPayment#

외부 결제 정보

type: Literal['EXTERNAL']#

id: str#: 결제 아이디

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']#: 통화

order_name: str | None#: 주문 명

method: PlatformPaymentMethodCard | PlatformPaymentMethodEasyPay | PlatformPaymentMethodGiftCertificate | PlatformPaymentMethodMobile | PlatformPaymentMethodTransfer | PlatformPaymentMethodVirtualAccount | None#: 결제 수단

paid_at: str | None#: 결제 일시 (RFC 3339 date-time)

class portone_server_sdk.platform.transfer.PlatformManualTransfer#

수기 정산건

type: Literal['MANUAL']#

id: str#: 정산건 아이디

graphql_id: str#

partner: PlatformPartner#: 파트너

status: Literal['SCHEDULED', 'IN_PROCESS', 'SETTLED', 'IN_PAYOUT', 'PAID_OUT']#: 정산 상태

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']#: 정산 통화

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

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

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

memo: str | None#: 메모

payout_id: str | None#

payout_graphql_id: str | None#

class portone_server_sdk.platform.transfer.PlatformManualTransferSummary#

type: Literal['MANUAL']#

id: str#

graphql_id: str#

partner: PlatformTransferSummaryPartner#

status: Literal['SCHEDULED', 'IN_PROCESS', 'SETTLED', 'IN_PAYOUT', 'PAID_OUT']#

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']#

is_for_test: bool#

partner_user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

settlement_amount: int#: (int64)

memo: str | None#

class portone_server_sdk.platform.transfer.PlatformOrderCancelTransfer#

주문 취소 정산건

type: Literal['ORDER_CANCEL']#

id: str#: 정산건 아이디

graphql_id: str#

partner: PlatformPartner#: 파트너

status: Literal['SCHEDULED', 'IN_PROCESS', 'SETTLED', 'IN_PAYOUT', 'PAID_OUT']#: 정산 상태

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']#: 정산 통화

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

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

amount: PlatformOrderSettlementAmount#: 정산 금액 정보

contract: PlatformContract#: 계약

payment: PlatformExternalPayment | PlatformPortOnePayment#: 결제 정보

settlement_start_date: str#

정산 시작일

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

order_lines: list[PlatformOrderTransferOrderLine]#: 주문 항목 리스트

additional_fees: list[PlatformOrderTransferAdditionalFee]#: 정산 금액 계산 시 사용된 추가 수수료 정보

discounts: list[PlatformOrderTransferDiscount]#: 정산 금액 계산 시 사용된 할인 정보

cancellation: PlatformOrderTransferCancellation#: 주문 취소 정보

parameters: TransferParameters#: 정산 파라미터 (실험기능)

memo: str | None#: 메모

payout_id: str | None#

payout_graphql_id: str | None#

class portone_server_sdk.platform.transfer.PlatformOrderCancelTransferSummary#

type: Literal['ORDER_CANCEL']#

id: str#

graphql_id: str#

store_id: str#

partner: PlatformTransferSummaryPartner#

status: Literal['SCHEDULED', 'IN_PROCESS', 'SETTLED', 'IN_PAYOUT', 'PAID_OUT']#

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']#

is_for_test: bool#

partner_user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

amount: PlatformOrderSettlementAmount#

payment: PlatformTransferSummaryExternalPayment | PlatformTransferSummaryPortOnePayment#

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

memo: str | None#

class portone_server_sdk.platform.transfer.PlatformOrderTransfer#

주문 정산건

type: Literal['ORDER']#

id: str#: 정산건 아이디

graphql_id: str#

partner: PlatformPartner#: 파트너

status: Literal['SCHEDULED', 'IN_PROCESS', 'SETTLED', 'IN_PAYOUT', 'PAID_OUT']#: 정산 상태

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']#: 정산 통화

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

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

amount: PlatformOrderSettlementAmount#: 정산 금액 정보

contract: PlatformContract#: 계약

payment: PlatformExternalPayment | PlatformPortOnePayment#: 결제 정보

settlement_start_date: str#

정산 시작일

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

order_lines: list[PlatformOrderTransferOrderLine]#: 주문 항목 리스트

additional_fees: list[PlatformOrderTransferAdditionalFee]#: 정산 금액 계산 시 사용된 추가 수수료 정보

discounts: list[PlatformOrderTransferDiscount]#: 정산 금액 계산 시 사용된 할인 정보

parameters: TransferParameters#: 정산 파라미터 (실험기능)

memo: str | None#: 메모

payout_id: str | None#

payout_graphql_id: str | None#

class portone_server_sdk.platform.transfer.PlatformOrderTransferAdditionalFee#

추가 수수료 정보

policy: PlatformAdditionalFeePolicy#: 추가 수수료 정책

amount: int#: 추가 수수료 금액 (int64)

vat: int#: 추가 수수료 부가세 금액 (int64)

class portone_server_sdk.platform.transfer.PlatformOrderTransferCancellation#

주문 취소 정보

id: str#: 주문 취소 아이디

cancelled_at: str#: 취소 일시 (RFC 3339 date-time)

class portone_server_sdk.platform.transfer.PlatformOrderTransferDiscount#

할인 정보

share_policy: PlatformDiscountSharePolicy#: 할인 분담 정책

amount: int#: 할인 금액 (int64)

tax_free_amount: int#: 면세 할인 금액 (int64)

share_amount: int#: 할인 분담 금액 (int64)

share_tax_free_amount: int#: 면세 할인 분담 금액 (int64)

class portone_server_sdk.platform.transfer.PlatformOrderTransferOrderLine#

주문 항목

product: PlatformOrderTransferProduct#: 상품

quantity: int#: 상품 수량 (int32)

discounts: list[PlatformOrderTransferDiscount]#: 상품 할인 정보

additional_fees: list[PlatformOrderTransferAdditionalFee]#: 상품 추가 수수료 정보

amount: PlatformOrderSettlementAmount#: 상품 정산 금액 정보

class portone_server_sdk.platform.transfer.PlatformOrderTransferProduct#

상품

id: str#: 상품 아이디

name: str#: 상품 이름

amount: int#: 상품 금액 (int64)

tax_free_amount: int#: 상품 면세 금액 (int64)

tag: str | None#: 태그

class portone_server_sdk.platform.transfer.PlatformOrderTransferSummary#

type: Literal['ORDER']#

id: str#

graphql_id: str#

store_id: str#

partner: PlatformTransferSummaryPartner#

status: Literal['SCHEDULED', 'IN_PROCESS', 'SETTLED', 'IN_PAYOUT', 'PAID_OUT']#

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']#

is_for_test: bool#

partner_user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

user_defined_properties: list[PlatformUserDefinedPropertyKeyValue]#: 사용자 정의 속성

amount: PlatformOrderSettlementAmount#

payment: PlatformTransferSummaryExternalPayment | PlatformTransferSummaryPortOnePayment#

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

memo: str | None#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodCard#

카드

type: Literal['CARD']#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodCardInput#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodEasyPay#

간편 결제

type: Literal['EASY_PAY']#

provider: Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY'] | None#: 간편 결제사

method_type: Literal['CARD', 'TRANSFER', 'CHARGE'] | None#: 간편 결제 수단

class portone_server_sdk.platform.transfer.PlatformPaymentMethodEasyPayInput#

간편 결제 입력 정보

provider: Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY'] | None#: 간편 결제사

method_type: Literal['CARD', 'TRANSFER', 'CHARGE'] | None#: 간편 결제 수단

class portone_server_sdk.platform.transfer.PlatformPaymentMethodGiftCertificate#

상품권

type: Literal['GIFT_CERTIFICATE']#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodGiftCertificateInput#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodInput#

결제 수단 입력 정보

card: PlatformPaymentMethodCardInput | None#: 카드

transfer: PlatformPaymentMethodTransferInput | None#: 계좌이체

virtual_account: PlatformPaymentMethodVirtualAccountInput | None#: 가상계좌

gift_certificate: PlatformPaymentMethodGiftCertificateInput | None#: 상품권

mobile: PlatformPaymentMethodMobileInput | None#: 모바일

easy_pay: PlatformPaymentMethodEasyPayInput | None#: 간편 결제

class portone_server_sdk.platform.transfer.PlatformPaymentMethodMobile#

모바일

type: Literal['MOBILE']#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodMobileInput#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodTransfer#

계좌이체

type: Literal['TRANSFER']#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodTransferInput#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodVirtualAccount#

가상계좌

type: Literal['VIRTUAL_ACCOUNT']#

class portone_server_sdk.platform.transfer.PlatformPaymentMethodVirtualAccountInput#

class portone_server_sdk.platform.transfer.PlatformPortOnePayment#

포트원 결제 정보

type: Literal['PORT_ONE']#

id: str#: 결제 아이디

store_id: str#: 상점 아이디

channel_key: str#: 채널 키

order_name: str#: 주문 명

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']#: 통화

paid_at: str#: 결제 일시 (RFC 3339 date-time)

method: PlatformPaymentMethodCard | PlatformPaymentMethodEasyPay | PlatformPaymentMethodGiftCertificate | PlatformPaymentMethodMobile | PlatformPaymentMethodTransfer | PlatformPaymentMethodVirtualAccount | None#: 결제 수단

class portone_server_sdk.platform.transfer.PlatformSettlementParameterValue#

플랫폼 정산 파라미터 값

decimal: int#: 크기가 조정되지 않은 숫자 (int64)

decimal_scale: int | None#

소수 자리수

정산 시 필요한 `decimalScale`이 지정되지 않은 경우 기본값으로 0을 사용합니다. 입력 가능한 법위는 0 ~ 5 입니다. (int32)

class portone_server_sdk.platform.transfer.PlatformTransferFilterInput#

정산건 필터 입력 정보

정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.

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

settlement_date_range: DateRange | None#: 정산 일 범위

partner_tags: list[str] | None#

파트너 태그 리스트

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 태그를 하나 이상 가지는 파트너에 대한 정산건만 조회합니다.

contract_ids: list[str] | None#

계약 아이디 리스트

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 계약 아이디를 가지는 정산건만 조회합니다.

discount_share_policy_ids: list[str] | None#

할인 분담 정책 아이디 리스트

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 할인 분담 정책 아이디를 하나 이상 가지는 정산건만 조회합니다.

additional_fee_policy_ids: list[str] | None#

추가 수수료 정책 아이디 리스트

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 추가 수수료 아이디를 하나 이상 가지는 정산건만 조회합니다.

payment_method_types: list[Literal['CARD', 'TRANSFER', 'VIRTUAL_ACCOUNT', 'GIFT_CERTIFICATE', 'MOBILE', 'EASY_PAY']] | None#

결제 수단 리스트

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 결제 수단을 가지는 파트너만 조회합니다.

channel_keys: list[str] | None#

채널 키 리스트

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 채널 키를 가지는 정산건만 조회합니다.

types: list[Literal['MANUAL', 'ORDER', 'ORDER_CANCEL']] | None#

정산 방식 리스트

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 방식의 정산건만 조회합니다.

statuses: list[Literal['SCHEDULED', 'IN_PROCESS', 'SETTLED', 'IN_PAYOUT', 'PAID_OUT']] | None#

정산 상태 리스트

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 상태인 정산건만 조회합니다.

keyword: PlatformTransferFilterInputKeyword | None#: 검색 키워드

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

class portone_server_sdk.platform.transfer.PlatformTransferFilterInputKeyword#

정산건 검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

all: str | None#: 해당 값이 포함된 정보를 가진 정산건만 조회합니다.

payment_id: str | None#: 해당 값이랑 일치하는 paymentId 를 가진 정산건만 조회합니다.

transfer_id: str | None#: 해당 값이랑 일치하는 transferId 를 가진 정산건만 조회합니다.

transfer_memo: str | None#: 해당 값이 포함된 transferMemo 를 가진 정산건만 조회합니다.

product_id: str | None#: 해당 값이랑 일치하는 productId 를 가진 정산건만 조회합니다.

product_name: str | None#: 해당 값이랑 일치하는 productName 을 가진 정산건만 조회합니다.

partner_id: str | None#: 해당 값이랑 일치하는 partnerId 를 가진 정산건만 조회합니다.

partner_name: str | None#: 해당 값이 포함된 partnerName 을 가진 정산건만 조회합니다.

partner_memo: str | None#: 해당 값이 포함된 partnerMemo 를 가진 정산건만 조회합니다.

class portone_server_sdk.platform.transfer.PlatformTransferSummaryExternalPayment#

type: Literal['EXTERNAL']#

id: str#

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']#

order_name: str | None#

method_type: Literal['CARD', 'TRANSFER', 'VIRTUAL_ACCOUNT', 'GIFT_CERTIFICATE', 'MOBILE', 'EASY_PAY'] | None#

class portone_server_sdk.platform.transfer.PlatformTransferSummaryPartner#

id: str#

graphql_id: str#

name: str#

type: Literal['BUSINESS', 'WHT_PAYER', 'NON_WHT_PAYER']#

taxation_type: Literal['NORMAL', 'SIMPLE_TAX_INVOICE_ISSUER', 'SIMPLE', 'TAX_FREE'] | None#

class portone_server_sdk.platform.transfer.PlatformTransferSummaryPortOnePayment#

type: Literal['PORT_ONE']#

id: str#

order_name: str#

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']#

method_type: Literal['CARD', 'TRANSFER', 'VIRTUAL_ACCOUNT', 'GIFT_CERTIFICATE', 'MOBILE', 'EASY_PAY'] | None#

class portone_server_sdk.platform.transfer.PlatformUserDefinedPropertyKeyValue#

사용자 정의 속성

key: str#: 사용자 정의 속성 키

value: PlatformUserDefinedPropertyValue#: 사용자 정의 속성 값

class portone_server_sdk.platform.transfer.TransferParameters#

decimal: int#: 크기가 조정되지 않은 숫자 (int64)

decimal_scale: int | None#

소수 자리수

정산 시 필요한 `decimalScale`이 지정되지 않은 경우 기본값으로 0을 사용합니다. 입력 가능한 법위는 0 ~ 5 입니다. (int32)

class portone_server_sdk.platform.transfer.TransferClient#

get_platform_transfer(*, id: str) → PlatformManualTransfer | PlatformOrderTransfer | PlatformOrderCancelTransfer#

정산건 조회

정산건을 조회합니다.

Parameters:

id (str) – 조회하고 싶은 정산건 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformTransferNotFoundError – PlatformTransferNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async get_platform_transfer_async(*, id: str) → PlatformManualTransfer | PlatformOrderTransfer | PlatformOrderCancelTransfer#

정산건 조회

정산건을 조회합니다.

Parameters:

id (str) – 조회하고 싶은 정산건 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformTransferNotFoundError – PlatformTransferNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

delete_platform_transfer(*, id: str) → DeletePlatformTransferResponse#

정산건 삭제

scheduled, in_process 상태의 정산건만 삭제가능합니다.

Parameters:

id (str) – 정산건 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCancelOrderTransfersExistsError – PlatformCancelOrderTransfersExistsError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformTransferNonDeletableStatusError – PlatformTransferNonDeletableStatusError
PlatformTransferNotFoundError – PlatformTransferNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async delete_platform_transfer_async(*, id: str) → DeletePlatformTransferResponse#

정산건 삭제

scheduled, in_process 상태의 정산건만 삭제가능합니다.

Parameters:

id (str) – 정산건 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCancelOrderTransfersExistsError – PlatformCancelOrderTransfersExistsError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformTransferNonDeletableStatusError – PlatformTransferNonDeletableStatusError
PlatformTransferNotFoundError – PlatformTransferNotFoundError
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

get_platform_transfer_summaries(*, page: PageInput | None = None, filter: PlatformTransferFilterInput | None = None) → GetPlatformTransferSummariesResponse#

정산건 다건 조회

성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformTransferFilterInput, optional) – 조회할 정산건 조건 필터

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async get_platform_transfer_summaries_async(*, page: PageInput | None = None, filter: PlatformTransferFilterInput | None = None) → GetPlatformTransferSummariesResponse#

정산건 다건 조회

성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다.

Parameters:

page (PageInput, optional) – 요청할 페이지 정보
filter (PlatformTransferFilterInput, optional) – 조회할 정산건 조건 필터

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

create_platform_order_transfer(*, partner_id: str, contract_id: str | None = None, memo: str | None = None, payment_id: str, order_detail: CreatePlatformOrderTransferBodyOrderDetail, tax_free_amount: int | None = None, settlement_start_date: str | None = None, discounts: list[CreatePlatformOrderTransferBodyDiscount], additional_fees: list[CreatePlatformOrderTransferBodyAdditionalFee], external_payment_detail: CreatePlatformOrderTransferBodyExternalPaymentDetail | None = None, is_for_test: bool | None = None, parameters: TransferParameters | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None) → CreateOrderTransferResponse#

주문 정산건 생성

성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.

Parameters:

partner_id (str) – 파트너 아이디
contract_id (str, optional) –
계약 아이디

기본값은 파트너의 기본 계약 아이디 입니다.
memo (str, optional) – 메모
payment_id (str) – 결제 아이디
order_detail (CreatePlatformOrderTransferBodyOrderDetail) – 주문 정보
tax_free_amount (int, optional) –
주문 면세 금액

주문 항목과 면세 금액을 같이 전달하시면 최종 면세 금액은 주문 항목의 면세 금액이 아닌 전달해주신 면세 금액으로 적용됩니다.
settlement_start_date (str, optional) –
정산 시작일

기본값은 결제 일시 입니다.
discounts (list[CreatePlatformOrderTransferBodyDiscount]) – 할인 정보
additional_fees (list[CreatePlatformOrderTransferBodyAdditionalFee]) – 추가 수수료 정보
external_payment_detail (CreatePlatformOrderTransferBodyExternalPaymentDetail, optional) –
외부 결제 상세 정보

해당 정보가 존재하는 경우 외부 결제 정산건 으로 등록되고, 존재하지않은 경우 포트원 결제 정산건으로 등록됩니다.
is_for_test (bool, optional) –
테스트 모드 여부

기본값은 false 입니다.
parameters (TransferParameters, optional) – 정산 파라미터 (실험기능)
user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePoliciesNotFoundError – PlatformAdditionalFeePoliciesNotFoundError
PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError – PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError – PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
PlatformCurrencyNotSupportedError – 지원 되지 않는 통화를 선택한 경우 지원 되지 않는 통화를 선택한 경우
PlatformDiscountSharePoliciesNotFoundError – PlatformDiscountSharePoliciesNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
PlatformPaymentNotFoundError – PlatformPaymentNotFoundError
PlatformProductIdDuplicatedError – PlatformProductIdDuplicatedError
PlatformSettlementAmountExceededError – 정산 가능한 금액을 초과한 경우 정산 가능한 금액을 초과한 경우
PlatformSettlementParameterNotFoundError – 정산 파라미터가 존재하지 않는 경우 정산 파라미터가 존재하지 않는 경우
PlatformSettlementPaymentAmountExceededPortOnePaymentError – 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우
PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError – 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우
PlatformSettlementTaxFreeAmountExceededPortOnePaymentError – 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우
PlatformTransferAlreadyExistsError – PlatformTransferAlreadyExistsError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async create_platform_order_transfer_async(*, partner_id: str, contract_id: str | None = None, memo: str | None = None, payment_id: str, order_detail: CreatePlatformOrderTransferBodyOrderDetail, tax_free_amount: int | None = None, settlement_start_date: str | None = None, discounts: list[CreatePlatformOrderTransferBodyDiscount], additional_fees: list[CreatePlatformOrderTransferBodyAdditionalFee], external_payment_detail: CreatePlatformOrderTransferBodyExternalPaymentDetail | None = None, is_for_test: bool | None = None, parameters: TransferParameters | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None) → CreateOrderTransferResponse#

주문 정산건 생성

성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.

Parameters:

partner_id (str) – 파트너 아이디
contract_id (str, optional) –
계약 아이디

기본값은 파트너의 기본 계약 아이디 입니다.
memo (str, optional) – 메모
payment_id (str) – 결제 아이디
order_detail (CreatePlatformOrderTransferBodyOrderDetail) – 주문 정보
tax_free_amount (int, optional) –
주문 면세 금액

주문 항목과 면세 금액을 같이 전달하시면 최종 면세 금액은 주문 항목의 면세 금액이 아닌 전달해주신 면세 금액으로 적용됩니다.
settlement_start_date (str, optional) –
정산 시작일

기본값은 결제 일시 입니다.
discounts (list[CreatePlatformOrderTransferBodyDiscount]) – 할인 정보
additional_fees (list[CreatePlatformOrderTransferBodyAdditionalFee]) – 추가 수수료 정보
external_payment_detail (CreatePlatformOrderTransferBodyExternalPaymentDetail, optional) –
외부 결제 상세 정보

해당 정보가 존재하는 경우 외부 결제 정산건 으로 등록되고, 존재하지않은 경우 포트원 결제 정산건으로 등록됩니다.
is_for_test (bool, optional) –
테스트 모드 여부

기본값은 false 입니다.
parameters (TransferParameters, optional) – 정산 파라미터 (실험기능)
user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformAdditionalFeePoliciesNotFoundError – PlatformAdditionalFeePoliciesNotFoundError
PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError – PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
PlatformContractNotFoundError – PlatformContractNotFoundError
PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError – PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
PlatformCurrencyNotSupportedError – 지원 되지 않는 통화를 선택한 경우 지원 되지 않는 통화를 선택한 경우
PlatformDiscountSharePoliciesNotFoundError – PlatformDiscountSharePoliciesNotFoundError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
PlatformPaymentNotFoundError – PlatformPaymentNotFoundError
PlatformProductIdDuplicatedError – PlatformProductIdDuplicatedError
PlatformSettlementAmountExceededError – 정산 가능한 금액을 초과한 경우 정산 가능한 금액을 초과한 경우
PlatformSettlementParameterNotFoundError – 정산 파라미터가 존재하지 않는 경우 정산 파라미터가 존재하지 않는 경우
PlatformSettlementPaymentAmountExceededPortOnePaymentError – 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우
PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError – 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우
PlatformSettlementTaxFreeAmountExceededPortOnePaymentError – 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우
PlatformTransferAlreadyExistsError – PlatformTransferAlreadyExistsError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

create_platform_order_cancel_transfer(*, partner_id: str | None = None, payment_id: str | None = None, transfer_id: str | None = None, cancellation_id: str, memo: str | None = None, order_detail: CreatePlatformOrderCancelTransferBodyOrderDetail | None = None, tax_free_amount: int | None = None, discounts: list[CreatePlatformOrderCancelTransferBodyDiscount], settlement_start_date: str | None = None, external_cancellation_detail: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail | None = None, is_for_test: bool | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None) → CreateOrderCancelTransferResponse#

주문 취소 정산건 생성

성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.

Parameters:

partner_id (str, optional) – 파트너 아이디
payment_id (str, optional) – 결제 아이디
transfer_id (str, optional) – 정산건 아이디
cancellation_id (str) – 취소 내역 아이디
memo (str, optional) – 메모
order_detail (CreatePlatformOrderCancelTransferBodyOrderDetail, optional) – 주문 취소 정보
tax_free_amount (int, optional) –
주문 취소 면세 금액

주문 취소 항목과 취소 면세 금액을 같이 전달하시면 최종 취소 면세 금액은 주문 취소 항목의 면세 금액이 아닌 전달해주신 취소 면세 금액으로 적용됩니다.
discounts (list[CreatePlatformOrderCancelTransferBodyDiscount]) – 할인 정보
settlement_start_date (str, optional) –
정산 시작일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
external_cancellation_detail (CreatePlatformOrderCancelTransferBodyExternalCancellationDetail, optional) –
외부 결제 상세 정보

해당 정보가 존재하는 경우 외부 결제 취소 정산건으로 등록되고, 존재하지않은 경우 포트원 결제 취소 정산건으로 등록됩니다.
is_for_test (bool, optional) –
테스트 모드 여부

기본값은 false 입니다.
user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCancellableAmountExceededError – 취소 가능한 금액이 초과한 경우 취소 가능한 금액이 초과한 경우
PlatformCancellableDiscountAmountExceededError – PlatformCancellableDiscountAmountExceededError
PlatformCancellableDiscountTaxFreeAmountExceededError – PlatformCancellableDiscountTaxFreeAmountExceededError
PlatformCancellableProductQuantityExceededError – PlatformCancellableProductQuantityExceededError
PlatformCancellationAndPaymentTypeMismatchedError – PlatformCancellationAndPaymentTypeMismatchedError
PlatformCancellationNotFoundError – PlatformCancellationNotFoundError
PlatformCannotSpecifyTransferError – 정산 건 식별에 실패한 경우 정산 건 식별에 실패한 경우
PlatformDiscountSharePolicyIdDuplicatedError – PlatformDiscountSharePolicyIdDuplicatedError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformOrderDetailMismatchedError – PlatformOrderDetailMismatchedError
PlatformOrderTransferAlreadyCancelledError – PlatformOrderTransferAlreadyCancelledError
PlatformPaymentNotFoundError – PlatformPaymentNotFoundError
PlatformProductIdDuplicatedError – PlatformProductIdDuplicatedError
PlatformProductIdNotFoundError – PlatformProductIdNotFoundError
PlatformSettlementAmountExceededError – 정산 가능한 금액을 초과한 경우 정산 가능한 금액을 초과한 경우
PlatformSettlementCancelAmountExceededPortOneCancelError – 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우
PlatformTransferAlreadyExistsError – PlatformTransferAlreadyExistsError
PlatformTransferDiscountSharePolicyNotFoundError – PlatformTransferDiscountSharePolicyNotFoundError
PlatformTransferNotFoundError – PlatformTransferNotFoundError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async create_platform_order_cancel_transfer_async(*, partner_id: str | None = None, payment_id: str | None = None, transfer_id: str | None = None, cancellation_id: str, memo: str | None = None, order_detail: CreatePlatformOrderCancelTransferBodyOrderDetail | None = None, tax_free_amount: int | None = None, discounts: list[CreatePlatformOrderCancelTransferBodyDiscount], settlement_start_date: str | None = None, external_cancellation_detail: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail | None = None, is_for_test: bool | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None) → CreateOrderCancelTransferResponse#

주문 취소 정산건 생성

성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.

Parameters:

partner_id (str, optional) – 파트너 아이디
payment_id (str, optional) – 결제 아이디
transfer_id (str, optional) – 정산건 아이디
cancellation_id (str) – 취소 내역 아이디
memo (str, optional) – 메모
order_detail (CreatePlatformOrderCancelTransferBodyOrderDetail, optional) – 주문 취소 정보
tax_free_amount (int, optional) –
주문 취소 면세 금액

주문 취소 항목과 취소 면세 금액을 같이 전달하시면 최종 취소 면세 금액은 주문 취소 항목의 면세 금액이 아닌 전달해주신 취소 면세 금액으로 적용됩니다.
discounts (list[CreatePlatformOrderCancelTransferBodyDiscount]) – 할인 정보
settlement_start_date (str, optional) –
정산 시작일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
external_cancellation_detail (CreatePlatformOrderCancelTransferBodyExternalCancellationDetail, optional) –
외부 결제 상세 정보

해당 정보가 존재하는 경우 외부 결제 취소 정산건으로 등록되고, 존재하지않은 경우 포트원 결제 취소 정산건으로 등록됩니다.
is_for_test (bool, optional) –
테스트 모드 여부

기본값은 false 입니다.
user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformCancellableAmountExceededError – 취소 가능한 금액이 초과한 경우 취소 가능한 금액이 초과한 경우
PlatformCancellableDiscountAmountExceededError – PlatformCancellableDiscountAmountExceededError
PlatformCancellableDiscountTaxFreeAmountExceededError – PlatformCancellableDiscountTaxFreeAmountExceededError
PlatformCancellableProductQuantityExceededError – PlatformCancellableProductQuantityExceededError
PlatformCancellationAndPaymentTypeMismatchedError – PlatformCancellationAndPaymentTypeMismatchedError
PlatformCancellationNotFoundError – PlatformCancellationNotFoundError
PlatformCannotSpecifyTransferError – 정산 건 식별에 실패한 경우 정산 건 식별에 실패한 경우
PlatformDiscountSharePolicyIdDuplicatedError – PlatformDiscountSharePolicyIdDuplicatedError
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformOrderDetailMismatchedError – PlatformOrderDetailMismatchedError
PlatformOrderTransferAlreadyCancelledError – PlatformOrderTransferAlreadyCancelledError
PlatformPaymentNotFoundError – PlatformPaymentNotFoundError
PlatformProductIdDuplicatedError – PlatformProductIdDuplicatedError
PlatformProductIdNotFoundError – PlatformProductIdNotFoundError
PlatformSettlementAmountExceededError – 정산 가능한 금액을 초과한 경우 정산 가능한 금액을 초과한 경우
PlatformSettlementCancelAmountExceededPortOneCancelError – 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우
PlatformTransferAlreadyExistsError – PlatformTransferAlreadyExistsError
PlatformTransferDiscountSharePolicyNotFoundError – PlatformTransferDiscountSharePolicyNotFoundError
PlatformTransferNotFoundError – PlatformTransferNotFoundError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

create_platform_manual_transfer(*, partner_id: str, memo: str | None = None, settlement_amount: int, settlement_date: str, is_for_test: bool | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None) → CreateManualTransferResponse#

수기 정산건 생성

성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.

Parameters:

partner_id (str) – 파트너 아이디
memo (str, optional) – 메모
settlement_amount (int) – 정산 금액
settlement_date (str) –
정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
is_for_test (bool, optional) –
테스트 모드 여부

기본값은 false 입니다.
user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async create_platform_manual_transfer_async(*, partner_id: str, memo: str | None = None, settlement_amount: int, settlement_date: str, is_for_test: bool | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None) → CreateManualTransferResponse#

수기 정산건 생성

성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.

Parameters:

partner_id (str) – 파트너 아이디
memo (str, optional) – 메모
settlement_amount (int) – 정산 금액
settlement_date (str) –
정산 일

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
is_for_test (bool, optional) –
테스트 모드 여부

기본값은 false 입니다.
user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PlatformNotEnabledError – 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformPartnerNotFoundError – PlatformPartnerNotFoundError
PlatformUserDefinedPropertyNotFoundError – 사용자 정의 속성이 존재 하지 않는 경우 사용자 정의 속성이 존재 하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

download_platform_transfer_sheet(*, filter: PlatformTransferFilterInput | None = None, fields: list[Literal['STATUS', 'TRANSFER_ID', 'PARTNER_NAME', 'SETTLEMENT_DATE', 'SETTLEMENT_START_DATE', 'TYPE', 'PAYMENT_ID', 'ORDER_NAME', 'PAYMENT_METHOD', 'SETTLEMENT_AMOUNT', 'SETTLEMENT_ORDER_AMOUNT', 'SETTLEMENT_ORDER_TAX_FREE_AMOUNT', 'SETTLEMENT_PAYMENT_AMOUNT', 'SETTLEMENT_PAYMENT_VAT_AMOUNT', 'SETTLEMENT_PAYMENT_VAT_BURDEN_AMOUNT', 'SETTLEMENT_SUPPLY_AMOUNT', 'SETTLEMENT_TAX_FREE_AMOUNT', 'SETTLEMENT_PAYMENT_SUPPLY_AMOUNT', 'SETTLEMENT_PAYMENT_TAX_FREE_AMOUNT', 'SETTLEMENT_PLATFORM_FEE_AMOUNT', 'SETTLEMENT_PLATFORM_FEE_VAT_AMOUNT', 'SETTLEMENT_DISCOUNT_AMOUNT', 'SETTLEMENT_DISCOUNT_TAX_FREE_AMOUNT', 'SETTLEMENT_DISCOUNT_SHARE_AMOUNT', 'SETTLEMENT_DISCOUNT_SHARE_TAX_FREE_AMOUNT', 'SETTLEMENT_ADDITIONAL_FEE_AMOUNT', 'SETTLEMENT_ADDITIONAL_FEE_VAT_AMOUNT', 'SETTLEMENT_CURRENCY', 'PARTNER_TYPE', 'TAXATION_TYPE', 'INCOME_TYPE', 'TAXATION_TYPE_OR_INCOME_TYPE']] | None = None, transfer_user_defined_property_keys: list[str] | None = None, partner_user_defined_property_keys: list[str] | None = None) → str#

정산 상세 내역 다운로드

정산 상세 내역을 csv 파일로 다운로드 합니다.

Parameters:

filter (PlatformTransferFilterInput, optional)
fields (list[PlatformTransferSheetField], optional) – 다운로드 할 시트 컬럼
transfer_user_defined_property_keys (list[str], optional)
partner_user_defined_property_keys (list[str], optional)

Raises:

InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async download_platform_transfer_sheet_async(*, filter: PlatformTransferFilterInput | None = None, fields: list[Literal['STATUS', 'TRANSFER_ID', 'PARTNER_NAME', 'SETTLEMENT_DATE', 'SETTLEMENT_START_DATE', 'TYPE', 'PAYMENT_ID', 'ORDER_NAME', 'PAYMENT_METHOD', 'SETTLEMENT_AMOUNT', 'SETTLEMENT_ORDER_AMOUNT', 'SETTLEMENT_ORDER_TAX_FREE_AMOUNT', 'SETTLEMENT_PAYMENT_AMOUNT', 'SETTLEMENT_PAYMENT_VAT_AMOUNT', 'SETTLEMENT_PAYMENT_VAT_BURDEN_AMOUNT', 'SETTLEMENT_SUPPLY_AMOUNT', 'SETTLEMENT_TAX_FREE_AMOUNT', 'SETTLEMENT_PAYMENT_SUPPLY_AMOUNT', 'SETTLEMENT_PAYMENT_TAX_FREE_AMOUNT', 'SETTLEMENT_PLATFORM_FEE_AMOUNT', 'SETTLEMENT_PLATFORM_FEE_VAT_AMOUNT', 'SETTLEMENT_DISCOUNT_AMOUNT', 'SETTLEMENT_DISCOUNT_TAX_FREE_AMOUNT', 'SETTLEMENT_DISCOUNT_SHARE_AMOUNT', 'SETTLEMENT_DISCOUNT_SHARE_TAX_FREE_AMOUNT', 'SETTLEMENT_ADDITIONAL_FEE_AMOUNT', 'SETTLEMENT_ADDITIONAL_FEE_VAT_AMOUNT', 'SETTLEMENT_CURRENCY', 'PARTNER_TYPE', 'TAXATION_TYPE', 'INCOME_TYPE', 'TAXATION_TYPE_OR_INCOME_TYPE']] | None = None, transfer_user_defined_property_keys: list[str] | None = None, partner_user_defined_property_keys: list[str] | None = None) → str#

정산 상세 내역 다운로드

정산 상세 내역을 csv 파일로 다운로드 합니다.

Parameters:

filter (PlatformTransferFilterInput, optional)
fields (list[PlatformTransferSheetField], optional) – 다운로드 할 시트 컬럼
transfer_user_defined_property_keys (list[str], optional)
partner_user_defined_property_keys (list[str], optional)

Raises:

InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

portone_server_sdk.platform.transfer

Contents

portone_server_sdk.platform.transfer#