Menu

## BankpayPrepareAccountAddRequestDto extends AbstractPaymentRequestDto
in package

BankpayPrepareAccountAddRequestDto.php : 11

決済サービスタイプ：bankpay、コマンド名：口座入力情報取得の要求Dtoクラス<br>

##### Tags

author

  Veritrans, Inc.

### Table of Contents

$payNowIdParam : PayNowIdParam
  PayNowIDオブジェクト
$accountId : mixed
  口座ID<br> 半角英数<br/> 最大桁数：100<br/> - マーチャント側で口座を一意に表す口座IDを指定します。<br/> - 口座ごとに一意である必要があります。<br/> - 半角英数、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。<br/>
$bankCode : mixed
  銀行コード<br> 半角数字<br/> 最大桁数：4<br/> 登録口座の銀行コードを入力します。<br/>
$errorUrl : mixed
  決済エラー時URL<br> URLに使用可能な文字<br/> 最大桁数：256<br/> 口座登録エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。<br/>
$maskedLog : mixed
  ログ用文字列(マスク済み)<br> 半角英数字<br>
$memberId : mixed
  会員ID<br> 半角英数<br/> 最大桁数：100<br/> 口座登録対象の会員IDを指定します。<br/>
$pushUrl : mixed
  プッシュ先URL<br> URLに使用可能な文字<br/> 最大桁数：256<br/> プッシュURLを指定します。<br/> <br/> ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。<br/>
$SERVICE_COMMAND : mixed
  決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
$SERVICE_TYPE : mixed
  決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
$serviceOptionType : mixed
  サービスオプションタイプ<br> 半角英数<br/> - "online":オンライン決済<br/>
$successUrl : mixed
  決済完了時URL<br> URLに使用可能な文字<br/> 最大桁数：256<br/> 口座登録完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。<br/>
$userTerminalId : mixed
  利用者端末識別ID<br> 半角英字<br/> 最大桁数：32<br/> 利用者の端末を識別するIDを指定します。<br/> スマホなどのデバイスを識別するためのUUIDなどの情報で、EC利用などの場合は一意なランダムな値を設定します。<br/>
__toString() : string
  ログ用文字列(マスク済み)を取得する<br>
_setMaskedLog() : mixed
  ログ用文字列(マスク済み)を設定する<br>
getAccountId() : string
  口座IDを取得する<br>
getBankCode() : string
  銀行コードを取得する<br>
getCreateDate() : string
  入会年月日を取得する<br>
getErrorUrl() : string
  決済エラー時URLを取得する<br>
getFreeKey() : string
  キー情報を取得する<br>
getMemberId() : string
  会員IDを取得する<br>
getMemo1() : string
  取引メモ１を取得する<br>
getMemo2() : string
  取引メモ２を取得する<br>
getMemo3() : string
  取引メモ３を取得する<br>
getPushUrl() : string
  プッシュ先URLを取得する<br>
getReceiptData() : string
  レシートデータを取得する。<br>
getServiceCommand() : string
  決済サービスコマンドを取得する<br>
getServiceOptionType() : string
  サービスオプションタイプを取得する<br>
getServiceType() : string
  決済サービスタイプを取得する<br>
getSuccessUrl() : string
  決済完了時URLを取得する<br>
getUserTerminalId() : string
  利用者端末識別IDを取得する<br>
setAccountId() : mixed
  口座IDを設定する<br>
setBankCode() : mixed
  銀行コードを設定する<br>
setCreateDate() : mixed
  入会年月日を設定する<br>
setErrorUrl() : mixed
  決済エラー時URLを設定する<br>
setFreeKey() : mixed
  キー情報を設定する<br>
setMemberId() : mixed
  会員IDを設定する<br>
setMemo1() : mixed
  取引メモ１を設定する<br>
setMemo2() : mixed
  取引メモ２を設定する<br>
setMemo3() : mixed
  取引メモ３を設定する<br>
setPushUrl() : mixed
  プッシュ先URLを設定する<br>
setReceiptData() : mixed
  レシートデータを設定する。<br>
setServiceOptionType() : mixed
  サービスオプションタイプを設定する<br>
setSuccessUrl() : mixed
  決済完了時URLを設定する<br>
setUserTerminalId() : 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

#### $payNowIdParam

AbstractPaymentRequestDto.php : 17

PayNowIDオブジェクト

`protected PayNowIdParam $payNowIdParam`

#### $accountId

BankpayPrepareAccountAddRequestDto.php : 60

口座ID<br> 半角英数<br/> 最大桁数：100<br/> - マーチャント側で口座を一意に表す口座IDを指定します。<br/> - 口座ごとに一意である必要があります。<br/> - 半角英数、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。<br/>

`private mixed $accountId`

#### $bankCode

BankpayPrepareAccountAddRequestDto.php : 98

銀行コード<br> 半角数字<br/> 最大桁数：4<br/> 登録口座の銀行コードを入力します。<br/>

`private mixed $bankCode`

#### $errorUrl

BankpayPrepareAccountAddRequestDto.php : 80

決済エラー時URL<br> URLに使用可能な文字<br/> 最大桁数：256<br/> 口座登録エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。<br/>

`private mixed $errorUrl`

#### $maskedLog

BankpayPrepareAccountAddRequestDto.php : 105

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

`private mixed $maskedLog`

#### $memberId

BankpayPrepareAccountAddRequestDto.php : 41

会員ID<br> 半角英数<br/> 最大桁数：100<br/> 口座登録対象の会員IDを指定します。<br/>

`private mixed $memberId`

#### $pushUrl

BankpayPrepareAccountAddRequestDto.php : 90

プッシュ先URL<br> URLに使用可能な文字<br/> 最大桁数：256<br/> プッシュURLを指定します。<br/> <br/> ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。<br/>

`private mixed $pushUrl`

#### $SERVICE_COMMAND

BankpayPrepareAccountAddRequestDto.php : 26

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

`private mixed $SERVICE_COMMAND = "PrepareAccountAdd"`

#### $SERVICE_TYPE

BankpayPrepareAccountAddRequestDto.php : 19

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

`private mixed $SERVICE_TYPE = "bankpay"`

#### $serviceOptionType

BankpayPrepareAccountAddRequestDto.php : 33

サービスオプションタイプ<br> 半角英数<br/> - "online":オンライン決済<br/>

`private mixed $serviceOptionType`

#### $successUrl

BankpayPrepareAccountAddRequestDto.php : 70

決済完了時URL<br> URLに使用可能な文字<br/> 最大桁数：256<br/> 口座登録完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> <br/> ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。<br/>

`private mixed $successUrl`

#### $userTerminalId

BankpayPrepareAccountAddRequestDto.php : 50

利用者端末識別ID<br> 半角英字<br/> 最大桁数：32<br/> 利用者の端末を識別するIDを指定します。<br/> スマホなどのデバイスを識別するためのUUIDなどの情報で、EC利用などの場合は一意なランダムな値を設定します。<br/>

`private mixed $userTerminalId`

### Methods

#### __toString()

BankpayPrepareAccountAddRequestDto.php : 284

ログ用文字列(マスク済み)を取得する<br>

`public __toString() : string`

##### Return values

string —

ログ用文字列(マスク済み)

#### _setMaskedLog()

BankpayPrepareAccountAddRequestDto.php : 275

ログ用文字列(マスク済み)を設定する<br>

`public _setMaskedLog(string $maskedLog) : mixed`

##### Parameters

$maskedLog : string

  ログ用文字列(マスク済み)

##### Return values

mixed —

#### getAccountId()

BankpayPrepareAccountAddRequestDto.php : 184

口座IDを取得する<br>

`public getAccountId() : string`

##### Return values

string —

口座ID

#### getBankCode()

BankpayPrepareAccountAddRequestDto.php : 256

銀行コードを取得する<br>

`public getBankCode() : string`

##### Return values

string —

銀行コード

#### getCreateDate()

AbstractPaymentRequestDto.php : 59

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

`public getCreateDate() : string`

##### Return values

string —

入会年月日

#### getErrorUrl()

BankpayPrepareAccountAddRequestDto.php : 220

決済エラー時URLを取得する<br>

`public getErrorUrl() : string`

##### Return values

string —

決済エラー時URL

#### getFreeKey()

AbstractPaymentRequestDto.php : 139

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

`public getFreeKey() : string`

##### Return values

string —

キー情報

#### getMemberId()

BankpayPrepareAccountAddRequestDto.php : 148

会員IDを取得する<br>

`public getMemberId() : string`

##### Return values

string —

会員ID

#### getMemo1()

AbstractPaymentRequestDto.php : 79

取引メモ１を取得する<br>

`public getMemo1() : string`

##### Return values

string —

取引メモ１

#### getMemo2()

AbstractPaymentRequestDto.php : 99

取引メモ２を取得する<br>

`public getMemo2() : string`

##### Return values

string —

取引メモ２

#### getMemo3()

AbstractPaymentRequestDto.php : 119

取引メモ３を取得する<br>

`public getMemo3() : string`

##### Return values

string —

取引メモ３を設定する

#### getPushUrl()

BankpayPrepareAccountAddRequestDto.php : 238

プッシュ先URLを取得する<br>

`public getPushUrl() : string`

##### Return values

string —

プッシュ先URL

#### getReceiptData()

AbstractPaymentRequestDto.php : 159

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

`public getReceiptData() : string`

##### Return values

string —

レシートデータ

#### getServiceCommand()

BankpayPrepareAccountAddRequestDto.php : 121

決済サービスコマンドを取得する<br>

`public getServiceCommand() : string`

##### Return values

string —

決済サービスコマンド

#### getServiceOptionType()

BankpayPrepareAccountAddRequestDto.php : 130

サービスオプションタイプを取得する<br>

`public getServiceOptionType() : string`

##### Return values

string —

サービスオプションタイプ

#### getServiceType()

BankpayPrepareAccountAddRequestDto.php : 112

決済サービスタイプを取得する<br>

`public getServiceType() : string`

##### Return values

string —

決済サービスタイプ

#### getSuccessUrl()

BankpayPrepareAccountAddRequestDto.php : 202

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

`public getSuccessUrl() : string`

##### Return values

string —

決済完了時URL

#### getUserTerminalId()

BankpayPrepareAccountAddRequestDto.php : 166

利用者端末識別IDを取得する<br>

`public getUserTerminalId() : string`

##### Return values

string —

利用者端末識別ID

#### setAccountId()

BankpayPrepareAccountAddRequestDto.php : 193

口座IDを設定する<br>

`public setAccountId(string $accountId) : mixed`

##### Parameters

$accountId : string

  口座ID

##### Return values

mixed —

#### setBankCode()

BankpayPrepareAccountAddRequestDto.php : 265

銀行コードを設定する<br>

`public setBankCode(string $bankCode) : mixed`

##### Parameters

$bankCode : string

  銀行コード

##### Return values

mixed —

#### setCreateDate()

AbstractPaymentRequestDto.php : 49

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

`public setCreateDate(string $createDate) : mixed`

##### Parameters

$createDate : string

  入会年月日

##### Return values

mixed —

#### setErrorUrl()

BankpayPrepareAccountAddRequestDto.php : 229

決済エラー時URLを設定する<br>

`public setErrorUrl(string $errorUrl) : mixed`

##### Parameters

$errorUrl : string

  決済エラー時URL

##### Return values

mixed —

#### setFreeKey()

AbstractPaymentRequestDto.php : 129

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

`public setFreeKey(string $freeKey) : mixed`

##### Parameters

$freeKey : string

  キー情報

##### Return values

mixed —

#### setMemberId()

BankpayPrepareAccountAddRequestDto.php : 157

会員IDを設定する<br>

`public setMemberId(string $memberId) : mixed`

##### Parameters

$memberId : string

  会員ID

##### Return values

mixed —

#### setMemo1()

AbstractPaymentRequestDto.php : 69

取引メモ１を設定する<br>

`public setMemo1(string $memo1) : mixed`

##### Parameters

$memo1 : string

  取引メモ１

##### Return values

mixed —

#### setMemo2()

AbstractPaymentRequestDto.php : 89

取引メモ２を設定する<br>

`public setMemo2(string $memo2) : mixed`

##### Parameters

$memo2 : string

  取引メモ２

##### Return values

mixed —

#### setMemo3()

AbstractPaymentRequestDto.php : 109

取引メモ３を設定する<br>

`public setMemo3(string $memo3) : mixed`

##### Parameters

$memo3 : string

  取引メモ３

##### Return values

mixed —

#### setPushUrl()

BankpayPrepareAccountAddRequestDto.php : 247

プッシュ先URLを設定する<br>

`public setPushUrl(string $pushUrl) : mixed`

##### Parameters

$pushUrl : string

  プッシュ先URL

##### Return values

mixed —

#### setReceiptData()

AbstractPaymentRequestDto.php : 149

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

`public setReceiptData(string $receiptData) : mixed`

##### Parameters

$receiptData : string

  レシートデータ

##### Return values

mixed —

#### setServiceOptionType()

BankpayPrepareAccountAddRequestDto.php : 139

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

`public setServiceOptionType(string $serviceOptionType) : mixed`

##### Parameters

$serviceOptionType : string

  サービスオプションタイプ

##### Return values

mixed —

#### setSuccessUrl()

BankpayPrepareAccountAddRequestDto.php : 211

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

`public setSuccessUrl(string $successUrl) : mixed`

##### Parameters

$successUrl : string

  決済完了時URL

##### Return values

mixed —

#### setUserTerminalId()

BankpayPrepareAccountAddRequestDto.php : 175

利用者端末識別IDを設定する<br>

`public setUserTerminalId(string $userTerminalId) : mixed`

##### Parameters

$userTerminalId : string

  利用者端末識別ID

##### Return values

mixed —

#### existAccountBasicParam()

AbstractPaymentRequestDto.php : 193

AccountBasicParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>

`protected existAccountBasicParam() : mixed`

##### Return values

mixed —

#### existAccountParam()

AbstractPaymentRequestDto.php : 180

AccountParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>

`protected existAccountParam() : mixed`

##### Return values

mixed —

#### existBankAccountParam()

AbstractPaymentRequestDto.php : 232

BankAccountParamがAccountParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、AccountParamに設定する。<br>

`protected existBankAccountParam() : mixed`

##### Return values

mixed —

#### existCardParam()

AbstractPaymentRequestDto.php : 206

CardParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>

`protected existCardParam() : mixed`

##### Return values

mixed —

#### existPayNowIdParam()

AbstractPaymentRequestDto.php : 169

PayNowIdPramが設定されているか判定する。<br> 設定されていない場合はインスタンスを生成する。<br>

`protected existPayNowIdParam() : mixed`

##### Return values

mixed —

#### existRecurringChargeParam()

AbstractPaymentRequestDto.php : 219

RecurringChargeParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>

`protected existRecurringChargeParam() : mixed`

##### Return values

mixed —

## Search results