VeriTrans 4G MDK

EmAuthorizeRequestDto extends AbstractPaymentRequestDto
in package

決済サービスタイプ:電子マネー、コマンド名:決済の要求Dtoクラス

Tags
author

Veritrans, Inc.

Table of Contents

$payNowIdParam  : PayNowIdParam
PayNowIDオブジェクト
$amount  : mixed
決済金額<br> 半角数字<br> 7 桁以内<br> 支払金額となります。<br> 例)2100<br> <p> <ul type="square"> <li>Edy: 1 以上 ~ 50,000 以下 <li>Suica: 1 以上 ~ 20,000 以下 <li>WAON: 1 以上 ~ 50,000 以下 <li>nanaco: 1 以上 ~ 50,000 以下 <li>BitCash: 1 以上 ~ 200,000 以下 </ul>
$cancelLimit  : mixed
支払取消期限<br> 半角数字<br> 14 桁固定<br> 決済後、該当の支払を返金(取消)することができる期限。<br> YYYYMMDDhhmmss の形式<br> 例)20060901235959<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 必須 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$cancelUrl  : mixed
キャンセルURL<br> 半角英数字<br> 128 バイト<br> PaSoRi決済時、確認画面等でキャンセルボタンが押された場合に遷移されるURL<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON(モバイルアプリ決済): 未使用 <li>WAON(PaSoRi決済): 必須 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$completeMailAddInfo  : mixed
完了メール付加情報<br> 文字列<br> 320 バイト以内<br> 決済完了メールに追加される文字列(遷移先URL 等)<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$completeMailFlag  : mixed
完了メール送信要否<br> 半角数字<br> 1 桁固定<br> 決済完了時にメールを送信するか否かを設定します。<br> 0: 送信不要 1: 送信要<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$completeNoticeUrl  : mixed
決済完了通知URL<br> 半角英数字<br> 256 文字以内<br> Edy Viewer にて支払いを完了した後に遷移するURL<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 未使用 <li>Edy(モバイルEdy以外): 任意 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$completeReturnKind  : mixed
決済完了戻り先種別<br> 半角数字<br> 1 桁固定<br> モバイルSuica でアプリ終了時に遷移する先の種別<br> 1: ローカルメニュー<br> 2: モバイルSuica アプリを終了し「決済完了戻り先URL」へ遷移<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$completeReturnUrl  : mixed
決済完了戻り先URL<br> 半角英数字<br> 256 文字以内<br> モバイルSuicaでアプリ終了時に遷移する先のURL<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$completeScreenAddInfo  : mixed
完了画面付加情報<br> 文字列<br> 256 バイト以内<br> 決済完了画面に表示する付加情報を設定します。<br> モバイルSuica で決済完了画面に表示される文字列<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$confirmScreenAddInfo  : mixed
内容確認画面付加情報<br> 文字列<br> 256 バイト以内<br> 内容確認画面に表示する付加情報を設定します。<br> モバイルSuica で決済内容確認画面に表示される文字列<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$failureUrl  : mixed
失敗時URL<br> 半角英数字<br> 128 バイト<br> PaSoRi決済時、決済が失敗した場合に遷移されるURL<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON(モバイルアプリ決済): 未使用 <li>WAON(PaSoRi決済): 必須 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$forwardMailFlag  : mixed
転送メール送信要否<br> 半角数字<br> 1 桁固定<br> 決済依頼メール、決済完了メールのコピーメール又はBCC メールをマーチャントメールアドレス(merchantMailAddr)に送信するか否かを設定します。<br> 0: 送信不要<br> 1: 送信要<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$free  : mixed
備考<br> 文字列<br> 256 バイト<br> 備考(商品詳細など)<br> <p> <ul type="square"> <li>Edy: 任意 ※カンマ、セミコロン、シングルクォーテーション、CR(復帰)、LF(改行)は使用不可 <li>Suica: 任意 ※CR(復帰)、LF(改行)は使用不可 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$hiraganaId  : mixed
ひらがなID<br> 全角<br> 最大桁数:16<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 必須 </ul>
$mailAddr  : mixed
メールアドレス<br> 半角英数字<br> 256 文字以内<br> 決済依頼メールを送信する消費者の携帯電話メールアドレスとなります。<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 必須 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 必須 <li>Suica(アプリ決済): 未使用 <li>WAON: 任意 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$maskedLog  : mixed
ログ用文字列(マスク済み)<br> 半角英数字<br>
$memberStoreSettleEntryTime  : mixed
加盟店決済受付時刻<br> 半角数字<br> 14 桁固定<br> 加盟店側で当該決済を受付た時刻<br> YYYYMMDDhhmmss の形式<br> 例)20060901235959<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 任意 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$merchantMailAddr  : mixed
マーチャントメールアドレス<br> 半角英数字<br> 256 文字以内<br> 決済依頼メール、決済完了メールのコピーメール又はBCC メール先マーチャントメールアドレス。<br> 以下の文字も使用できます。<br> “.”(ドット)、“-”(ハイフン)、“_”(アンダースコア)、“@”(アットマーク)<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$optionParams  : mixed
拡張パラメータ<br> 並列処理用の拡張パラメータを保持する。
$orderId  : mixed
取引ID<br> 半角英数字<br> 100 文字以内<br> マーチャント側で取引を一意に表す注文管理IDを指定します。<br> 申込処理ごとに一意である必要があります。<br> 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br> ※Suicaに限り40桁を上限とする。<br>
$rating  : mixed
商品レイティング<br> 半角数字<br> 最大桁数:2<br> 19:ST<br> 99:EX<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 必須 </ul>
$requestMailAddInfo  : mixed
依頼メール付加情報<br> 文字列<br> 256 バイト以内<br> 支払依頼メールに追加される文字列(商品情報等)です。<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$salesType  : mixed
販売区分<br> 半角数字<br> 1 桁固定<br> Edy で任意に登録する販売区分<br>  1:物販、 2:デジタル<br> <p> <ul type="square"> <li>Edy: 任意 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$screenTitle  : mixed
画面タイトル<br> 文字列<br> 40 バイト以内<br> モバイルSuica で決済完了画面・決済確認画面等で「商品・サービス名」に表示されます。<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 必須 ※CR(復帰)、LF(改行)は使用不可 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$SERVICE_COMMAND  : mixed
決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
$SERVICE_TYPE  : mixed
決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
$serviceOptionType  : mixed
決済サービスオプション<br> 半角英数字<br> 決済サービスのオプションを指定します<br> 例) モバイルEdyの場合: "edy-mobile"<br> <p> <b>Edy</b> <ul type="square"> <li>"edy-pc": サイバーEdy(pc) <li>"edy-mobile": モバイルEdy <li>"edy-direct": モバイルEdyダイレクト </ul>
$settlementLimit  : mixed
決済期限<br> 半角数字<br> 14 桁固定<br> 支払の期限となります。<br> 支払期限を過ぎた決済については、消費者はアプリ上から確認できます。<br> YYYYMMDDhhmmss の形式<br> 例)20060901235959<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 当日~90日後 <li>Edy(モバイルEdy以外): 未使用(10日固定) <li>Suica: 60日以内 <li>WAON: 決済日から365日先の日付までが上限 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$shopName  : mixed
ショップ名<br> 文字列<br> 48 バイト以内<br> Edy で使用する店舗名<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$successUrl  : mixed
成功時URL<br> 半角英数字<br> 128 バイト<br> PaSoRi決済時、決済が成功した場合に遷移されるURL<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON(モバイルアプリ決済): 未使用 <li>WAON(PaSoRi決済): 必須 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>
$transactionKind  : mixed
取引種別<br> 半角数字<br> 最大桁数:2<br> "02":電子マネー決済<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 必須 <li>BitCash: 未使用 </ul>
$userId  : mixed
ユーザID<br> 半角英数字記号<br> 最大桁数:64<br> 取引対象利用者を一意に特定可能なID。<br> <br> RFC2822に準拠する。<br> [0-9][a-z][A-Z]!#$%&'*+-/=?^_`{|}~.<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 必須 <li>BitCash: 未使用 </ul>
__toString()  : string
ログ用文字列(マスク済み)を取得する<br>
_setMaskedLog()  : mixed
ログ用文字列(マスク済み)を設定する<br>
getAccountId()  : string
会員IDを取得する。<br>
getAmount()  : string
決済金額を取得する<br>
getCancelLimit()  : string
支払取消期限を取得する<br>
getCancelUrl()  : string
キャンセルURLを取得する<br>
getCompleteMailAddInfo()  : string
完了メール付加情報を取得する<br>
getCompleteMailFlag()  : string
完了メール送信要否を取得する<br>
getCompleteNoticeUrl()  : string
決済完了通知URLを取得する<br>
getCompleteReturnKind()  : string
決済完了戻り先種別を取得する<br>
getCompleteReturnUrl()  : string
決済完了戻り先URLを取得する<br>
getCompleteScreenAddInfo()  : string
完了画面付加情報を取得する<br>
getConfirmScreenAddInfo()  : string
内容確認画面付加情報を取得する<br>
getCreateDate()  : string
入会年月日を取得する<br>
getFailureUrl()  : string
失敗時URLを取得する<br>
getForwardMailFlag()  : string
転送メール送信要否を取得する<br>
getFree()  : string
備考を取得する<br>
getFreeKey()  : string
キー情報を取得する<br>
getHiraganaId()  : string
ひらがなIDを取得する<br>
getMailAddr()  : string
メールアドレスを取得する<br>
getMemberStoreSettleEntryTime()  : string
加盟店決済受付時刻を取得する<br>
getMemo1()  : string
取引メモ1を取得する<br>
getMemo2()  : string
取引メモ2を取得する<br>
getMemo3()  : string
取引メモ3を取得する<br>
getMerchantMailAddr()  : string
マーチャントメールアドレスを取得する<br>
getOptionParams()  : OptionParams
拡張パラメータリストを取得する<br>
getOrderId()  : string
取引IDを取得する<br>
getRating()  : string
商品レイティングを取得する<br>
getReceiptData()  : string
レシートデータを取得する。<br>
getRequestMailAddInfo()  : string
依頼メール付加情報を取得する<br>
getSalesType()  : string
販売区分を取得する<br>
getScreenTitle()  : string
画面タイトルを取得する<br>
getServiceCommand()  : string
決済サービスコマンドを取得する<br>
getServiceOptionType()  : string
決済サービスオプションを取得する<br>
getServiceType()  : string
決済サービスタイプを取得する<br>
getSettlementLimit()  : string
決済期限を取得する<br>
getShopName()  : string
ショップ名を取得する<br>
getSuccessUrl()  : string
成功時URLを取得する<br>
getTransactionKind()  : string
取引種別を取得する<br>
getUserId()  : string
ユーザIDを取得する<br>
setAccountId()  : mixed
会員IDを設定する。<br>
setAmount()  : mixed
決済金額を設定する<br>
setCancelLimit()  : mixed
支払取消期限を設定する<br>
setCancelUrl()  : mixed
キャンセルURLを設定する<br>
setCompleteMailAddInfo()  : mixed
完了メール付加情報を設定する<br>
setCompleteMailFlag()  : mixed
完了メール送信要否を設定する<br>
setCompleteNoticeUrl()  : mixed
決済完了通知URLを設定する<br>
setCompleteReturnKind()  : mixed
決済完了戻り先種別を設定する<br>
setCompleteReturnUrl()  : mixed
決済完了戻り先URLを設定する<br>
setCompleteScreenAddInfo()  : mixed
完了画面付加情報を設定する<br>
setConfirmScreenAddInfo()  : mixed
内容確認画面付加情報を設定する<br>
setCreateDate()  : mixed
入会年月日を設定する<br>
setFailureUrl()  : mixed
失敗時URLを設定する<br>
setForwardMailFlag()  : mixed
転送メール送信要否を設定する<br>
setFree()  : mixed
備考を設定する<br>
setFreeKey()  : mixed
キー情報を設定する<br>
setHiraganaId()  : mixed
ひらがなIDを設定する<br>
setMailAddr()  : mixed
メールアドレスを設定する<br>
setMemberStoreSettleEntryTime()  : mixed
加盟店決済受付時刻を設定する<br>
setMemo1()  : mixed
取引メモ1を設定する<br>
setMemo2()  : mixed
取引メモ2を設定する<br>
setMemo3()  : mixed
取引メモ3を設定する<br>
setMerchantMailAddr()  : mixed
マーチャントメールアドレスを設定する<br>
setOptionParams()  : mixed
拡張パラメータリストを設定する<br>
setOrderId()  : mixed
取引IDを設定する<br>
setRating()  : mixed
商品レイティングを設定する<br>
setReceiptData()  : mixed
レシートデータを設定する。<br>
setRequestMailAddInfo()  : mixed
依頼メール付加情報を設定する<br>
setSalesType()  : mixed
販売区分を設定する<br>
setScreenTitle()  : mixed
画面タイトルを設定する<br>
setServiceOptionType()  : mixed
決済サービスオプションを設定する<br>
setSettlementLimit()  : mixed
決済期限を設定する<br>
setShopName()  : mixed
ショップ名を設定する<br>
setSuccessUrl()  : mixed
成功時URLを設定する<br>
setTransactionKind()  : mixed
取引種別を設定する<br>
setUserId()  : mixed
ユーザIDを設定する<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

$amount

決済金額<br> 半角数字<br> 7 桁以内<br> 支払金額となります。<br> 例)2100<br> <p> <ul type="square"> <li>Edy: 1 以上 ~ 50,000 以下 <li>Suica: 1 以上 ~ 20,000 以下 <li>WAON: 1 以上 ~ 50,000 以下 <li>nanaco: 1 以上 ~ 50,000 以下 <li>BitCash: 1 以上 ~ 200,000 以下 </ul>

private mixed $amount

$cancelLimit

支払取消期限<br> 半角数字<br> 14 桁固定<br> 決済後、該当の支払を返金(取消)することができる期限。<br> YYYYMMDDhhmmss の形式<br> 例)20060901235959<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 必須 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $cancelLimit

$cancelUrl

キャンセルURL<br> 半角英数字<br> 128 バイト<br> PaSoRi決済時、確認画面等でキャンセルボタンが押された場合に遷移されるURL<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON(モバイルアプリ決済): 未使用 <li>WAON(PaSoRi決済): 必須 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $cancelUrl

$completeMailAddInfo

完了メール付加情報<br> 文字列<br> 320 バイト以内<br> 決済完了メールに追加される文字列(遷移先URL 等)<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $completeMailAddInfo

$completeMailFlag

完了メール送信要否<br> 半角数字<br> 1 桁固定<br> 決済完了時にメールを送信するか否かを設定します。<br> 0: 送信不要 1: 送信要<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $completeMailFlag

$completeNoticeUrl

決済完了通知URL<br> 半角英数字<br> 256 文字以内<br> Edy Viewer にて支払いを完了した後に遷移するURL<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 未使用 <li>Edy(モバイルEdy以外): 任意 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $completeNoticeUrl

$completeReturnKind

決済完了戻り先種別<br> 半角数字<br> 1 桁固定<br> モバイルSuica でアプリ終了時に遷移する先の種別<br> 1: ローカルメニュー<br> 2: モバイルSuica アプリを終了し「決済完了戻り先URL」へ遷移<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $completeReturnKind

$completeReturnUrl

決済完了戻り先URL<br> 半角英数字<br> 256 文字以内<br> モバイルSuicaでアプリ終了時に遷移する先のURL<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $completeReturnUrl

$completeScreenAddInfo

完了画面付加情報<br> 文字列<br> 256 バイト以内<br> 決済完了画面に表示する付加情報を設定します。<br> モバイルSuica で決済完了画面に表示される文字列<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $completeScreenAddInfo

$confirmScreenAddInfo

内容確認画面付加情報<br> 文字列<br> 256 バイト以内<br> 内容確認画面に表示する付加情報を設定します。<br> モバイルSuica で決済内容確認画面に表示される文字列<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $confirmScreenAddInfo

$failureUrl

失敗時URL<br> 半角英数字<br> 128 バイト<br> PaSoRi決済時、決済が失敗した場合に遷移されるURL<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON(モバイルアプリ決済): 未使用 <li>WAON(PaSoRi決済): 必須 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $failureUrl

$forwardMailFlag

転送メール送信要否<br> 半角数字<br> 1 桁固定<br> 決済依頼メール、決済完了メールのコピーメール又はBCC メールをマーチャントメールアドレス(merchantMailAddr)に送信するか否かを設定します。<br> 0: 送信不要<br> 1: 送信要<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $forwardMailFlag

$free

備考<br> 文字列<br> 256 バイト<br> 備考(商品詳細など)<br> <p> <ul type="square"> <li>Edy: 任意 ※カンマ、セミコロン、シングルクォーテーション、CR(復帰)、LF(改行)は使用不可 <li>Suica: 任意 ※CR(復帰)、LF(改行)は使用不可 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $free

$hiraganaId

ひらがなID<br> 全角<br> 最大桁数:16<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 必須 </ul>

private mixed $hiraganaId

$mailAddr

メールアドレス<br> 半角英数字<br> 256 文字以内<br> 決済依頼メールを送信する消費者の携帯電話メールアドレスとなります。<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 必須 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 必須 <li>Suica(アプリ決済): 未使用 <li>WAON: 任意 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $mailAddr

$maskedLog

ログ用文字列(マスク済み)<br> 半角英数字<br>

private mixed $maskedLog

$memberStoreSettleEntryTime

加盟店決済受付時刻<br> 半角数字<br> 14 桁固定<br> 加盟店側で当該決済を受付た時刻<br> YYYYMMDDhhmmss の形式<br> 例)20060901235959<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 任意 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $memberStoreSettleEntryTime

$merchantMailAddr

マーチャントメールアドレス<br> 半角英数字<br> 256 文字以内<br> 決済依頼メール、決済完了メールのコピーメール又はBCC メール先マーチャントメールアドレス。<br> 以下の文字も使用できます。<br> “.”(ドット)、“-”(ハイフン)、“_”(アンダースコア)、“@”(アットマーク)<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 任意 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $merchantMailAddr

$optionParams

拡張パラメータ<br> 並列処理用の拡張パラメータを保持する。

private mixed $optionParams

$orderId

取引ID<br> 半角英数字<br> 100 文字以内<br> マーチャント側で取引を一意に表す注文管理IDを指定します。<br> 申込処理ごとに一意である必要があります。<br> 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br> ※Suicaに限り40桁を上限とする。<br>

private mixed $orderId

$rating

商品レイティング<br> 半角数字<br> 最大桁数:2<br> 19:ST<br> 99:EX<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 必須 </ul>

private mixed $rating

$requestMailAddInfo

依頼メール付加情報<br> 文字列<br> 256 バイト以内<br> 支払依頼メールに追加される文字列(商品情報等)です。<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica(メール決済): 任意 <li>Suica(アプリ決済): 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $requestMailAddInfo

$salesType

販売区分<br> 半角数字<br> 1 桁固定<br> Edy で任意に登録する販売区分<br>  1:物販、 2:デジタル<br> <p> <ul type="square"> <li>Edy: 任意 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $salesType

$screenTitle

画面タイトル<br> 文字列<br> 40 バイト以内<br> モバイルSuica で決済完了画面・決済確認画面等で「商品・サービス名」に表示されます。<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 必須 ※CR(復帰)、LF(改行)は使用不可 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $screenTitle

$SERVICE_COMMAND

決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>

private mixed $SERVICE_COMMAND = "Authorize"

$SERVICE_TYPE

決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>

private mixed $SERVICE_TYPE = "em"

$serviceOptionType

決済サービスオプション<br> 半角英数字<br> 決済サービスのオプションを指定します<br> 例) モバイルEdyの場合: "edy-mobile"<br> <p> <b>Edy</b> <ul type="square"> <li>"edy-pc": サイバーEdy(pc) <li>"edy-mobile": モバイルEdy <li>"edy-direct": モバイルEdyダイレクト </ul>

private mixed $serviceOptionType

Suica

  • "suica-mobile-mail": モバイル-メール決済
  • "suica-mobile-app": モバイル-アプリ決済
  • "suica-pc-mail": ネット-メール決済
  • "suica-pc-app": ネット-アプリ決済

WAON

  • "waon-mobile": モバイルアプリ決済
  • "waon-pc": PaSoRi決済

nanaco

  • "tcc-redirect": nanaco決済

BitCash

  • "bitcash-api": BitCash決済

$settlementLimit

決済期限<br> 半角数字<br> 14 桁固定<br> 支払の期限となります。<br> 支払期限を過ぎた決済については、消費者はアプリ上から確認できます。<br> YYYYMMDDhhmmss の形式<br> 例)20060901235959<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 当日~90日後 <li>Edy(モバイルEdy以外): 未使用(10日固定) <li>Suica: 60日以内 <li>WAON: 決済日から365日先の日付までが上限 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $settlementLimit

$shopName

ショップ名<br> 文字列<br> 48 バイト以内<br> Edy で使用する店舗名<br> <p> <ul type="square"> <li>Edy(モバイルEdy): 任意 <li>Edy(モバイルEdy以外): 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $shopName

$successUrl

成功時URL<br> 半角英数字<br> 128 バイト<br> PaSoRi決済時、決済が成功した場合に遷移されるURL<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON(モバイルアプリ決済): 未使用 <li>WAON(PaSoRi決済): 必須 <li>nanaco: 未使用 <li>BitCash: 未使用 </ul>

private mixed $successUrl

$transactionKind

取引種別<br> 半角数字<br> 最大桁数:2<br> "02":電子マネー決済<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 必須 <li>BitCash: 未使用 </ul>

private mixed $transactionKind

$userId

ユーザID<br> 半角英数字記号<br> 最大桁数:64<br> 取引対象利用者を一意に特定可能なID。<br> <br> RFC2822に準拠する。<br> [0-9][a-z][A-Z]!#$%&'*+-/=?^_`{|}~.<br> <p> <ul type="square"> <li>Edy: 未使用 <li>Suica: 未使用 <li>WAON: 未使用 <li>nanaco: 必須 <li>BitCash: 未使用 </ul>

private mixed $userId

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

getAmount()

決済金額を取得する<br>

public getAmount() : string
Return values
string

決済金額

getCancelLimit()

支払取消期限を取得する<br>

public getCancelLimit() : string
Return values
string

支払取消期限

getCancelUrl()

キャンセルURLを取得する<br>

public getCancelUrl() : string
Return values
string

キャンセルURL

getCompleteMailAddInfo()

完了メール付加情報を取得する<br>

public getCompleteMailAddInfo() : string
Return values
string

完了メール付加情報

getCompleteMailFlag()

完了メール送信要否を取得する<br>

public getCompleteMailFlag() : string
Return values
string

完了メール送信要否

getCompleteNoticeUrl()

決済完了通知URLを取得する<br>

public getCompleteNoticeUrl() : string
Return values
string

決済完了通知URL

getCompleteReturnKind()

決済完了戻り先種別を取得する<br>

public getCompleteReturnKind() : string
Return values
string

決済完了戻り先種別

getCompleteReturnUrl()

決済完了戻り先URLを取得する<br>

public getCompleteReturnUrl() : string
Return values
string

決済完了戻り先URL

getCompleteScreenAddInfo()

完了画面付加情報を取得する<br>

public getCompleteScreenAddInfo() : string
Return values
string

完了画面付加情報

getConfirmScreenAddInfo()

内容確認画面付加情報を取得する<br>

public getConfirmScreenAddInfo() : string
Return values
string

内容確認画面付加情報

getCreateDate()

入会年月日を取得する<br>

public getCreateDate() : string
Return values
string

入会年月日

getFailureUrl()

失敗時URLを取得する<br>

public getFailureUrl() : string
Return values
string

失敗時URL

getForwardMailFlag()

転送メール送信要否を取得する<br>

public getForwardMailFlag() : string
Return values
string

転送メール送信要否

getFree()

備考を取得する<br>

public getFree() : string
Return values
string

備考

getFreeKey()

キー情報を取得する<br>

public getFreeKey() : string
Return values
string

キー情報

getHiraganaId()

ひらがなIDを取得する<br>

public getHiraganaId() : string
Return values
string

ひらがなID

getMailAddr()

メールアドレスを取得する<br>

public getMailAddr() : string
Return values
string

メールアドレス

getMemberStoreSettleEntryTime()

加盟店決済受付時刻を取得する<br>

public getMemberStoreSettleEntryTime() : 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を設定する

getMerchantMailAddr()

マーチャントメールアドレスを取得する<br>

public getMerchantMailAddr() : string
Return values
string

マーチャントメールアドレス

getOrderId()

取引IDを取得する<br>

public getOrderId() : string
Return values
string

取引ID

getRating()

商品レイティングを取得する<br>

public getRating() : string
Return values
string

商品レイティング

getReceiptData()

レシートデータを取得する。<br>

public getReceiptData() : string
Return values
string

レシートデータ

getRequestMailAddInfo()

依頼メール付加情報を取得する<br>

public getRequestMailAddInfo() : string
Return values
string

依頼メール付加情報

getSalesType()

販売区分を取得する<br>

public getSalesType() : string
Return values
string

販売区分

getScreenTitle()

画面タイトルを取得する<br>

public getScreenTitle() : 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

決済サービスタイプ

getSettlementLimit()

決済期限を取得する<br>

public getSettlementLimit() : string
Return values
string

決済期限

getShopName()

ショップ名を取得する<br>

public getShopName() : string
Return values
string

ショップ名

getSuccessUrl()

成功時URLを取得する<br>

public getSuccessUrl() : string
Return values
string

成功時URL

getTransactionKind()

取引種別を取得する<br>

public getTransactionKind() : string
Return values
string

取引種別

getUserId()

ユーザIDを取得する<br>

public getUserId() : string
Return values
string

ユーザID

setAccountId()

会員IDを設定する。<br>

public setAccountId(string $accountId) : mixed
Parameters
$accountId : string

会員ID

Return values
mixed

setAmount()

決済金額を設定する<br>

public setAmount(string $amount) : mixed
Parameters
$amount : string

決済金額

Return values
mixed

setCancelLimit()

支払取消期限を設定する<br>

public setCancelLimit(string $cancelLimit) : mixed
Parameters
$cancelLimit : string

支払取消期限

Return values
mixed

setCancelUrl()

キャンセルURLを設定する<br>

public setCancelUrl(string $cancelUrl) : mixed
Parameters
$cancelUrl : string

キャンセルURL

Return values
mixed

setCompleteMailAddInfo()

完了メール付加情報を設定する<br>

public setCompleteMailAddInfo(string $completeMailAddInfo) : mixed
Parameters
$completeMailAddInfo : string

完了メール付加情報

Return values
mixed

setCompleteMailFlag()

完了メール送信要否を設定する<br>

public setCompleteMailFlag(string $completeMailFlag) : mixed
Parameters
$completeMailFlag : string

完了メール送信要否

Return values
mixed

setCompleteNoticeUrl()

決済完了通知URLを設定する<br>

public setCompleteNoticeUrl(string $completeNoticeUrl) : mixed
Parameters
$completeNoticeUrl : string

決済完了通知URL

Return values
mixed

setCompleteReturnKind()

決済完了戻り先種別を設定する<br>

public setCompleteReturnKind(string $completeReturnKind) : mixed
Parameters
$completeReturnKind : string

決済完了戻り先種別

Return values
mixed

setCompleteReturnUrl()

決済完了戻り先URLを設定する<br>

public setCompleteReturnUrl(string $completeReturnUrl) : mixed
Parameters
$completeReturnUrl : string

決済完了戻り先URL

Return values
mixed

setCompleteScreenAddInfo()

完了画面付加情報を設定する<br>

public setCompleteScreenAddInfo(string $completeScreenAddInfo) : mixed
Parameters
$completeScreenAddInfo : string

完了画面付加情報

Return values
mixed

setConfirmScreenAddInfo()

内容確認画面付加情報を設定する<br>

public setConfirmScreenAddInfo(string $confirmScreenAddInfo) : mixed
Parameters
$confirmScreenAddInfo : string

内容確認画面付加情報

Return values
mixed

setCreateDate()

入会年月日を設定する<br>

public setCreateDate(string $createDate) : mixed
Parameters
$createDate : string

入会年月日

Return values
mixed

setFailureUrl()

失敗時URLを設定する<br>

public setFailureUrl(string $failureUrl) : mixed
Parameters
$failureUrl : string

失敗時URL

Return values
mixed

setForwardMailFlag()

転送メール送信要否を設定する<br>

public setForwardMailFlag(string $forwardMailFlag) : mixed
Parameters
$forwardMailFlag : string

転送メール送信要否

Return values
mixed

setFree()

備考を設定する<br>

public setFree(string $free) : mixed
Parameters
$free : string

備考

Return values
mixed

setFreeKey()

キー情報を設定する<br>

public setFreeKey(string $freeKey) : mixed
Parameters
$freeKey : string

キー情報

Return values
mixed

setHiraganaId()

ひらがなIDを設定する<br>

public setHiraganaId(string $hiraganaId) : mixed
Parameters
$hiraganaId : string

ひらがなID

Return values
mixed

setMailAddr()

メールアドレスを設定する<br>

public setMailAddr(string $mailAddr) : mixed
Parameters
$mailAddr : string

メールアドレス

Return values
mixed

setMemberStoreSettleEntryTime()

加盟店決済受付時刻を設定する<br>

public setMemberStoreSettleEntryTime(string $memberStoreSettleEntryTime) : mixed
Parameters
$memberStoreSettleEntryTime : 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

setMerchantMailAddr()

マーチャントメールアドレスを設定する<br>

public setMerchantMailAddr(string $merchantMailAddr) : mixed
Parameters
$merchantMailAddr : string

マーチャントメールアドレス

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

setRating()

商品レイティングを設定する<br>

public setRating(string $rating) : mixed
Parameters
$rating : string

商品レイティング

Return values
mixed

setReceiptData()

レシートデータを設定する。<br>

public setReceiptData(string $receiptData) : mixed
Parameters
$receiptData : string

レシートデータ

Return values
mixed

setRequestMailAddInfo()

依頼メール付加情報を設定する<br>

public setRequestMailAddInfo(string $requestMailAddInfo) : mixed
Parameters
$requestMailAddInfo : string

依頼メール付加情報

Return values
mixed

setSalesType()

販売区分を設定する<br>

public setSalesType(string $salesType) : mixed
Parameters
$salesType : string

販売区分

Return values
mixed

setScreenTitle()

画面タイトルを設定する<br>

public setScreenTitle(string $screenTitle) : mixed
Parameters
$screenTitle : string

画面タイトル

Return values
mixed

setServiceOptionType()

決済サービスオプションを設定する<br>

public setServiceOptionType(string $serviceOptionType) : mixed
Parameters
$serviceOptionType : string

決済サービスオプション

Return values
mixed

setSettlementLimit()

決済期限を設定する<br>

public setSettlementLimit(string $settlementLimit) : mixed
Parameters
$settlementLimit : string

決済期限

Return values
mixed

setShopName()

ショップ名を設定する<br>

public setShopName(string $shopName) : mixed
Parameters
$shopName : string

ショップ名

Return values
mixed

setSuccessUrl()

成功時URLを設定する<br>

public setSuccessUrl(string $successUrl) : mixed
Parameters
$successUrl : string

成功時URL

Return values
mixed

setTransactionKind()

取引種別を設定する<br>

public setTransactionKind(string $transactionKind) : mixed
Parameters
$transactionKind : string

取引種別

Return values
mixed

setUserId()

ユーザIDを設定する<br>

public setUserId(string $userId) : mixed
Parameters
$userId : string

ユーザID

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
Return values
mixed

Search results