PortOne Server SDK for JVM/io.portone.sdk.server.platform/PlatformClient

PlatformClient

class PlatformClient(apiSecret: String, apiBase: String = "https://api.portone.io", storeId: String? = null) : Closeable

Constructors

Link copied to clipboard
constructor(apiSecret: String, apiBase: String = "https://api.portone.io", storeId: String? = null)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

@JvmName(name = "cancelPlatformAdditionalFeePolicyScheduleSuspend")
suspend fun cancelPlatformAdditionalFeePolicySchedule(id: String): CancelPlatformAdditionalFeePolicyScheduleResponse

주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 취소합니다.

Link copied to clipboard
@JvmName(name = "cancelPlatformContractScheduleSuspend")
suspend fun cancelPlatformContractSchedule(id: String): CancelPlatformContractScheduleResponse

주어진 아이디에 대응되는 계약의 예약 업데이트를 취소합니다.

@JvmName(name = "cancelPlatformDiscountSharePolicyScheduleSuspend")
suspend fun cancelPlatformDiscountSharePolicySchedule(id: String): CancelPlatformDiscountSharePolicyScheduleResponse

주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 취소합니다.

Link copied to clipboard
@JvmName(name = "cancelPlatformPartnerScheduleSuspend")
suspend fun cancelPlatformPartnerSchedule(id: String): CancelPlatformPartnerScheduleResponse

주어진 아이디에 대응되는 파트너의 예약 업데이트를 취소합니다.

Link copied to clipboard
open override fun close()
Link copied to clipboard
@JvmName(name = "getPlatformSuspend")
suspend fun getPlatform(): Platform

고객사의 플랫폼 정보를 조회합니다. 요청된 Authorization header 를 통해 자동으로 요청자의 고객사를 특정합니다.

Link copied to clipboard
@JvmName(name = "getPlatformAdditionalFeePolicyScheduleSuspend")
suspend fun getPlatformAdditionalFeePolicySchedule(id: String): PlatformAdditionalFeePolicy

주어진 아이디에 대응되는 추가 수수료 정책의 예약 업데이트를 조회합니다.

Link copied to clipboard
@JvmName(name = "getPlatformContractScheduleSuspend")
suspend fun getPlatformContractSchedule(id: String): PlatformContract

주어진 아이디에 대응되는 계약의 예약 업데이트를 조회합니다.

@JvmName(name = "getPlatformDiscountSharePolicyFilterOptionsSuspend")
suspend fun getPlatformDiscountSharePolicyFilterOptions(isArchived: Boolean? = null): PlatformDiscountSharePolicyFilterOptions

할인 분담 정책 다건 조회 시 필요한 필터 옵션을 조회합니다.

Link copied to clipboard
@JvmName(name = "getPlatformDiscountSharePolicyScheduleSuspend")
suspend fun getPlatformDiscountSharePolicySchedule(id: String): PlatformDiscountSharePolicy

주어진 아이디에 대응되는 할인 분담의 예약 업데이트를 조회합니다.

Link copied to clipboard
@JvmName(name = "getPlatformPartnerFilterOptionsSuspend")
suspend fun getPlatformPartnerFilterOptions(isArchived: Boolean? = null): PlatformPartnerFilterOptions

파트너 다건 조회 시 필요한 필터 옵션을 조회합니다.

Link copied to clipboard
@JvmName(name = "getPlatformPartnerScheduleSuspend")
suspend fun getPlatformPartnerSchedule(id: String): PlatformPartner

주어진 아이디에 대응되는 파트너의 예약 업데이트를 조회합니다.

Link copied to clipboard
@JvmName(name = "getPlatformSettingSuspend")
suspend fun getPlatformSetting(): PlatformSetting

플랫폼 설정 조회

Link copied to clipboard
@JvmName(name = "rescheduleAdditionalFeePolicySuspend")
suspend fun rescheduleAdditionalFeePolicy(id: String, update: UpdatePlatformAdditionalFeePolicyBody, appliedAt: Instant): ReschedulePlatformAdditionalFeePolicyResponse
Link copied to clipboard
@JvmName(name = "rescheduleContractSuspend")
suspend fun rescheduleContract(id: String, update: UpdatePlatformContractBody, appliedAt: Instant): ReschedulePlatformContractResponse

주어진 아이디에 대응되는 계약에 예약 업데이트를 재설정합니다.

Link copied to clipboard
@JvmName(name = "rescheduleDiscountSharePolicySuspend")
suspend fun rescheduleDiscountSharePolicy(id: String, update: UpdatePlatformDiscountSharePolicyBody, appliedAt: Instant): ReschedulePlatformDiscountSharePolicyResponse

주어진 아이디에 대응되는 할인 분담에 예약 업데이트를 재설정합니다.

Link copied to clipboard
@JvmName(name = "reschedulePartnerSuspend")
suspend fun reschedulePartner(id: String, update: UpdatePlatformPartnerBody, appliedAt: Instant): ReschedulePlatformPartnerResponse

주어진 아이디에 대응되는 파트너에 예약 업데이트를 재설정합니다.

Link copied to clipboard
@JvmName(name = "scheduleAdditionalFeePolicySuspend")
suspend fun scheduleAdditionalFeePolicy(id: String, update: UpdatePlatformAdditionalFeePolicyBody, appliedAt: Instant): SchedulePlatformAdditionalFeePolicyResponse

주어진 아이디에 대응되는 추가 수수료 정책에 업데이트를 예약합니다.

Link copied to clipboard
@JvmName(name = "scheduleContractSuspend")
suspend fun scheduleContract(id: String, update: UpdatePlatformContractBody, appliedAt: Instant): SchedulePlatformContractResponse

주어진 아이디에 대응되는 계약에 업데이트를 예약합니다.

Link copied to clipboard
@JvmName(name = "scheduleDiscountSharePolicySuspend")
suspend fun scheduleDiscountSharePolicy(id: String, update: UpdatePlatformDiscountSharePolicyBody, appliedAt: Instant): SchedulePlatformDiscountSharePolicyResponse

주어진 아이디에 대응되는 할인 분담에 업데이트를 예약합니다.

Link copied to clipboard
@JvmName(name = "schedulePartnerSuspend")
suspend fun schedulePartner(id: String, update: UpdatePlatformPartnerBody, appliedAt: Instant): SchedulePlatformPartnerResponse

주어진 아이디에 대응되는 파트너에 업데이트를 예약합니다.

Link copied to clipboard
@JvmName(name = "schedulePlatformPartnersSuspend")
suspend fun schedulePlatformPartners(filter: PlatformPartnerFilterInput? = null, update: SchedulePlatformPartnersBodyUpdate, appliedAt: Instant): SchedulePlatformPartnersResponse
Link copied to clipboard
@JvmName(name = "updatePlatformSuspend")
suspend fun updatePlatform(roundType: PlatformRoundType? = null, settlementFormula: UpdatePlatformBodySettlementFormula? = null, settlementRule: UpdatePlatformBodySettlementRule? = null): UpdatePlatformResponse

고객사의 플랫폼 관련 정보를 업데이트합니다. 요청된 Authorization header 를 통해 자동으로 요청자의 고객사를 특정합니다.

Link copied to clipboard
@JvmName(name = "updatePlatformSettingSuspend")
suspend fun updatePlatformSetting(defaultWithdrawalMemo: String? = null, defaultDepositMemo: String? = null): UpdatePlatformSettingResponse

플랫폼 설정 업데이트