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

PayoutClient

final class PayoutClient 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
CompletePlatformPayoutByPartnerSettlementIdsResponse
completePlatformPayoutByPartnerSettlementIds(bool|null $test = null, string|null $bulkPayoutId = null, string|null $name = null, array|null $partnerSettlementIds = null, string|null $completedAt = null, bool|null $isForTest = null)

일괄 지급 완료 처리 기능입니다.

Future
completePlatformPayoutByPartnerSettlementIdsAsync(bool|null $test = null, string|null $bulkPayoutId = null, string|null $name = null, array|null $partnerSettlementIds = null, string|null $completedAt = null, bool|null $isForTest = null)

일괄 지급 완료 처리 기능입니다.

GetPlatformPayoutsResponse
getPlatformPayouts(bool|null $test = null, bool|null $isForTest = null, array|null $page = null, array|null $filter = null)

지급 내역 다건 조회 기능입니다.

Future
getPlatformPayoutsAsync(bool|null $test = null, bool|null $isForTest = null, array|null $page = null, array|null $filter = 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 26
CompletePlatformPayoutByPartnerSettlementIdsResponse completePlatformPayoutByPartnerSettlementIds(bool|null $test = null, string|null $bulkPayoutId = null, string|null $name = null, array|null $partnerSettlementIds = null, string|null $completedAt = null, bool|null $isForTest = null)

일괄 지급 완료 처리 기능입니다.

선택한 정산내역 아이디들로 일괄 지급을 완료 처리 합니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
string|null $bulkPayoutId

일괄 지급 아이디
string|null $name

일괄 지급 이름
array|null $partnerSettlementIds

일괄 지급 처리 대상 정산내역 아이디 목록
string|null $completedAt

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
bool|null $isForTest

Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

CompletePlatformPayoutByPartnerSettlementIdsResponse

at line 43
Future completePlatformPayoutByPartnerSettlementIdsAsync(bool|null $test = null, string|null $bulkPayoutId = null, string|null $name = null, array|null $partnerSettlementIds = null, string|null $completedAt = null, bool|null $isForTest = null)

일괄 지급 완료 처리 기능입니다.

선택한 정산내역 아이디들로 일괄 지급을 완료 처리 합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
string|null $bulkPayoutId

일괄 지급 아이디
string|null $name

일괄 지급 이름
array|null $partnerSettlementIds

일괄 지급 처리 대상 정산내역 아이디 목록
string|null $completedAt

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
bool|null $isForTest

Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.

Return Value

Future

at line 57
GetPlatformPayoutsResponse getPlatformPayouts(bool|null $test = null, bool|null $isForTest = null, array|null $page = null, array|null $filter = null)

지급 내역 다건 조회 기능입니다.

여러 지급 내역을 조회합니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
bool|null $isForTest

Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보
array|null $filter

지급 내역 필터 입력 정보

Return Value

GetPlatformPayoutsResponse

at line 72
Future getPlatformPayoutsAsync(bool|null $test = null, bool|null $isForTest = null, array|null $page = null, array|null $filter = null)

지급 내역 다건 조회 기능입니다.

여러 지급 내역을 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

bool|null $test

테스트 모드 여부를 결정합니다. true 이면 테스트 모드로 실행됩니다. Request Body에도 isForTest가 있을 수 있으나, 둘 다 제공되면 Query Parameter의 test 값을 사용하고, Request Body의 isForTest는 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
bool|null $isForTest

Query Parameter의 test에 값이 제공된 경우 Query Parameter의 test를 사용하고 해당 값은 무시됩니다. Query Parameter의 test와 Request Body의 isForTest에 모두 값이 제공되지 않으면 기본값인 false로 적용됩니다.
array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보
array|null $filter

지급 내역 필터 입력 정보

Return Value

Future