final class PolicyClient extends AbstractClient (View source)

플랫폼 정책 API 작업을 제공합니다.

Properties

protected RequestExecutor $executor from  AbstractClient

Methods

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

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

array
__debugInfo()

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

array
__serialize()

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

void
__unserialize(array $data)

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

createExecutor(string $apiSecret)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

callUnitOperationWithQueryAsync(string $operation, string $method, string $path, array $query)

No description

archivePlatformAdditionalFeePolicy(string|null $id = null, bool|null $test = null)

추가 수수료 정책 보관 기능입니다.

archivePlatformAdditionalFeePolicyAsync(string|null $id = null, bool|null $test = null)

추가 수수료 정책 보관 기능입니다.

archivePlatformContract(string|null $id = null, bool|null $test = null)

계약 보관 기능입니다.

archivePlatformContractAsync(string|null $id = null, bool|null $test = null)

계약 보관 기능입니다.

archivePlatformDiscountSharePolicy(string|null $id = null, bool|null $test = null)

할인 분담 정책 보관 기능입니다.

archivePlatformDiscountSharePolicyAsync(string|null $id = null, bool|null $test = null)

할인 분담 정책 보관 기능입니다.

createPlatformAdditionalFeePolicy(bool|null $test = null, string|null $id = null, string|null $name = null, array|null $fee = null, string|null $memo = null, string|null $vatPayer = null)

추가 수수료 정책 생성 기능입니다.

createPlatformAdditionalFeePolicyAsync(bool|null $test = null, string|null $id = null, string|null $name = null, array|null $fee = null, string|null $memo = null, string|null $vatPayer = null)

추가 수수료 정책 생성 기능입니다.

createPlatformContract(bool|null $test = null, string|null $id = null, string|null $name = null, string|null $memo = null, array|null $platformFee = null, array|null $settlementCycle = null, string|null $platformFeeVatPayer = null, bool|null $subtractPaymentVatAmount = null)

계약 생성 기능입니다.

createPlatformContractAsync(bool|null $test = null, string|null $id = null, string|null $name = null, string|null $memo = null, array|null $platformFee = null, array|null $settlementCycle = null, string|null $platformFeeVatPayer = null, bool|null $subtractPaymentVatAmount = null)

계약 생성 기능입니다.

createPlatformDiscountSharePolicy(bool|null $test = null, string|null $id = null, string|null $name = null, int|null $partnerShareRate = null, string|null $memo = null)

할인 분담 정책 생성 기능입니다.

createPlatformDiscountSharePolicyAsync(bool|null $test = null, string|null $id = null, string|null $name = null, int|null $partnerShareRate = null, string|null $memo = null)

할인 분담 정책 생성 기능입니다.

getPlatformAdditionalFeePolicies(bool|null $test = null, array|null $page = null, array|null $filter = null)

추가 수수료 정책 다건 조회 기능입니다.

getPlatformAdditionalFeePoliciesAsync(bool|null $test = null, array|null $page = null, array|null $filter = null)

추가 수수료 정책 다건 조회 기능입니다.

getPlatformAdditionalFeePolicy(string|null $id = null, bool|null $test = null)

추가 수수료 정책 조회 기능입니다.

getPlatformAdditionalFeePolicyAsync(string|null $id = null, bool|null $test = null)

추가 수수료 정책 조회 기능입니다.

getPlatformContract(string|null $id = null, bool|null $test = null)

계약 조회 기능입니다.

getPlatformContractAsync(string|null $id = null, bool|null $test = null)

계약 조회 기능입니다.

getPlatformContracts(bool|null $test = null, array|null $page = null, array|null $filter = null)

계약 다건 조회 기능입니다.

getPlatformContractsAsync(bool|null $test = null, array|null $page = null, array|null $filter = null)

계약 다건 조회 기능입니다.

getPlatformDiscountSharePolicies(bool|null $test = null, array|null $page = null, array|null $filter = null)

할인 분담 정책 다건 조회 기능입니다.

getPlatformDiscountSharePoliciesAsync(bool|null $test = null, array|null $page = null, array|null $filter = null)

할인 분담 정책 다건 조회 기능입니다.

getPlatformDiscountSharePolicy(string|null $id = null, bool|null $test = null)

할인 분담 정책 조회 기능입니다.

getPlatformDiscountSharePolicyAsync(string|null $id = null, bool|null $test = null)

할인 분담 정책 조회 기능입니다.

recoverPlatformAdditionalFeePolicy(string|null $id = null, bool|null $test = null)

추가 수수료 정책 복원 기능입니다.

recoverPlatformAdditionalFeePolicyAsync(string|null $id = null, bool|null $test = null)

추가 수수료 정책 복원 기능입니다.

recoverPlatformContract(string|null $id = null, bool|null $test = null)

계약 복원 기능입니다.

recoverPlatformContractAsync(string|null $id = null, bool|null $test = null)

계약 복원 기능입니다.

recoverPlatformDiscountSharePolicy(string|null $id = null, bool|null $test = null)

할인 분담 정책 복원 기능입니다.

recoverPlatformDiscountSharePolicyAsync(string|null $id = null, bool|null $test = null)

할인 분담 정책 복원 기능입니다.

updatePlatformAdditionalFeePolicy(string|null $id = null, bool|null $test = null, array|null $fee = null, string|null $name = null, string|null $memo = null, string|null $vatPayer = null)

추가 수수료 정책 수정 기능입니다.

updatePlatformAdditionalFeePolicyAsync(string|null $id = null, bool|null $test = null, array|null $fee = null, string|null $name = null, string|null $memo = null, string|null $vatPayer = null)

추가 수수료 정책 수정 기능입니다.

updatePlatformContract(string|null $id = null, bool|null $test = null, string|null $name = null, string|null $memo = null, array|null $platformFee = null, array|null $settlementCycle = null, string|null $platformFeeVatPayer = null, bool|null $subtractPaymentVatAmount = null)

계약 수정 기능입니다.

updatePlatformContractAsync(string|null $id = null, bool|null $test = null, string|null $name = null, string|null $memo = null, array|null $platformFee = null, array|null $settlementCycle = null, string|null $platformFeeVatPayer = null, bool|null $subtractPaymentVatAmount = null)

계약 수정 기능입니다.

updatePlatformDiscountSharePolicy(string|null $id = null, bool|null $test = null, string|null $name = null, int|null $partnerShareRate = null, string|null $memo = null)

할인 분담 정책 수정 기능입니다.

updatePlatformDiscountSharePolicyAsync(string|null $id = null, bool|null $test = null, string|null $name = null, int|null $partnerShareRate = null, string|null $memo = null)

할인 분담 정책 수정 기능입니다.

Details

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

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

Parameters

string $apiSecret

PortOne V2 API 요청 인증에 사용하는 API Secret입니다.

RequestExecutor|null $executor

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

array __debugInfo()

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

Return Value

array

array __serialize()

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

Return Value

array

void __unserialize(array $data)

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

Parameters

array $data

Return Value

void

protected RequestExecutor createExecutor(string $apiSecret)

No description

Parameters

string $apiSecret

Return Value

RequestExecutor

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ArchivePlatformAdditionalFeePolicyResponse archivePlatformAdditionalFeePolicy(string|null $id = null, bool|null $test = null)

추가 수수료 정책 보관 기능입니다.

주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.

Parameters

string|null $id

추가 수수료 정책 아이디

bool|null $test

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

Return Value

ArchivePlatformAdditionalFeePolicyResponse

Future archivePlatformAdditionalFeePolicyAsync(string|null $id = null, bool|null $test = null)

추가 수수료 정책 보관 기능입니다.

주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

추가 수수료 정책 아이디

bool|null $test

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

Return Value

Future

ArchivePlatformContractResponse archivePlatformContract(string|null $id = null, bool|null $test = null)

계약 보관 기능입니다.

주어진 아이디에 대응되는 계약을 보관합니다.

Parameters

string|null $id

계약 아이디

bool|null $test

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

Return Value

ArchivePlatformContractResponse

Future archivePlatformContractAsync(string|null $id = null, bool|null $test = null)

계약 보관 기능입니다.

주어진 아이디에 대응되는 계약을 보관합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

계약 아이디

bool|null $test

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

Return Value

Future

ArchivePlatformDiscountSharePolicyResponse archivePlatformDiscountSharePolicy(string|null $id = null, bool|null $test = null)

할인 분담 정책 보관 기능입니다.

주어진 아이디에 대응되는 할인 분담을 보관합니다.

Parameters

string|null $id

할인 분담 아이디

bool|null $test

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

Return Value

ArchivePlatformDiscountSharePolicyResponse

Future archivePlatformDiscountSharePolicyAsync(string|null $id = null, bool|null $test = null)

할인 분담 정책 보관 기능입니다.

주어진 아이디에 대응되는 할인 분담을 보관합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

할인 분담 아이디

bool|null $test

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

Return Value

Future

CreatePlatformAdditionalFeePolicyResponse createPlatformAdditionalFeePolicy(bool|null $test = null, string|null $id = null, string|null $name = null, array|null $fee = null, string|null $memo = null, string|null $vatPayer = null)

추가 수수료 정책 생성 기능입니다.

새로운 추가 수수료 정책을 생성합니다.

Parameters

bool|null $test

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

string|null $id

생성할 추가 수수료 정책 아이디: 명시하지 않으면 id 가 임의로 생성됩니다.

string|null $name 이름
array|null $fee

수수료 계산 방식을 특정하기 위한 입력 정보: 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

string|null $memo 메모
string|null $vatPayer

금액 부담 주체: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

Return Value

CreatePlatformAdditionalFeePolicyResponse

Future createPlatformAdditionalFeePolicyAsync(bool|null $test = null, string|null $id = null, string|null $name = null, array|null $fee = null, string|null $memo = null, string|null $vatPayer = 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 $id

생성할 추가 수수료 정책 아이디: 명시하지 않으면 id 가 임의로 생성됩니다.

string|null $name 이름
array|null $fee

수수료 계산 방식을 특정하기 위한 입력 정보: 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

string|null $memo 메모
string|null $vatPayer

금액 부담 주체: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

Return Value

Future

CreatePlatformContractResponse createPlatformContract(bool|null $test = null, string|null $id = null, string|null $name = null, string|null $memo = null, array|null $platformFee = null, array|null $settlementCycle = null, string|null $platformFeeVatPayer = null, bool|null $subtractPaymentVatAmount = null)

계약 생성 기능입니다.

새로운 계약을 생성합니다.

Parameters

bool|null $test

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

string|null $id

계약에 부여할 고유 아이디: 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

string|null $name

계약 이름

string|null $memo

계약 내부 표기를 위한 메모

array|null $platformFee

수수료 계산 방식을 특정하기 위한 입력 정보: 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

array|null $settlementCycle

플랫폼 정산 주기 입력 정보

string|null $platformFeeVatPayer

금액 부담 주체: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

bool|null $subtractPaymentVatAmount

정산 시 결제금액 부가세 감액 여부

Return Value

CreatePlatformContractResponse

Future createPlatformContractAsync(bool|null $test = null, string|null $id = null, string|null $name = null, string|null $memo = null, array|null $platformFee = null, array|null $settlementCycle = null, string|null $platformFeeVatPayer = null, bool|null $subtractPaymentVatAmount = 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 $id

계약에 부여할 고유 아이디: 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

string|null $name

계약 이름

string|null $memo

계약 내부 표기를 위한 메모

array|null $platformFee

수수료 계산 방식을 특정하기 위한 입력 정보: 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

array|null $settlementCycle

플랫폼 정산 주기 입력 정보

string|null $platformFeeVatPayer

금액 부담 주체: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

bool|null $subtractPaymentVatAmount

정산 시 결제금액 부가세 감액 여부

Return Value

Future

CreatePlatformDiscountSharePolicyResponse createPlatformDiscountSharePolicy(bool|null $test = null, string|null $id = null, string|null $name = null, int|null $partnerShareRate = null, string|null $memo = null)

할인 분담 정책 생성 기능입니다.

새로운 할인 분담을 생성합니다.

Parameters

bool|null $test

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

string|null $id

할인 분담에 부여할 고유 아이디: 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

string|null $name

할인 분담에 부여할 이름

int|null $partnerShareRate

파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.

string|null $memo

해당 할인 분담에 대한 메모 ex) 파트너 브랜드 쿠폰

Return Value

CreatePlatformDiscountSharePolicyResponse

Future createPlatformDiscountSharePolicyAsync(bool|null $test = null, string|null $id = null, string|null $name = null, int|null $partnerShareRate = null, string|null $memo = 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 $id

할인 분담에 부여할 고유 아이디: 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

string|null $name

할인 분담에 부여할 이름

int|null $partnerShareRate

파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.

string|null $memo

해당 할인 분담에 대한 메모 ex) 파트너 브랜드 쿠폰

Return Value

Future

GetPlatformAdditionalFeePoliciesResponse getPlatformAdditionalFeePolicies(bool|null $test = 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로 적용됩니다.

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보

array|null $filter

추가 수수료 정책 다건 조회를 위한 필터 조건

Return Value

GetPlatformAdditionalFeePoliciesResponse

Future getPlatformAdditionalFeePoliciesAsync(bool|null $test = 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로 적용됩니다.

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보

array|null $filter

추가 수수료 정책 다건 조회를 위한 필터 조건

Return Value

Future

PlatformAdditionalFeePolicy getPlatformAdditionalFeePolicy(string|null $id = null, bool|null $test = null)

추가 수수료 정책 조회 기능입니다.

주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.

Parameters

string|null $id

조회할 추가 수수료 정책 아이디

bool|null $test

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

Return Value

PlatformAdditionalFeePolicy

Future getPlatformAdditionalFeePolicyAsync(string|null $id = null, bool|null $test = null)

추가 수수료 정책 조회 기능입니다.

주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

조회할 추가 수수료 정책 아이디

bool|null $test

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

Return Value

Future

PlatformContract getPlatformContract(string|null $id = null, bool|null $test = null)

계약 조회 기능입니다.

주어진 아이디에 대응되는 계약을 조회합니다.

Parameters

string|null $id

조회할 계약 아이디

bool|null $test

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

Return Value

PlatformContract

Future getPlatformContractAsync(string|null $id = null, bool|null $test = null)

계약 조회 기능입니다.

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

Parameters

string|null $id

조회할 계약 아이디

bool|null $test

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

Return Value

Future

GetPlatformContractsResponse getPlatformContracts(bool|null $test = 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로 적용됩니다.

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보

array|null $filter

계약 다건 조회를 위한 필터 조건

Return Value

GetPlatformContractsResponse

Future getPlatformContractsAsync(bool|null $test = 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로 적용됩니다.

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보

array|null $filter

계약 다건 조회를 위한 필터 조건

Return Value

Future

GetPlatformDiscountSharePoliciesResponse getPlatformDiscountSharePolicies(bool|null $test = 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로 적용됩니다.

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보

array|null $filter

할인 분담 정책 다건 조회를 위한 필터 조건

Return Value

GetPlatformDiscountSharePoliciesResponse

Future getPlatformDiscountSharePoliciesAsync(bool|null $test = 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로 적용됩니다.

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보

array|null $filter

할인 분담 정책 다건 조회를 위한 필터 조건

Return Value

Future

PlatformDiscountSharePolicy getPlatformDiscountSharePolicy(string|null $id = null, bool|null $test = null)

할인 분담 정책 조회 기능입니다.

주어진 아이디에 대응되는 할인 분담을 조회합니다.

Parameters

string|null $id

조회할 할인 분담 정책 아이디

bool|null $test

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

Return Value

PlatformDiscountSharePolicy

Future getPlatformDiscountSharePolicyAsync(string|null $id = null, bool|null $test = null)

할인 분담 정책 조회 기능입니다.

주어진 아이디에 대응되는 할인 분담을 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

조회할 할인 분담 정책 아이디

bool|null $test

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

Return Value

Future

RecoverPlatformAdditionalFeePolicyResponse recoverPlatformAdditionalFeePolicy(string|null $id = null, bool|null $test = null)

추가 수수료 정책 복원 기능입니다.

주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.

Parameters

string|null $id

추가 수수료 정책 아이디

bool|null $test

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

Return Value

RecoverPlatformAdditionalFeePolicyResponse

Future recoverPlatformAdditionalFeePolicyAsync(string|null $id = null, bool|null $test = null)

추가 수수료 정책 복원 기능입니다.

주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

추가 수수료 정책 아이디

bool|null $test

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

Return Value

Future

RecoverPlatformContractResponse recoverPlatformContract(string|null $id = null, bool|null $test = null)

계약 복원 기능입니다.

주어진 아이디에 대응되는 계약을 복원합니다.

Parameters

string|null $id

계약 아이디

bool|null $test

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

Return Value

RecoverPlatformContractResponse

Future recoverPlatformContractAsync(string|null $id = null, bool|null $test = null)

계약 복원 기능입니다.

주어진 아이디에 대응되는 계약을 복원합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

계약 아이디

bool|null $test

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

Return Value

Future

RecoverPlatformDiscountSharePolicyResponse recoverPlatformDiscountSharePolicy(string|null $id = null, bool|null $test = null)

할인 분담 정책 복원 기능입니다.

주어진 아이디에 대응되는 할인 분담을 복원합니다.

Parameters

string|null $id

할인 분담 아이디

bool|null $test

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

Return Value

RecoverPlatformDiscountSharePolicyResponse

Future recoverPlatformDiscountSharePolicyAsync(string|null $id = null, bool|null $test = null)

할인 분담 정책 복원 기능입니다.

주어진 아이디에 대응되는 할인 분담을 복원합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

할인 분담 아이디

bool|null $test

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

Return Value

Future

UpdatePlatformAdditionalFeePolicyResponse updatePlatformAdditionalFeePolicy(string|null $id = null, bool|null $test = null, array|null $fee = null, string|null $name = null, string|null $memo = null, string|null $vatPayer = null)

추가 수수료 정책 수정 기능입니다.

주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다.

Parameters

string|null $id

업데이트할 추가 수수료 정책 아이디

bool|null $test

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

array|null $fee

수수료 계산 방식을 특정하기 위한 입력 정보: 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

string|null $name

추가 수수료 정책 이름

string|null $memo

해당 추가 수수료 정책에 대한 메모

string|null $vatPayer

금액 부담 주체: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

Return Value

UpdatePlatformAdditionalFeePolicyResponse

Future updatePlatformAdditionalFeePolicyAsync(string|null $id = null, bool|null $test = null, array|null $fee = null, string|null $name = null, string|null $memo = null, string|null $vatPayer = null)

추가 수수료 정책 수정 기능입니다.

주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

업데이트할 추가 수수료 정책 아이디

bool|null $test

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

array|null $fee

수수료 계산 방식을 특정하기 위한 입력 정보: 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

string|null $name

추가 수수료 정책 이름

string|null $memo

해당 추가 수수료 정책에 대한 메모

string|null $vatPayer

금액 부담 주체: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

Return Value

Future

UpdatePlatformContractResponse updatePlatformContract(string|null $id = null, bool|null $test = null, string|null $name = null, string|null $memo = null, array|null $platformFee = null, array|null $settlementCycle = null, string|null $platformFeeVatPayer = null, bool|null $subtractPaymentVatAmount = null)

계약 수정 기능입니다.

주어진 아이디에 대응되는 계약을 업데이트합니다.

Parameters

string|null $id

업데이트할 계약 아이디

bool|null $test

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

string|null $name

계약 이름

string|null $memo

계약 내부 표기를 위한 메모

array|null $platformFee

수수료 계산 방식을 특정하기 위한 입력 정보: 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

array|null $settlementCycle

플랫폼 정산 주기 입력 정보

string|null $platformFeeVatPayer

금액 부담 주체: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

bool|null $subtractPaymentVatAmount

정산 시 결제금액 부가세 감액 여부

Return Value

UpdatePlatformContractResponse

Future updatePlatformContractAsync(string|null $id = null, bool|null $test = null, string|null $name = null, string|null $memo = null, array|null $platformFee = null, array|null $settlementCycle = null, string|null $platformFeeVatPayer = null, bool|null $subtractPaymentVatAmount = null)

계약 수정 기능입니다.

주어진 아이디에 대응되는 계약을 업데이트합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

업데이트할 계약 아이디

bool|null $test

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

string|null $name

계약 이름

string|null $memo

계약 내부 표기를 위한 메모

array|null $platformFee

수수료 계산 방식을 특정하기 위한 입력 정보: 정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

array|null $settlementCycle

플랫폼 정산 주기 입력 정보

string|null $platformFeeVatPayer

금액 부담 주체: 플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

bool|null $subtractPaymentVatAmount

정산 시 결제금액 부가세 감액 여부

Return Value

Future

UpdatePlatformDiscountSharePolicyResponse updatePlatformDiscountSharePolicy(string|null $id = null, bool|null $test = null, string|null $name = null, int|null $partnerShareRate = null, string|null $memo = null)

할인 분담 정책 수정 기능입니다.

주어진 아이디에 대응되는 할인 분담을 업데이트합니다.

Parameters

string|null $id

업데이트할 할인 분담 정책 아이디

bool|null $test

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

string|null $name

할인 분담 정책 이름

int|null $partnerShareRate

할인 분담율: 파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.

string|null $memo

해당 할인 분담에 대한 메모

Return Value

UpdatePlatformDiscountSharePolicyResponse

Future updatePlatformDiscountSharePolicyAsync(string|null $id = null, bool|null $test = null, string|null $name = null, int|null $partnerShareRate = null, string|null $memo = null)

할인 분담 정책 수정 기능입니다.

주어진 아이디에 대응되는 할인 분담을 업데이트합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $id

업데이트할 할인 분담 정책 아이디

bool|null $test

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

string|null $name

할인 분담 정책 이름

int|null $partnerShareRate

할인 분담율: 파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.

string|null $memo

해당 할인 분담에 대한 메모

Return Value

Future