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

CashReceiptClient

class CashReceiptClient(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
@JvmName(name = "cancelCashReceiptByPaymentIdSuspend")
suspend fun cancelCashReceiptByPaymentId(paymentId: String): CancelCashReceiptResponse

현금 영수증 취소

Link copied to clipboard
open override fun close()
Link copied to clipboard
@JvmName(name = "getCashReceiptByPaymentIdSuspend")
suspend fun getCashReceiptByPaymentId(paymentId: String): CashReceipt

현금 영수증 단건 조회

Link copied to clipboard
@JvmName(name = "getCashReceiptsSuspend")
suspend fun getCashReceipts(page: PageInput? = null, sort: CashReceiptSortInput? = null, filter: CashReceiptFilterInput? = null): GetCashReceiptsResponse

현금영수증 다건 조회

Link copied to clipboard
@JvmName(name = "issueCashReceiptSuspend")
suspend fun issueCashReceipt(paymentId: String, channelKey: String, type: CashReceiptType, orderName: String, currency: Currency, amount: PaymentAmountInput, productType: PaymentProductType? = null, customer: IssueCashReceiptCustomerInput, paidAt: Instant? = null, businessRegistrationNumber: String? = null, paymentMethod: IssueCashReceiptPaymentMethodType? = null): IssueCashReceiptResponse

현금 영수증 수동 발급