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

PaymentClient

class PaymentClient extends AbstractClient (View source)

결제 API 작업과 결제 관련 하위 클라이언트에 접근할 수 있습니다.

Properties

protected RequestExecutor $executor from  AbstractClient
BillingKeyClient $billingKey
CashReceiptClient $cashReceipt
AdditionalFeatureClient $additionalFeature
PaymentScheduleClient $paymentSchedule
PromotionClient $promotion

Methods

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

PaymentClient 객체를 초기화합니다.

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
GetPaymentsResponse
getPayments(array|null $page = null, array|null $filter = null)

결제 다건 조회(페이지 기반) 기능입니다.

Future
getPaymentsAsync(array|null $page = null, array|null $filter = null)

결제 다건 조회(페이지 기반) 기능입니다.

ApplyEscrowLogisticsResponse
applyEscrowLogistics(string|null $paymentId = null, array|null $sender = null, array|null $receiver = null, array|null $logistics = null, bool|null $sendEmail = null, array|null $products = null, string|null $storeId = null)

에스크로 배송 정보 등록 기능입니다.

Future
applyEscrowLogisticsAsync(string|null $paymentId = null, array|null $sender = null, array|null $receiver = null, array|null $logistics = null, bool|null $sendEmail = null, array|null $products = null, string|null $storeId = null)

에스크로 배송 정보 등록 기능입니다.

CancelPaymentResponse
cancelPayment(string|null $paymentId = null, int|null $amount = null, int|null $taxFreeAmount = null, int|null $vatAmount = null, string|null $reason = null, string|null $requester = null, string|null $promotionDiscountRetainOption = null, int|null $currentCancellableAmount = null, array|null $refundAccount = null, string|null $refundEmail = null, bool|null $skipWebhook = null, string|null $storeId = null)

결제 취소 기능입니다.

Future
cancelPaymentAsync(string|null $paymentId = null, int|null $amount = null, int|null $taxFreeAmount = null, int|null $vatAmount = null, string|null $reason = null, string|null $requester = null, string|null $promotionDiscountRetainOption = null, int|null $currentCancellableAmount = null, array|null $refundAccount = null, string|null $refundEmail = null, bool|null $skipWebhook = null, string|null $storeId = null)

결제 취소 기능입니다.

CapturePaymentResponse
capturePayment(string|null $paymentId = null, string|null $storeId = null)

수동 매입 기능입니다.

Future
capturePaymentAsync(string|null $paymentId = null, string|null $storeId = null)

수동 매입 기능입니다.

CloseVirtualAccountResponse
closeVirtualAccount(string|null $paymentId = null, string|null $storeId = null)

가상계좌 말소 기능입니다.

Future
closeVirtualAccountAsync(string|null $paymentId = null, string|null $storeId = null)

가상계좌 말소 기능입니다.

ConfirmEscrowResponse
confirmEscrow(string|null $paymentId = null, bool|null $fromStore = null, string|null $storeId = null)

에스크로 구매 확정 기능입니다.

Future
confirmEscrowAsync(string|null $paymentId = null, bool|null $fromStore = null, string|null $storeId = null)

에스크로 구매 확정 기능입니다.

ConfirmedPaymentSummary
confirmPayment(string|null $paymentId = null, string|null $paymentToken = null, string|null $txId = null, string|null $currency = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

인증 결제 수동 승인 기능입니다.

Future
confirmPaymentAsync(string|null $paymentId = null, string|null $paymentToken = null, string|null $txId = null, string|null $currency = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

인증 결제 수동 승인 기능입니다.

GetAllPaymentEventsByCursorResponse
getAllPaymentEventsByCursor(string|null $from = null, string|null $until = null, string|null $cursor = null, int|null $size = null, string|null $storeId = null)

결제 이벤트 대용량 다건 조회(커서 기반) 기능입니다.

Future
getAllPaymentEventsByCursorAsync(string|null $from = null, string|null $until = null, string|null $cursor = null, int|null $size = null, string|null $storeId = null)

결제 이벤트 대용량 다건 조회(커서 기반) 기능입니다.

GetAllPaymentsByCursorResponse
getAllPaymentsByCursor(string|null $from = null, string|null $until = null, string|null $cursor = null, int|null $size = null, string|null $storeId = null)

결제 대용량 다건 조회(커서 기반) 기능입니다.

Future
getAllPaymentsByCursorAsync(string|null $from = null, string|null $until = null, string|null $cursor = null, int|null $size = null, string|null $storeId = null)

결제 대용량 다건 조회(커서 기반) 기능입니다.

Payment
getPayment(string|null $paymentId = null, string|null $storeId = null)

결제 단건 조회 기능입니다.

Future
getPaymentAsync(string|null $paymentId = null, string|null $storeId = null)

결제 단건 조회 기능입니다.

GetPaymentTransactionsResponse
getPaymentTransactions(string|null $paymentId = null, string|null $storeId = null)

결제 시도 내역 조회 기능입니다.

Future
getPaymentTransactionsAsync(string|null $paymentId = null, string|null $storeId = null)

결제 시도 내역 조회 기능입니다.

ModifyEscrowLogisticsResponse
modifyEscrowLogistics(string|null $paymentId = null, array|null $sender = null, array|null $receiver = null, array|null $logistics = null, bool|null $sendEmail = null, array|null $products = null, string|null $storeId = null)

에스크로 배송 정보 수정 기능입니다.

Future
modifyEscrowLogisticsAsync(string|null $paymentId = null, array|null $sender = null, array|null $receiver = null, array|null $logistics = null, bool|null $sendEmail = null, array|null $products = null, string|null $storeId = null)

에스크로 배송 정보 수정 기능입니다.

PayInstantlyResponse
payInstantly(string|null $paymentId = null, string|null $channelKey = null, string|null $channelGroupId = null, array|null $method = null, string|null $orderName = null, bool|null $isCulturalExpense = null, bool|null $isEscrow = null, array|null $customer = null, string|null $customData = null, array|null $amount = null, string|null $currency = null, string|null $country = null, array|null $noticeUrls = null, array|null $products = null, int|null $productCount = null, string|null $productType = null, array|null $shippingAddress = null, string|null $promotionId = null, array|null $bypass = null, bool|null $skipWebhook = null, string|null $storeId = null)

수기 결제 기능입니다.

Future
payInstantlyAsync(string|null $paymentId = null, string|null $channelKey = null, string|null $channelGroupId = null, array|null $method = null, string|null $orderName = null, bool|null $isCulturalExpense = null, bool|null $isEscrow = null, array|null $customer = null, string|null $customData = null, array|null $amount = null, string|null $currency = null, string|null $country = null, array|null $noticeUrls = null, array|null $products = null, int|null $productCount = null, string|null $productType = null, array|null $shippingAddress = null, string|null $promotionId = null, array|null $bypass = null, bool|null $skipWebhook = null, string|null $storeId = null)

수기 결제 기능입니다.

PayWithBillingKeyResponse
payWithBillingKey(string|null $paymentId = null, string|null $billingKey = null, string|null $channelKey = null, string|null $orderName = null, array|null $customer = null, string|null $customData = null, array|null $amount = null, string|null $currency = null, int|null $installmentMonth = null, bool|null $useFreeInterestFromMerchant = null, bool|null $useCardPoint = null, array|null $cashReceipt = null, string|null $country = null, array|null $noticeUrls = null, array|null $products = null, int|null $productCount = null, string|null $productType = null, array|null $shippingAddress = null, string|null $promotionId = null, string|null $locale = null, array|null $bypass = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 결제 기능입니다.

Future
payWithBillingKeyAsync(string|null $paymentId = null, string|null $billingKey = null, string|null $channelKey = null, string|null $orderName = null, array|null $customer = null, string|null $customData = null, array|null $amount = null, string|null $currency = null, int|null $installmentMonth = null, bool|null $useFreeInterestFromMerchant = null, bool|null $useCardPoint = null, array|null $cashReceipt = null, string|null $country = null, array|null $noticeUrls = null, array|null $products = null, int|null $productCount = null, string|null $productType = null, array|null $shippingAddress = null, string|null $promotionId = null, string|null $locale = null, array|null $bypass = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 결제 기능입니다.

PreRegisterPaymentResponse
preRegisterPayment(string|null $paymentId = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, string|null $currency = null, string|null $storeId = null)

결제 정보 사전 등록 기능입니다.

Future
preRegisterPaymentAsync(string|null $paymentId = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, string|null $currency = null, string|null $storeId = null)

결제 정보 사전 등록 기능입니다.

RegisterStoreReceiptResponse
registerStoreReceipt(string|null $paymentId = null, array|null $items = null, string|null $storeId = null)

영수증 내 하위 상점 거래 등록 기능입니다.

Future
registerStoreReceiptAsync(string|null $paymentId = null, array|null $items = null, string|null $storeId = null)

영수증 내 하위 상점 거래 등록 기능입니다.

ResendWebhookResponse
resendWebhook(string|null $paymentId = null, string|null $webhookId = null, string|null $storeId = null)

웹훅 재발송 기능입니다.

Future
resendWebhookAsync(string|null $paymentId = null, string|null $webhookId = null, string|null $storeId = null)

웹훅 재발송 기능입니다.

StopPaymentCancellationResponse
stopPaymentCancellation(string|null $paymentId = null, string|null $cancellationId = null, string|null $storeId = null)

결제 취소 요청 취소 기능입니다.

Future
stopPaymentCancellationAsync(string|null $paymentId = null, string|null $cancellationId = null, string|null $storeId = null)

결제 취소 요청 취소 기능입니다.

Details

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

PaymentClient 객체를 초기화합니다.

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 50
GetPaymentsResponse getPayments(array|null $page = null, array|null $filter = null)

결제 다건 조회(페이지 기반) 기능입니다.

주어진 조건에 맞는 결제 건들을 페이지 기반으로 조회합니다.

Parameters

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보: 미 입력 시 number = 0, size = 10 으로 기본값이 적용됩니다. (number + 1) * size가 60,000을 초과할 수 없습니다.
array|null $filter

결제 다건 조회를 위한 입력 정보: V1 결제 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.

Return Value

GetPaymentsResponse

at line 70
Future getPaymentsAsync(array|null $page = null, array|null $filter = null)

결제 다건 조회(페이지 기반) 기능입니다.

주어진 조건에 맞는 결제 건들을 페이지 기반으로 조회합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

array|null $page

다건 조회 API 에 사용되는 페이지 입력 정보: 미 입력 시 number = 0, size = 10 으로 기본값이 적용됩니다. (number + 1) * size가 60,000을 초과할 수 없습니다.
array|null $filter

결제 다건 조회를 위한 입력 정보: V1 결제 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.

Return Value

Future

at line 94
ApplyEscrowLogisticsResponse applyEscrowLogistics(string|null $paymentId = null, array|null $sender = null, array|null $receiver = null, array|null $logistics = null, bool|null $sendEmail = null, array|null $products = null, string|null $storeId = null)

에스크로 배송 정보 등록 기능입니다.

에스크로 배송 정보를 등록합니다.

Parameters

string|null $paymentId

결제 건 아이디
array|null $sender

에스크로 발송자 정보
array|null $receiver

에스크로 수취인 정보
array|null $logistics 배송정보
bool|null $sendEmail

이메일 알림 전송 여부: 에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
array|null $products

상품 정보
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

ApplyEscrowLogisticsResponse

at line 112
Future applyEscrowLogisticsAsync(string|null $paymentId = null, array|null $sender = null, array|null $receiver = null, array|null $logistics = null, bool|null $sendEmail = null, array|null $products = null, string|null $storeId = null)

에스크로 배송 정보 등록 기능입니다.

에스크로 배송 정보를 등록합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
array|null $sender

에스크로 발송자 정보
array|null $receiver

에스크로 수취인 정보
array|null $logistics 배송정보
bool|null $sendEmail

이메일 알림 전송 여부: 에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
array|null $products

상품 정보
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 134
CancelPaymentResponse cancelPayment(string|null $paymentId = null, int|null $amount = null, int|null $taxFreeAmount = null, int|null $vatAmount = null, string|null $reason = null, string|null $requester = null, string|null $promotionDiscountRetainOption = null, int|null $currentCancellableAmount = null, array|null $refundAccount = null, string|null $refundEmail = null, bool|null $skipWebhook = null, string|null $storeId = null)

결제 취소 기능입니다.

결제 취소를 요청합니다.

Parameters

string|null $paymentId

결제 건 아이디
int|null $amount

취소 총 금액: 값을 입력하지 않으면 전액 취소됩니다.
int|null $taxFreeAmount

취소 금액 중 면세 금액: 값을 입력하지 않으면 전액 과세 취소됩니다.
int|null $vatAmount

취소 금액 중 부가세액: 값을 입력하지 않으면 자동 계산됩니다.
string|null $reason

취소 사유
string|null $requester

결제 취소 요청 주체: 고객에 의한 취소일 경우 Customer, 관리자에 의한 취소일 경우 Admin으로 입력합니다.
string|null $promotionDiscountRetainOption

프로모션 할인율 유지 옵션: 프로모션이 적용된 결제를 부분 취소하는 경우, 최초 할인율을 유지할지 여부를 선택할 수 있습니다. RETAIN 으로 설정 시, 최초 할인율을 유지할 수 있도록 취소 금액이 조정됩니다. RELEASE 으로 설정 시, 취소 후 남은 금액이 속한 구간에 맞게 프로모션 할인이 새롭게 적용됩니다. 값을 입력하지 않으면 RELEASE 로 취급합니다.
int|null $currentCancellableAmount

결제 건의 취소 가능 잔액: 본 취소 요청 이전의 취소 가능 잔액으로써, 값을 입력하면 잔액이 일치하는 경우에만 취소가 진행됩니다. 값을 입력하지 않으면 별도의 검증 처리를 수행하지 않습니다.
array|null $refundAccount

고객 정보 입력 형식: 계좌 환불일 경우 입력합니다. 계좌 환불이 필요한 경우는 가상계좌 환불, 휴대폰 익월 환불 등이 있습니다.
string|null $refundEmail

환불 이메일: Triple-A 결제 환불에 필요합니다. 해당 이메일로 환불 안내가 발송됩니다.
bool|null $skipWebhook

웹훅 생략 여부: 취소가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

CancelPaymentResponse

at line 157
Future cancelPaymentAsync(string|null $paymentId = null, int|null $amount = null, int|null $taxFreeAmount = null, int|null $vatAmount = null, string|null $reason = null, string|null $requester = null, string|null $promotionDiscountRetainOption = null, int|null $currentCancellableAmount = null, array|null $refundAccount = null, string|null $refundEmail = null, bool|null $skipWebhook = null, string|null $storeId = null)

결제 취소 기능입니다.

결제 취소를 요청합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
int|null $amount

취소 총 금액: 값을 입력하지 않으면 전액 취소됩니다.
int|null $taxFreeAmount

취소 금액 중 면세 금액: 값을 입력하지 않으면 전액 과세 취소됩니다.
int|null $vatAmount

취소 금액 중 부가세액: 값을 입력하지 않으면 자동 계산됩니다.
string|null $reason

취소 사유
string|null $requester

결제 취소 요청 주체: 고객에 의한 취소일 경우 Customer, 관리자에 의한 취소일 경우 Admin으로 입력합니다.
string|null $promotionDiscountRetainOption

프로모션 할인율 유지 옵션: 프로모션이 적용된 결제를 부분 취소하는 경우, 최초 할인율을 유지할지 여부를 선택할 수 있습니다. RETAIN 으로 설정 시, 최초 할인율을 유지할 수 있도록 취소 금액이 조정됩니다. RELEASE 으로 설정 시, 취소 후 남은 금액이 속한 구간에 맞게 프로모션 할인이 새롭게 적용됩니다. 값을 입력하지 않으면 RELEASE 로 취급합니다.
int|null $currentCancellableAmount

결제 건의 취소 가능 잔액: 본 취소 요청 이전의 취소 가능 잔액으로써, 값을 입력하면 잔액이 일치하는 경우에만 취소가 진행됩니다. 값을 입력하지 않으면 별도의 검증 처리를 수행하지 않습니다.
array|null $refundAccount

고객 정보 입력 형식: 계좌 환불일 경우 입력합니다. 계좌 환불이 필요한 경우는 가상계좌 환불, 휴대폰 익월 환불 등이 있습니다.
string|null $refundEmail

환불 이메일: Triple-A 결제 환불에 필요합니다. 해당 이메일로 환불 안내가 발송됩니다.
bool|null $skipWebhook

웹훅 생략 여부: 취소가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 169
CapturePaymentResponse capturePayment(string|null $paymentId = null, string|null $storeId = null)

수동 매입 기능입니다.

수동 매입을 요청합니다. PG 및 포트원과의 사전 협의가 필요합니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

CapturePaymentResponse

at line 182
Future capturePaymentAsync(string|null $paymentId = null, string|null $storeId = null)

수동 매입 기능입니다.

수동 매입을 요청합니다. PG 및 포트원과의 사전 협의가 필요합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 194
CloseVirtualAccountResponse closeVirtualAccount(string|null $paymentId = null, string|null $storeId = null)

가상계좌 말소 기능입니다.

발급된 가상계좌를 말소합니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

CloseVirtualAccountResponse

at line 207
Future closeVirtualAccountAsync(string|null $paymentId = null, string|null $storeId = null)

가상계좌 말소 기능입니다.

발급된 가상계좌를 말소합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 220
ConfirmEscrowResponse confirmEscrow(string|null $paymentId = null, bool|null $fromStore = null, string|null $storeId = null)

에스크로 구매 확정 기능입니다.

에스크로 결제를 구매 확정 처리합니다

Parameters

string|null $paymentId

결제 건 아이디
bool|null $fromStore

확인 주체가 상점인지 여부: 구매확정요청 주체가 고객사 관리자인지 구매자인지 구분하기 위한 필드입니다. 네이버페이 전용 파라미터이며, 구분이 모호한 경우 고객사 관리자(true)로 입력합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

ConfirmEscrowResponse

at line 234
Future confirmEscrowAsync(string|null $paymentId = null, bool|null $fromStore = null, string|null $storeId = null)

에스크로 구매 확정 기능입니다.

에스크로 결제를 구매 확정 처리합니다 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
bool|null $fromStore

확인 주체가 상점인지 여부: 구매확정요청 주체가 고객사 관리자인지 구매자인지 구분하기 위한 필드입니다. 네이버페이 전용 파라미터이며, 구분이 모호한 경우 고객사 관리자(true)로 입력합니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 253
ConfirmedPaymentSummary confirmPayment(string|null $paymentId = null, string|null $paymentToken = null, string|null $txId = null, string|null $currency = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

인증 결제 수동 승인 기능입니다.

수동 승인으로 설정된 인증 결제에 대해, 결제를 완료 처리합니다.

Parameters

string|null $paymentId

결제 아이디
string|null $paymentToken

결제 토큰: 인증 완료 시 발급된 토큰입니다.
string|null $txId

검증용 파라미터로, 결제 시도 아이디와 일치하지 않을 경우 오류가 반환됩니다.
string|null $currency

통화: 검증용 파라미터로, 결제 건 화폐와 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
int|null $totalAmount

결제 금액: 검증용 파라미터로, 결제 건 총 금액과 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
int|null $taxFreeAmount

검증용 파라미터로, 결제 건 면세 금액과 일치하지 않을 경우 오류가 반환됩니다.
bool|null $isTest

테스트 결제 여부: 검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
bool|null $skipWebhook

웹훅 생략 여부: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

ConfirmedPaymentSummary

at line 273
Future confirmPaymentAsync(string|null $paymentId = null, string|null $paymentToken = null, string|null $txId = null, string|null $currency = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, bool|null $isTest = null, bool|null $skipWebhook = null, string|null $storeId = null)

인증 결제 수동 승인 기능입니다.

수동 승인으로 설정된 인증 결제에 대해, 결제를 완료 처리합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 아이디
string|null $paymentToken

결제 토큰: 인증 완료 시 발급된 토큰입니다.
string|null $txId

검증용 파라미터로, 결제 시도 아이디와 일치하지 않을 경우 오류가 반환됩니다.
string|null $currency

통화: 검증용 파라미터로, 결제 건 화폐와 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
int|null $totalAmount

결제 금액: 검증용 파라미터로, 결제 건 총 금액과 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
int|null $taxFreeAmount

검증용 파라미터로, 결제 건 면세 금액과 일치하지 않을 경우 오류가 반환됩니다.
bool|null $isTest

테스트 결제 여부: 검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다. 값 전달을 권장합니다.
bool|null $skipWebhook

웹훅 생략 여부: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 288
GetAllPaymentEventsByCursorResponse getAllPaymentEventsByCursor(string|null $from = null, string|null $until = null, string|null $cursor = null, int|null $size = null, string|null $storeId = null)

결제 이벤트 대용량 다건 조회(커서 기반) 기능입니다.

기간 내 모든 결제 이벤트를 커서 기반으로 조회합니다. 결제 이벤트의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 이벤트가 조회됩니다.

Parameters

string|null $from

결제 이벤트 생성시점 범위 조건의 시작: 값을 입력하지 않으면 end의 90일 전으로 설정됩니다.
string|null $until

결제 이벤트 생성시점 범위 조건의 끝: 값을 입력하지 않으면 현재 시점으로 설정됩니다.
string|null $cursor

커서: 결제 이벤트 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.
int|null $size

페이지 크기: 미입력 시 기본값은 10 이며 최대 1000까지 허용
string|null $storeId

상점 아이디: Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제 이벤트를 조회합니다.

Return Value

GetAllPaymentEventsByCursorResponse

at line 304
Future getAllPaymentEventsByCursorAsync(string|null $from = null, string|null $until = null, string|null $cursor = null, int|null $size = null, string|null $storeId = null)

결제 이벤트 대용량 다건 조회(커서 기반) 기능입니다.

기간 내 모든 결제 이벤트를 커서 기반으로 조회합니다. 결제 이벤트의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 이벤트가 조회됩니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $from

결제 이벤트 생성시점 범위 조건의 시작: 값을 입력하지 않으면 end의 90일 전으로 설정됩니다.
string|null $until

결제 이벤트 생성시점 범위 조건의 끝: 값을 입력하지 않으면 현재 시점으로 설정됩니다.
string|null $cursor

커서: 결제 이벤트 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.
int|null $size

페이지 크기: 미입력 시 기본값은 10 이며 최대 1000까지 허용
string|null $storeId

상점 아이디: Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제 이벤트를 조회합니다.

Return Value

Future

at line 319
GetAllPaymentsByCursorResponse getAllPaymentsByCursor(string|null $from = null, string|null $until = null, string|null $cursor = null, int|null $size = null, string|null $storeId = null)

결제 대용량 다건 조회(커서 기반) 기능입니다.

기간 내 모든 결제 건을 커서 기반으로 조회합니다. 결제 건의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 건이 조회됩니다.

Parameters

string|null $from

결제 건 생성시점 범위 조건의 시작: 값을 입력하지 않으면 end의 90일 전으로 설정됩니다.
string|null $until

결제 건 생성시점 범위 조건의 끝: 값을 입력하지 않으면 현재 시점으로 설정됩니다.
string|null $cursor

커서: 결제 건 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.
int|null $size

페이지 크기: 미입력 시 기본값은 10 이며 최대 1000까지 허용
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

GetAllPaymentsByCursorResponse

at line 335
Future getAllPaymentsByCursorAsync(string|null $from = null, string|null $until = null, string|null $cursor = null, int|null $size = null, string|null $storeId = null)

결제 대용량 다건 조회(커서 기반) 기능입니다.

기간 내 모든 결제 건을 커서 기반으로 조회합니다. 결제 건의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 건이 조회됩니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $from

결제 건 생성시점 범위 조건의 시작: 값을 입력하지 않으면 end의 90일 전으로 설정됩니다.
string|null $until

결제 건 생성시점 범위 조건의 끝: 값을 입력하지 않으면 현재 시점으로 설정됩니다.
string|null $cursor

커서: 결제 건 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.
int|null $size

페이지 크기: 미입력 시 기본값은 10 이며 최대 1000까지 허용
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 347
Payment getPayment(string|null $paymentId = null, string|null $storeId = null)

결제 단건 조회 기능입니다.

주어진 아이디에 대응되는 결제 건을 조회합니다.

Parameters

string|null $paymentId

조회할 결제 아이디
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Payment

at line 360
Future getPaymentAsync(string|null $paymentId = null, string|null $storeId = null)

결제 단건 조회 기능입니다.

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

Parameters

string|null $paymentId

조회할 결제 아이디
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 372
GetPaymentTransactionsResponse getPaymentTransactions(string|null $paymentId = null, string|null $storeId = null)

결제 시도 내역 조회 기능입니다.

주어진 아이디에 대응되는 결제 건의 결제 시도 내역을 조회합니다.

Parameters

string|null $paymentId

조회할 결제 아이디
string|null $storeId

상점 아이디

Return Value

GetPaymentTransactionsResponse

at line 385
Future getPaymentTransactionsAsync(string|null $paymentId = null, string|null $storeId = null)

결제 시도 내역 조회 기능입니다.

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

Parameters

string|null $paymentId

조회할 결제 아이디
string|null $storeId

상점 아이디

Return Value

Future

at line 402
ModifyEscrowLogisticsResponse modifyEscrowLogistics(string|null $paymentId = null, array|null $sender = null, array|null $receiver = null, array|null $logistics = null, bool|null $sendEmail = null, array|null $products = null, string|null $storeId = null)

에스크로 배송 정보 수정 기능입니다.

에스크로 배송 정보를 수정합니다.

Parameters

string|null $paymentId

결제 건 아이디
array|null $sender

에스크로 발송자 정보
array|null $receiver

에스크로 수취인 정보
array|null $logistics 배송정보
bool|null $sendEmail

이메일 알림 전송 여부: 에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
array|null $products

상품 정보
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

ModifyEscrowLogisticsResponse

at line 420
Future modifyEscrowLogisticsAsync(string|null $paymentId = null, array|null $sender = null, array|null $receiver = null, array|null $logistics = null, bool|null $sendEmail = null, array|null $products = null, string|null $storeId = null)

에스크로 배송 정보 수정 기능입니다.

에스크로 배송 정보를 수정합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
array|null $sender

에스크로 발송자 정보
array|null $receiver

에스크로 수취인 정보
array|null $logistics 배송정보
bool|null $sendEmail

이메일 알림 전송 여부: 에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
array|null $products

상품 정보
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 451
PayInstantlyResponse payInstantly(string|null $paymentId = null, string|null $channelKey = null, string|null $channelGroupId = null, array|null $method = null, string|null $orderName = null, bool|null $isCulturalExpense = null, bool|null $isEscrow = null, array|null $customer = null, string|null $customData = null, array|null $amount = null, string|null $currency = null, string|null $country = null, array|null $noticeUrls = null, array|null $products = null, int|null $productCount = null, string|null $productType = null, array|null $shippingAddress = null, string|null $promotionId = null, array|null $bypass = null, bool|null $skipWebhook = null, string|null $storeId = null)

수기 결제 기능입니다.

카드 비인증 결제 또는 가상 계좌 발급을 API로 요청합니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $channelKey

채널 키 또는 채널 그룹 ID 필수
string|null $channelGroupId

채널 키 또는 채널 그룹 ID 필수
array|null $method

수기 결제 수단 입력 정보: 하나의 필드만 입력합니다.
string|null $orderName 주문명
bool|null $isCulturalExpense

문화비 지출 여부: 기본값은 false 입니다.
bool|null $isEscrow

에스크로 결제 여부: 기본값은 false 입니다.
array|null $customer

고객 정보 입력 정보
string|null $customData

사용자 지정 데이터
array|null $amount

금액 세부 입력 정보
string|null $currency 통화
string|null $country 국가
array|null $noticeUrls

결제 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 빈 배열은 무시됩니다.
array|null $products

상품 정보: 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
int|null $productCount

상품 개수
string|null $productType

상품 유형
array|null $shippingAddress

분리 형식 주소 입력 정보
string|null $promotionId

해당 결제에 적용할 프로모션 아이디
array|null $bypass

PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
bool|null $skipWebhook

웹훅 생략 여부: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

PayInstantlyResponse

at line 483
Future payInstantlyAsync(string|null $paymentId = null, string|null $channelKey = null, string|null $channelGroupId = null, array|null $method = null, string|null $orderName = null, bool|null $isCulturalExpense = null, bool|null $isEscrow = null, array|null $customer = null, string|null $customData = null, array|null $amount = null, string|null $currency = null, string|null $country = null, array|null $noticeUrls = null, array|null $products = null, int|null $productCount = null, string|null $productType = null, array|null $shippingAddress = null, string|null $promotionId = null, array|null $bypass = null, bool|null $skipWebhook = null, string|null $storeId = null)

수기 결제 기능입니다.

카드 비인증 결제 또는 가상 계좌 발급을 API로 요청합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $channelKey

채널 키 또는 채널 그룹 ID 필수
string|null $channelGroupId

채널 키 또는 채널 그룹 ID 필수
array|null $method

수기 결제 수단 입력 정보: 하나의 필드만 입력합니다.
string|null $orderName 주문명
bool|null $isCulturalExpense

문화비 지출 여부: 기본값은 false 입니다.
bool|null $isEscrow

에스크로 결제 여부: 기본값은 false 입니다.
array|null $customer

고객 정보 입력 정보
string|null $customData

사용자 지정 데이터
array|null $amount

금액 세부 입력 정보
string|null $currency 통화
string|null $country 국가
array|null $noticeUrls

결제 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 빈 배열은 무시됩니다.
array|null $products

상품 정보: 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
int|null $productCount

상품 개수
string|null $productType

상품 유형
array|null $shippingAddress

분리 형식 주소 입력 정보
string|null $promotionId

해당 결제에 적용할 프로모션 아이디
array|null $bypass

PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
bool|null $skipWebhook

웹훅 생략 여부: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 516
PayWithBillingKeyResponse payWithBillingKey(string|null $paymentId = null, string|null $billingKey = null, string|null $channelKey = null, string|null $orderName = null, array|null $customer = null, string|null $customData = null, array|null $amount = null, string|null $currency = null, int|null $installmentMonth = null, bool|null $useFreeInterestFromMerchant = null, bool|null $useCardPoint = null, array|null $cashReceipt = null, string|null $country = null, array|null $noticeUrls = null, array|null $products = null, int|null $productCount = null, string|null $productType = null, array|null $shippingAddress = null, string|null $promotionId = null, string|null $locale = null, array|null $bypass = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 결제 기능입니다.

빌링키로 결제를 진행합니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $billingKey

빌링키 결제에 사용할 빌링키
string|null $channelKey

채널 키: 다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시
string|null $orderName 주문명
array|null $customer

고객 정보 입력 정보
string|null $customData

사용자 지정 데이터
array|null $amount

금액 세부 입력 정보
string|null $currency 통화
int|null $installmentMonth

할부 개월 수
bool|null $useFreeInterestFromMerchant

무이자 할부 이자를 고객사가 부담할지 여부
bool|null $useCardPoint

카드 포인트 사용 여부
array|null $cashReceipt

현금영수증 입력 정보: 나이스페이먼츠를 통해 네이버페이 포인트 빌링결제 시, 현금영수증 발급을 위해 입력 가능 (신청 필요)
string|null $country 국가
array|null $noticeUrls

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 빈 배열은 무시됩니다.
array|null $products

상품 정보: 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
int|null $productCount

상품 개수
string|null $productType

상품 유형
array|null $shippingAddress

분리 형식 주소 입력 정보
string|null $promotionId

해당 결제에 적용할 프로모션 아이디
string|null $locale

결제 언어: 엑심베이의 경우 필수 입력입니다.
array|null $bypass

PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
bool|null $skipWebhook

웹훅 생략 여부: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

PayWithBillingKeyResponse

at line 550
Future payWithBillingKeyAsync(string|null $paymentId = null, string|null $billingKey = null, string|null $channelKey = null, string|null $orderName = null, array|null $customer = null, string|null $customData = null, array|null $amount = null, string|null $currency = null, int|null $installmentMonth = null, bool|null $useFreeInterestFromMerchant = null, bool|null $useCardPoint = null, array|null $cashReceipt = null, string|null $country = null, array|null $noticeUrls = null, array|null $products = null, int|null $productCount = null, string|null $productType = null, array|null $shippingAddress = null, string|null $promotionId = null, string|null $locale = null, array|null $bypass = null, bool|null $skipWebhook = null, string|null $storeId = null)

빌링키 결제 기능입니다.

빌링키로 결제를 진행합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $billingKey

빌링키 결제에 사용할 빌링키
string|null $channelKey

채널 키: 다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시
string|null $orderName 주문명
array|null $customer

고객 정보 입력 정보
string|null $customData

사용자 지정 데이터
array|null $amount

금액 세부 입력 정보
string|null $currency 통화
int|null $installmentMonth

할부 개월 수
bool|null $useFreeInterestFromMerchant

무이자 할부 이자를 고객사가 부담할지 여부
bool|null $useCardPoint

카드 포인트 사용 여부
array|null $cashReceipt

현금영수증 입력 정보: 나이스페이먼츠를 통해 네이버페이 포인트 빌링결제 시, 현금영수증 발급을 위해 입력 가능 (신청 필요)
string|null $country 국가
array|null $noticeUrls

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 빈 배열은 무시됩니다.
array|null $products

상품 정보: 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
int|null $productCount

상품 개수
string|null $productType

상품 유형
array|null $shippingAddress

분리 형식 주소 입력 정보
string|null $promotionId

해당 결제에 적용할 프로모션 아이디
string|null $locale

결제 언어: 엑심베이의 경우 필수 입력입니다.
array|null $bypass

PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
bool|null $skipWebhook

웹훅 생략 여부: 결제가 성공했을 때 웹훅을 전송하지 않으려면 true로 설정합니다. 가상계좌 입금 완료 등 외부 이벤트로 결제가 완료되는 경우 발생하는 웹훅은 스킵되지 않습니다.
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 565
PreRegisterPaymentResponse preRegisterPayment(string|null $paymentId = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, string|null $currency = null, string|null $storeId = null)

결제 정보 사전 등록 기능입니다.

결제 정보를 사전 등록합니다.

Parameters

string|null $paymentId

결제 건 아이디
int|null $totalAmount

결제 총 금액
int|null $taxFreeAmount

결제 면세 금액
string|null $currency 통화
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

PreRegisterPaymentResponse

at line 581
Future preRegisterPaymentAsync(string|null $paymentId = null, int|null $totalAmount = null, int|null $taxFreeAmount = null, string|null $currency = null, string|null $storeId = null)

결제 정보 사전 등록 기능입니다.

결제 정보를 사전 등록합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
int|null $totalAmount

결제 총 금액
int|null $taxFreeAmount

결제 면세 금액
string|null $currency 통화
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 596
RegisterStoreReceiptResponse registerStoreReceipt(string|null $paymentId = null, array|null $items = null, string|null $storeId = null)

영수증 내 하위 상점 거래 등록 기능입니다.

결제 내역 매출전표에 하위 상점의 거래를 등록합니다. 지원되는 PG사: KG이니시스(이용 전 콘솔 -> 결제연동 탭에서 INIApi Key 등록 필요)

Parameters

string|null $paymentId

등록할 하위 상점 결제 건 아이디
array|null $items

하위 상점 거래 목록
string|null $storeId

상점 아이디

Return Value

RegisterStoreReceiptResponse

at line 612
Future registerStoreReceiptAsync(string|null $paymentId = null, array|null $items = null, string|null $storeId = null)

영수증 내 하위 상점 거래 등록 기능입니다.

결제 내역 매출전표에 하위 상점의 거래를 등록합니다. 지원되는 PG사: KG이니시스(이용 전 콘솔 -> 결제연동 탭에서 INIApi Key 등록 필요) 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

등록할 하위 상점 결제 건 아이디
array|null $items

하위 상점 거래 목록
string|null $storeId

상점 아이디

Return Value

Future

at line 625
ResendWebhookResponse resendWebhook(string|null $paymentId = null, string|null $webhookId = null, string|null $storeId = null)

웹훅 재발송 기능입니다.

웹훅을 재발송합니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $webhookId

입력하지 않으면 결제 건의 가장 최근 웹훅 아이디가 기본 적용됩니다
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

ResendWebhookResponse

at line 639
Future resendWebhookAsync(string|null $paymentId = null, string|null $webhookId = null, string|null $storeId = null)

웹훅 재발송 기능입니다.

웹훅을 재발송합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $webhookId

입력하지 않으면 결제 건의 가장 최근 웹훅 아이디가 기본 적용됩니다
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future

at line 653
StopPaymentCancellationResponse stopPaymentCancellation(string|null $paymentId = null, string|null $cancellationId = null, string|null $storeId = null)

결제 취소 요청 취소 기능입니다.

비동기적으로 수행되는 결제 취소 요청을 취소합니다. Triple-A에서만 사용됩니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $cancellationId

취소 요청 아이디
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

StopPaymentCancellationResponse

at line 668
Future stopPaymentCancellationAsync(string|null $paymentId = null, string|null $cancellationId = null, string|null $storeId = null)

결제 취소 요청 취소 기능입니다.

비동기적으로 수행되는 결제 취소 요청을 취소합니다. Triple-A에서만 사용됩니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $paymentId

결제 건 아이디
string|null $cancellationId

취소 요청 아이디
string|null $storeId

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 인증 정보의 상점 아이디를 사용합니다.

Return Value

Future