PaypalRefundResponseDto
extends MdkBaseDto
in package
決済サービスタイプ:Paypal、コマンド名:返金の応答Dtoクラス
Tags
Table of Contents
- $centerTxnId : mixed
- 決済センタ取引ID<br> 半角英数字<br> 19 文字以内<br> PayPalが発番する返金取引単位でユニークとなるIDが格納されます。<br>
- $custTxn : mixed
- 取引毎に付くID<br>
- $feeRefundAmount : mixed
- 払戻し手数料<br> 半角数字<br> 払い戻し手数料が格納されます。<br>
- $invoiceId : mixed
- 請求番号<br> 半角数字<br> 請求番号が格納されます。<br>
- $marchTxn : mixed
- 電文ID<br>
- $merrMsg : mixed
- エラーメッセージ<br> 文字列<br> 1024 バイト以内<br> エラーメッセージ<br>
- $mstatus : mixed
- 処理結果コード<br> 半角英数字<br> 32 文字以内<br> 取消請求処理後、応答電文に含まれる値。<br> 以下の処理結果のいずれかが格納される<br> ・success:正常終了<br> ・failure:異常終了<br> ・pending:保留状態<br>
- $netRefundAmount : mixed
- 純返金金額<br> 半角数字<br> PayPal残高から差し引かれた金額が格納されます。<br>
- $orderId : mixed
- 取引ID<br> 半角英数字<br> 100 文字以内<br> 返金を行った取引IDが格納されます。<br> “.”(ドット)、“-”(ハイフン)、“_”(アンダースコア)も使用できます。<br>
- $payNowIdResponse : mixed
- PayNowIDオブジェクト<br> オブジェクト<br> PayNowID用項目を格納するオブジェクト<br>
- $principalAmount : mixed
- 元決済金額<br> 半角数字<br> 元決済金額が格納されます。<br>
- $refundAmount : mixed
- 返金金額<br> 半角数字<br> 返金金額が格納されます。<br>
- $resultXml : mixed
- 結果XML(マスク済み)<br> 半角英数字<br>
- $serviceType : mixed
- 決済サービスタイプ<br> 半角英数字<br> 10 文字以内<br> 決済サービスの区分を指定します。<br> 必須項目、固定値<br> "paypal": PayPal決済<br>
- $settlementBalance : mixed
- 決済残高<br> 半角数字<br> 決済残高が格納されます。<br>
- $txnVersion : mixed
- MDK バージョン<br> 半角英数字<br> 5 桁<br> 電文のバージョン番号。<br>
- $vResultCode : mixed
- 詳細結果コード<br> 半角英数字<br> 16 文字以内<br> 結果コード<br> 例) L001000100000000<br>
- __toString() : string
- 結果XML(マスク済み)を取得する<br>
- _setResultXml() : mixed
- 結果XML(マスク済み)を設定する<br>
- getCenterTxnId() : string
- 決済センタ取引IDを取得する<br>
- getCustTxn() : string
- 取引毎に付くIDを取得する<br>
- getFeeRefundAmount() : string
- 払戻し手数料を取得する<br>
- getInvoiceId() : string
- 請求番号を取得する<br>
- getMarchTxn() : string
- 電文IDを取得する<br>
- getMerrMsg() : string
- エラーメッセージを取得する<br>
- getMstatus() : string
- 処理結果コードを取得する<br>
- getNetRefundAmount() : string
- 純返金金額を取得する<br>
- getOrderId() : string
- 取引IDを取得する<br>
- getPayNowIdResponse() : PayNowIdResponse
- PayNowIDオブジェクトを取得する<br>
- getPrincipalAmount() : string
- 元決済金額を取得する<br>
- getRefundAmount() : string
- 返金金額を取得する<br>
- getServiceType() : string
- 決済サービスタイプを取得する<br>
- getSettlementBalance() : string
- 決済残高を取得する<br>
- getTxnVersion() : string
- MDK バージョンを取得する<br>
- getVResultCode() : string
- 詳細結果コードを取得する<br>
- setCenterTxnId() : mixed
- 決済センタ取引IDを設定する<br>
- setCustTxn() : mixed
- 取引毎に付くIDを設定する<br>
- setFeeRefundAmount() : mixed
- 払戻し手数料を設定する<br>
- setInvoiceId() : mixed
- 請求番号を設定する<br>
- setMarchTxn() : mixed
- 電文IDを設定する<br>
- setMerrMsg() : mixed
- エラーメッセージを設定する<br>
- setMstatus() : mixed
- 処理結果コードを設定する<br>
- setNetRefundAmount() : mixed
- 純返金金額を設定する<br>
- setOrderId() : mixed
- 取引IDを設定する<br>
- setPayNowIdResponse() : mixed
- PayNowIDオブジェクトを設定する<br>
- setPrincipalAmount() : mixed
- 元決済金額を設定する<br>
- setRefundAmount() : mixed
- 返金金額を設定する<br>
- setServiceType() : mixed
- 決済サービスタイプを設定する<br>
- setSettlementBalance() : mixed
- 決済残高を設定する<br>
- setTxnVersion() : mixed
- MDK バージョンを設定する<br>
- setVResultCode() : mixed
- 詳細結果コードを設定する<br>
Properties
$centerTxnId
決済センタ取引ID<br> 半角英数字<br> 19 文字以内<br> PayPalが発番する返金取引単位でユニークとなるIDが格納されます。<br>
private
mixed
$centerTxnId
$custTxn
取引毎に付くID<br>
private
mixed
$custTxn
$feeRefundAmount
払戻し手数料<br> 半角数字<br> 払い戻し手数料が格納されます。<br>
private
mixed
$feeRefundAmount
$invoiceId
請求番号<br> 半角数字<br> 請求番号が格納されます。<br>
private
mixed
$invoiceId
$marchTxn
電文ID<br>
private
mixed
$marchTxn
$merrMsg
エラーメッセージ<br> 文字列<br> 1024 バイト以内<br> エラーメッセージ<br>
private
mixed
$merrMsg
$mstatus
処理結果コード<br> 半角英数字<br> 32 文字以内<br> 取消請求処理後、応答電文に含まれる値。<br> 以下の処理結果のいずれかが格納される<br> ・success:正常終了<br> ・failure:異常終了<br> ・pending:保留状態<br>
private
mixed
$mstatus
$netRefundAmount
純返金金額<br> 半角数字<br> PayPal残高から差し引かれた金額が格納されます。<br>
private
mixed
$netRefundAmount
$orderId
取引ID<br> 半角英数字<br> 100 文字以内<br> 返金を行った取引IDが格納されます。<br> “.”(ドット)、“-”(ハイフン)、“_”(アンダースコア)も使用できます。<br>
private
mixed
$orderId
$payNowIdResponse
PayNowIDオブジェクト<br> オブジェクト<br> PayNowID用項目を格納するオブジェクト<br>
private
mixed
$payNowIdResponse
$principalAmount
元決済金額<br> 半角数字<br> 元決済金額が格納されます。<br>
private
mixed
$principalAmount
$refundAmount
返金金額<br> 半角数字<br> 返金金額が格納されます。<br>
private
mixed
$refundAmount
$resultXml
結果XML(マスク済み)<br> 半角英数字<br>
private
mixed
$resultXml
$serviceType
決済サービスタイプ<br> 半角英数字<br> 10 文字以内<br> 決済サービスの区分を指定します。<br> 必須項目、固定値<br> "paypal": PayPal決済<br>
private
mixed
$serviceType
$settlementBalance
決済残高<br> 半角数字<br> 決済残高が格納されます。<br>
private
mixed
$settlementBalance
$txnVersion
MDK バージョン<br> 半角英数字<br> 5 桁<br> 電文のバージョン番号。<br>
private
mixed
$txnVersion
$vResultCode
詳細結果コード<br> 半角英数字<br> 16 文字以内<br> 結果コード<br> 例) L001000100000000<br>
private
mixed
$vResultCode
Methods
__toString()
結果XML(マスク済み)を取得する<br>
public
__toString() : string
Return values
string —結果XML(マスク済み)
_setResultXml()
結果XML(マスク済み)を設定する<br>
public
_setResultXml(string $resultXml) : mixed
Parameters
- $resultXml : string
-
結果XML(マスク済み)
Return values
mixed —getCenterTxnId()
決済センタ取引IDを取得する<br>
public
getCenterTxnId() : string
Return values
string —決済センタ取引ID
getCustTxn()
取引毎に付くIDを取得する<br>
public
getCustTxn() : string
Return values
string —取引毎に付くID
getFeeRefundAmount()
払戻し手数料を取得する<br>
public
getFeeRefundAmount() : string
Return values
string —払戻し手数料
getInvoiceId()
請求番号を取得する<br>
public
getInvoiceId() : string
Return values
string —請求番号
getMarchTxn()
電文IDを取得する<br>
public
getMarchTxn() : string
Return values
string —電文ID
getMerrMsg()
エラーメッセージを取得する<br>
public
getMerrMsg() : string
Return values
string —エラーメッセージ
getMstatus()
処理結果コードを取得する<br>
public
getMstatus() : string
Return values
string —処理結果コード
getNetRefundAmount()
純返金金額を取得する<br>
public
getNetRefundAmount() : string
Return values
string —純返金金額
getOrderId()
取引IDを取得する<br>
public
getOrderId() : string
Return values
string —取引ID
getPayNowIdResponse()
PayNowIDオブジェクトを取得する<br>
public
getPayNowIdResponse() : PayNowIdResponse
Return values
PayNowIdResponse —PayNowIDオブジェクト
getPrincipalAmount()
元決済金額を取得する<br>
public
getPrincipalAmount() : string
Return values
string —元決済金額
getRefundAmount()
返金金額を取得する<br>
public
getRefundAmount() : string
Return values
string —返金金額
getServiceType()
決済サービスタイプを取得する<br>
public
getServiceType() : string
Return values
string —決済サービスタイプ
getSettlementBalance()
決済残高を取得する<br>
public
getSettlementBalance() : string
Return values
string —決済残高
getTxnVersion()
MDK バージョンを取得する<br>
public
getTxnVersion() : string
Return values
string —MDK バージョン
getVResultCode()
詳細結果コードを取得する<br>
public
getVResultCode() : string
Return values
string —詳細結果コード
setCenterTxnId()
決済センタ取引IDを設定する<br>
public
setCenterTxnId(string $centerTxnId) : mixed
Parameters
- $centerTxnId : string
-
決済センタ取引ID
Return values
mixed —setCustTxn()
取引毎に付くIDを設定する<br>
public
setCustTxn(string $custTxn) : mixed
Parameters
- $custTxn : string
-
取引毎に付くID
Return values
mixed —setFeeRefundAmount()
払戻し手数料を設定する<br>
public
setFeeRefundAmount(string $feeRefundAmount) : mixed
Parameters
- $feeRefundAmount : string
-
払戻し手数料
Return values
mixed —setInvoiceId()
請求番号を設定する<br>
public
setInvoiceId(string $invoiceId) : mixed
Parameters
- $invoiceId : string
-
請求番号
Return values
mixed —setMarchTxn()
電文IDを設定する<br>
public
setMarchTxn(string $marchTxn) : mixed
Parameters
- $marchTxn : string
-
電文ID
Return values
mixed —setMerrMsg()
エラーメッセージを設定する<br>
public
setMerrMsg(string $merrMsg) : mixed
Parameters
- $merrMsg : string
-
エラーメッセージ
Return values
mixed —setMstatus()
処理結果コードを設定する<br>
public
setMstatus(string $mstatus) : mixed
Parameters
- $mstatus : string
-
処理結果コード
Return values
mixed —setNetRefundAmount()
純返金金額を設定する<br>
public
setNetRefundAmount(string $netRefundAmount) : mixed
Parameters
- $netRefundAmount : string
-
純返金金額
Return values
mixed —setOrderId()
取引IDを設定する<br>
public
setOrderId(string $orderId) : mixed
Parameters
- $orderId : string
-
取引ID
Return values
mixed —setPayNowIdResponse()
PayNowIDオブジェクトを設定する<br>
public
setPayNowIdResponse(PayNowIdResponse $payNowIdResponse) : mixed
Parameters
- $payNowIdResponse : PayNowIdResponse
-
PayNowIDオブジェクト
Return values
mixed —setPrincipalAmount()
元決済金額を設定する<br>
public
setPrincipalAmount(string $principalAmount) : mixed
Parameters
- $principalAmount : string
-
元決済金額
Return values
mixed —setRefundAmount()
返金金額を設定する<br>
public
setRefundAmount(string $refundAmount) : mixed
Parameters
- $refundAmount : string
-
返金金額
Return values
mixed —setServiceType()
決済サービスタイプを設定する<br>
public
setServiceType(string $serviceType) : mixed
Parameters
- $serviceType : string
-
決済サービスタイプ
Return values
mixed —setSettlementBalance()
決済残高を設定する<br>
public
setSettlementBalance(string $settlementBalance) : mixed
Parameters
- $settlementBalance : string
-
決済残高
Return values
mixed —setTxnVersion()
MDK バージョンを設定する<br>
public
setTxnVersion(string $txnVersion) : mixed
Parameters
- $txnVersion : string
-
MDK バージョン
Return values
mixed —setVResultCode()
詳細結果コードを設定する<br>
public
setVResultCode(string $vResultCode) : mixed
Parameters
- $vResultCode : string
-
詳細結果コード