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

PaymentSessionClient

final class PaymentSessionClient 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
CreatePaymentSessionResponse
createPaymentSession(string|null $storeId = null, string|null $paymentId = null, string|null $profileKey = null, string|null $paymentMethod = null, string|null $country = null, string|null $currency = null, int|null $totalAmount = null, string|null $orderName = null, string|null $redirectUrl = null, array|null $products = null, string|null $customerName = null, string|null $customerEmail = null, string|null $storeName = null, array|null $agreements = null, string|null $orderImageUrl = null, string|null $customData = null, array|null $colors = null, int|null $ttlSeconds = null)

결제 세션 생성 기능입니다.

Future
createPaymentSessionAsync(string|null $storeId = null, string|null $paymentId = null, string|null $profileKey = null, string|null $paymentMethod = null, string|null $country = null, string|null $currency = null, int|null $totalAmount = null, string|null $orderName = null, string|null $redirectUrl = null, array|null $products = null, string|null $customerName = null, string|null $customerEmail = null, string|null $storeName = null, array|null $agreements = null, string|null $orderImageUrl = null, string|null $customData = null, array|null $colors = null, int|null $ttlSeconds = null)

결제 세션 생성 기능입니다.

PaymentSession
getPaymentSession(string|null $sessionId = null)

결제 세션 조회 기능입니다.

Future
getPaymentSessionAsync(string|null $sessionId = null)

결제 세션 조회 기능입니다.

ClosePaymentSessionResponse
closePaymentSession(string|null $sessionId = null)

결제 세션 종료 기능입니다.

Future
closePaymentSessionAsync(string|null $sessionId = 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 38
CreatePaymentSessionResponse createPaymentSession(string|null $storeId = null, string|null $paymentId = null, string|null $profileKey = null, string|null $paymentMethod = null, string|null $country = null, string|null $currency = null, int|null $totalAmount = null, string|null $orderName = null, string|null $redirectUrl = null, array|null $products = null, string|null $customerName = null, string|null $customerEmail = null, string|null $storeName = null, array|null $agreements = null, string|null $orderImageUrl = null, string|null $customData = null, array|null $colors = null, int|null $ttlSeconds = null)

결제 세션 생성 기능입니다.

결제 세션을 생성합니다. 호스티드 체크아웃 페이지가 생성되어 URL이 반환됩니다.

Parameters

string|null $storeId

상점 아이디
string|null $paymentId

결제 건 아이디
string|null $profileKey

프로필 키
string|null $paymentMethod

결제 수단: 지정한 경우, 정보 추가 입력이 필요하지 않은 경우에 주문서를 건너뛰고 결제로 바로 이동합니다.
string|null $country 국가
string|null $currency 통화
int|null $totalAmount

전체 결제 금액
string|null $orderName 주문명
string|null $redirectUrl

결제 완료 후 리다이렉트 URL: 지정하지 않으면 기본 결과 페이지가 표시됩니다.
array|null $products

결제 세션 주문 항목
string|null $customerName

구매자 이름
string|null $customerEmail

구매자 이메일
string|null $storeName

상점 이름: 페이지 헤더 및 결제사 UI에 표시됩니다.
array|null $agreements

결제 세션 약관: 구매자가 모든 약관에 동의해야 결제 버튼이 활성화됩니다.
string|null $orderImageUrl

주문 대표 이미지 URL
string|null $customData

사용자 지정 데이터: 결제 완료 후 결제 건 조회에서도 확인할 수 있습니다.
array|null $colors

체크아웃 페이지 색 설정
int|null $ttlSeconds

세션 TTL (초)

Return Value

CreatePaymentSessionResponse

at line 67
Future createPaymentSessionAsync(string|null $storeId = null, string|null $paymentId = null, string|null $profileKey = null, string|null $paymentMethod = null, string|null $country = null, string|null $currency = null, int|null $totalAmount = null, string|null $orderName = null, string|null $redirectUrl = null, array|null $products = null, string|null $customerName = null, string|null $customerEmail = null, string|null $storeName = null, array|null $agreements = null, string|null $orderImageUrl = null, string|null $customData = null, array|null $colors = null, int|null $ttlSeconds = null)

결제 세션 생성 기능입니다.

결제 세션을 생성합니다. 호스티드 체크아웃 페이지가 생성되어 URL이 반환됩니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $storeId

상점 아이디
string|null $paymentId

결제 건 아이디
string|null $profileKey

프로필 키
string|null $paymentMethod

결제 수단: 지정한 경우, 정보 추가 입력이 필요하지 않은 경우에 주문서를 건너뛰고 결제로 바로 이동합니다.
string|null $country 국가
string|null $currency 통화
int|null $totalAmount

전체 결제 금액
string|null $orderName 주문명
string|null $redirectUrl

결제 완료 후 리다이렉트 URL: 지정하지 않으면 기본 결과 페이지가 표시됩니다.
array|null $products

결제 세션 주문 항목
string|null $customerName

구매자 이름
string|null $customerEmail

구매자 이메일
string|null $storeName

상점 이름: 페이지 헤더 및 결제사 UI에 표시됩니다.
array|null $agreements

결제 세션 약관: 구매자가 모든 약관에 동의해야 결제 버튼이 활성화됩니다.
string|null $orderImageUrl

주문 대표 이미지 URL
string|null $customData

사용자 지정 데이터: 결제 완료 후 결제 건 조회에서도 확인할 수 있습니다.
array|null $colors

체크아웃 페이지 색 설정
int|null $ttlSeconds

세션 TTL (초)

Return Value

Future

at line 78
PaymentSession getPaymentSession(string|null $sessionId = null)

결제 세션 조회 기능입니다.

결제 세션을 조회합니다. 인증 헤더 없이 웹 페이지에서도 접근 가능합니다.

Parameters

string|null $sessionId

결제 세션 아이디

Return Value

PaymentSession

at line 90
Future getPaymentSessionAsync(string|null $sessionId = null)

결제 세션 조회 기능입니다.

결제 세션을 조회합니다. 인증 헤더 없이 웹 페이지에서도 접근 가능합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $sessionId

결제 세션 아이디

Return Value

Future

at line 101
ClosePaymentSessionResponse closePaymentSession(string|null $sessionId = null)

결제 세션 종료 기능입니다.

결제 세션을 즉시 만료시킵니다. 이후 해당 세션으로는 결제 페이지에 접근할 수 없습니다.

Parameters

string|null $sessionId

결제 세션 아이디

Return Value

ClosePaymentSessionResponse

at line 113
Future closePaymentSessionAsync(string|null $sessionId = null)

결제 세션 종료 기능입니다.

결제 세션을 즉시 만료시킵니다. 이후 해당 세션으로는 결제 페이지에 접근할 수 없습니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $sessionId

결제 세션 아이디

Return Value

Future