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

createPlatformOrderCancelTransfer

@JvmName(name = "createPlatformOrderCancelTransferSuspend")
suspend fun createPlatformOrderCancelTransfer(partnerId: String? = null, paymentId: String? = null, transferId: String? = null, cancellationId: String, memo: String? = null, orderDetail: CreatePlatformOrderCancelTransferBodyOrderDetail? = null, taxFreeAmount: Long? = null, discounts: List<CreatePlatformOrderCancelTransferBodyDiscount>, settlementStartDate: String? = null, externalCancellationDetail: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail? = null, isForTest: Boolean? = null, userDefinedProperties: List<PlatformUserDefinedPropertyKeyValue>? = null): CreateOrderCancelTransferResponse

주문 취소 정산건 생성

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

Parameters

partnerId

파트너 아이디

paymentId

결제 아이디

transferId

정산건 아이디

cancellationId

취소 내역 아이디

memo

메모

orderDetail

주문 취소 정보

taxFreeAmount

주문 취소 면세 금액

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

discounts

할인 정보

settlementStartDate

정산 시작일

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

externalCancellationDetail

외부 결제 상세 정보

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

isForTest

테스트 모드 여부

기본값은 false 입니다.

userDefinedProperties

사용자 정의 속성

Throws

요청이 거절된 경우

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

취소 가능한 금액이 초과한 경우

PlatformCancellableDiscountAmountExceededError

PlatformCancellableDiscountTaxFreeAmountExceededError

PlatformCancellableProductQuantityExceededError

PlatformCancellationAndPaymentTypeMismatchedError

PlatformCancellationNotFoundError

정산 건 식별에 실패한 경우

PlatformDiscountSharePolicyIdDuplicatedError

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

PlatformOrderDetailMismatchedError

PlatformOrderTransferAlreadyCancelledError

PlatformPaymentNotFoundError

PlatformProductIdDuplicatedError

PlatformProductIdNotFoundError

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

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

PlatformTransferAlreadyExistsError

PlatformTransferDiscountSharePolicyNotFoundError

PlatformTransferNotFoundError

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

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

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