1. class
  2. Cable8mm
  3. \
  4. PortonePhp
  5. \
  6. Client
  7. \
  8. BillingKeyClient

BillingKeyClient

final class BillingKeyClient extends AbstractClient (View source)

빌링키 API 작업을 제공합니다.

Properties

protected RequestExecutor $executor from  AbstractClient

Methods

__construct(string $apiSecret, RequestExecutor|null $executor = null)

PortOne API Secret과 선택적으로 전달된 공용 요청 실행기로 클라이언트를 초기화합니다.

from  AbstractClient
array
__debugInfo()

인증 정보가 디버그 출력에 노출되지 않도록 빈 정보를 반환합니다.

from  AbstractClient
array
__serialize()

인증 정보가 직렬화되어 노출되지 않도록 직렬화를 거부합니다.

from  AbstractClient
void
__unserialize(array $data)

인증 정보가 포함된 객체의 역직렬화를 거부합니다.

from  AbstractClient
RequestExecutor
createExecutor(string $apiSecret)

No description

from  AbstractClient
object
callOperation(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

from  AbstractClient
Future
callOperationAsync(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

from  AbstractClient
object
callOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
Future
callOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
object
callOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
Future
callOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
string
callStringOperation(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
Future
callStringOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
string
callStringOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
Future
callStringOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
void
callUnitOperation(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
Future
callUnitOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
void
callUnitOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
Future
callUnitOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
void
callUnitOperationWithQuery(string $operation, string $method, string $path, array $query)

No description

from  AbstractClient
Future
callUnitOperationWithQueryAsync(string $operation, string $method, string $path, array $query)

No description

from  AbstractClient
ConfirmedBillingKeySummary
confirmBillingKey(string|null $billingIssueToken = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 수동 승인 기능입니다.

Future
confirmBillingKeyAsync(string|null $billingIssueToken = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 수동 승인 기능입니다.

ConfirmedBillingKeyIssueAndPaySummary
confirmBillingKeyIssueAndPay(string|null $billingIssueToken = null, string|null $paymentId = null, string|null $currency = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 및 초회 결제 수동 승인 기능입니다.

Future
confirmBillingKeyIssueAndPayAsync(string|null $billingIssueToken = null, string|null $paymentId = null, string|null $currency = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 및 초회 결제 수동 승인 기능입니다.

DeleteBillingKeyResponse
deleteBillingKey(string|null $billingKey = null, string|null $reason = null, string|null $requester = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 삭제 기능입니다.

Future
deleteBillingKeyAsync(string|null $billingKey = null, string|null $reason = null, string|null $requester = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 삭제 기능입니다.

BillingKeyInfo
getBillingKeyInfo(string|null $billingKey = null, string|null $storeId = null)

빌링키 단건 조회 기능입니다.

Future
getBillingKeyInfoAsync(string|null $billingKey = null, string|null $storeId = null)

빌링키 단건 조회 기능입니다.

GetBillingKeyInfosResponse
getBillingKeyInfos(array|null $page = null, array|null $sort = null, array|null $filter = null)

빌링키 다건 조회 기능입니다.

Future
getBillingKeyInfosAsync(array|null $page = null, array|null $sort = null, array|null $filter = null)

빌링키 다건 조회 기능입니다.

IssueBillingKeyResponse
issueBillingKey(array|null $method = null, string|null $channelKey = null, string|null $channelGroupId = null, array|null $customer = null, string|null $customData = null, array|null $bypass = null, array|null $noticeUrls = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 기능입니다.

Future
issueBillingKeyAsync(array|null $method = null, string|null $channelKey = null, string|null $channelGroupId = null, array|null $customer = null, string|null $customData = null, array|null $bypass = null, array|null $noticeUrls = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 기능입니다.

Details

in AbstractClient at line 31
__construct(string $apiSecret, RequestExecutor|null $executor = null)

PortOne API Secret과 선택적으로 전달된 공용 요청 실행기로 클라이언트를 초기화합니다.

Parameters

string $apiSecret

PortOne V2 API 요청 인증에 사용하는 API Secret입니다.
RequestExecutor|null $executor

부모 클라이언트와 공유하는 요청 실행기입니다.

in AbstractClient at line 39
array __debugInfo()

인증 정보가 디버그 출력에 노출되지 않도록 빈 정보를 반환합니다.

Return Value

array

in AbstractClient at line 50
array __serialize()

인증 정보가 직렬화되어 노출되지 않도록 직렬화를 거부합니다.

Return Value

array

in AbstractClient at line 58
void __unserialize(array $data)

인증 정보가 포함된 객체의 역직렬화를 거부합니다.

Parameters

array $data

Return Value

void

in AbstractClient at line 63
protected RequestExecutor createExecutor(string $apiSecret)

No description

Parameters

string $apiSecret

Return Value

RequestExecutor

in AbstractClient at line 72
protected object callOperation(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

Parameters

string $operation
string $method
string $path
array $parameters
string $responseClass
bool $requestBody

Return Value

object

in AbstractClient at line 91
protected Future callOperationAsync(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

Parameters

string $operation
string $method
string $path
array $parameters
string $responseClass
bool $requestBody

Return Value

Future

in AbstractClient at line 116
protected object callOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

object

in AbstractClient at line 136
protected Future callOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

Future

in AbstractClient at line 161
protected object callOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

object

in AbstractClient at line 181
protected Future callOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

Future

in AbstractClient at line 202
protected string callStringOperation(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

string

in AbstractClient at line 213
protected Future callStringOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

Future

in AbstractClient at line 230
protected string callStringOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

string

in AbstractClient at line 239
protected Future callStringOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

Future

in AbstractClient at line 245
protected void callUnitOperation(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

void

in AbstractClient at line 251
protected Future callUnitOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

Future

in AbstractClient at line 268
protected void callUnitOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

void

in AbstractClient at line 277
protected Future callUnitOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

Future

in AbstractClient at line 283
protected void callUnitOperationWithQuery(string $operation, string $method, string $path, array $query)

No description

Parameters

string $operation
string $method
string $path
array $query

Return Value

void

in AbstractClient at line 289
protected Future callUnitOperationWithQueryAsync(string $operation, string $method, string $path, array $query)

No description

Parameters

string $operation
string $method
string $path
array $query

Return Value

Future

at line 24
ConfirmedBillingKeySummary confirmBillingKey(string|null $billingIssueToken = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 수동 승인 기능입니다.

수동 승인으로 설정된 빌링키 발급에 대해, 빌링키 발급을 완료 처리합니다.

Parameters

string|null $billingIssueToken

빌링키 발급 토큰: 빌링키 발급 요청 완료 시 발급된 토큰입니다.
bool|null $isTest

테스트 결제 여부: 검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다.
bool|null $skipWebhook

웹훅 생략 여부: 빌링키 발급이 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

ConfirmedBillingKeySummary

at line 39
Future confirmBillingKeyAsync(string|null $billingIssueToken = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 수동 승인 기능입니다.

수동 승인으로 설정된 빌링키 발급에 대해, 빌링키 발급을 완료 처리합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $billingIssueToken

빌링키 발급 토큰: 빌링키 발급 요청 완료 시 발급된 토큰입니다.
bool|null $isTest

테스트 결제 여부: 검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다.
bool|null $skipWebhook

웹훅 생략 여부: 빌링키 발급이 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 57
ConfirmedBillingKeyIssueAndPaySummary confirmBillingKeyIssueAndPay(string|null $billingIssueToken = null, string|null $paymentId = null, string|null $currency = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 및 초회 결제 수동 승인 기능입니다.

수동 승인으로 설정된 빌링키 발급 및 초회 결제에 대해, 빌링키 발급과 결제를 완료 처리합니다.

Parameters

string|null $billingIssueToken

빌링키 발급 토큰: 빌링키 발급 및 초회 결제 요청 완료 시 발급된 토큰입니다.
string|null $paymentId

검증용 파라미터로, 결제 건 아이디와 일치하지 않을 경우 오류가 반환됩니다.
string|null $currency

통화: 검증용 파라미터로, 결제 건 화폐와 일치하지 않을 경우 오류가 반환됩니다.
int|null $totalAmount

결제 금액: 검증용 파라미터로, 결제 건 총 금액과 일치하지 않을 경우 오류가 반환됩니다.
int|null $taxFreeAmount

검증용 파라미터로, 결제 건 면세 금액과 일치하지 않을 경우 오류가 반환됩니다.
bool|null $isTest

테스트 결제 여부: 검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다.
bool|null $skipWebhook

웹훅 생략 여부: 빌링키 발급 및 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

ConfirmedBillingKeyIssueAndPaySummary

at line 76
Future confirmBillingKeyIssueAndPayAsync(string|null $billingIssueToken = null, string|null $paymentId = null, string|null $currency = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 및 초회 결제 수동 승인 기능입니다.

수동 승인으로 설정된 빌링키 발급 및 초회 결제에 대해, 빌링키 발급과 결제를 완료 처리합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $billingIssueToken

빌링키 발급 토큰: 빌링키 발급 및 초회 결제 요청 완료 시 발급된 토큰입니다.
string|null $paymentId

검증용 파라미터로, 결제 건 아이디와 일치하지 않을 경우 오류가 반환됩니다.
string|null $currency

통화: 검증용 파라미터로, 결제 건 화폐와 일치하지 않을 경우 오류가 반환됩니다.
int|null $totalAmount

결제 금액: 검증용 파라미터로, 결제 건 총 금액과 일치하지 않을 경우 오류가 반환됩니다.
int|null $taxFreeAmount

검증용 파라미터로, 결제 건 면세 금액과 일치하지 않을 경우 오류가 반환됩니다.
bool|null $isTest

테스트 결제 여부: 검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다.
bool|null $skipWebhook

웹훅 생략 여부: 빌링키 발급 및 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 91
DeleteBillingKeyResponse deleteBillingKey(string|null $billingKey = null, string|null $reason = null, string|null $requester = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 삭제 기능입니다.

빌링키를 삭제합니다.

Parameters

string|null $billingKey

삭제할 빌링키
string|null $reason

네이버페이: 자동결제 해지 사유입니다. 명시가 필요합니다.
string|null $requester

네이버페이: 자동결제 해지 요청 주체입니다. 명시가 필요합니다.
bool|null $skipWebhook

웹훅 생략 여부: 빌링키 삭제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

DeleteBillingKeyResponse

at line 107
Future deleteBillingKeyAsync(string|null $billingKey = null, string|null $reason = null, string|null $requester = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 삭제 기능입니다.

빌링키를 삭제합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $billingKey

삭제할 빌링키
string|null $reason

네이버페이: 자동결제 해지 사유입니다. 명시가 필요합니다.
string|null $requester

네이버페이: 자동결제 해지 요청 주체입니다. 명시가 필요합니다.
bool|null $skipWebhook

웹훅 생략 여부: 빌링키 삭제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 119
BillingKeyInfo getBillingKeyInfo(string|null $billingKey = null, string|null $storeId = null)

빌링키 단건 조회 기능입니다.

주어진 빌링키에 대응되는 빌링키 정보를 조회합니다.

Parameters

string|null $billingKey

조회할 빌링키
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

BillingKeyInfo

at line 132
Future getBillingKeyInfoAsync(string|null $billingKey = null, string|null $storeId = null)

빌링키 단건 조회 기능입니다.

주어진 빌링키에 대응되는 빌링키 정보를 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $billingKey

조회할 빌링키
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 145
GetBillingKeyInfosResponse getBillingKeyInfos(array|null $page = null, array|null $sort = null, array|null $filter = null)

빌링키 다건 조회 기능입니다.

주어진 조건에 맞는 빌링키들을 페이지 기반으로 조회합니다.

Parameters

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보: 미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.
array|null $sort

빌링키 다건 조회 시 정렬 조건: 미 입력 시 sortBy: TIME_TO_PAY, sortOrder: DESC 으로 기본값이 적용됩니다.
array|null $filter

빌링키 다건 조회를 위한 입력 정보: V1 빌링키 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.

Return Value

GetBillingKeyInfosResponse

at line 159
Future getBillingKeyInfosAsync(array|null $page = null, array|null $sort = null, array|null $filter = null)

빌링키 다건 조회 기능입니다.

주어진 조건에 맞는 빌링키들을 페이지 기반으로 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보: 미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.
array|null $sort

빌링키 다건 조회 시 정렬 조건: 미 입력 시 sortBy: TIME_TO_PAY, sortOrder: DESC 으로 기본값이 적용됩니다.
array|null $filter

빌링키 다건 조회를 위한 입력 정보: V1 빌링키 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.

Return Value

Future

at line 178
IssueBillingKeyResponse issueBillingKey(array|null $method = null, string|null $channelKey = null, string|null $channelGroupId = null, array|null $customer = null, string|null $customData = null, array|null $bypass = null, array|null $noticeUrls = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 기능입니다.

빌링키 발급을 요청합니다.

Parameters

array|null $method

빌링키 발급 시 결제 수단 입력 양식: card를 반드시 입력해 주세요.
string|null $channelKey

채널 키 또는 채널 그룹 ID 필수
string|null $channelGroupId

채널 키 또는 채널 그룹 ID 필수
array|null $customer

고객 정보 입력 정보
string|null $customData

사용자 지정 데이터
array|null $bypass

PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
array|null $noticeUrls

빌링키 발급 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
bool|null $skipWebhook

웹훅 생략 여부: 빌링키 발급이 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

IssueBillingKeyResponse

at line 198
Future issueBillingKeyAsync(array|null $method = null, string|null $channelKey = null, string|null $channelGroupId = null, array|null $customer = null, string|null $customData = null, array|null $bypass = null, array|null $noticeUrls = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 발급 기능입니다.

빌링키 발급을 요청합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

array|null $method

빌링키 발급 시 결제 수단 입력 양식: card를 반드시 입력해 주세요.
string|null $channelKey

채널 키 또는 채널 그룹 ID 필수
string|null $channelGroupId

채널 키 또는 채널 그룹 ID 필수
array|null $customer

고객 정보 입력 정보
string|null $customData

사용자 지정 데이터
array|null $bypass

PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
array|null $noticeUrls

빌링키 발급 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
bool|null $skipWebhook

웹훅 생략 여부: 빌링키 발급이 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future