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

TransferClient

final class TransferClient 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
CreateManualTransferResponse
createPlatformManualTransfer(bool|null $test = null, string|null $partnerId = null, string|null $memo = null, int|null $settlementAmount = null, int|null $settlementTaxFreeAmount = null, string|null $settlementDate = null, bool|null $isForTest = null, array|null $userDefinedProperties = null, string|null $id = null, string|null $settlementCurrency = null)

수기 정산건 생성 기능입니다.

Future
createPlatformManualTransferAsync(bool|null $test = null, string|null $partnerId = null, string|null $memo = null, int|null $settlementAmount = null, int|null $settlementTaxFreeAmount = null, string|null $settlementDate = null, bool|null $isForTest = null, array|null $userDefinedProperties = null, string|null $id = null, string|null $settlementCurrency = null)

수기 정산건 생성 기능입니다.

CreateOrderCancelTransferResponse
createPlatformOrderCancelTransfer(bool|null $test = null, string|null $partnerId = null, string|null $paymentId = null, string|null $transferId = null, string|null $cancellationId = null, string|null $memo = null, array|null $orderDetail = null, int|null $taxFreeAmount = null, array|null $discounts = null, string|null $settlementStartDate = null, string|null $settlementDate = null, array|null $externalCancellationDetail = null, bool|null $isForTest = null, array|null $userDefinedProperties = null, string|null $id = null)

주문 취소 정산건 생성 기능입니다.

Future
createPlatformOrderCancelTransferAsync(bool|null $test = null, string|null $partnerId = null, string|null $paymentId = null, string|null $transferId = null, string|null $cancellationId = null, string|null $memo = null, array|null $orderDetail = null, int|null $taxFreeAmount = null, array|null $discounts = null, string|null $settlementStartDate = null, string|null $settlementDate = null, array|null $externalCancellationDetail = null, bool|null $isForTest = null, array|null $userDefinedProperties = null, string|null $id = null)

주문 취소 정산건 생성 기능입니다.

CreateOrderTransferResponse
createPlatformOrderTransfer(bool|null $test = null, string|null $partnerId = null, string|null $contractId = null, string|null $memo = null, string|null $paymentId = null, array|null $orderDetail = null, int|null $taxFreeAmount = null, string|null $settlementStartDate = null, string|null $settlementDate = null, array|null $discounts = null, array|null $additionalFees = null, array|null $externalPaymentDetail = null, bool|null $isForTest = null, array|null $parameters = null, array|null $userDefinedProperties = null, string|null $id = null)

주문 정산건 생성 기능입니다.

Future
createPlatformOrderTransferAsync(bool|null $test = null, string|null $partnerId = null, string|null $contractId = null, string|null $memo = null, string|null $paymentId = null, array|null $orderDetail = null, int|null $taxFreeAmount = null, string|null $settlementStartDate = null, string|null $settlementDate = null, array|null $discounts = null, array|null $additionalFees = null, array|null $externalPaymentDetail = null, bool|null $isForTest = null, array|null $parameters = null, array|null $userDefinedProperties = null, string|null $id = null)

주문 정산건 생성 기능입니다.

DeletePlatformTransferResponse
deletePlatformTransfer(string|null $id = null, bool|null $test = null)

정산건 삭제 기능입니다.

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

정산건 삭제 기능입니다.

string
downloadPlatformTransferSheet(bool|null $test = null, array|null $filter = null, array|null $fields = null)

정산 상세 내역 다운로드 기능입니다.

Future
downloadPlatformTransferSheetAsync(bool|null $test = null, array|null $filter = null, array|null $fields = null)

정산 상세 내역 다운로드 기능입니다.

PlatformTransfer
getPlatformTransfer(string|null $id = null, bool|null $test = null)

정산건 조회 기능입니다.

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

정산건 조회 기능입니다.

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

정산건 다건 조회 기능입니다.

Future
getPlatformTransferSummariesAsync(bool|null $test = 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 30
CreateManualTransferResponse createPlatformManualTransfer(bool|null $test = null, string|null $partnerId = null, string|null $memo = null, int|null $settlementAmount = null, int|null $settlementTaxFreeAmount = null, string|null $settlementDate = null, bool|null $isForTest = null, array|null $userDefinedProperties = null, string|null $id = null, string|null $settlementCurrency = null)

수기 정산건 생성 기능입니다.

성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.

Parameters

bool|null $test

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

파트너 아이디
string|null $memo 메모
int|null $settlementAmount

정산 금액
int|null $settlementTaxFreeAmount

정산 면세 금액
string|null $settlementDate

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

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

사용자 정의 속성
string|null $id

생성할 정산건 아이디: 명시하지 않으면 id 가 임의로 생성됩니다.
string|null $settlementCurrency 통화

Return Value

CreateManualTransferResponse

at line 51
Future createPlatformManualTransferAsync(bool|null $test = null, string|null $partnerId = null, string|null $memo = null, int|null $settlementAmount = null, int|null $settlementTaxFreeAmount = null, string|null $settlementDate = null, bool|null $isForTest = null, array|null $userDefinedProperties = null, string|null $id = null, string|null $settlementCurrency = 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 $partnerId

파트너 아이디
string|null $memo 메모
int|null $settlementAmount

정산 금액
int|null $settlementTaxFreeAmount

정산 면세 금액
string|null $settlementDate

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

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

사용자 정의 속성
string|null $id

생성할 정산건 아이디: 명시하지 않으면 id 가 임의로 생성됩니다.
string|null $settlementCurrency 통화

Return Value

Future

at line 76
CreateOrderCancelTransferResponse createPlatformOrderCancelTransfer(bool|null $test = null, string|null $partnerId = null, string|null $paymentId = null, string|null $transferId = null, string|null $cancellationId = null, string|null $memo = null, array|null $orderDetail = null, int|null $taxFreeAmount = null, array|null $discounts = null, string|null $settlementStartDate = null, string|null $settlementDate = null, array|null $externalCancellationDetail = null, bool|null $isForTest = null, array|null $userDefinedProperties = null, string|null $id = null)

주문 취소 정산건 생성 기능입니다.

성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.

Parameters

bool|null $test

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

파트너 아이디
string|null $paymentId

결제 아이디
string|null $transferId

정산건 아이디
string|null $cancellationId

취소 내역 아이디
string|null $memo 메모
array|null $orderDetail

주문 취소 정보: orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.
int|null $taxFreeAmount

주문 취소 면세 금액: 주문 취소 항목과 취소 면세 금액을 같이 전달하시면 최종 취소 면세 금액은 주문 취소 항목의 면세 금액이 아닌 전달해주신 취소 면세 금액으로 적용됩니다.
array|null $discounts

할인 정보
string|null $settlementStartDate

정산 시작일: 날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
string|null $settlementDate

정산일: 날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
array|null $externalCancellationDetail

외부 결제 상세 정보: 해당 정보가 존재하는 경우 외부 결제 취소 정산건으로 등록되고, 존재하지않은 경우 포트원 결제 취소 정산건으로 등록됩니다.
bool|null $isForTest

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

사용자 정의 속성
string|null $id

생성할 취소 정산건 아이디: 명시하지 않으면 id 가 임의로 생성됩니다.

Return Value

CreateOrderCancelTransferResponse

at line 102
Future createPlatformOrderCancelTransferAsync(bool|null $test = null, string|null $partnerId = null, string|null $paymentId = null, string|null $transferId = null, string|null $cancellationId = null, string|null $memo = null, array|null $orderDetail = null, int|null $taxFreeAmount = null, array|null $discounts = null, string|null $settlementStartDate = null, string|null $settlementDate = null, array|null $externalCancellationDetail = null, bool|null $isForTest = null, array|null $userDefinedProperties = null, string|null $id = 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 $partnerId

파트너 아이디
string|null $paymentId

결제 아이디
string|null $transferId

정산건 아이디
string|null $cancellationId

취소 내역 아이디
string|null $memo 메모
array|null $orderDetail

주문 취소 정보: orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.
int|null $taxFreeAmount

주문 취소 면세 금액: 주문 취소 항목과 취소 면세 금액을 같이 전달하시면 최종 취소 면세 금액은 주문 취소 항목의 면세 금액이 아닌 전달해주신 취소 면세 금액으로 적용됩니다.
array|null $discounts

할인 정보
string|null $settlementStartDate

정산 시작일: 날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
string|null $settlementDate

정산일: 날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
array|null $externalCancellationDetail

외부 결제 상세 정보: 해당 정보가 존재하는 경우 외부 결제 취소 정산건으로 등록되고, 존재하지않은 경우 포트원 결제 취소 정산건으로 등록됩니다.
bool|null $isForTest

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

사용자 정의 속성
string|null $id

생성할 취소 정산건 아이디: 명시하지 않으면 id 가 임의로 생성됩니다.

Return Value

Future

at line 128
CreateOrderTransferResponse createPlatformOrderTransfer(bool|null $test = null, string|null $partnerId = null, string|null $contractId = null, string|null $memo = null, string|null $paymentId = null, array|null $orderDetail = null, int|null $taxFreeAmount = null, string|null $settlementStartDate = null, string|null $settlementDate = null, array|null $discounts = null, array|null $additionalFees = null, array|null $externalPaymentDetail = null, bool|null $isForTest = null, array|null $parameters = null, array|null $userDefinedProperties = null, string|null $id = null)

주문 정산건 생성 기능입니다.

성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.

Parameters

bool|null $test

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

파트너 아이디
string|null $contractId

기본값은 파트너의 기본 계약 아이디 입니다.
string|null $memo 메모
string|null $paymentId

결제 아이디
array|null $orderDetail

주문 정보: 주문 금액 또는 주문 항목 하나만 입력 가능합니다.
int|null $taxFreeAmount

주문 면세 금액: 주문 항목과 면세 금액을 같이 전달하시면 최종 면세 금액은 주문 항목의 면세 금액이 아닌 전달해주신 면세 금액으로 적용됩니다.
string|null $settlementStartDate

정산 시작일: 날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
string|null $settlementDate

정산일: 날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
array|null $discounts

할인 정보
array|null $additionalFees

추가 수수료 정보
array|null $externalPaymentDetail

외부 결제 상세 정보: 해당 정보가 존재하는 경우 외부 결제 정산건 으로 등록되고, 존재하지않은 경우 포트원 결제 정산건으로 등록됩니다.
bool|null $isForTest

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

정산 파라미터 (실험기능)
array|null $userDefinedProperties

사용자 정의 속성
string|null $id

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

Return Value

CreateOrderTransferResponse

at line 155
Future createPlatformOrderTransferAsync(bool|null $test = null, string|null $partnerId = null, string|null $contractId = null, string|null $memo = null, string|null $paymentId = null, array|null $orderDetail = null, int|null $taxFreeAmount = null, string|null $settlementStartDate = null, string|null $settlementDate = null, array|null $discounts = null, array|null $additionalFees = null, array|null $externalPaymentDetail = null, bool|null $isForTest = null, array|null $parameters = null, array|null $userDefinedProperties = null, string|null $id = 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 $partnerId

파트너 아이디
string|null $contractId

기본값은 파트너의 기본 계약 아이디 입니다.
string|null $memo 메모
string|null $paymentId

결제 아이디
array|null $orderDetail

주문 정보: 주문 금액 또는 주문 항목 하나만 입력 가능합니다.
int|null $taxFreeAmount

주문 면세 금액: 주문 항목과 면세 금액을 같이 전달하시면 최종 면세 금액은 주문 항목의 면세 금액이 아닌 전달해주신 면세 금액으로 적용됩니다.
string|null $settlementStartDate

정산 시작일: 날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
string|null $settlementDate

정산일: 날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
array|null $discounts

할인 정보
array|null $additionalFees

추가 수수료 정보
array|null $externalPaymentDetail

외부 결제 상세 정보: 해당 정보가 존재하는 경우 외부 결제 정산건 으로 등록되고, 존재하지않은 경우 포트원 결제 정산건으로 등록됩니다.
bool|null $isForTest

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

정산 파라미터 (실험기능)
array|null $userDefinedProperties

사용자 정의 속성
string|null $id

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

Return Value

Future

at line 167
DeletePlatformTransferResponse deletePlatformTransfer(string|null $id = null, bool|null $test = null)

정산건 삭제 기능입니다.

scheduled, in_process 상태의 정산건만 삭제가능합니다.

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

DeletePlatformTransferResponse

at line 180
Future deletePlatformTransferAsync(string|null $id = null, bool|null $test = null)

정산건 삭제 기능입니다.

scheduled, in_process 상태의 정산건만 삭제가능합니다. 비동기 요청을 시작하며, 반환된 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

at line 193
string downloadPlatformTransferSheet(bool|null $test = null, array|null $filter = null, array|null $fields = null)

정산 상세 내역 다운로드 기능입니다.

정산 상세 내역을 csv 파일로 다운로드 합니다.

Parameters

bool|null $test

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

정산건 필터 입력 정보: 정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.
array|null $fields

다운로드할 시트 컬럼

Return Value

string

at line 207
Future downloadPlatformTransferSheetAsync(bool|null $test = null, array|null $filter = null, array|null $fields = null)

정산 상세 내역 다운로드 기능입니다.

정산 상세 내역을 csv 파일로 다운로드 합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

bool|null $test

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

정산건 필터 입력 정보: 정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.
array|null $fields

다운로드할 시트 컬럼

Return Value

Future

at line 219
PlatformTransfer getPlatformTransfer(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

PlatformTransfer

at line 232
Future getPlatformTransferAsync(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

at line 245
GetPlatformTransferSummariesResponse getPlatformTransferSummaries(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

GetPlatformTransferSummariesResponse

at line 259
Future getPlatformTransferSummariesAsync(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