Menu

## CarrierCancelRequestDto extends AbstractPaymentRequestDto
in package

CarrierCancelRequestDto.php : 11

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

##### Tags

author

  Veritrans, Inc.

### Table of Contents

$payNowIdParam : PayNowIdParam
  PayNowIDオブジェクト
$amount : mixed
  返金金額<br> 半角数字<br/> 最大桁数：12<br/> 返金する金額を指定します。<br/> 例）250円*4個=1000円の買い物をし1個返品した場合には、返金金額に250円を指定します。<br/> - 1 以上かつ 999999999999 以下<br/> <br/>
$cancelMonth : mixed
  課金取消月<br> 半角英数字<br/> 最大桁数：6<br/> docomo, au, flets, sb_ktaiで、継続課金（月額）の取消時のみ指定可能。<br/> - YYYYMM形式<br/>
$maskedLog : mixed
  ログ用文字列(マスク済み)<br> 半角英数字<br>
$orderId : mixed
  取引ID<br> 半角英数字<br/> 最大桁数：100<br/> キャンセル対象の取引IDを指定する。<br/>
$receiptNo : mixed
  レシート番号<br> 半角英数字<br/> 最大桁数：128<br/> auのバーコード決済、スキャンコード決済で指定可能です。<br/> <br/> ※未指定の場合は、Authorize時と同じ値<br/>
$SERVICE_COMMAND : mixed
  決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
$SERVICE_TYPE : mixed
  決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
$serviceOptionType : mixed
  サービスオプションタイプ<br> 半角英数字<br/> - "docomo":ドコモケータイ払い<br/> - "au":auかんたん決済<br/> - "sb_ktai":ソフトバンクまとめて支払い（B）<br/> - "flets":フレッツまとめて支払い<br/> 以下は指定できない。<br/> - "sb_matomete":ソフトバンクまとめて支払い（A）<br/> - "s_bikkuri":S!まとめて支払い<br/>
$storeId : mixed
  店舗ID<br> 半角数字<br/> 最大桁数：8<br/> auのバーコード決済、スキャンコード決済で指定可能です。<br/> <br/> ※未指定の場合は、Authorize時と同じ値<br/>
$termId : mixed
  端末管理番号<br> 半角英数字<br/> 最大桁数：128<br/> auのバーコード決済、スキャンコード決済で指定可能です。<br/> <br/> ※未指定の場合は、Authorize時と同じ値<br/>
__toString() : string
  ログ用文字列(マスク済み)を取得する<br>
_setMaskedLog() : mixed
  ログ用文字列(マスク済み)を設定する<br>
getAccountId() : string
  会員IDを取得する。<br>
getAmount() : string
  返金金額を取得する<br>
getCancelMonth() : string
  課金取消月を取得する<br>
getCreateDate() : string
  入会年月日を取得する<br>
getFreeKey() : string
  キー情報を取得する<br>
getMemo1() : string
  取引メモ１を取得する<br>
getMemo2() : string
  取引メモ２を取得する<br>
getMemo3() : string
  取引メモ３を取得する<br>
getOrderId() : string
  取引IDを取得する<br>
getReceiptData() : string
  レシートデータを取得する。<br>
getReceiptNo() : string
  レシート番号を取得する<br>
getServiceCommand() : string
  決済サービスコマンドを取得する<br>
getServiceOptionType() : string
  サービスオプションタイプを取得する<br>
getServiceType() : string
  決済サービスタイプを取得する<br>
getStoreId() : string
  店舗IDを取得する<br>
getTermId() : string
  端末管理番号を取得する<br>
setAccountId() : mixed
  会員IDを設定する。<br>
setAmount() : mixed
  返金金額を設定する<br>
setCancelMonth() : mixed
  課金取消月を設定する<br>
setCreateDate() : mixed
  入会年月日を設定する<br>
setFreeKey() : mixed
  キー情報を設定する<br>
setMemo1() : mixed
  取引メモ１を設定する<br>
setMemo2() : mixed
  取引メモ２を設定する<br>
setMemo3() : mixed
  取引メモ３を設定する<br>
setOrderId() : mixed
  取引IDを設定する<br>
setReceiptData() : mixed
  レシートデータを設定する。<br>
setReceiptNo() : mixed
  レシート番号を設定する<br>
setServiceOptionType() : mixed
  サービスオプションタイプを設定する<br>
setStoreId() : mixed
  店舗IDを設定する<br>
setTermId() : 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

AbstractPaymentRequestDto.php : 17

PayNowIDオブジェクト

`protected PayNowIdParam $payNowIdParam`

#### $amount

CarrierCancelRequestDto.php : 67

返金金額<br> 半角数字<br/> 最大桁数：12<br/> 返金する金額を指定します。<br/> 例）250円*4個=1000円の買い物をし1個返品した場合には、返金金額に250円を指定します。<br/> - 1 以上かつ 999999999999 以下<br/> <br/>

`private mixed $amount`

#### $cancelMonth

CarrierCancelRequestDto.php : 56

課金取消月<br> 半角英数字<br/> 最大桁数：6<br/> docomo, au, flets, sb_ktaiで、継続課金（月額）の取消時のみ指定可能。<br/> - YYYYMM形式<br/>

`private mixed $cancelMonth`

#### $maskedLog

CarrierCancelRequestDto.php : 104

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

`private mixed $maskedLog`

#### $orderId

CarrierCancelRequestDto.php : 34

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

`private mixed $orderId`

#### $receiptNo

CarrierCancelRequestDto.php : 97

レシート番号<br> 半角英数字<br/> 最大桁数：128<br/> auのバーコード決済、スキャンコード決済で指定可能です。<br/> <br/> ※未指定の場合は、Authorize時と同じ値<br/>

`private mixed $receiptNo`

#### $SERVICE_COMMAND

CarrierCancelRequestDto.php : 26

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

`private mixed $SERVICE_COMMAND = "Cancel"`

#### $SERVICE_TYPE

CarrierCancelRequestDto.php : 19

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

`private mixed $SERVICE_TYPE = "carrier"`

#### $serviceOptionType

CarrierCancelRequestDto.php : 47

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

`private mixed $serviceOptionType`

#### $storeId

CarrierCancelRequestDto.php : 77

店舗ID<br> 半角数字<br/> 最大桁数：8<br/> auのバーコード決済、スキャンコード決済で指定可能です。<br/> <br/> ※未指定の場合は、Authorize時と同じ値<br/>

`private mixed $storeId`

#### $termId

CarrierCancelRequestDto.php : 87

端末管理番号<br> 半角英数字<br/> 最大桁数：128<br/> auのバーコード決済、スキャンコード決済で指定可能です。<br/> <br/> ※未指定の場合は、Authorize時と同じ値<br/>

`private mixed $termId`

### Methods

#### __toString()

CarrierCancelRequestDto.php : 265

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

`public __toString() : string`

##### Return values

string —

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

#### _setMaskedLog()

CarrierCancelRequestDto.php : 256

ログ用文字列(マスク済み)を設定する<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()

CarrierCancelRequestDto.php : 183

返金金額を取得する<br>

`public getAmount() : string`

##### Return values

string —

返金金額

#### getCancelMonth()

CarrierCancelRequestDto.php : 165

課金取消月を取得する<br>

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

CarrierCancelRequestDto.php : 129

取引IDを取得する<br>

`public getOrderId() : string`

##### Return values

string —

取引ID

#### getReceiptData()

AbstractPaymentRequestDto.php : 159

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

`public getReceiptData() : string`

##### Return values

string —

レシートデータ

#### getReceiptNo()

CarrierCancelRequestDto.php : 237

レシート番号を取得する<br>

`public getReceiptNo() : string`

##### Return values

string —

レシート番号

#### getServiceCommand()

CarrierCancelRequestDto.php : 120

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

`public getServiceCommand() : string`

##### Return values

string —

決済サービスコマンド

#### getServiceOptionType()

CarrierCancelRequestDto.php : 147

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

`public getServiceOptionType() : string`

##### Return values

string —

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

#### getServiceType()

CarrierCancelRequestDto.php : 111

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

`public getServiceType() : string`

##### Return values

string —

決済サービスタイプ

#### getStoreId()

CarrierCancelRequestDto.php : 201

店舗IDを取得する<br>

`public getStoreId() : string`

##### Return values

string —

店舗ID

#### getTermId()

CarrierCancelRequestDto.php : 219

端末管理番号を取得する<br>

`public getTermId() : string`

##### Return values

string —

端末管理番号

#### setAccountId()

AbstractPaymentRequestDto.php : 33

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

`public setAccountId(string $accountId) : mixed`

##### Parameters

$accountId : string

  会員ID

##### Return values

mixed —

#### setAmount()

CarrierCancelRequestDto.php : 192

返金金額を設定する<br>

`public setAmount(string $amount) : mixed`

##### Parameters

$amount : string

  返金金額

##### Return values

mixed —

#### setCancelMonth()

CarrierCancelRequestDto.php : 174

課金取消月を設定する<br>

`public setCancelMonth(string $cancelMonth) : mixed`

##### Parameters

$cancelMonth : 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()

CarrierCancelRequestDto.php : 138

取引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 —

#### setReceiptNo()

CarrierCancelRequestDto.php : 246

レシート番号を設定する<br>

`public setReceiptNo(string $receiptNo) : mixed`

##### Parameters

$receiptNo : string

  レシート番号

##### Return values

mixed —

#### setServiceOptionType()

CarrierCancelRequestDto.php : 156

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

`public setServiceOptionType(string $serviceOptionType) : mixed`

##### Parameters

$serviceOptionType : string

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

##### Return values

mixed —

#### setStoreId()

CarrierCancelRequestDto.php : 210

店舗IDを設定する<br>

`public setStoreId(string $storeId) : mixed`

##### Parameters

$storeId : string

  店舗ID

##### Return values

mixed —

#### setTermId()

CarrierCancelRequestDto.php : 228

端末管理番号を設定する<br>

`public setTermId(string $termId) : mixed`

##### Parameters

$termId : string

  端末管理番号

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