PortOne Server SDK for JVM/io.portone.sdk.server.platform.transfer/TransferClient/createPlatformOrderTransfer

createPlatformOrderTransfer

@JvmName(name = "createPlatformOrderTransferSuspend")
suspend fun createPlatformOrderTransfer(partnerId: String, contractId: String? = null, memo: String? = null, paymentId: String, orderDetail: CreatePlatformOrderTransferBodyOrderDetail, taxFreeAmount: Long? = null, settlementStartDate: String? = null, discounts: List<CreatePlatformOrderTransferBodyDiscount>, additionalFees: List<CreatePlatformOrderTransferBodyAdditionalFee>, externalPaymentDetail: CreatePlatformOrderTransferBodyExternalPaymentDetail? = null, isForTest: Boolean? = null, parameters: TransferParameters? = null, userDefinedProperties: List<PlatformUserDefinedPropertyKeyValue>? = null): CreateOrderTransferResponse

주문 정산건 생성

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

Parameters

partnerId

파트너 아이디

contractId

계약 아이디

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

memo

메모

paymentId

결제 아이디

orderDetail

주문 정보

taxFreeAmount

주문 면세 금액

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

settlementStartDate

정산 시작일

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

discounts

할인 정보

additionalFees

추가 수수료 정보

externalPaymentDetail

외부 결제 상세 정보

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

isForTest

테스트 모드 여부

기본값은 false 입니다.

parameters

정산 파라미터 (실험기능)

userDefinedProperties

사용자 정의 속성

Throws

요청이 거절된 경우

요청된 입력 정보가 유효하지 않은 경우

PlatformAdditionalFeePoliciesNotFoundError

PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError

PlatformContractNotFoundError

PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError

지원 되지 않는 통화를 선택한 경우

PlatformDiscountSharePoliciesNotFoundError

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

PlatformPartnerNotFoundError

PlatformPaymentNotFoundError

PlatformProductIdDuplicatedError

정산 가능한 금액을 초과한 경우

정산 파라미터가 존재하지 않는 경우

정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우

정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우

정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우

PlatformTransferAlreadyExistsError

사용자 정의 속성이 존재 하지 않는 경우

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

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