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

CashReceiptClient

final class CashReceiptClient 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
CancelCashReceiptResponse
cancelCashReceiptByPaymentId(string|null $paymentId = null, string|null $storeId = null)

현금 영수증 취소 기능입니다.

Future
cancelCashReceiptByPaymentIdAsync(string|null $paymentId = null, string|null $storeId = null)

현금 영수증 취소 기능입니다.

CashReceipt
getCashReceiptByPaymentId(string|null $paymentId = null, string|null $storeId = null)

현금 영수증 단건 조회 기능입니다.

Future
getCashReceiptByPaymentIdAsync(string|null $paymentId = null, string|null $storeId = null)

현금 영수증 단건 조회 기능입니다.

GetCashReceiptsResponse
getCashReceipts(array|null $page = null, array|null $sort = null, array|null $filter = null)

현금영수증 다건 조회 기능입니다.

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

현금영수증 다건 조회 기능입니다.

IssueCashReceiptResponse
issueCashReceipt(string|null $paymentId = null, string|null $channelKey = null, string|null $type = null, string|null $orderName = null, string|null $currency = null, array|null $amount = null, string|null $productType = null, array|null $customer = null, string|null $paidAt = null, string|null $businessRegistrationNumber = null, string|null $paymentMethod = null, string|null $storeId = null)

현금 영수증 수동 발급 기능입니다.

Future
issueCashReceiptAsync(string|null $paymentId = null, string|null $channelKey = null, string|null $type = null, string|null $orderName = null, string|null $currency = null, array|null $amount = null, string|null $productType = null, array|null $customer = null, string|null $paidAt = null, string|null $businessRegistrationNumber = null, string|null $paymentMethod = 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 22
CancelCashReceiptResponse cancelCashReceiptByPaymentId(string|null $paymentId = null, string|null $storeId = null)

현금 영수증 취소 기능입니다.

현금 영수증 취소를 요청합니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $storeId

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

Return Value

CancelCashReceiptResponse

at line 35
Future cancelCashReceiptByPaymentIdAsync(string|null $paymentId = null, string|null $storeId = null)

현금 영수증 취소 기능입니다.

현금 영수증 취소를 요청합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $storeId

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

Return Value

Future

at line 47
CashReceipt getCashReceiptByPaymentId(string|null $paymentId = null, string|null $storeId = null)

현금 영수증 단건 조회 기능입니다.

주어진 결제 아이디에 대응되는 현금 영수증 내역을 조회합니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $storeId

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

Return Value

CashReceipt

at line 60
Future getCashReceiptByPaymentIdAsync(string|null $paymentId = null, string|null $storeId = null)

현금 영수증 단건 조회 기능입니다.

주어진 결제 아이디에 대응되는 현금 영수증 내역을 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $storeId

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

Return Value

Future

at line 73
GetCashReceiptsResponse getCashReceipts(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: ISSUED_AT, sortOrder: DESC 으로 기본값이 적용됩니다.
array|null $filter

현금영수증 다건 조회를 위한 입력 정보

Return Value

GetCashReceiptsResponse

at line 87
Future getCashReceiptsAsync(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: ISSUED_AT, sortOrder: DESC 으로 기본값이 적용됩니다.
array|null $filter

현금영수증 다건 조회를 위한 입력 정보

Return Value

Future

at line 109
IssueCashReceiptResponse issueCashReceipt(string|null $paymentId = null, string|null $channelKey = null, string|null $type = null, string|null $orderName = null, string|null $currency = null, array|null $amount = null, string|null $productType = null, array|null $customer = null, string|null $paidAt = null, string|null $businessRegistrationNumber = null, string|null $paymentMethod = null, string|null $storeId = null)

현금 영수증 수동 발급 기능입니다.

현금 영수증 발급을 요청합니다.

Parameters

string|null $paymentId

결제 건 아이디: 외부 결제 건에 대한 수동 발급의 경우, 아이디를 직접 채번하여 입력합니다.
string|null $channelKey

채널 키
string|null $type

발급 유형
string|null $orderName 주문명
string|null $currency 통화
array|null $amount

금액 세부 입력 정보
string|null $productType

상품 유형
array|null $customer

현금영수증 발급 시 고객 관련 입력 정보
string|null $paidAt

결제 일자
string|null $businessRegistrationNumber

사업자등록번호: 웰컴페이먼츠의 경우에만 입력합니다.
string|null $paymentMethod

현금영수증 발급 가능 결제 수단: 웰컴페이먼츠의 경우에만 입력합니다.
string|null $storeId

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

Return Value

IssueCashReceiptResponse

at line 132
Future issueCashReceiptAsync(string|null $paymentId = null, string|null $channelKey = null, string|null $type = null, string|null $orderName = null, string|null $currency = null, array|null $amount = null, string|null $productType = null, array|null $customer = null, string|null $paidAt = null, string|null $businessRegistrationNumber = null, string|null $paymentMethod = null, string|null $storeId = null)

현금 영수증 수동 발급 기능입니다.

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

Parameters

string|null $paymentId

결제 건 아이디: 외부 결제 건에 대한 수동 발급의 경우, 아이디를 직접 채번하여 입력합니다.
string|null $channelKey

채널 키
string|null $type

발급 유형
string|null $orderName 주문명
string|null $currency 통화
array|null $amount

금액 세부 입력 정보
string|null $productType

상품 유형
array|null $customer

현금영수증 발급 시 고객 관련 입력 정보
string|null $paidAt

결제 일자
string|null $businessRegistrationNumber

사업자등록번호: 웰컴페이먼츠의 경우에만 입력합니다.
string|null $paymentMethod

현금영수증 발급 가능 결제 수단: 웰컴페이먼츠의 경우에만 입력합니다.
string|null $storeId

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

Return Value

Future