Menu

## RakutenCancelRequestDto extends AbstractPaymentRequestDto
in package

RakutenCancelRequestDto.php : 11

決済サービスタイプ：楽天、コマンド名：取消の要求Dtoクラス<br>

##### Tags

author

  Veritrans, Inc.

### Table of Contents

$payNowIdParam : PayNowIdParam
  PayNowIDオブジェクト
$amount : mixed
  金額<br> 半角数字<br/> 最大桁数：8<br/> 減額する金額を指定する<br/> <br/> payType=0（オンライン決済）：売上前の場合は全額以外を指定できません。売上後は指定任意<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定できません<br/> payType=2（オンライン決済（V2））:売上前の場合は全額以外を指定できません。売上後は指定任意。<br/>
$cancelReason : mixed
  キャンセル理由詳細<br> 文字列<br/> 最大桁数：1024<br/> キャンセル理由の詳細を記載します。<br/> -最大文字数:1024byte<br/> payType=0（オンライン決済）：指定できません<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意<br/> payType=2（オンライン決済（V2））：指定できません<br/>
$cancelType : mixed
  キャンセル理由種別<br> 半角数字<br/> 最大桁数：2<br/> キャンセル理由の種別を下記のコード値から指定します。<br/> <br/> - 10: 重複しての決済<br/> - 11: 商品の返品<br/> - 12: お支払方法の変更<br/> - 13: 金額の間違い<br/> - 14: テスト決済<br/> - 98: 障害取消（タイムアウトなど）<br/> - 99: その他<br/> <br/> payType=0（オンライン決済）：指定できません<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定必須<br/> payType=2（オンライン決済（V2））：指定できません<br/>
$maskedLog : mixed
  ログ用文字列(マスク済み)<br> 半角英数字<br>
$orderId : mixed
  取引ID<br> 半角英数字<br/> 最大桁数：100<br/> キャンセル対象の取引IDを指定する。<br/>
$SERVICE_COMMAND : mixed
  決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
$SERVICE_TYPE : mixed
  決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
$storeId : mixed
  店舗ID<br> 半角英数字<br/> 最大桁数：36<br/> 店舗番号を指定します。<br/> - 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。<br/> <br/> payType=0（オンライン決済）：指定できません<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意<br/> payType=2（オンライン決済（V2））：指定できません<br/>
$terminalId : mixed
  店舗端末ID<br> 半角英数字<br/> 最大桁数：36<br/> 端末を識別するIDを指定します。<br/> - 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。<br/> <br/> payType=0（オンライン決済）：指定できません<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意<br/> payType=2（オンライン決済（V2））：指定できません<br/>
__toString() : string
  ログ用文字列(マスク済み)を取得する<br>
_setMaskedLog() : mixed
  ログ用文字列(マスク済み)を設定する<br>
getAccountId() : string
  会員IDを取得する。<br>
getAmount() : string
  金額を取得する<br>
getCancelReason() : string
  キャンセル理由詳細を取得する<br>
getCancelType() : string
  キャンセル理由種別を取得する<br>
getCreateDate() : string
  入会年月日を取得する<br>
getFreeKey() : string
  キー情報を取得する<br>
getMemo1() : string
  取引メモ１を取得する<br>
getMemo2() : string
  取引メモ２を取得する<br>
getMemo3() : string
  取引メモ３を取得する<br>
getOrderId() : string
  取引IDを取得する<br>
getReceiptData() : string
  レシートデータを取得する。<br>
getServiceCommand() : string
  決済サービスコマンドを取得する<br>
getServiceType() : string
  決済サービスタイプを取得する<br>
getStoreId() : string
  店舗IDを取得する<br>
getTerminalId() : string
  店舗端末IDを取得する<br>
setAccountId() : mixed
  会員IDを設定する。<br>
setAmount() : mixed
  金額を設定する<br>
setCancelReason() : mixed
  キャンセル理由詳細を設定する<br>
setCancelType() : mixed
  キャンセル理由種別を設定する<br>
setCreateDate() : mixed
  入会年月日を設定する<br>
setFreeKey() : mixed
  キー情報を設定する<br>
setMemo1() : mixed
  取引メモ１を設定する<br>
setMemo2() : mixed
  取引メモ２を設定する<br>
setMemo3() : mixed
  取引メモ３を設定する<br>
setOrderId() : mixed
  取引IDを設定する<br>
setReceiptData() : mixed
  レシートデータを設定する。<br>
setStoreId() : mixed
  店舗IDを設定する<br>
setTerminalId() : 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`

#### $amount

RakutenCancelRequestDto.php : 46

金額<br> 半角数字<br/> 最大桁数：8<br/> 減額する金額を指定する<br/> <br/> payType=0（オンライン決済）：売上前の場合は全額以外を指定できません。売上後は指定任意<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定できません<br/> payType=2（オンライン決済（V2））:売上前の場合は全額以外を指定できません。売上後は指定任意。<br/>

`private mixed $amount`

#### $cancelReason

RakutenCancelRequestDto.php : 104

キャンセル理由詳細<br> 文字列<br/> 最大桁数：1024<br/> キャンセル理由の詳細を記載します。<br/> -最大文字数:1024byte<br/> payType=0（オンライン決済）：指定できません<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意<br/> payType=2（オンライン決済（V2））：指定できません<br/>

`private mixed $cancelReason`

#### $cancelType

RakutenCancelRequestDto.php : 92

キャンセル理由種別<br> 半角数字<br/> 最大桁数：2<br/> キャンセル理由の種別を下記のコード値から指定します。<br/> <br/> - 10: 重複しての決済<br/> - 11: 商品の返品<br/> - 12: お支払方法の変更<br/> - 13: 金額の間違い<br/> - 14: テスト決済<br/> - 98: 障害取消（タイムアウトなど）<br/> - 99: その他<br/> <br/> payType=0（オンライン決済）：指定できません<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定必須<br/> payType=2（オンライン決済（V2））：指定できません<br/>

`private mixed $cancelType`

#### $maskedLog

RakutenCancelRequestDto.php : 111

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

`private mixed $maskedLog`

#### $orderId

RakutenCancelRequestDto.php : 34

取引ID<br> 半角英数字<br/> 最大桁数：100<br/> キャンセル対象の取引IDを指定する。<br/>

`private mixed $orderId`

#### $SERVICE_COMMAND

RakutenCancelRequestDto.php : 26

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

`private mixed $SERVICE_COMMAND = "Cancel"`

#### $SERVICE_TYPE

RakutenCancelRequestDto.php : 19

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

`private mixed $SERVICE_TYPE = "rakuten"`

#### $storeId

RakutenCancelRequestDto.php : 59

店舗ID<br> 半角英数字<br/> 最大桁数：36<br/> 店舗番号を指定します。<br/> - 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。<br/> <br/> payType=0（オンライン決済）：指定できません<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意<br/> payType=2（オンライン決済（V2））：指定できません<br/>

`private mixed $storeId`

#### $terminalId

RakutenCancelRequestDto.php : 72

店舗端末ID<br> 半角英数字<br/> 最大桁数：36<br/> 端末を識別するIDを指定します。<br/> - 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。<br/> <br/> payType=0（オンライン決済）：指定できません<br/> payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意<br/> payType=2（オンライン決済（V2））：指定できません<br/>

`private mixed $terminalId`

### Methods

#### __toString()

RakutenCancelRequestDto.php : 254

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

`public __toString() : string`

##### Return values

string —

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

#### _setMaskedLog()

RakutenCancelRequestDto.php : 245

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

`public _setMaskedLog(string $maskedLog) : mixed`

##### Parameters

$maskedLog : string

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

##### Return values

mixed —

#### getAccountId()

AbstractPaymentRequestDto.php : 23

会員IDを取得する。<br>

`public getAccountId() : string`

##### Return values

string —

会員ID

#### getAmount()

RakutenCancelRequestDto.php : 154

金額を取得する<br>

`public getAmount() : string`

##### Return values

string —

金額

#### getCancelReason()

RakutenCancelRequestDto.php : 226

キャンセル理由詳細を取得する<br>

`public getCancelReason() : string`

##### Return values

string —

キャンセル理由詳細

#### getCancelType()

RakutenCancelRequestDto.php : 208

キャンセル理由種別を取得する<br>

`public getCancelType() : string`

##### Return values

string —

キャンセル理由種別

#### getCreateDate()

AbstractPaymentRequestDto.php : 59

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

`public getCreateDate() : string`

##### Return values

string —

入会年月日

#### getFreeKey()

AbstractPaymentRequestDto.php : 139

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

`public getFreeKey() : string`

##### Return values

string —

キー情報

#### 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 —

取引メモ３を設定する

#### getOrderId()

RakutenCancelRequestDto.php : 136

取引IDを取得する<br>

`public getOrderId() : string`

##### Return values

string —

取引ID

#### getReceiptData()

AbstractPaymentRequestDto.php : 159

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

`public getReceiptData() : string`

##### Return values

string —

レシートデータ

#### getServiceCommand()

RakutenCancelRequestDto.php : 127

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

`public getServiceCommand() : string`

##### Return values

string —

決済サービスコマンド

#### getServiceType()

RakutenCancelRequestDto.php : 118

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

`public getServiceType() : string`

##### Return values

string —

決済サービスタイプ

#### getStoreId()

RakutenCancelRequestDto.php : 172

店舗IDを取得する<br>

`public getStoreId() : string`

##### Return values

string —

店舗ID

#### getTerminalId()

RakutenCancelRequestDto.php : 190

店舗端末IDを取得する<br>

`public getTerminalId() : string`

##### Return values

string —

店舗端末ID

#### setAccountId()

AbstractPaymentRequestDto.php : 33

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

`public setAccountId(string $accountId) : mixed`

##### Parameters

$accountId : string

  会員ID

##### Return values

mixed —

#### setAmount()

RakutenCancelRequestDto.php : 163

金額を設定する<br>

`public setAmount(string $amount) : mixed`

##### Parameters

$amount : string

  金額

##### Return values

mixed —

#### setCancelReason()

RakutenCancelRequestDto.php : 235

キャンセル理由詳細を設定する<br>

`public setCancelReason(string $cancelReason) : mixed`

##### Parameters

$cancelReason : string

  キャンセル理由詳細

##### Return values

mixed —

#### setCancelType()

RakutenCancelRequestDto.php : 217

キャンセル理由種別を設定する<br>

`public setCancelType(string $cancelType) : mixed`

##### Parameters

$cancelType : string

  キャンセル理由種別

##### Return values

mixed —

#### setCreateDate()

AbstractPaymentRequestDto.php : 49

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

`public setCreateDate(string $createDate) : mixed`

##### Parameters

$createDate : string

  入会年月日

##### Return values

mixed —

#### setFreeKey()

AbstractPaymentRequestDto.php : 129

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

`public setFreeKey(string $freeKey) : mixed`

##### Parameters

$freeKey : string

  キー情報

##### 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 —

#### setOrderId()

RakutenCancelRequestDto.php : 145

取引IDを設定する<br>

`public setOrderId(string $orderId) : mixed`

##### Parameters

$orderId : string

  取引ID

##### Return values

mixed —

#### setReceiptData()

AbstractPaymentRequestDto.php : 149

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

`public setReceiptData(string $receiptData) : mixed`

##### Parameters

$receiptData : string

  レシートデータ

##### Return values

mixed —

#### setStoreId()

RakutenCancelRequestDto.php : 181

店舗IDを設定する<br>

`public setStoreId(string $storeId) : mixed`

##### Parameters

$storeId : string

  店舗ID

##### Return values

mixed —

#### setTerminalId()

RakutenCancelRequestDto.php : 199

店舗端末IDを設定する<br>

`public setTerminalId(string $terminalId) : mixed`

##### Parameters

$terminalId : 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