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

Package-level declarations

Types

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

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

BillingKeyDeleteRequester

@Serializable(with = BillingKeyDeleteRequesterSerializer::class)

sealed interface BillingKeyDeleteRequester

빌링키 삭제 요청 주체

BillingKeyDeleteRequesterSerializer

object BillingKeyDeleteRequesterSerializer : KSerializer<BillingKeyDeleteRequester>

BillingKeyFailure

@Serializable

data class BillingKeyFailure(val message: String? = null, val pgCode: String? = null, val pgMessage: String? = null, val failedAt: @Serializable(with = InstantSerializer::class) Instant)

발급 실패 상세 정보

BillingKeyFilterInput

@Serializable

data class BillingKeyFilterInput(val storeId: String? = null, val timeRangeField: BillingKeyTimeRangeField? = null, val from: @Serializable(with = InstantSerializer::class) Instant? = null, val until: @Serializable(with = InstantSerializer::class) Instant? = null, val status: List<BillingKeyStatus>? = null, val channelGroupIds: List<String>? = null, val customerId: String? = null, val platformType: PaymentClientType? = null, val textSearch: BillingKeyTextSearch? = null, val pgProviders: List<PgProvider>? = null, val pgCompanies: List<PgCompany>? = null, val methods: List<BillingKeyPaymentMethodType>? = null, val version: PortOneVersion? = null)

빌링키 다건 조회를 위한 입력 정보

BillingKeyInfo

@Serializable(with = BillingKeyInfoSerializer::class)

sealed interface BillingKeyInfo

빌링키 정보

BillingKeyInfoSerializer

object BillingKeyInfoSerializer : JsonContentPolymorphicSerializer<BillingKeyInfo>

BillingKeyInfoSummary

@Serializable

data class BillingKeyInfoSummary(val billingKey: String, val channels: List<SelectedChannel>? = null, val issuedAt: @Serializable(with = InstantSerializer::class) Instant)

BillingKeyPaymentMethod

@Serializable(with = BillingKeyPaymentMethodSerializer::class)

sealed interface BillingKeyPaymentMethod

빌링키 발급 수단 정보

BillingKeyPaymentMethodCard

@Serializable

@SerialName(value = "BillingKeyPaymentMethodCard")

data class BillingKeyPaymentMethodCard(val card: Card? = null) : BillingKeyPaymentMethod.Recognized, BillingKeyPaymentMethodEasyPayMethod.Recognized

카드 정보

BillingKeyPaymentMethodEasyPay

@Serializable

@SerialName(value = "BillingKeyPaymentMethodEasyPay")

data class BillingKeyPaymentMethodEasyPay(val provider: EasyPayProvider? = null, val method: BillingKeyPaymentMethodEasyPayMethod? = null) : BillingKeyPaymentMethod.Recognized

간편 결제 정보

BillingKeyPaymentMethodEasyPayCharge

@Serializable

@SerialName(value = "BillingKeyPaymentMethodEasyPayCharge")

data object BillingKeyPaymentMethodEasyPayCharge : BillingKeyPaymentMethodEasyPayMethod.Recognized

충전식 포인트 결제 정보

BillingKeyPaymentMethodEasyPayMethod

@Serializable(with = BillingKeyPaymentMethodEasyPayMethodSerializer::class)

sealed interface BillingKeyPaymentMethodEasyPayMethod

간편 결제 수단

BillingKeyPaymentMethodEasyPayMethodSerializer

object BillingKeyPaymentMethodEasyPayMethodSerializer : JsonContentPolymorphicSerializer<BillingKeyPaymentMethodEasyPayMethod>

BillingKeyPaymentMethodMobile

@Serializable

@SerialName(value = "BillingKeyPaymentMethodMobile")

data class BillingKeyPaymentMethodMobile(val phoneNumber: String? = null) : BillingKeyPaymentMethod.Recognized

모바일 정보

BillingKeyPaymentMethodPaypal

@Serializable

@SerialName(value = "BillingKeyPaymentMethodPaypal")

data object BillingKeyPaymentMethodPaypal : BillingKeyPaymentMethod.Recognized

페이팔 정보

BillingKeyPaymentMethodSerializer

object BillingKeyPaymentMethodSerializer : JsonContentPolymorphicSerializer<BillingKeyPaymentMethod>

BillingKeyPaymentMethodTransfer

@Serializable

@SerialName(value = "BillingKeyPaymentMethodTransfer")

data class BillingKeyPaymentMethodTransfer(val bank: Bank? = null, val accountNumber: String? = null) : BillingKeyPaymentMethod.Recognized, BillingKeyPaymentMethodEasyPayMethod.Recognized

계좌이체 정보

BillingKeyPaymentMethodType

@Serializable(with = BillingKeyPaymentMethodTypeSerializer::class)

sealed interface BillingKeyPaymentMethodType

빌링키 결제 수단

BillingKeyPaymentMethodTypeSerializer

object BillingKeyPaymentMethodTypeSerializer : KSerializer<BillingKeyPaymentMethodType>

BillingKeySortBy

@Serializable(with = BillingKeySortBySerializer::class)

sealed interface BillingKeySortBy

빌링키 정렬 기준

BillingKeySortBySerializer

object BillingKeySortBySerializer : KSerializer<BillingKeySortBy>

BillingKeySortInput

@Serializable

data class BillingKeySortInput(val by: BillingKeySortBy? = null, val order: SortOrder? = null)

빌링키 다건 조회 시 정렬 조건

BillingKeyStatus

@Serializable(with = BillingKeyStatusSerializer::class)

sealed interface BillingKeyStatus

빌링키 상태

BillingKeyStatusSerializer

object BillingKeyStatusSerializer : KSerializer<BillingKeyStatus>

BillingKeyTextSearch

@Serializable

data class BillingKeyTextSearch(val field: BillingKeyTextSearchField, val value: String)

통합검색 입력 정보

BillingKeyTextSearchField

@Serializable(with = BillingKeyTextSearchFieldSerializer::class)

sealed interface BillingKeyTextSearchField

통합검색 항목

BillingKeyTextSearchFieldSerializer

object BillingKeyTextSearchFieldSerializer : KSerializer<BillingKeyTextSearchField>

BillingKeyTimeRangeField

@Serializable(with = BillingKeyTimeRangeFieldSerializer::class)

sealed interface BillingKeyTimeRangeField

빌링키 다건 조회 시, 시각 범위를 적용할 필드

BillingKeyTimeRangeFieldSerializer

object BillingKeyTimeRangeFieldSerializer : KSerializer<BillingKeyTimeRangeField>

ChannelSpecificFailure

@Serializable(with = ChannelSpecificFailureSerializer::class)

sealed interface ChannelSpecificFailure

ChannelSpecificFailureInvalidRequest

@Serializable

@SerialName(value = "INVALID_REQUEST")

data class ChannelSpecificFailureInvalidRequest(val channel: SelectedChannel, val message: String? = null) : ChannelSpecificFailure.Recognized

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

ChannelSpecificFailurePgProvider

@Serializable

@SerialName(value = "PG_PROVIDER")

data class ChannelSpecificFailurePgProvider(val channel: SelectedChannel, val message: String? = null, val pgCode: String, val pgMessage: String) : ChannelSpecificFailure.Recognized

PG사에서 오류를 전달한 경우

ChannelSpecificFailureSerializer

object ChannelSpecificFailureSerializer : JsonContentPolymorphicSerializer<ChannelSpecificFailure>

ConfirmedBillingKeyIssueAndPaySummary

@Serializable

data class ConfirmedBillingKeyIssueAndPaySummary(val billingKey: String, val paymentId: String)

빌링키 발급 및 초회 결제 수동 승인 완료 응답

ConfirmedBillingKeySummary

@Serializable

data class ConfirmedBillingKeySummary(val billingKey: String)

빌링키 발급 수동 승인 완료 응답

DeleteBillingKeyResponse

@Serializable

data class DeleteBillingKeyResponse(val deletedAt: @Serializable(with = InstantSerializer::class) Instant)

빌링키 삭제 성공 응답

DeletedBillingKeyInfo

@Serializable

@SerialName(value = "DELETED")

data class DeletedBillingKeyInfo(val billingKey: String, val merchantId: String, val storeId: String, val methods: List<BillingKeyPaymentMethod>? = null, val channels: List<SelectedChannel>, val customer: Customer, val customData: String? = null, val issueId: String? = null, val issueName: String? = null, val requestedAt: @Serializable(with = InstantSerializer::class) Instant? = null, val issuedAt: @Serializable(with = InstantSerializer::class) Instant, val channelGroup: ChannelGroupSummary? = null, val pgBillingKeyIssueResponses: List<PgBillingKeyIssueResponse>? = null, val deletedAt: @Serializable(with = InstantSerializer::class) Instant) : BillingKeyInfo.Recognized

빌링키 삭제 완료 상태 건

FailedPgBillingKeyIssueResponse

@Serializable

@SerialName(value = "FAILED")

data class FailedPgBillingKeyIssueResponse(val channel: SelectedChannel, val failure: BillingKeyFailure) : PgBillingKeyIssueResponse.Recognized

빌링키 발급 실패 채널 응답

GetBillingKeyInfosResponse

@Serializable

data class GetBillingKeyInfosResponse(val items: List<BillingKeyInfo>, val page: PageInfo)

빌링키 다건 조회 성공 응답 정보

InstantBillingKeyPaymentMethodInput

@Serializable

data class InstantBillingKeyPaymentMethodInput(val card: InstantBillingKeyPaymentMethodInputCard? = null)

빌링키 발급 시 결제 수단 입력 양식

InstantBillingKeyPaymentMethodInputCard

@Serializable

data class InstantBillingKeyPaymentMethodInputCard(val credential: CardCredential)

카드 수단 정보 입력 양식

IssueBillingKeyResponse

@Serializable

data class IssueBillingKeyResponse(val billingKeyInfo: BillingKeyInfoSummary, val channelSpecificFailures: List<ChannelSpecificFailure>? = null)

빌링키 발급 성공 응답

IssuedBillingKeyInfo

@Serializable

@SerialName(value = "ISSUED")

data class IssuedBillingKeyInfo(val billingKey: String, val merchantId: String, val storeId: String, val methods: List<BillingKeyPaymentMethod>? = null, val channels: List<SelectedChannel>, val customer: Customer, val customData: String? = null, val issueId: String? = null, val issueName: String? = null, val requestedAt: @Serializable(with = InstantSerializer::class) Instant? = null, val issuedAt: @Serializable(with = InstantSerializer::class) Instant, val channelGroup: ChannelGroupSummary? = null, val pgBillingKeyIssueResponses: List<PgBillingKeyIssueResponse>? = null) : BillingKeyInfo.Recognized

빌링키 발급 완료 상태 건

IssuedPgBillingKeyIssueResponse

@Serializable

@SerialName(value = "ISSUED")

data class IssuedPgBillingKeyIssueResponse(val channel: SelectedChannel, val pgTxId: String? = null, val method: BillingKeyPaymentMethod? = null) : PgBillingKeyIssueResponse.Recognized

빌링키 발급 성공 채널 응답

PgBillingKeyIssueResponse

@Serializable(with = PgBillingKeyIssueResponseSerializer::class)

sealed interface PgBillingKeyIssueResponse

채널 별 빌링키 발급 응답

PgBillingKeyIssueResponseSerializer

object PgBillingKeyIssueResponseSerializer : JsonContentPolymorphicSerializer<PgBillingKeyIssueResponse>