VeriTrans 4G MDK

CarrierTerminateRequestDto extends AbstractPaymentRequestDto
in package

決済サービスタイプ:キャリア、コマンド名:継続終了の要求Dtoクラス<br>

Tags
author

Veritrans, Inc.

Table of Contents

$payNowIdParam  : PayNowIdParam
PayNowIDオブジェクト
$cancelUrl  : mixed
継続課金終了キャンセル時URL<br> URL<br/> 最大桁数:256<br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録時に設定した値を使用<br/> <br/> 継続課金終了キャンセル後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/>
$errorUrl  : mixed
継続課金終了エラー時URL<br> URL<br/> 最大桁数:256<br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録時に設定した値を使用<br/> <br/> 継続課金終了エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/>
$force  : mixed
強制終了<br> 英字(boolean)<br/> ※docomo、sb_matomete のみ指定可能なパラメータです。<br/> <br/> 継続課金の終了方式(3者間または2者間)を指定します。<br/> - "true" :強制終了(2者間)<br/> - "false" :消費者を介する終了要求(3者間/デフォルト)<br/> <br/> ※auの場合は強制終了で固定のため、指定できません。<br/>
$maskedLog  : mixed
ログ用文字列(マスク済み)<br> 半角英数字<br>
$orderId  : mixed
取引ID<br> 半角英数字<br/> 最大桁数:100<br/> - 継続課金を終了する対象の取引IDを指定する。<br/> - 随時決済を終了する利用承諾の取引IDを指定する。<br/>
$pushUrl  : mixed
プッシュ先URL<br> URL<br/> 最大桁数:256<br/> 「ダミー取引」時のプッシュURLを指定します。<br/> <br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/> ※本パラメータは店舗側システムの開発時にのみ利用されることを想定しており、ダミー取引で指定可能です。<br/> ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録時にDBに設定された値を使用<br/>
$SERVICE_COMMAND  : mixed
決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
$SERVICE_TYPE  : mixed
決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
$serviceOptionType  : mixed
サービスオプションタイプ<br> 半角英数字<br/> - "docomo":ドコモケータイ払い<br/> - "au":auかんたん決済<br/> - "sb_matomete":ソフトバンクまとめて支払い(A)<br/> - "flets":フレッツまとめて支払い<br/> - "sb_ktai":ソフトバンクまとめて支払い(B)<br/> 以下は指定できない。<br/> - "s_bikkuri":S!まとめて支払い<br/>
$successUrl  : mixed
継続課金終了完了時URL<br> URL<br/> 最大桁数:256<br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録時に設定した値を使用<br/> <br/> 継続課金終了完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/>
$terminalKind  : mixed
端末種別<br> 半角数字<br/> 最大桁数:1<br/> 消費者が使用している端末の種別を指定します。<br/> - 0:PC<br/> - 1:スマートフォン<br/> - 2:フィーチャーフォン<br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<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>
getTerminalKind()  : string
端末種別を取得する<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>
setTerminalKind()  : 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

$cancelUrl

継続課金終了キャンセル時URL<br> URL<br/> 最大桁数:256<br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録時に設定した値を使用<br/> <br/> 継続課金終了キャンセル後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/>

private mixed $cancelUrl

$errorUrl

継続課金終了エラー時URL<br> URL<br/> 最大桁数:256<br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録時に設定した値を使用<br/> <br/> 継続課金終了エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/>

private mixed $errorUrl

$force

強制終了<br> 英字(boolean)<br/> ※docomo、sb_matomete のみ指定可能なパラメータです。<br/> <br/> 継続課金の終了方式(3者間または2者間)を指定します。<br/> - "true" :強制終了(2者間)<br/> - "false" :消費者を介する終了要求(3者間/デフォルト)<br/> <br/> ※auの場合は強制終了で固定のため、指定できません。<br/>

private mixed $force

$orderId

取引ID<br> 半角英数字<br/> 最大桁数:100<br/> - 継続課金を終了する対象の取引IDを指定する。<br/> - 随時決済を終了する利用承諾の取引IDを指定する。<br/>

private mixed $orderId

$pushUrl

プッシュ先URL<br> URL<br/> 最大桁数:256<br/> 「ダミー取引」時のプッシュURLを指定します。<br/> <br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/> ※本パラメータは店舗側システムの開発時にのみ利用されることを想定しており、ダミー取引で指定可能です。<br/> ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録時にDBに設定された値を使用<br/>

private mixed $pushUrl

$SERVICE_COMMAND

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

private mixed $SERVICE_COMMAND = "Terminate"

$SERVICE_TYPE

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

private mixed $SERVICE_TYPE = "carrier"

$serviceOptionType

サービスオプションタイプ<br> 半角英数字<br/> - "docomo":ドコモケータイ払い<br/> - "au":auかんたん決済<br/> - "sb_matomete":ソフトバンクまとめて支払い(A)<br/> - "flets":フレッツまとめて支払い<br/> - "sb_ktai":ソフトバンクまとめて支払い(B)<br/> 以下は指定できない。<br/> - "s_bikkuri":S!まとめて支払い<br/>

private mixed $serviceOptionType

$successUrl

継続課金終了完了時URL<br> URL<br/> 最大桁数:256<br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/> ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録時に設定した値を使用<br/> <br/> 継続課金終了完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/>

private mixed $successUrl

$terminalKind

端末種別<br> 半角数字<br/> 最大桁数:1<br/> 消費者が使用している端末の種別を指定します。<br/> - 0:PC<br/> - 1:スマートフォン<br/> - 2:フィーチャーフォン<br/> ※消費者を介する終了要求(3者間)の場合に指定可能なパラメータです。<br/>

private mixed $terminalKind

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

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を設定する

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

getTerminalKind()

端末種別を取得する<br>

public getTerminalKind() : string
Return values
string

端末種別

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

setTerminalKind()

端末種別を設定する<br>

public setTerminalKind(string $terminalKind) : mixed
Parameters
$terminalKind : 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
Return values
mixed

Search results