CounterpartyClient

class CounterpartyClient(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 = "createB2bCounterpartySuspend")
suspend fun createB2bCounterparty(test: Boolean? = null, counterpartyId: String? = null, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions? = null): CreateB2bCounterpartyResponse

거래처 생성

Link copied to clipboard
@JvmName(name = "deleteB2bCounterpartySuspend")
suspend fun deleteB2bCounterparty(counterpartyId: String, test: Boolean? = null): DeleteB2bCounterpartyResponse

거래처 삭제

Link copied to clipboard
@JvmName(name = "getB2bCounterpartiesSuspend")
suspend fun getB2bCounterparties(test: Boolean? = null, page: PageInput? = null, filter: B2bCounterpartyFilter? = null): GetB2bCounterpartiesResponse

거래처 검색

Link copied to clipboard
@JvmName(name = "getB2bCounterpartySuspend")
suspend fun getB2bCounterparty(counterpartyId: String, test: Boolean? = null): B2bCounterparty

거래처 조회

Link copied to clipboard
@JvmName(name = "getB2bCounterpartyCertificateSuspend")
suspend fun getB2bCounterpartyCertificate(brn: String, test: Boolean? = null): B2bCertificate

인증서 조회

@JvmName(name = "getB2bCounterpartyCertificateRegistrationUrlSuspend")
suspend fun getB2bCounterpartyCertificateRegistrationUrl(brn: String, test: Boolean? = null): GetB2bCounterpartyCertificateRegistrationUrlResponse

사업자 인증서 등록 URL 조회

Link copied to clipboard
@JvmName(name = "updateB2bCounterpartySuspend")
suspend fun updateB2bCounterparty(counterpartyId: String, test: Boolean? = null, counterparty: B2bCounterpartyInput, options: B2bCounterpartyCreateOptions? = null): UpdateB2bCounterpartyResponse

거래처 정보 수정

Link copied to clipboard
@JvmName(name = "validateB2bCounterpartyCertificateSuspend")
suspend fun validateB2bCounterpartyCertificate(brn: String, test: Boolean? = null): ValidateB2bCounterpartyCertificateResponse

사업자 인증서 유효성 검증