PaymentScheduleClient
final class PaymentScheduleClient extends AbstractClient (View source)
결제 예약 API 작업을 제공합니다.
Properties
| protected RequestExecutor | $executor | from AbstractClient |
Methods
PortOne API Secret과 선택적으로 전달된 공용 요청 실행기로 클라이언트를 초기화합니다.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
결제 예약 기능입니다.
결제 예약 기능입니다.
결제 예약 단건 조회 기능입니다.
결제 예약 단건 조회 기능입니다.
결제 예약 다건 조회 기능입니다.
결제 예약 다건 조회 기능입니다.
결제 예약 취소 기능입니다.
결제 예약 취소 기능입니다.
Details
__construct(string $apiSecret, RequestExecutor|null $executor = null)
PortOne API Secret과 선택적으로 전달된 공용 요청 실행기로 클라이언트를 초기화합니다.
array
__debugInfo()
인증 정보가 디버그 출력에 노출되지 않도록 빈 정보를 반환합니다.
array
__serialize()
인증 정보가 직렬화되어 노출되지 않도록 직렬화를 거부합니다.
void
__unserialize(array $data)
인증 정보가 포함된 객체의 역직렬화를 거부합니다.
protected RequestExecutor
createExecutor(string $apiSecret)
No description
protected object
callOperation(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)
No description
protected Future
callOperationAsync(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)
No description
protected object
callOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)
No description
protected Future
callOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)
No description
protected object
callOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)
No description
protected Future
callOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)
No description
protected string
callStringOperation(string $operation, string $method, string $path, array $options = [])
No description
protected Future
callStringOperationAsync(string $operation, string $method, string $path, array $options = [])
No description
protected string
callStringOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body)
No description
protected Future
callStringOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body)
No description
protected void
callUnitOperation(string $operation, string $method, string $path, array $options = [])
No description
protected Future
callUnitOperationAsync(string $operation, string $method, string $path, array $options = [])
No description
protected void
callUnitOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body)
No description
protected Future
callUnitOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body)
No description
protected void
callUnitOperationWithQuery(string $operation, string $method, string $path, array $query)
No description
protected Future
callUnitOperationWithQueryAsync(string $operation, string $method, string $path, array $query)
No description
CreatePaymentScheduleResponse
createPaymentSchedule(string|null $paymentId = null, array|null $payment = null, string|null $timeToPay = null)
결제 예약 기능입니다.
결제를 예약합니다.
Future
createPaymentScheduleAsync(string|null $paymentId = null, array|null $payment = null, string|null $timeToPay = null)
결제 예약 기능입니다.
결제를 예약합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.
PaymentSchedule
getPaymentSchedule(string|null $paymentScheduleId = null, string|null $storeId = null)
결제 예약 단건 조회 기능입니다.
주어진 아이디에 대응되는 결제 예약 건을 조회합니다.
Future
getPaymentScheduleAsync(string|null $paymentScheduleId = null, string|null $storeId = null)
결제 예약 단건 조회 기능입니다.
주어진 아이디에 대응되는 결제 예약 건을 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.
GetPaymentSchedulesResponse
getPaymentSchedules(array|null $page = null, array|null $sort = null, array|null $filter = null)
결제 예약 다건 조회 기능입니다.
주어진 조건에 맞는 결제 예약 건들을 조회합니다.
filter.from, filter.until 파라미터의 기본값이 결제 시점 기준 지난 90일에 속하는 건을 조회하도록 되어 있으니, 미래 예약 상태의 건을 조회하기 위해서는 해당 파라미터를 직접 설정해 주셔야 합니다.
Future
getPaymentSchedulesAsync(array|null $page = null, array|null $sort = null, array|null $filter = null)
결제 예약 다건 조회 기능입니다.
주어진 조건에 맞는 결제 예약 건들을 조회합니다.
filter.from, filter.until 파라미터의 기본값이 결제 시점 기준 지난 90일에 속하는 건을 조회하도록 되어 있으니, 미래 예약 상태의 건을 조회하기 위해서는 해당 파라미터를 직접 설정해 주셔야 합니다.
비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.
RevokePaymentSchedulesResponse
revokePaymentSchedules(string|null $billingKey = null, array|null $scheduleIds = null, string|null $storeId = null)
결제 예약 취소 기능입니다.
결제 예약 건을 취소합니다. billingKey, scheduleIds 중 하나 이상은 필수로 입력합니다. billingKey 만 입력된 경우 -> 해당 빌링키로 예약된 모든 결제 예약 건들이 취소됩니다. scheduleIds 만 입력된 경우 -> 입력된 결제 예약 건 아이디에 해당하는 예약 건들이 취소됩니다. billingKey, scheduleIds 모두 입력된 경우 -> 입력된 결제 예약 건 아이디에 해당하는 예약 건들이 취소됩니다. 단, 예약한 빌링키가 입력된 빌링키와 일치하지 않으면 실패합니다. 위 정책에 따라 선택된 결제 예약 건들 중 하나라도 취소에 실패할 경우, 모든 취소 요청이 실패합니다.
Future
revokePaymentSchedulesAsync(string|null $billingKey = null, array|null $scheduleIds = null, string|null $storeId = null)
결제 예약 취소 기능입니다.
결제 예약 건을 취소합니다. billingKey, scheduleIds 중 하나 이상은 필수로 입력합니다. billingKey 만 입력된 경우 -> 해당 빌링키로 예약된 모든 결제 예약 건들이 취소됩니다. scheduleIds 만 입력된 경우 -> 입력된 결제 예약 건 아이디에 해당하는 예약 건들이 취소됩니다. billingKey, scheduleIds 모두 입력된 경우 -> 입력된 결제 예약 건 아이디에 해당하는 예약 건들이 취소됩니다. 단, 예약한 빌링키가 입력된 빌링키와 일치하지 않으면 실패합니다. 위 정책에 따라 선택된 결제 예약 건들 중 하나라도 취소에 실패할 경우, 모든 취소 요청이 실패합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.