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

Package-level declarations

Types

CreatePaymentScheduleResponse

@Serializable

data class CreatePaymentScheduleResponse(val schedule: PaymentScheduleSummary)

결제 예약 성공 응답

FailedPaymentSchedule

@Serializable

@SerialName(value = "FAILED")

data class FailedPaymentSchedule(val id: String, val merchantId: String, val storeId: String, val paymentId: String, val billingKey: String, val orderName: String, val isCulturalExpense: Boolean, val isEscrow: Boolean, val customer: Customer, val customData: String, val totalAmount: Long, val currency: Currency, val createdAt: @Serializable(with = InstantSerializer::class) Instant, val timeToPay: @Serializable(with = InstantSerializer::class) Instant, val startedAt: @Serializable(with = InstantSerializer::class) Instant, val completedAt: @Serializable(with = InstantSerializer::class) Instant, val taxFreeAmount: Long? = null, val vatAmount: Long? = null, val installmentMonth: Int? = null, val noticeUrls: List<String>? = null, val products: List<PaymentProduct>? = null) : PaymentSchedule

결제 실패 상태

GetPaymentSchedulesResponse

@Serializable

data class GetPaymentSchedulesResponse(val items: List<PaymentSchedule>, val page: PageInfo)

결제 예약 다건 조회 성공 응답 정보

PaymentSchedule

@Serializable

sealed interface PaymentSchedule

결제 예약 건

PaymentScheduleClient

class PaymentScheduleClient

PaymentScheduleFilterInput

@Serializable

data class PaymentScheduleFilterInput(val storeId: String? = null, val billingKey: String? = null, val from: @Serializable(with = InstantSerializer::class) Instant? = null, val until: @Serializable(with = InstantSerializer::class) Instant? = null, val status: List<PaymentScheduleStatus>? = null)

결제 예약 건 다건 조회를 위한 입력 정보

PaymentScheduleSortBy

@Serializable

enum PaymentScheduleSortBy : Enum<PaymentScheduleSortBy>

결제 예약 건 정렬 기준

PaymentScheduleSortInput

@Serializable

data class PaymentScheduleSortInput(val by: PaymentScheduleSortBy? = null, val order: SortOrder? = null)

결제 예약 건 다건 조회 시 정렬 조건

PaymentScheduleStatus

@Serializable

enum PaymentScheduleStatus : Enum<PaymentScheduleStatus>

결제 예약 건 상태

PaymentScheduleSummary

@Serializable

data class PaymentScheduleSummary(val id: String)

결제 예약 건

PendingPaymentSchedule

@Serializable

@SerialName(value = "PENDING")

data class PendingPaymentSchedule(val id: String, val merchantId: String, val storeId: String, val paymentId: String, val billingKey: String, val orderName: String, val isCulturalExpense: Boolean, val isEscrow: Boolean, val customer: Customer, val customData: String, val totalAmount: Long, val currency: Currency, val createdAt: @Serializable(with = InstantSerializer::class) Instant, val timeToPay: @Serializable(with = InstantSerializer::class) Instant, val startedAt: @Serializable(with = InstantSerializer::class) Instant, val completedAt: @Serializable(with = InstantSerializer::class) Instant, val taxFreeAmount: Long? = null, val vatAmount: Long? = null, val installmentMonth: Int? = null, val noticeUrls: List<String>? = null, val products: List<PaymentProduct>? = null) : PaymentSchedule

결제 완료 대기 상태

RevokedPaymentSchedule

@Serializable

@SerialName(value = "REVOKED")

data class RevokedPaymentSchedule(val id: String, val merchantId: String, val storeId: String, val paymentId: String, val billingKey: String, val orderName: String, val isCulturalExpense: Boolean, val isEscrow: Boolean, val customer: Customer, val customData: String, val totalAmount: Long, val currency: Currency, val createdAt: @Serializable(with = InstantSerializer::class) Instant, val timeToPay: @Serializable(with = InstantSerializer::class) Instant, val revokedAt: @Serializable(with = InstantSerializer::class) Instant, val taxFreeAmount: Long? = null, val vatAmount: Long? = null, val installmentMonth: Int? = null, val noticeUrls: List<String>? = null, val products: List<PaymentProduct>? = null) : PaymentSchedule

결제 예약 취소 상태

RevokePaymentSchedulesResponse

@Serializable

data class RevokePaymentSchedulesResponse(val revokedScheduleIds: List<String>, val revokedAt: @Serializable(with = InstantSerializer::class) Instant? = null)

결제 예약 건 취소 성공 응답

ScheduledPaymentSchedule

@Serializable

@SerialName(value = "SCHEDULED")

data class ScheduledPaymentSchedule(val id: String, val merchantId: String, val storeId: String, val paymentId: String, val billingKey: String, val orderName: String, val isCulturalExpense: Boolean, val isEscrow: Boolean, val customer: Customer, val customData: String, val totalAmount: Long, val currency: Currency, val createdAt: @Serializable(with = InstantSerializer::class) Instant, val timeToPay: @Serializable(with = InstantSerializer::class) Instant, val taxFreeAmount: Long? = null, val vatAmount: Long? = null, val installmentMonth: Int? = null, val noticeUrls: List<String>? = null, val products: List<PaymentProduct>? = null) : PaymentSchedule

결제 예약 완료 상태

StartedPaymentSchedule

@Serializable

@SerialName(value = "STARTED")

data class StartedPaymentSchedule(val id: String, val merchantId: String, val storeId: String, val paymentId: String, val billingKey: String, val orderName: String, val isCulturalExpense: Boolean, val isEscrow: Boolean, val customer: Customer, val customData: String, val totalAmount: Long, val currency: Currency, val createdAt: @Serializable(with = InstantSerializer::class) Instant, val timeToPay: @Serializable(with = InstantSerializer::class) Instant, val startedAt: @Serializable(with = InstantSerializer::class) Instant, val taxFreeAmount: Long? = null, val vatAmount: Long? = null, val installmentMonth: Int? = null, val noticeUrls: List<String>? = null, val products: List<PaymentProduct>? = null) : PaymentSchedule

결제 시작 상태

SucceededPaymentSchedule

@Serializable

@SerialName(value = "SUCCEEDED")

data class SucceededPaymentSchedule(val id: String, val merchantId: String, val storeId: String, val paymentId: String, val billingKey: String, val orderName: String, val isCulturalExpense: Boolean, val isEscrow: Boolean, val customer: Customer, val customData: String, val totalAmount: Long, val currency: Currency, val createdAt: @Serializable(with = InstantSerializer::class) Instant, val timeToPay: @Serializable(with = InstantSerializer::class) Instant, val startedAt: @Serializable(with = InstantSerializer::class) Instant, val completedAt: @Serializable(with = InstantSerializer::class) Instant, val taxFreeAmount: Long? = null, val vatAmount: Long? = null, val installmentMonth: Int? = null, val noticeUrls: List<String>? = null, val products: List<PaymentProduct>? = null) : PaymentSchedule

결제 성공 상태