PortOne Server SDK for JVM/io.portone.sdk.server.payment.billingkey/BillingKeyClient

BillingKeyClient

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

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Parameters

apiSecret

포트원 API Secret입니다.

apiBase

포트원 REST API 주소입니다. 기본값은 "https://api.portone.io"입니다.

storeId

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

Constructors

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

Functions

Link copied to clipboard
open override fun close()
Link copied to clipboard
@JvmName(name = "deleteBillingKeySuspend")
suspend fun deleteBillingKey(billingKey: String, reason: String? = null): DeleteBillingKeyResponse

빌링키 삭제

Link copied to clipboard
@JvmName(name = "getBillingKeyInfoSuspend")
suspend fun getBillingKeyInfo(billingKey: String): BillingKeyInfo

빌링키 단건 조회

Link copied to clipboard
@JvmName(name = "getBillingKeyInfosSuspend")
suspend fun getBillingKeyInfos(page: PageInput? = null, sort: BillingKeySortInput? = null, filter: BillingKeyFilterInput? = null): GetBillingKeyInfosResponse

빌링키 다건 조회

Link copied to clipboard
@JvmName(name = "issueBillingKeySuspend")
suspend fun issueBillingKey(method: InstantBillingKeyPaymentMethodInput, channelKey: String? = null, channelGroupId: String? = null, customer: CustomerInput? = null, customData: String? = null, bypass: JsonObject? = null, noticeUrls: List<String>? = null): IssueBillingKeyResponse

빌링키 발급