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

createPlatformOrderCancelTransfer

@JvmName(name = "createPlatformOrderCancelTransferSuspend")

suspend fun createPlatformOrderCancelTransfer(test: Boolean? = null, 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, settlementDate: String? = null, externalCancellationDetail: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail? = null, isForTest: Boolean? = null, userDefinedProperties: List<PlatformUserDefinedPropertyKeyValue>? = null): CreateOrderCancelTransferResponse

주문 취소 정산건 생성

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

Parameters

test

테스트 모드 여부

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

partnerId

파트너 아이디

paymentId

결제 아이디

transferId

정산건 아이디

cancellationId

취소 내역 아이디

memo

메모

orderDetail

주문 취소 정보

taxFreeAmount

주문 취소 면세 금액

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

discounts

할인 정보

settlementStartDate

정산 시작일

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

settlementDate

정산일

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

externalCancellationDetail

외부 결제 상세 정보

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

isForTest

테스트 모드 여부

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

userDefinedProperties

사용자 정의 속성

Throws

CreatePlatformOrderCancelTransferException