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

PgSpecificClient

final class PgSpecificClient extends AbstractClient (View source)

PG사별 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
GetKakaopayPaymentOrderResponse
getKakaopayPaymentOrder(string|null $pgTxId = null, string|null $channelKey = null)

카카오페이 주문 조회 API 기능입니다.

Future
getKakaopayPaymentOrderAsync(string|null $pgTxId = null, string|null $channelKey = null)

카카오페이 주문 조회 API 기능입니다.

ConfirmPaymentwallDeliveryResponse
confirmPaymentwallDelivery(string|null $transactionId = null, string|null $deliveryType = null, string|null $deliveryStatus = null, string|null $estimatedDeliveryDatetime = null, string|null $estimatedUpdateDatetime = null, string|null $reason = null, bool|null $refundable = null, string|null $details = null, string|null $shippingAddressEmail = null, string|null $carrierTrackingId = null, string|null $carrierType = null, string|null $shippingAddressCountry = null, string|null $shippingAddressCity = null, string|null $shippingAddressZip = null, string|null $shippingAddressState = null, string|null $shippingAddressStreet = null, string|null $shippingAddressPhone = null, string|null $shippingAddressFirstname = null, string|null $shippingAddressLastname = null, array|null $attachments = null)

페이먼트월 배송 정보 등록 기능입니다.

Future
confirmPaymentwallDeliveryAsync(string|null $transactionId = null, string|null $deliveryType = null, string|null $deliveryStatus = null, string|null $estimatedDeliveryDatetime = null, string|null $estimatedUpdateDatetime = null, string|null $reason = null, bool|null $refundable = null, string|null $details = null, string|null $shippingAddressEmail = null, string|null $carrierTrackingId = null, string|null $carrierType = null, string|null $shippingAddressCountry = null, string|null $shippingAddressCity = null, string|null $shippingAddressZip = null, string|null $shippingAddressState = null, string|null $shippingAddressStreet = null, string|null $shippingAddressPhone = null, string|null $shippingAddressFirstname = null, string|null $shippingAddressLastname = null, array|null $attachments = 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 23
GetKakaopayPaymentOrderResponse getKakaopayPaymentOrder(string|null $pgTxId = null, string|null $channelKey = null)

카카오페이 주문 조회 API 기능입니다.

주어진 아이디에 대응되는 카카오페이 주문 건을 조회합니다. 해당 API 사용이 필요한 경우 포트원 기술지원팀으로 문의 주시길 바랍니다.

Parameters

string|null $pgTxId

카카오페이 주문 번호 (tid)
string|null $channelKey

채널 키

Return Value

GetKakaopayPaymentOrderResponse

at line 37
Future getKakaopayPaymentOrderAsync(string|null $pgTxId = null, string|null $channelKey = null)

카카오페이 주문 조회 API 기능입니다.

주어진 아이디에 대응되는 카카오페이 주문 건을 조회합니다. 해당 API 사용이 필요한 경우 포트원 기술지원팀으로 문의 주시길 바랍니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $pgTxId

카카오페이 주문 번호 (tid)
string|null $channelKey

채널 키

Return Value

Future

at line 68
ConfirmPaymentwallDeliveryResponse confirmPaymentwallDelivery(string|null $transactionId = null, string|null $deliveryType = null, string|null $deliveryStatus = null, string|null $estimatedDeliveryDatetime = null, string|null $estimatedUpdateDatetime = null, string|null $reason = null, bool|null $refundable = null, string|null $details = null, string|null $shippingAddressEmail = null, string|null $carrierTrackingId = null, string|null $carrierType = null, string|null $shippingAddressCountry = null, string|null $shippingAddressCity = null, string|null $shippingAddressZip = null, string|null $shippingAddressState = null, string|null $shippingAddressStreet = null, string|null $shippingAddressPhone = null, string|null $shippingAddressFirstname = null, string|null $shippingAddressLastname = null, array|null $attachments = null)

페이먼트월 배송 정보 등록 기능입니다.

배송 정보를 페이먼트월에 등록합니다. 등록된 배송 정보는 차지백 발생 시 고객사의 상품 배송 완료 증빙 자료로 활용되므로, 반드시 연동해야 합니다.

Parameters

string|null $transactionId

결제 건 포트원 채번 아이디
string|null $deliveryType

페이먼트월 배송 유형
string|null $deliveryStatus

페이먼트월 배송 상태
string|null $estimatedDeliveryDatetime

배송 완료 예상 일시: 배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다.
string|null $estimatedUpdateDatetime

배송 상태 업데이트 예정 일시: 배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다.
string|null $reason

상태 변경 사유
bool|null $refundable

환불 가능 여부
string|null $details

상세 설명
string|null $shippingAddressEmail

고객 이메일 주소
string|null $carrierTrackingId

운송장 번호: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $carrierType

운송사 이름: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressCountry

국가: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressCity

수신자 도시: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressZip

수신자 우편번호: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressState

수신자 주: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressStreet

수신자 도로명 주소: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressPhone

수신자 전화번호: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressFirstname

수신자 이름: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressLastname

수신자 성: 배송 유형이 PHYSICAL인 경우 필수입니다.
array|null $attachments

배송 증빙 첨부 파일 URL 목록: 배송 증빙 자료의 URL(이미지 등)을 입력합니다. 증빙 자료를 제공하기 어려운 경우 생략할 수 있습니다.

Return Value

ConfirmPaymentwallDeliveryResponse

at line 100
Future confirmPaymentwallDeliveryAsync(string|null $transactionId = null, string|null $deliveryType = null, string|null $deliveryStatus = null, string|null $estimatedDeliveryDatetime = null, string|null $estimatedUpdateDatetime = null, string|null $reason = null, bool|null $refundable = null, string|null $details = null, string|null $shippingAddressEmail = null, string|null $carrierTrackingId = null, string|null $carrierType = null, string|null $shippingAddressCountry = null, string|null $shippingAddressCity = null, string|null $shippingAddressZip = null, string|null $shippingAddressState = null, string|null $shippingAddressStreet = null, string|null $shippingAddressPhone = null, string|null $shippingAddressFirstname = null, string|null $shippingAddressLastname = null, array|null $attachments = null)

페이먼트월 배송 정보 등록 기능입니다.

배송 정보를 페이먼트월에 등록합니다. 등록된 배송 정보는 차지백 발생 시 고객사의 상품 배송 완료 증빙 자료로 활용되므로, 반드시 연동해야 합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $transactionId

결제 건 포트원 채번 아이디
string|null $deliveryType

페이먼트월 배송 유형
string|null $deliveryStatus

페이먼트월 배송 상태
string|null $estimatedDeliveryDatetime

배송 완료 예상 일시: 배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다.
string|null $estimatedUpdateDatetime

배송 상태 업데이트 예정 일시: 배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다.
string|null $reason

상태 변경 사유
bool|null $refundable

환불 가능 여부
string|null $details

상세 설명
string|null $shippingAddressEmail

고객 이메일 주소
string|null $carrierTrackingId

운송장 번호: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $carrierType

운송사 이름: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressCountry

국가: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressCity

수신자 도시: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressZip

수신자 우편번호: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressState

수신자 주: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressStreet

수신자 도로명 주소: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressPhone

수신자 전화번호: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressFirstname

수신자 이름: 배송 유형이 PHYSICAL인 경우 필수입니다.
string|null $shippingAddressLastname

수신자 성: 배송 유형이 PHYSICAL인 경우 필수입니다.
array|null $attachments

배송 증빙 첨부 파일 URL 목록: 배송 증빙 자료의 URL(이미지 등)을 입력합니다. 증빙 자료를 제공하기 어려운 경우 생략할 수 있습니다.

Return Value

Future