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 클라이언트를 생성합니다.

Parameters:

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

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

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

Methods

__init__(*, secret[, base_url, store_id])	API Secret을 사용해 포트원 API 클라이언트를 생성합니다.
create_platform_manual_transfer(*[, test, ...])	수기 정산건 생성
create_platform_manual_transfer_async(*[, ...])	수기 정산건 생성
create_platform_order_cancel_transfer(*[, ...])	주문 취소 정산건 생성
create_platform_order_cancel_transfer_async(*)	주문 취소 정산건 생성
create_platform_order_transfer(*[, test, ...])	주문 정산건 생성
create_platform_order_transfer_async(*[, ...])	주문 정산건 생성
delete_platform_transfer(*, id[, test])	정산건 삭제
delete_platform_transfer_async(*, id[, test])	정산건 삭제
download_platform_transfer_sheet(*[, test, ...])	정산 상세 내역 다운로드
download_platform_transfer_sheet_async(*[, ...])	정산 상세 내역 다운로드
get_platform_transfer(*, id[, test])	정산건 조회
get_platform_transfer_async(*, id[, test])	정산건 조회
get_platform_transfer_summaries(*[, test, ...])	정산건 다건 조회
get_platform_transfer_summaries_async(*[, ...])	정산건 다건 조회

download_platform_transfer_sheet(*, test: bool | None = None, filter: PlatformTransferFilterInput | None = None, fields: list[str] | None = None) → str

정산 상세 내역 다운로드

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

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

• filter (PlatformTransferFilterInput, optional) –

  컬럼 키 목록

  • TRANSFER_MEMO: 메모

  • TRANSFER_TYPE: 정산 유형

  • TRANSFER_STATUS: 상태

  • TRANSFER_ID: 정산 아이디

  • TRANSFER_SETTLEMENT_DATE: 정산일

  • TRANSFER_SETTLEMENT_AMOUNT: 정산 금액

  • TRANSFER_SETTLEMENT_TAX_FREE_AMOUNT: 정산 면세액

  • TRANSFER_SETTLEMENT_CURRENCY: 정산 통화

  • TRANSFER_SETTLEMENT_START_DATE: 정산 시작일

  • TRANSFER_ORDER_NAME: 주문명

  • TRANSFER_ORDER_AMOUNT: 주문 금액

  • TRANSFER_ORDER_TAX_FREE_AMOUNT: 주문 면세액

  • TRANSFER_PAYMENT_ID: 주문 번호

  • TRANSFER_PAYMENT_METHOD: 결제 수단

  • TRANSFER_PAYMENT_AMOUNT: 결제 금액

  • TRANSFER_PAYMENT_SUPPLY_AMOUNT: 결제 공급가액

  • TRANSFER_PAYMENT_VAT_AMOUNT: 결제 부가세액

  • TRANSFER_PAYMENT_TAX_FREE_AMOUNT: 결제 면세액

  • TRANSFER_PAYMENT_VAT_BURDEN_AMOUNT: 결제 부가세 부담금

  • TRANSFER_PLATFORM_FEE: 중개수수료

  • TRANSFER_PLATFORM_FEE_VAT: 중개수수료 부가세 부담금

  • TRANSFER_CONTRACT_ID: 계약 아이디

  • TRANSFER_CONTRACT_NAME: 계약 이름

  • TRANSFER_DISCOUNT_AMOUNT: 할인 금액

  • TRANSFER_DISCOUNT_TAX_FREE_AMOUNT: 할인 면세액

  • TRANSFER_DISCOUNT_SHARE_AMOUNT: 할인 분담금

  • TRANSFER_DISCOUNT_SHARE_TAX_FREE_AMOUNT: 할인 면세 분담금

  • TRANSFER_ADDITIONAL_FEE: 추가수수료

  • TRANSFER_ADDITIONAL_FEE_VAT: 추가수수료 부가세 부담금

  • TRANSFER_{UserDefinedProperty.Key}

  • FORMULA_{UserDefinedFormula.Key}

  • PARTNER_* : 파트너 컬럼 키 사용 가능(w/o PARTNER_STATUS_UPDATED_AT)

• fields (list[str], optional)

Raises:

• DownloadPlatformTransferSheetError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async download_platform_transfer_sheet_async(*, test: bool | None = None, filter: PlatformTransferFilterInput | None = None, fields: list[str] | None = None) → str

정산 상세 내역 다운로드

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

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

• filter (PlatformTransferFilterInput, optional) –

  컬럼 키 목록

  • TRANSFER_MEMO: 메모

  • TRANSFER_TYPE: 정산 유형

  • TRANSFER_STATUS: 상태

  • TRANSFER_ID: 정산 아이디

  • TRANSFER_SETTLEMENT_DATE: 정산일

  • TRANSFER_SETTLEMENT_AMOUNT: 정산 금액

  • TRANSFER_SETTLEMENT_TAX_FREE_AMOUNT: 정산 면세액

  • TRANSFER_SETTLEMENT_CURRENCY: 정산 통화

  • TRANSFER_SETTLEMENT_START_DATE: 정산 시작일

  • TRANSFER_ORDER_NAME: 주문명

  • TRANSFER_ORDER_AMOUNT: 주문 금액

  • TRANSFER_ORDER_TAX_FREE_AMOUNT: 주문 면세액

  • TRANSFER_PAYMENT_ID: 주문 번호

  • TRANSFER_PAYMENT_METHOD: 결제 수단

  • TRANSFER_PAYMENT_AMOUNT: 결제 금액

  • TRANSFER_PAYMENT_SUPPLY_AMOUNT: 결제 공급가액

  • TRANSFER_PAYMENT_VAT_AMOUNT: 결제 부가세액

  • TRANSFER_PAYMENT_TAX_FREE_AMOUNT: 결제 면세액

  • TRANSFER_PAYMENT_VAT_BURDEN_AMOUNT: 결제 부가세 부담금

  • TRANSFER_PLATFORM_FEE: 중개수수료

  • TRANSFER_PLATFORM_FEE_VAT: 중개수수료 부가세 부담금

  • TRANSFER_CONTRACT_ID: 계약 아이디

  • TRANSFER_CONTRACT_NAME: 계약 이름

  • TRANSFER_DISCOUNT_AMOUNT: 할인 금액

  • TRANSFER_DISCOUNT_TAX_FREE_AMOUNT: 할인 면세액

  • TRANSFER_DISCOUNT_SHARE_AMOUNT: 할인 분담금

  • TRANSFER_DISCOUNT_SHARE_TAX_FREE_AMOUNT: 할인 면세 분담금

  • TRANSFER_ADDITIONAL_FEE: 추가수수료

  • TRANSFER_ADDITIONAL_FEE_VAT: 추가수수료 부가세 부담금

  • TRANSFER_{UserDefinedProperty.Key}

  • FORMULA_{UserDefinedFormula.Key}

  • PARTNER_* : 파트너 컬럼 키 사용 가능(w/o PARTNER_STATUS_UPDATED_AT)

• fields (list[str], optional)

Raises:

• DownloadPlatformTransferSheetError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

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

정산건 다건 조회

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

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 (PlatformTransferFilterInput, optional) – 조회할 정산건 조건 필터

Raises:

• GetPlatformTransferSummariesError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

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

정산건 다건 조회

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

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 (PlatformTransferFilterInput, optional) – 조회할 정산건 조건 필터

Raises:

• GetPlatformTransferSummariesError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

create_platform_manual_transfer(*, test: bool | None = None, partner_id: str, memo: str | None = None, settlement_amount: int, settlement_tax_free_amount: int | None = None, settlement_date: str, is_for_test: bool | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None, id: str | None = None, 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 | None = None) → CreateManualTransferResponse

수기 정산건 생성

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

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

• partner_id (str) – 파트너 아이디

• memo (str, optional) – 메모

• settlement_amount (int) – 정산 금액

• settlement_tax_free_amount (int, optional) – 정산 면세 금액

• settlement_date (str) –

  정산 일

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

• is_for_test (bool, optional) –

  테스트 모드 여부

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

• user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

• id (str, optional) –

  생성할 정산건 아이디

  명시하지 않으면 id 가 임의로 생성됩니다.

• settlement_currency (Currency, optional) – 정산 통화

Raises:

• CreatePlatformManualTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async create_platform_manual_transfer_async(*, test: bool | None = None, partner_id: str, memo: str | None = None, settlement_amount: int, settlement_tax_free_amount: int | None = None, settlement_date: str, is_for_test: bool | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None, id: str | None = None, 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 | None = None) → CreateManualTransferResponse

수기 정산건 생성

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

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

• partner_id (str) – 파트너 아이디

• memo (str, optional) – 메모

• settlement_amount (int) – 정산 금액

• settlement_tax_free_amount (int, optional) – 정산 면세 금액

• settlement_date (str) –

  정산 일

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

• is_for_test (bool, optional) –

  테스트 모드 여부

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

• user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

• id (str, optional) –

  생성할 정산건 아이디

  명시하지 않으면 id 가 임의로 생성됩니다.

• settlement_currency (Currency, optional) – 정산 통화

Raises:

• CreatePlatformManualTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

create_platform_order_cancel_transfer(*, test: bool | None = None, 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, settlement_date: str | None = None, external_cancellation_detail: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail | None = None, is_for_test: bool | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None, id: str | None = None) → CreateOrderCancelTransferResponse

주문 취소 정산건 생성

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

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

• 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) –

  주문 취소 면세 금액

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

• discounts (list[CreatePlatformOrderCancelTransferBodyDiscount]) – 할인 정보

• settlement_start_date (str, optional) –

  정산 시작일

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

• settlement_date (str, optional) –

  정산일

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

• external_cancellation_detail (CreatePlatformOrderCancelTransferBodyExternalCancellationDetail, optional) –

  외부 결제 상세 정보

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

• is_for_test (bool, optional) –

  테스트 모드 여부

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

• user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

• id (str, optional) –

  생성할 취소 정산건 아이디

  명시하지 않으면 id 가 임의로 생성됩니다.

Raises:

• CreatePlatformOrderCancelTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async create_platform_order_cancel_transfer_async(*, test: bool | None = None, 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, settlement_date: str | None = None, external_cancellation_detail: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail | None = None, is_for_test: bool | None = None, user_defined_properties: list[PlatformUserDefinedPropertyKeyValue] | None = None, id: str | None = None) → CreateOrderCancelTransferResponse

주문 취소 정산건 생성

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

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

• 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) –

  주문 취소 면세 금액

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

• discounts (list[CreatePlatformOrderCancelTransferBodyDiscount]) – 할인 정보

• settlement_start_date (str, optional) –

  정산 시작일

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

• settlement_date (str, optional) –

  정산일

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

• external_cancellation_detail (CreatePlatformOrderCancelTransferBodyExternalCancellationDetail, optional) –

  외부 결제 상세 정보

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

• is_for_test (bool, optional) –

  테스트 모드 여부

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

• user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

• id (str, optional) –

  생성할 취소 정산건 아이디

  명시하지 않으면 id 가 임의로 생성됩니다.

Raises:

• CreatePlatformOrderCancelTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

create_platform_order_transfer(*, test: bool | None = None, 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, settlement_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, id: str | None = None) → CreateOrderTransferResponse

주문 정산건 생성

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

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

• partner_id (str) – 파트너 아이디

• contract_id (str, optional) –

  계약 아이디

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

• memo (str, optional) – 메모

• payment_id (str) – 결제 아이디

• order_detail (CreatePlatformOrderTransferBodyOrderDetail) – 주문 정보

• tax_free_amount (int, optional) –

  주문 면세 금액

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

• settlement_start_date (str, optional) –

  정산 시작일

  기본값은 결제 일시 입니다. (yyyy-MM-dd)

• settlement_date (str, optional) –

  정산일

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

• discounts (list[CreatePlatformOrderTransferBodyDiscount]) – 할인 정보

• additional_fees (list[CreatePlatformOrderTransferBodyAdditionalFee]) – 추가 수수료 정보

• external_payment_detail (CreatePlatformOrderTransferBodyExternalPaymentDetail, optional) –

  외부 결제 상세 정보

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

• is_for_test (bool, optional) –

  테스트 모드 여부

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

• parameters (TransferParameters, optional) – 정산 파라미터 (실험기능)

• user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

• id (str, optional) –

  생성할 정산건 아이디

  명시하지 않으면 id 가 임의로 생성됩니다.

Raises:

• CreatePlatformOrderTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async create_platform_order_transfer_async(*, test: bool | None = None, 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, settlement_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, id: str | None = None) → CreateOrderTransferResponse

주문 정산건 생성

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

Parameters:

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

• partner_id (str) – 파트너 아이디

• contract_id (str, optional) –

  계약 아이디

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

• memo (str, optional) – 메모

• payment_id (str) – 결제 아이디

• order_detail (CreatePlatformOrderTransferBodyOrderDetail) – 주문 정보

• tax_free_amount (int, optional) –

  주문 면세 금액

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

• settlement_start_date (str, optional) –

  정산 시작일

  기본값은 결제 일시 입니다. (yyyy-MM-dd)

• settlement_date (str, optional) –

  정산일

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

• discounts (list[CreatePlatformOrderTransferBodyDiscount]) – 할인 정보

• additional_fees (list[CreatePlatformOrderTransferBodyAdditionalFee]) – 추가 수수료 정보

• external_payment_detail (CreatePlatformOrderTransferBodyExternalPaymentDetail, optional) –

  외부 결제 상세 정보

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

• is_for_test (bool, optional) –

  테스트 모드 여부

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

• parameters (TransferParameters, optional) – 정산 파라미터 (실험기능)

• user_defined_properties (list[PlatformUserDefinedPropertyKeyValue], optional) – 사용자 정의 속성

• id (str, optional) –

  생성할 정산건 아이디

  명시하지 않으면 id 가 임의로 생성됩니다.

Raises:

• CreatePlatformOrderTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_platform_transfer(*, id: str, test: bool | None = None) → PlatformManualTransfer | PlatformOrderTransfer | PlatformOrderCancelTransfer | dict

정산건 조회

정산건을 조회합니다.

Parameters:

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

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Raises:

• GetPlatformTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_platform_transfer_async(*, id: str, test: bool | None = None) → PlatformManualTransfer | PlatformOrderTransfer | PlatformOrderCancelTransfer | dict

정산건 조회

정산건을 조회합니다.

Parameters:

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

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Raises:

• GetPlatformTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

delete_platform_transfer(*, id: str, test: bool | None = None) → DeletePlatformTransferResponse

정산건 삭제

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

Parameters:

• id (str) – 정산건 아이디

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Raises:

• DeletePlatformTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async delete_platform_transfer_async(*, id: str, test: bool | None = None) → DeletePlatformTransferResponse

정산건 삭제

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

Parameters:

• id (str) – 정산건 아이디

• test (bool, optional) –

  테스트 모드 여부

  테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Raises:

• DeletePlatformTransferError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우