EmCancelRequestDto
extends AbstractPaymentRequestDto
in package
決済サービスタイプ:電子マネー、コマンド名:取消の要求Dtoクラス
Tags
Table of Contents
- $payNowIdParam : PayNowIdParam
- PayNowIDオブジェクト
- $cancelMailAddr : mixed
- 取消通知メールアドレス<br> 半角英数字<br> 256 文字以内<br> 決済の取消完了を利用者に通知するためのメールアドレスを指定します。<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 必須 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
- $maskedLog : mixed
- ログ用文字列(マスク済み)<br> 半角英数字<br>
- $optionParams : mixed
- 拡張パラメータ<br> 並列処理用の拡張パラメータを保持する。
- $orderId : mixed
- 取引ID<br> 半角英数字<br> 100 文字以内<br> 取り消し処理を依頼する、マーチャント側で発番済みの注文管理ID<br> ※Suicaに限り40桁を上限とする。<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 必須 <li>WAON: 未使用 <li>nanaco: 必須 <li>BitCash: 必須 </ul>
- $orderKind : mixed
- オーダー種別<br> 半角英数字<br> 10 文字以内<br> オーダー種別を指定します。<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 必須 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul> <br> <p> オーダー種別(Suica)の詳細 <ul> <li>"authorize": 決済 <li>"refund": 返金 <li>"refund_new": 新規返金 <li>"give": プレゼント請求 </ul>
- $SERVICE_COMMAND : mixed
- 決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
- $SERVICE_TYPE : mixed
- 決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
- $serviceOptionType : mixed
- 決済サービスオプション<br> 半角英数字<br> 配列<br> 10 文字以内<br> 決済サービスのオプションを指定します<br> 例) モバイル-メール決済の場合: "suica-mobile-mail"<br> <p> <b>Edy</b> <ul type="square"> <li>未使用 </ul>
- __toString() : string
- ログ用文字列(マスク済み)を取得する<br>
- _setMaskedLog() : mixed
- ログ用文字列(マスク済み)を設定する<br>
- getAccountId() : string
- 会員IDを取得する。<br>
- getCancelMailAddr() : string
- 取消通知メールアドレスを取得する<br>
- getCreateDate() : string
- 入会年月日を取得する<br>
- getFreeKey() : string
- キー情報を取得する<br>
- getMemo1() : string
- 取引メモ1を取得する<br>
- getMemo2() : string
- 取引メモ2を取得する<br>
- getMemo3() : string
- 取引メモ3を取得する<br>
- getOptionParams() : OptionParams
- 拡張パラメータリストを取得する<br>
- getOrderId() : string
- 取引IDを取得する<br>
- getOrderKind() : string
- オーダー種別を取得する<br>
- getReceiptData() : string
- レシートデータを取得する。<br>
- getServiceCommand() : string
- 決済サービスコマンドを取得する<br>
- getServiceOptionType() : string
- 決済サービスオプションを取得する<br>
- getServiceType() : string
- 決済サービスタイプを取得する<br>
- setAccountId() : mixed
- 会員IDを設定する。<br>
- setCancelMailAddr() : mixed
- 取消通知メールアドレスを設定する<br>
- setCreateDate() : mixed
- 入会年月日を設定する<br>
- setFreeKey() : mixed
- キー情報を設定する<br>
- setMemo1() : mixed
- 取引メモ1を設定する<br>
- setMemo2() : mixed
- 取引メモ2を設定する<br>
- setMemo3() : mixed
- 取引メモ3を設定する<br>
- setOptionParams() : mixed
- 拡張パラメータリストを設定する<br>
- setOrderId() : mixed
- 取引IDを設定する<br>
- setOrderKind() : mixed
- オーダー種別を設定する<br>
- setReceiptData() : mixed
- レシートデータを設定する。<br>
- setServiceOptionType() : mixed
- 決済サービスオプションを設定する<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
$cancelMailAddr
取消通知メールアドレス<br> 半角英数字<br> 256 文字以内<br> 決済の取消完了を利用者に通知するためのメールアドレスを指定します。<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 必須 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
private
mixed
$cancelMailAddr
$maskedLog
ログ用文字列(マスク済み)<br> 半角英数字<br>
private
mixed
$maskedLog
$optionParams
拡張パラメータ<br> 並列処理用の拡張パラメータを保持する。
private
mixed
$optionParams
$orderId
取引ID<br> 半角英数字<br> 100 文字以内<br> 取り消し処理を依頼する、マーチャント側で発番済みの注文管理ID<br> ※Suicaに限り40桁を上限とする。<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 必須 <li>WAON: 未使用 <li>nanaco: 必須 <li>BitCash: 必須 </ul>
private
mixed
$orderId
$orderKind
オーダー種別<br> 半角英数字<br> 10 文字以内<br> オーダー種別を指定します。<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 必須 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul> <br> <p> オーダー種別(Suica)の詳細 <ul> <li>"authorize": 決済 <li>"refund": 返金 <li>"refund_new": 新規返金 <li>"give": プレゼント請求 </ul>
private
mixed
$orderKind
$SERVICE_COMMAND
決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_COMMAND
= "Cancel"
$SERVICE_TYPE
決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_TYPE
= "em"
$serviceOptionType
決済サービスオプション<br> 半角英数字<br> 配列<br> 10 文字以内<br> 決済サービスのオプションを指定します<br> 例) モバイル-メール決済の場合: "suica-mobile-mail"<br> <p> <b>Edy</b> <ul type="square"> <li>未使用 </ul>
private
mixed
$serviceOptionType
Suica
- "suica-mobile-mail": モバイル-メール決済
- "suica-mobile-app": モバイル-アプリ決済
- "suica-pc-mail": ネット-メール決済
- "suica-pc-app": ネット-アプリ決済
WAON
- 未使用
nanaco
- "tcc-redirect": nanaco決済
BitCash
- "bitcash-api": BitCash決済
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
getCancelMailAddr()
取消通知メールアドレスを取得する<br>
public
getCancelMailAddr() : string
Return values
string —取消通知メールアドレス
getCreateDate()
入会年月日を取得する<br>
public
getCreateDate() : 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を設定する
getOptionParams()
拡張パラメータリストを取得する<br>
public
getOptionParams() : OptionParams
Return values
OptionParams —拡張パラメータリスト
getOrderId()
取引IDを取得する<br>
public
getOrderId() : string
Return values
string —取引ID
getOrderKind()
オーダー種別を取得する<br>
public
getOrderKind() : string
Return values
string —オーダー種別
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 —決済サービスタイプ
setAccountId()
会員IDを設定する。<br>
public
setAccountId(string $accountId) : mixed
Parameters
- $accountId : string
-
会員ID
Return values
mixed —setCancelMailAddr()
取消通知メールアドレスを設定する<br>
public
setCancelMailAddr(string $cancelMailAddr) : mixed
Parameters
- $cancelMailAddr : string
-
取消通知メールアドレス
Return values
mixed —setCreateDate()
入会年月日を設定する<br>
public
setCreateDate(string $createDate) : mixed
Parameters
- $createDate : 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 —setOptionParams()
拡張パラメータリストを設定する<br>
public
setOptionParams(OptionParams $optionParams) : mixed
Parameters
- $optionParams : OptionParams
-
拡張パラメータリスト
Return values
mixed —setOrderId()
取引IDを設定する<br>
public
setOrderId(string $orderId) : mixed
Parameters
- $orderId : string
-
取引ID
Return values
mixed —setOrderKind()
オーダー種別を設定する<br>
public
setOrderKind(string $orderKind) : mixed
Parameters
- $orderKind : string
-
オーダー種別
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 —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