portone_server_sdk.TransferClient

class portone_server_sdk.TransferClient

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 클라이언트를 생성합니다.
create_platform_manual_transfer(*, partner_id)	수기 정산건 생성
create_platform_manual_transfer_async(*, ...)	수기 정산건 생성
create_platform_order_cancel_transfer(*[, ...])	주문 취소 정산건 생성
create_platform_order_cancel_transfer_async(*)	주문 취소 정산건 생성
create_platform_order_transfer(*, partner_id)	주문 정산건 생성
create_platform_order_transfer_async(*, ...)	주문 정산건 생성
delete_platform_transfer(*, id)	정산건 삭제
delete_platform_transfer_async(*, id)	정산건 삭제
download_platform_transfer_sheet(*[, ...])	정산 상세 내역 다운로드
download_platform_transfer_sheet_async(*[, ...])	정산 상세 내역 다운로드
get_platform_transfer(*, id)	정산건 조회
get_platform_transfer_async(*, id)	정산건 조회
get_platform_transfer_summaries(*[, page, ...])	정산건 다건 조회
get_platform_transfer_summaries_async(*[, ...])	정산건 다건 조회

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

정산건 조회

정산건을 조회합니다.

Parameters:

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

Raises:

GetPlatformTransferError –

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

정산건 조회

정산건을 조회합니다.

Parameters:

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

Raises:

GetPlatformTransferError –

delete_platform_transfer(*, id: str) → DeletePlatformTransferResponse

정산건 삭제

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

Parameters:

id (str) – 정산건 아이디

Raises:

DeletePlatformTransferError –

async delete_platform_transfer_async(*, id: str) → DeletePlatformTransferResponse

정산건 삭제

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

Parameters:

id (str) – 정산건 아이디

Raises:

DeletePlatformTransferError –

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

정산건 다건 조회

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

Parameters:

• page (PageInput, optional) – 요청할 페이지 정보

• filter (PlatformTransferFilterInput, optional) – 조회할 정산건 조건 필터

Raises:

GetPlatformTransferSummariesError –

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

정산건 다건 조회

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

Parameters:

• page (PageInput, optional) – 요청할 페이지 정보

• filter (PlatformTransferFilterInput, optional) – 조회할 정산건 조건 필터

Raises:

GetPlatformTransferSummariesError –

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:

CreatePlatformOrderTransferError –

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:

CreatePlatformOrderTransferError –

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:

CreatePlatformOrderCancelTransferError –

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:

CreatePlatformOrderCancelTransferError –

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:

CreatePlatformManualTransferError –

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:

CreatePlatformManualTransferError –

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_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', 'PARTNER_TAXATION_TYPE', 'PARTNER_INCOME_TYPE', 'PARTNER_TAXATION_TYPE_OR_INCOME_TYPE', 'PARTNER_ID', 'MEMO'] | str] | 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:

DownloadPlatformTransferSheetError –

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_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', 'PARTNER_TAXATION_TYPE', 'PARTNER_INCOME_TYPE', 'PARTNER_TAXATION_TYPE_OR_INCOME_TYPE', 'PARTNER_ID', 'MEMO'] | str] | 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:

DownloadPlatformTransferSheetError –