Menu

## UpopRefundResponseDto extends MdkBaseDto
in package

UpopRefundResponseDto.php : 11

決済サービスタイプ：UPOP、コマンド名：返金の応答Dtoクラス<br>

##### Tags

author

  Veritrans, Inc.

### Table of Contents

$capturedAmount : mixed
  元売上金額<br> 半角数字<br/> 最大桁数：12<br/> 与信（売上同時）、与信後の売上に対する返金の場合の元売上金額 <br/>
$custTxn : mixed
  トランザクションID(取引毎につけるID)<br> 半角英数字<br/> 最大桁数：100<br/>
$marchTxn : mixed
  電文ID<br> 半角英数字<br/> 最大桁数：100<br/>
$merrMsg : mixed
  エラーメッセージ<br> 文字列<br/> 最大桁数：300<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>
$remainingAmount : mixed
  返品後の金額<br> 半角数字<br/> 最大桁数：12<br/> 返品後の金額<br/>
$resultXml : mixed
  結果XML(マスク済み)<br> 半角英数字<br>
$serviceType : mixed
  サービスタイプ<br> 半角英数字<br/> 最大桁数：10<br/> 決済サービスの区分が固定値として指定されます。<br/> "upop"： 銀聯ネット決済（UPOP）<br/>
$settleAmount : mixed
  清算金額<br> 半角数字<br/> 最大桁数：12<br/> 清算金額<br/>
$settleCurrency : mixed
  清算通貨種類<br> 半角数字<br/> 最大桁数：3<br/> 清算通貨種類<br/> 392：日本円（固定）<br/>
$settleDate : mixed
  清算日付<br> 半角数字<br/> 最大桁数：4<br/> 清算日付（MMDD形式）<br/>
$settleRate : mixed
  清算レート<br> 半角数字<br/> 最大桁数：8<br/> 清算レート<br/>
$txnDatetimeCn : mixed
  決済時刻（中国時間）<br> 半角数字<br/> 最大桁数：14<br/> 銀聯ネット決済（UPOP）で返金が確定した日時（中国時間）を返します。<br/>
$txnDatetimeJp : mixed
  決済時刻（日本時間）<br> 半角数字<br/> 最大桁数：14<br/> 銀聯ネット決済（UPOP）で返金が確定した日時（日本時間）を返します。<br/>
$txnVersion : mixed
  MDKバージョン<br> 半角英数字<br/> 最大桁数：5<br/> 電文のバージョン番号を返却します。<br/>
$upopOrderId : mixed
  決済センターとの取引ID<br> 半角英数字<br/> 最大桁数：20<br/> 決済センターとの取引ID<br/>
$vResultCode : mixed
  詳細結果コード<br> 半角英数字<br/> 最大桁数：16<br/> 処理結果を詳細に表すコードを返却します。<br/> <br/> 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。<br/>
_setResultXml() : mixed
  結果XML(マスク済み)を設定する<br>
getCapturedAmount() : string
  元売上金額を取得する<br>
getCustTxn() : string
  トランザクションID(取引毎につけるID)を取得する<br>
getMarchTxn() : string
  電文IDを取得する<br>
getMerrMsg() : string
  エラーメッセージを取得する<br>
getMstatus() : string
  処理結果コードを取得する<br>
getOrderId() : string
  取引IDを取得する<br>
getPayNowIdResponse() : PayNowIdResponse
  PayNowIDオブジェクトを取得する<br>
getRemainingAmount() : string
  返品後の金額を取得する<br>
getServiceType() : string
  サービスタイプを取得する<br>
getSettleAmount() : string
  清算金額を取得する<br>
getSettleCurrency() : string
  清算通貨種類を取得する<br>
getSettleDate() : string
  清算日付を取得する<br>
getSettleRate() : string
  清算レートを取得する<br>
getTxnDatetimeCn() : string
  決済時刻（中国時間）を取得する<br>
getTxnDatetimeJp() : string
  決済時刻（日本時間）を取得する<br>
getTxnVersion() : string
  MDKバージョンを取得する<br>
getUpopOrderId() : string
  決済センターとの取引IDを取得する<br>
getVResultCode() : string
  詳細結果コードを取得する<br>
setCapturedAmount() : mixed
  元売上金額を設定する<br>
setCustTxn() : mixed
  トランザクションID(取引毎につけるID)を設定する<br>
setMarchTxn() : mixed
  電文IDを設定する<br>
setMerrMsg() : mixed
  エラーメッセージを設定する<br>
setMstatus() : mixed
  処理結果コードを設定する<br>
setOrderId() : mixed
  取引IDを設定する<br>
setPayNowIdResponse() : mixed
  PayNowIDオブジェクトを設定する<br>
setRemainingAmount() : mixed
  返品後の金額を設定する<br>
setServiceType() : mixed
  サービスタイプを設定する<br>
setSettleAmount() : mixed
  清算金額を設定する<br>
setSettleCurrency() : mixed
  清算通貨種類を設定する<br>
setSettleDate() : mixed
  清算日付を設定する<br>
setSettleRate() : mixed
  清算レートを設定する<br>
setTxnDatetimeCn() : mixed
  決済時刻（中国時間）を設定する<br>
setTxnDatetimeJp() : mixed
  決済時刻（日本時間）を設定する<br>
setTxnVersion() : mixed
  MDKバージョンを設定する<br>
setUpopOrderId() : mixed
  決済センターとの取引IDを設定する<br>
setVResultCode() : mixed
  詳細結果コードを設定する<br>
toString() : string
  結果XML(マスク済み)を取得する<br>

### Properties

#### $capturedAmount

UpopRefundResponseDto.php : 104

元売上金額<br> 半角数字<br/> 最大桁数：12<br/> 与信（売上同時）、与信後の売上に対する返金の場合の元売上金額 <br/>

`private mixed $capturedAmount`

#### $custTxn

UpopRefundResponseDto.php : 58

トランザクションID(取引毎につけるID)<br> 半角英数字<br/> 最大桁数：100<br/>

`private mixed $custTxn`

#### $marchTxn

UpopRefundResponseDto.php : 65

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

`private mixed $marchTxn`

#### $merrMsg

UpopRefundResponseDto.php : 51

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

`private mixed $merrMsg`

#### $mstatus

UpopRefundResponseDto.php : 33

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

`private mixed $mstatus`

#### $orderId

UpopRefundResponseDto.php : 72

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

`private mixed $orderId`

#### $payNowIdResponse

UpopRefundResponseDto.php : 167

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

`private mixed $payNowIdResponse`

#### $remainingAmount

UpopRefundResponseDto.php : 112

返品後の金額<br> 半角数字<br/> 最大桁数：12<br/> 返品後の金額<br/>

`private mixed $remainingAmount`

#### $resultXml

UpopRefundResponseDto.php : 160

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

`private mixed $resultXml`

#### $serviceType

UpopRefundResponseDto.php : 21

サービスタイプ<br> 半角英数字<br/> 最大桁数：10<br/> 決済サービスの区分が固定値として指定されます。<br/> "upop"： 銀聯ネット決済（UPOP）<br/>

`private mixed $serviceType`

#### $settleAmount

UpopRefundResponseDto.php : 120

清算金額<br> 半角数字<br/> 最大桁数：12<br/> 清算金額<br/>

`private mixed $settleAmount`

#### $settleCurrency

UpopRefundResponseDto.php : 137

清算通貨種類<br> 半角数字<br/> 最大桁数：3<br/> 清算通貨種類<br/> 392：日本円（固定）<br/>

`private mixed $settleCurrency`

#### $settleDate

UpopRefundResponseDto.php : 128

清算日付<br> 半角数字<br/> 最大桁数：4<br/> 清算日付（MMDD形式）<br/>

`private mixed $settleDate`

#### $settleRate

UpopRefundResponseDto.php : 145

清算レート<br> 半角数字<br/> 最大桁数：8<br/> 清算レート<br/>

`private mixed $settleRate`

#### $txnDatetimeCn

UpopRefundResponseDto.php : 96

決済時刻（中国時間）<br> 半角数字<br/> 最大桁数：14<br/> 銀聯ネット決済（UPOP）で返金が確定した日時（中国時間）を返します。<br/>

`private mixed $txnDatetimeCn`

#### $txnDatetimeJp

UpopRefundResponseDto.php : 88

決済時刻（日本時間）<br> 半角数字<br/> 最大桁数：14<br/> 銀聯ネット決済（UPOP）で返金が確定した日時（日本時間）を返します。<br/>

`private mixed $txnDatetimeJp`

#### $txnVersion

UpopRefundResponseDto.php : 80

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

`private mixed $txnVersion`

#### $upopOrderId

UpopRefundResponseDto.php : 153

決済センターとの取引ID<br> 半角英数字<br/> 最大桁数：20<br/> 決済センターとの取引ID<br/>

`private mixed $upopOrderId`

#### $vResultCode

UpopRefundResponseDto.php : 43

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

`private mixed $vResultCode`

### Methods

#### _setResultXml()

UpopRefundResponseDto.php : 481

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

`public _setResultXml(string $resultXml) : mixed`

##### Parameters

$resultXml : string

  結果XML(マスク済み)

##### Return values

mixed —

#### getCapturedAmount()

UpopRefundResponseDto.php : 354

元売上金額を取得する<br>

`public getCapturedAmount() : string`

##### Return values

string —

元売上金額

#### getCustTxn()

UpopRefundResponseDto.php : 246

トランザクションID(取引毎につけるID)を取得する<br>

`public getCustTxn() : string`

##### Return values

string —

トランザクションID(取引毎につけるID)

#### getMarchTxn()

UpopRefundResponseDto.php : 264

電文IDを取得する<br>

`public getMarchTxn() : string`

##### Return values

string —

電文ID

#### getMerrMsg()

UpopRefundResponseDto.php : 228

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

`public getMerrMsg() : string`

##### Return values

string —

エラーメッセージ

#### getMstatus()

UpopRefundResponseDto.php : 192

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

`public getMstatus() : string`

##### Return values

string —

処理結果コード

#### getOrderId()

UpopRefundResponseDto.php : 282

取引IDを取得する<br>

`public getOrderId() : string`

##### Return values

string —

取引ID

#### getPayNowIdResponse()

UpopRefundResponseDto.php : 508

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

`public getPayNowIdResponse() : PayNowIdResponse`

##### Return values

PayNowIdResponse —

PayNowIDオブジェクト

#### getRemainingAmount()

UpopRefundResponseDto.php : 372

返品後の金額を取得する<br>

`public getRemainingAmount() : string`

##### Return values

string —

返品後の金額

#### getServiceType()

UpopRefundResponseDto.php : 174

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

`public getServiceType() : string`

##### Return values

string —

サービスタイプ

#### getSettleAmount()

UpopRefundResponseDto.php : 390

清算金額を取得する<br>

`public getSettleAmount() : string`

##### Return values

string —

清算金額

#### getSettleCurrency()

UpopRefundResponseDto.php : 426

清算通貨種類を取得する<br>

`public getSettleCurrency() : string`

##### Return values

string —

清算通貨種類

#### getSettleDate()

UpopRefundResponseDto.php : 408

清算日付を取得する<br>

`public getSettleDate() : string`

##### Return values

string —

清算日付

#### getSettleRate()

UpopRefundResponseDto.php : 444

清算レートを取得する<br>

`public getSettleRate() : string`

##### Return values

string —

清算レート

#### getTxnDatetimeCn()

UpopRefundResponseDto.php : 336

決済時刻（中国時間）を取得する<br>

`public getTxnDatetimeCn() : string`

##### Return values

string —

決済時刻（中国時間）

#### getTxnDatetimeJp()

UpopRefundResponseDto.php : 318

決済時刻（日本時間）を取得する<br>

`public getTxnDatetimeJp() : string`

##### Return values

string —

決済時刻（日本時間）

#### getTxnVersion()

UpopRefundResponseDto.php : 300

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

`public getTxnVersion() : string`

##### Return values

string —

MDKバージョン

#### getUpopOrderId()

UpopRefundResponseDto.php : 462

決済センターとの取引IDを取得する<br>

`public getUpopOrderId() : string`

##### Return values

string —

決済センターとの取引ID

#### getVResultCode()

UpopRefundResponseDto.php : 210

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

`public getVResultCode() : string`

##### Return values

string —

詳細結果コード

#### setCapturedAmount()

UpopRefundResponseDto.php : 363

元売上金額を設定する<br>

`public setCapturedAmount(string $capturedAmount) : mixed`

##### Parameters

$capturedAmount : string

  元売上金額

##### Return values

mixed —

#### setCustTxn()

UpopRefundResponseDto.php : 255

トランザクションID(取引毎につけるID)を設定する<br>

`public setCustTxn(string $custTxn) : mixed`

##### Parameters

$custTxn : string

  トランザクションID(取引毎につけるID)

##### Return values

mixed —

#### setMarchTxn()

UpopRefundResponseDto.php : 273

電文IDを設定する<br>

`public setMarchTxn(string $marchTxn) : mixed`

##### Parameters

$marchTxn : string

  電文ID

##### Return values

mixed —

#### setMerrMsg()

UpopRefundResponseDto.php : 237

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

`public setMerrMsg(string $merrMsg) : mixed`

##### Parameters

$merrMsg : string

  エラーメッセージ

##### Return values

mixed —

#### setMstatus()

UpopRefundResponseDto.php : 201

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

`public setMstatus(string $mstatus) : mixed`

##### Parameters

$mstatus : string

  処理結果コード

##### Return values

mixed —

#### setOrderId()

UpopRefundResponseDto.php : 291

取引IDを設定する<br>

`public setOrderId(string $orderId) : mixed`

##### Parameters

$orderId : string

  取引ID

##### Return values

mixed —

#### setPayNowIdResponse()

UpopRefundResponseDto.php : 499

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

`public setPayNowIdResponse(PayNowIdResponse $payNowIdResponse) : mixed`

##### Parameters

$payNowIdResponse : PayNowIdResponse

  PayNowIDオブジェクト

##### Return values

mixed —

#### setRemainingAmount()

UpopRefundResponseDto.php : 381

返品後の金額を設定する<br>

`public setRemainingAmount(string $remainingAmount) : mixed`

##### Parameters

$remainingAmount : string

  返品後の金額

##### Return values

mixed —

#### setServiceType()

UpopRefundResponseDto.php : 183

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

`public setServiceType(string $serviceType) : mixed`

##### Parameters

$serviceType : string

  サービスタイプ

##### Return values

mixed —

#### setSettleAmount()

UpopRefundResponseDto.php : 399

清算金額を設定する<br>

`public setSettleAmount(string $settleAmount) : mixed`

##### Parameters

$settleAmount : string

  清算金額

##### Return values

mixed —

#### setSettleCurrency()

UpopRefundResponseDto.php : 435

清算通貨種類を設定する<br>

`public setSettleCurrency(string $settleCurrency) : mixed`

##### Parameters

$settleCurrency : string

  清算通貨種類

##### Return values

mixed —

#### setSettleDate()

UpopRefundResponseDto.php : 417

清算日付を設定する<br>

`public setSettleDate(string $settleDate) : mixed`

##### Parameters

$settleDate : string

  清算日付

##### Return values

mixed —

#### setSettleRate()

UpopRefundResponseDto.php : 453

清算レートを設定する<br>

`public setSettleRate(string $settleRate) : mixed`

##### Parameters

$settleRate : string

  清算レート

##### Return values

mixed —

#### setTxnDatetimeCn()

UpopRefundResponseDto.php : 345

決済時刻（中国時間）を設定する<br>

`public setTxnDatetimeCn(string $txnDatetimeCn) : mixed`

##### Parameters

$txnDatetimeCn : string

  決済時刻（中国時間）

##### Return values

mixed —

#### setTxnDatetimeJp()

UpopRefundResponseDto.php : 327

決済時刻（日本時間）を設定する<br>

`public setTxnDatetimeJp(string $txnDatetimeJp) : mixed`

##### Parameters

$txnDatetimeJp : string

  決済時刻（日本時間）

##### Return values

mixed —

#### setTxnVersion()

UpopRefundResponseDto.php : 309

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

`public setTxnVersion(string $txnVersion) : mixed`

##### Parameters

$txnVersion : string

  MDKバージョン

##### Return values

mixed —

#### setUpopOrderId()

UpopRefundResponseDto.php : 471

決済センターとの取引IDを設定する<br>

`public setUpopOrderId(string $upopOrderId) : mixed`

##### Parameters

$upopOrderId : string

  決済センターとの取引ID

##### Return values

mixed —

#### setVResultCode()

UpopRefundResponseDto.php : 219

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

`public setVResultCode(string $vResultCode) : mixed`

##### Parameters

$vResultCode : string

  詳細結果コード

##### Return values

mixed —

#### toString()

UpopRefundResponseDto.php : 490

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

`public toString() : string`

##### Return values

string —

結果XML(マスク済み)

## Search results