Menu

## RakutenCancelResponseDto extends MdkBaseDto
in package

RakutenCancelResponseDto.php : 11

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

##### Tags

author

  Veritrans, Inc.

### Table of Contents

$balance : mixed
  残高<br> 半角数字<br/> 最大桁数：7<br/> 現在の残高（返金後の売上残高）<br/> ※バーコード決済（店舗スキャン型）、オンライン決済（V2）、バーコード決済（消費者スキャン型）で返却します。<br/>
$cancelReqDatetime : mixed
  取消要求日時（YYYYMMDDhhmmss）<br> 半角数字<br/> 最大桁数：14<br/> ※オンライン決済で返却します。<br/>
$cancelTxnId : mixed
  決済取消トランザクションID<br> 半角英数字<br/> 最大桁数：36<br/> 決済取消時にGWで設定する処理通番<br/> ※バーコード決済（店舗スキャン型）、バーコード決済（消費者スキャン型）で返却します。<br/>
$custTxn : mixed
  取引毎に付くID<br> 半角英数字<br/> 最大桁数：100<br/>
$gatewayOrderId : mixed
  決済取引ID<br> 文字列<br/> 最大桁数：20<br/> GWが取引毎に発番するID。<br/> ※オンライン決済（V2）で返却します。<br/>
$marchTxn : mixed
  電文ID<br> 半角英数字<br/> 最大桁数：100<br/>
$merrMsg : mixed
  エラーメッセージ<br> 文字列<br/> 処理結果に対するメッセージを返却します。<br/>
$mstatus : mixed
  処理結果コード<br> 半角英数字<br/> 最大桁数：32<br/> 取消請求処理後、応答電文に含まれる値。<br/> 以下の処理結果のいずれかが格納される<br/> - success：正常終了<br/> - failure：異常終了<br/> - pending：保留状態<br/>
$orderId : mixed
  取引ID<br> 半角英数字<br/> 最大桁数：100<br/>
$payNowIdResponse : mixed
  PayNowIDオブジェクト<br> オブジェクト<br> PayNowID用項目を格納するオブジェクト<br>
$rakutenOrderId : mixed
  楽天取引ID<br> 文字列<br/> 最大桁数：14<br/> 決済センターが取引毎に発番するID。<br/> ※オンライン決済（V2）で返却します。<br/>
$resultXml : mixed
  結果XML(マスク済み)<br> 半角英数字<br>
$serviceType : mixed
  決済サービスタイプ<br> 半角英数字<br/> 最大桁数：10<br/> 決済サービスの区分を返却します。<br/> - "rakuten"： 楽天決済<br/>
$transactionDatetime : mixed
  取引成立日時<br> 半角数字<br/> 最大桁数：14<br/> 決済センターで決済が確定した日時(YYYYMMDDhhmmss)を返します。<br/> ※オンライン決済（V2）で返却します。<br/>
$txnVersion : mixed
  MDKバージョン<br> 半角英数字<br/> 最大桁数：5<br/> 電文のバージョン番号を返却します。<br/>
$usedPoint : mixed
  利用ポイント<br> 数字<br/> 最大桁数：8<br/> 利用されたポイントを返却します。<br/> ※オンライン決済（V2）で返却します。<br/>
$vResultCode : mixed
  詳細結果コード<br> 半角英数字<br/> 最大桁数：16<br/> 処理結果を詳細に表すコードを返却します。<br/> <br/> 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。<br/>
__toString() : string
  結果XML(マスク済み)を取得する<br>
_setResultXml() : mixed
  結果XML(マスク済み)を設定する<br>
getBalance() : string
  残高を取得する<br>
getCancelReqDatetime() : string
  取消要求日時（YYYYMMDDhhmmss）を取得する<br>
getCancelTxnId() : string
  決済取消トランザクションIDを取得する<br>
getCustTxn() : string
  取引毎に付くIDを取得する<br>
getGatewayOrderId() : string
  決済取引IDを取得する<br>
getMarchTxn() : string
  電文IDを取得する<br>
getMerrMsg() : string
  エラーメッセージを取得する<br>
getMstatus() : string
  処理結果コードを取得する<br>
getOrderId() : string
  取引IDを取得する<br>
getPayNowIdResponse() : PayNowIdResponse
  PayNowIDオブジェクトを取得する<br>
getRakutenOrderId() : string
  楽天取引IDを取得する<br>
getServiceType() : string
  決済サービスタイプを取得する<br>
getTransactionDatetime() : string
  取引成立日時を取得する<br>
getTxnVersion() : string
  MDKバージョンを取得する<br>
getUsedPoint() : string
  利用ポイントを取得する<br>
getVResultCode() : string
  詳細結果コードを取得する<br>
setBalance() : mixed
  残高を設定する<br>
setCancelReqDatetime() : mixed
  取消要求日時（YYYYMMDDhhmmss）を設定する<br>
setCancelTxnId() : mixed
  決済取消トランザクションIDを設定する<br>
setCustTxn() : mixed
  取引毎に付くIDを設定する<br>
setGatewayOrderId() : mixed
  決済取引IDを設定する<br>
setMarchTxn() : mixed
  電文IDを設定する<br>
setMerrMsg() : mixed
  エラーメッセージを設定する<br>
setMstatus() : mixed
  処理結果コードを設定する<br>
setOrderId() : mixed
  取引IDを設定する<br>
setPayNowIdResponse() : mixed
  PayNowIDオブジェクトを設定する<br>
setRakutenOrderId() : mixed
  楽天取引IDを設定する<br>
setServiceType() : mixed
  決済サービスタイプを設定する<br>
setTransactionDatetime() : mixed
  取引成立日時を設定する<br>
setTxnVersion() : mixed
  MDKバージョンを設定する<br>
setUsedPoint() : mixed
  利用ポイントを設定する<br>
setVResultCode() : mixed
  詳細結果コードを設定する<br>

### Properties

#### $balance

RakutenCancelResponseDto.php : 96

残高<br> 半角数字<br/> 最大桁数：7<br/> 現在の残高（返金後の売上残高）<br/> ※バーコード決済（店舗スキャン型）、オンライン決済（V2）、バーコード決済（消費者スキャン型）で返却します。<br/>

`private mixed $balance`

#### $cancelReqDatetime

RakutenCancelResponseDto.php : 87

取消要求日時（YYYYMMDDhhmmss）<br> 半角数字<br/> 最大桁数：14<br/> ※オンライン決済で返却します。<br/>

`private mixed $cancelReqDatetime`

#### $cancelTxnId

RakutenCancelResponseDto.php : 105

決済取消トランザクションID<br> 半角英数字<br/> 最大桁数：36<br/> 決済取消時にGWで設定する処理通番<br/> ※バーコード決済（店舗スキャン型）、バーコード決済（消費者スキャン型）で返却します。<br/>

`private mixed $cancelTxnId`

#### $custTxn

RakutenCancelResponseDto.php : 71

取引毎に付くID<br> 半角英数字<br/> 最大桁数：100<br/>

`private mixed $custTxn`

#### $gatewayOrderId

RakutenCancelResponseDto.php : 132

決済取引ID<br> 文字列<br/> 最大桁数：20<br/> GWが取引毎に発番するID。<br/> ※オンライン決済（V2）で返却します。<br/>

`private mixed $gatewayOrderId`

#### $marchTxn

RakutenCancelResponseDto.php : 57

電文ID<br> 半角英数字<br/> 最大桁数：100<br/>

`private mixed $marchTxn`

#### $merrMsg

RakutenCancelResponseDto.php : 50

エラーメッセージ<br> 文字列<br/> 処理結果に対するメッセージを返却します。<br/>

`private mixed $merrMsg`

#### $mstatus

RakutenCancelResponseDto.php : 33

処理結果コード<br> 半角英数字<br/> 最大桁数：32<br/> 取消請求処理後、応答電文に含まれる値。<br/> 以下の処理結果のいずれかが格納される<br/> - success：正常終了<br/> - failure：異常終了<br/> - pending：保留状態<br/>

`private mixed $mstatus`

#### $orderId

RakutenCancelResponseDto.php : 64

取引ID<br> 半角英数字<br/> 最大桁数：100<br/>

`private mixed $orderId`

#### $payNowIdResponse

RakutenCancelResponseDto.php : 155

PayNowIDオブジェクト<br> オブジェクト<br> PayNowID用項目を格納するオブジェクト<br>

`private mixed $payNowIdResponse`

#### $rakutenOrderId

RakutenCancelResponseDto.php : 123

楽天取引ID<br> 文字列<br/> 最大桁数：14<br/> 決済センターが取引毎に発番するID。<br/> ※オンライン決済（V2）で返却します。<br/>

`private mixed $rakutenOrderId`

#### $resultXml

RakutenCancelResponseDto.php : 148

結果XML(マスク済み)<br> 半角英数字<br>

`private mixed $resultXml`

#### $serviceType

RakutenCancelResponseDto.php : 21

決済サービスタイプ<br> 半角英数字<br/> 最大桁数：10<br/> 決済サービスの区分を返却します。<br/> - "rakuten"： 楽天決済<br/>

`private mixed $serviceType`

#### $transactionDatetime

RakutenCancelResponseDto.php : 114

取引成立日時<br> 半角数字<br/> 最大桁数：14<br/> 決済センターで決済が確定した日時(YYYYMMDDhhmmss)を返します。<br/> ※オンライン決済（V2）で返却します。<br/>

`private mixed $transactionDatetime`

#### $txnVersion

RakutenCancelResponseDto.php : 79

MDKバージョン<br> 半角英数字<br/> 最大桁数：5<br/> 電文のバージョン番号を返却します。<br/>

`private mixed $txnVersion`

#### $usedPoint

RakutenCancelResponseDto.php : 141

利用ポイント<br> 数字<br/> 最大桁数：8<br/> 利用されたポイントを返却します。<br/> ※オンライン決済（V2）で返却します。<br/>

`private mixed $usedPoint`

#### $vResultCode

RakutenCancelResponseDto.php : 43

詳細結果コード<br> 半角英数字<br/> 最大桁数：16<br/> 処理結果を詳細に表すコードを返却します。<br/> <br/> 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。<br/>

`private mixed $vResultCode`

### Methods

#### __toString()

RakutenCancelResponseDto.php : 442

結果XML(マスク済み)を取得する<br>

`public __toString() : string`

##### Return values

string —

結果XML(マスク済み)

#### _setResultXml()

RakutenCancelResponseDto.php : 433

結果XML(マスク済み)を設定する<br>

`public _setResultXml(string $resultXml) : mixed`

##### Parameters

$resultXml : string

  結果XML(マスク済み)

##### Return values

mixed —

#### getBalance()

RakutenCancelResponseDto.php : 324

残高を取得する<br>

`public getBalance() : string`

##### Return values

string —

残高

#### getCancelReqDatetime()

RakutenCancelResponseDto.php : 306

取消要求日時（YYYYMMDDhhmmss）を取得する<br>

`public getCancelReqDatetime() : string`

##### Return values

string —

取消要求日時（YYYYMMDDhhmmss）

#### getCancelTxnId()

RakutenCancelResponseDto.php : 342

決済取消トランザクションIDを取得する<br>

`public getCancelTxnId() : string`

##### Return values

string —

決済取消トランザクションID

#### getCustTxn()

RakutenCancelResponseDto.php : 270

取引毎に付くIDを取得する<br>

`public getCustTxn() : string`

##### Return values

string —

取引毎に付くID

#### getGatewayOrderId()

RakutenCancelResponseDto.php : 396

決済取引IDを取得する<br>

`public getGatewayOrderId() : string`

##### Return values

string —

決済取引ID

#### getMarchTxn()

RakutenCancelResponseDto.php : 234

電文IDを取得する<br>

`public getMarchTxn() : string`

##### Return values

string —

電文ID

#### getMerrMsg()

RakutenCancelResponseDto.php : 216

エラーメッセージを取得する<br>

`public getMerrMsg() : string`

##### Return values

string —

エラーメッセージ

#### getMstatus()

RakutenCancelResponseDto.php : 180

処理結果コードを取得する<br>

`public getMstatus() : string`

##### Return values

string —

処理結果コード

#### getOrderId()

RakutenCancelResponseDto.php : 252

取引IDを取得する<br>

`public getOrderId() : string`

##### Return values

string —

取引ID

#### getPayNowIdResponse()

RakutenCancelResponseDto.php : 460

PayNowIDオブジェクトを取得する<br>

`public getPayNowIdResponse() : PayNowIdResponse`

##### Return values

PayNowIdResponse —

PayNowIDオブジェクト

#### getRakutenOrderId()

RakutenCancelResponseDto.php : 378

楽天取引IDを取得する<br>

`public getRakutenOrderId() : string`

##### Return values

string —

楽天取引ID

#### getServiceType()

RakutenCancelResponseDto.php : 162

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

`public getServiceType() : string`

##### Return values

string —

決済サービスタイプ

#### getTransactionDatetime()

RakutenCancelResponseDto.php : 360

取引成立日時を取得する<br>

`public getTransactionDatetime() : string`

##### Return values

string —

取引成立日時

#### getTxnVersion()

RakutenCancelResponseDto.php : 288

MDKバージョンを取得する<br>

`public getTxnVersion() : string`

##### Return values

string —

MDKバージョン

#### getUsedPoint()

RakutenCancelResponseDto.php : 414

利用ポイントを取得する<br>

`public getUsedPoint() : string`

##### Return values

string —

利用ポイント

#### getVResultCode()

RakutenCancelResponseDto.php : 198

詳細結果コードを取得する<br>

`public getVResultCode() : string`

##### Return values

string —

詳細結果コード

#### setBalance()

RakutenCancelResponseDto.php : 333

残高を設定する<br>

`public setBalance(string $balance) : mixed`

##### Parameters

$balance : string

  残高

##### Return values

mixed —

#### setCancelReqDatetime()

RakutenCancelResponseDto.php : 315

取消要求日時（YYYYMMDDhhmmss）を設定する<br>

`public setCancelReqDatetime(string $cancelReqDatetime) : mixed`

##### Parameters

$cancelReqDatetime : string

  取消要求日時（YYYYMMDDhhmmss）

##### Return values

mixed —

#### setCancelTxnId()

RakutenCancelResponseDto.php : 351

決済取消トランザクションIDを設定する<br>

`public setCancelTxnId(string $cancelTxnId) : mixed`

##### Parameters

$cancelTxnId : string

  決済取消トランザクションID

##### Return values

mixed —

#### setCustTxn()

RakutenCancelResponseDto.php : 279

取引毎に付くIDを設定する<br>

`public setCustTxn(string $custTxn) : mixed`

##### Parameters

$custTxn : string

  取引毎に付くID

##### Return values

mixed —

#### setGatewayOrderId()

RakutenCancelResponseDto.php : 405

決済取引IDを設定する<br>

`public setGatewayOrderId(string $gatewayOrderId) : mixed`

##### Parameters

$gatewayOrderId : string

  決済取引ID

##### Return values

mixed —

#### setMarchTxn()

RakutenCancelResponseDto.php : 243

電文IDを設定する<br>

`public setMarchTxn(string $marchTxn) : mixed`

##### Parameters

$marchTxn : string

  電文ID

##### Return values

mixed —

#### setMerrMsg()

RakutenCancelResponseDto.php : 225

エラーメッセージを設定する<br>

`public setMerrMsg(string $merrMsg) : mixed`

##### Parameters

$merrMsg : string

  エラーメッセージ

##### Return values

mixed —

#### setMstatus()

RakutenCancelResponseDto.php : 189

処理結果コードを設定する<br>

`public setMstatus(string $mstatus) : mixed`

##### Parameters

$mstatus : string

  処理結果コード

##### Return values

mixed —

#### setOrderId()

RakutenCancelResponseDto.php : 261

取引IDを設定する<br>

`public setOrderId(string $orderId) : mixed`

##### Parameters

$orderId : string

  取引ID

##### Return values

mixed —

#### setPayNowIdResponse()

RakutenCancelResponseDto.php : 451

PayNowIDオブジェクトを設定する<br>

`public setPayNowIdResponse(PayNowIdResponse $payNowIdResponse) : mixed`

##### Parameters

$payNowIdResponse : PayNowIdResponse

  PayNowIDオブジェクト

##### Return values

mixed —

#### setRakutenOrderId()

RakutenCancelResponseDto.php : 387

楽天取引IDを設定する<br>

`public setRakutenOrderId(string $rakutenOrderId) : mixed`

##### Parameters

$rakutenOrderId : string

  楽天取引ID

##### Return values

mixed —

#### setServiceType()

RakutenCancelResponseDto.php : 171

決済サービスタイプを設定する<br>

`public setServiceType(string $serviceType) : mixed`

##### Parameters

$serviceType : string

  決済サービスタイプ

##### Return values

mixed —

#### setTransactionDatetime()

RakutenCancelResponseDto.php : 369

取引成立日時を設定する<br>

`public setTransactionDatetime(string $transactionDatetime) : mixed`

##### Parameters

$transactionDatetime : string

  取引成立日時

##### Return values

mixed —

#### setTxnVersion()

RakutenCancelResponseDto.php : 297

MDKバージョンを設定する<br>

`public setTxnVersion(string $txnVersion) : mixed`

##### Parameters

$txnVersion : string

  MDKバージョン

##### Return values

mixed —

#### setUsedPoint()

RakutenCancelResponseDto.php : 423

利用ポイントを設定する<br>

`public setUsedPoint(string $usedPoint) : mixed`

##### Parameters

$usedPoint : string

  利用ポイント

##### Return values

mixed —

#### setVResultCode()

RakutenCancelResponseDto.php : 207

詳細結果コードを設定する<br>

`public setVResultCode(string $vResultCode) : mixed`

##### Parameters

$vResultCode : string

  詳細結果コード

##### Return values

mixed —

## Search results