PaypayTerminateRequestDto
extends AbstractPaymentRequestDto
in package
決済サービスタイプ:paypay、コマンド名:解約の要求Dtoクラス<br>
Tags
Table of Contents
- $payNowIdParam : PayNowIdParam
- PayNowIDオブジェクト
- $cancelUrl : mixed
- 解約キャンセル時URL<br> URL<br/> 最大桁数:1024<br/> 解約キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※消費者を介する解約要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはMAP(Merchant Administrator Portal)から登録申請した値を使用。<br/>
- $errorUrl : mixed
- 解約エラー時URL<br> URL<br/> 最大桁数:1024<br/> 解約キャンセルエラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※消費者を介する解約要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはMAP(Merchant Administrator Portal)から登録申請した値を使用。<br/>
- $force : mixed
- 強制解約<br> 英字(boolean)<br/> 解約の方式(3者間または2者間)を指定します。<br/> - "true" :強制解約(2者間)<br/> - "false" :消費者を介する解約要求(3者間/デフォルト)<br/>
- $maskedLog : mixed
- ログ用文字列(マスク済み)<br> 半角英数字<br>
- $orderId : mixed
- 取引ID<br> 半角英数字<br/> 最大桁数:100<br/> - 随時決済を解約する対象の取引IDを指定する。<br/> <br/>
- $pushUrl : mixed
- プッシュ先URL<br> URL<br/> 最大桁数:1024<br/> プッシュURLを指定します。<br/> <br/> ※消費者を介する解約要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはMAP(Merchant Administrator Portal)から登録申請した値を使用。<br/>
- $SERVICE_COMMAND : mixed
- 決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
- $SERVICE_TYPE : mixed
- 決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
- $serviceOptionType : mixed
- サービスオプションタイプ<br> 半角英数字<br/> - "online":オンライン決済<br/> ※オンラン決済のみ指定可<br/>
- $successUrl : mixed
- 解約完了時URL<br> URL<br/> 最大桁数:1024<br/> 解約完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※消費者を介する解約要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはMAP(Merchant Administrator Portal)から登録申請した値を使用。<br/>
- __toString() : string
- ログ用文字列(マスク済み)を取得する<br>
- _setMaskedLog() : mixed
- ログ用文字列(マスク済み)を設定する<br>
- getAccountId() : string
- 会員IDを取得する。<br>
- getCancelUrl() : string
- 解約キャンセル時URLを取得する<br>
- getCreateDate() : string
- 入会年月日を取得する<br>
- getErrorUrl() : string
- 解約エラー時URLを取得する<br>
- getForce() : string
- 強制解約を取得する<br>
- getFreeKey() : string
- キー情報を取得する<br>
- getMemo1() : string
- 取引メモ1を取得する<br>
- getMemo2() : string
- 取引メモ2を取得する<br>
- getMemo3() : string
- 取引メモ3を取得する<br>
- getOrderId() : string
- 取引IDを取得する<br>
- getPushUrl() : string
- プッシュ先URLを取得する<br>
- getReceiptData() : string
- レシートデータを取得する。<br>
- getServiceCommand() : string
- 決済サービスコマンドを取得する<br>
- getServiceOptionType() : string
- サービスオプションタイプを取得する<br>
- getServiceType() : string
- 決済サービスタイプを取得する<br>
- getSuccessUrl() : string
- 解約完了時URLを取得する<br>
- setAccountId() : mixed
- 会員IDを設定する。<br>
- setCancelUrl() : mixed
- 解約キャンセル時URLを設定する<br>
- setCreateDate() : mixed
- 入会年月日を設定する<br>
- setErrorUrl() : mixed
- 解約エラー時URLを設定する<br>
- setForce() : mixed
- 強制解約を設定する<br>
- setFreeKey() : mixed
- キー情報を設定する<br>
- setMemo1() : mixed
- 取引メモ1を設定する<br>
- setMemo2() : mixed
- 取引メモ2を設定する<br>
- setMemo3() : mixed
- 取引メモ3を設定する<br>
- setOrderId() : mixed
- 取引IDを設定する<br>
- setPushUrl() : mixed
- プッシュ先URLを設定する<br>
- setReceiptData() : mixed
- レシートデータを設定する。<br>
- setServiceOptionType() : mixed
- サービスオプションタイプを設定する<br>
- setSuccessUrl() : mixed
- 解約完了時URLを設定する<br>
- existAccountBasicParam() : mixed
- AccountBasicParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
- existAccountParam() : mixed
- AccountParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
- existBankAccountParam() : mixed
- BankAccountParamがAccountParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、AccountParamに設定する。<br>
- existCardParam() : mixed
- CardParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
- existPayNowIdParam() : mixed
- PayNowIdPramが設定されているか判定する。<br> 設定されていない場合はインスタンスを生成する。<br>
- existRecurringChargeParam() : mixed
- RecurringChargeParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
Properties
$payNowIdParam
PayNowIDオブジェクト
protected
PayNowIdParam
$payNowIdParam
$cancelUrl
解約キャンセル時URL<br> URL<br/> 最大桁数:1024<br/> 解約キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※消費者を介する解約要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはMAP(Merchant Administrator Portal)から登録申請した値を使用。<br/>
private
mixed
$cancelUrl
$errorUrl
解約エラー時URL<br> URL<br/> 最大桁数:1024<br/> 解約キャンセルエラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※消費者を介する解約要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはMAP(Merchant Administrator Portal)から登録申請した値を使用。<br/>
private
mixed
$errorUrl
$force
強制解約<br> 英字(boolean)<br/> 解約の方式(3者間または2者間)を指定します。<br/> - "true" :強制解約(2者間)<br/> - "false" :消費者を介する解約要求(3者間/デフォルト)<br/>
private
mixed
$force
$maskedLog
ログ用文字列(マスク済み)<br> 半角英数字<br>
private
mixed
$maskedLog
$orderId
取引ID<br> 半角英数字<br/> 最大桁数:100<br/> - 随時決済を解約する対象の取引IDを指定する。<br/> <br/>
private
mixed
$orderId
$pushUrl
プッシュ先URL<br> URL<br/> 最大桁数:1024<br/> プッシュURLを指定します。<br/> <br/> ※消費者を介する解約要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはMAP(Merchant Administrator Portal)から登録申請した値を使用。<br/>
private
mixed
$pushUrl
$SERVICE_COMMAND
決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_COMMAND
= "Terminate"
$SERVICE_TYPE
決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_TYPE
= "paypay"
$serviceOptionType
サービスオプションタイプ<br> 半角英数字<br/> - "online":オンライン決済<br/> ※オンラン決済のみ指定可<br/>
private
mixed
$serviceOptionType
$successUrl
解約完了時URL<br> URL<br/> 最大桁数:1024<br/> 解約完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※消費者を介する解約要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはMAP(Merchant Administrator Portal)から登録申請した値を使用。<br/>
private
mixed
$successUrl
Methods
__toString()
ログ用文字列(マスク済み)を取得する<br>
public
__toString() : string
Return values
string —ログ用文字列(マスク済み)
_setMaskedLog()
ログ用文字列(マスク済み)を設定する<br>
public
_setMaskedLog(string $maskedLog) : mixed
Parameters
- $maskedLog : string
-
ログ用文字列(マスク済み)
Return values
mixed —getAccountId()
会員IDを取得する。<br>
public
getAccountId() : string
Return values
string —会員ID
getCancelUrl()
解約キャンセル時URLを取得する<br>
public
getCancelUrl() : string
Return values
string —解約キャンセル時URL
getCreateDate()
入会年月日を取得する<br>
public
getCreateDate() : string
Return values
string —入会年月日
getErrorUrl()
解約エラー時URLを取得する<br>
public
getErrorUrl() : string
Return values
string —解約エラー時URL
getForce()
強制解約を取得する<br>
public
getForce() : string
Return values
string —強制解約
getFreeKey()
キー情報を取得する<br>
public
getFreeKey() : string
Return values
string —キー情報
getMemo1()
取引メモ1を取得する<br>
public
getMemo1() : string
Return values
string —取引メモ1
getMemo2()
取引メモ2を取得する<br>
public
getMemo2() : string
Return values
string —取引メモ2
getMemo3()
取引メモ3を取得する<br>
public
getMemo3() : string
Return values
string —取引メモ3を設定する
getOrderId()
取引IDを取得する<br>
public
getOrderId() : string
Return values
string —取引ID
getPushUrl()
プッシュ先URLを取得する<br>
public
getPushUrl() : string
Return values
string —プッシュ先URL
getReceiptData()
レシートデータを取得する。<br>
public
getReceiptData() : string
Return values
string —レシートデータ
getServiceCommand()
決済サービスコマンドを取得する<br>
public
getServiceCommand() : string
Return values
string —決済サービスコマンド
getServiceOptionType()
サービスオプションタイプを取得する<br>
public
getServiceOptionType() : string
Return values
string —サービスオプションタイプ
getServiceType()
決済サービスタイプを取得する<br>
public
getServiceType() : string
Return values
string —決済サービスタイプ
getSuccessUrl()
解約完了時URLを取得する<br>
public
getSuccessUrl() : string
Return values
string —解約完了時URL
setAccountId()
会員IDを設定する。<br>
public
setAccountId(string $accountId) : mixed
Parameters
- $accountId : string
-
会員ID
Return values
mixed —setCancelUrl()
解約キャンセル時URLを設定する<br>
public
setCancelUrl(string $cancelUrl) : mixed
Parameters
- $cancelUrl : string
-
解約キャンセル時URL
Return values
mixed —setCreateDate()
入会年月日を設定する<br>
public
setCreateDate(string $createDate) : mixed
Parameters
- $createDate : string
-
入会年月日
Return values
mixed —setErrorUrl()
解約エラー時URLを設定する<br>
public
setErrorUrl(string $errorUrl) : mixed
Parameters
- $errorUrl : string
-
解約エラー時URL
Return values
mixed —setForce()
強制解約を設定する<br>
public
setForce(string $force) : mixed
Parameters
- $force : string
-
強制解約
Return values
mixed —setFreeKey()
キー情報を設定する<br>
public
setFreeKey(string $freeKey) : mixed
Parameters
- $freeKey : string
-
キー情報
Return values
mixed —setMemo1()
取引メモ1を設定する<br>
public
setMemo1(string $memo1) : mixed
Parameters
- $memo1 : string
-
取引メモ1
Return values
mixed —setMemo2()
取引メモ2を設定する<br>
public
setMemo2(string $memo2) : mixed
Parameters
- $memo2 : string
-
取引メモ2
Return values
mixed —setMemo3()
取引メモ3を設定する<br>
public
setMemo3(string $memo3) : mixed
Parameters
- $memo3 : string
-
取引メモ3
Return values
mixed —setOrderId()
取引IDを設定する<br>
public
setOrderId(string $orderId) : mixed
Parameters
- $orderId : string
-
取引ID
Return values
mixed —setPushUrl()
プッシュ先URLを設定する<br>
public
setPushUrl(string $pushUrl) : mixed
Parameters
- $pushUrl : string
-
プッシュ先URL
Return values
mixed —setReceiptData()
レシートデータを設定する。<br>
public
setReceiptData(string $receiptData) : mixed
Parameters
- $receiptData : string
-
レシートデータ
Return values
mixed —setServiceOptionType()
サービスオプションタイプを設定する<br>
public
setServiceOptionType(string $serviceOptionType) : mixed
Parameters
- $serviceOptionType : string
-
サービスオプションタイプ
Return values
mixed —setSuccessUrl()
解約完了時URLを設定する<br>
public
setSuccessUrl(string $successUrl) : mixed
Parameters
- $successUrl : string
-
解約完了時URL
Return values
mixed —existAccountBasicParam()
AccountBasicParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
protected
existAccountBasicParam() : mixed
Return values
mixed —existAccountParam()
AccountParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
protected
existAccountParam() : mixed
Return values
mixed —existBankAccountParam()
BankAccountParamがAccountParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、AccountParamに設定する。<br>
protected
existBankAccountParam() : mixed
Return values
mixed —existCardParam()
CardParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
protected
existCardParam() : mixed
Return values
mixed —existPayNowIdParam()
PayNowIdPramが設定されているか判定する。<br> 設定されていない場合はインスタンスを生成する。<br>
protected
existPayNowIdParam() : mixed
Return values
mixed —existRecurringChargeParam()
RecurringChargeParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
protected
existRecurringChargeParam() : mixed