PaypayRefundRequestDto
extends AbstractPaymentRequestDto
in package
決済サービスタイプ:paypay、コマンド名:返金の要求Dtoクラス<br>
Tags
Table of Contents
- $payNowIdParam : PayNowIdParam
- PayNowIDオブジェクト
- $amount : mixed
- 返金金額<br> 半角数字<br/> 最大桁数:7<br/> 返金する金額を指定します。<br/> 例)250円*4個=1000円の買い物をし1個返品した場合には、返金金額に250円を指定します。<br/> - 1 以上かつ 9999999 以下<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定できません<br/> serviceOptionType="online"(オンライン決済) : 指定任意<br/> ※オンライン決済で指定しなかった場合は、全額返金になります。<br/>
- $maskedLog : mixed
- ログ用文字列(マスク済み)<br> 半角英数字<br>
- $orderId : mixed
- 取引ID<br> 半角英数字<br/> 最大桁数:100<br/> 返金対象の取引IDを指定する。<br/>
- $receiptNumber : mixed
- レシート番号<br> 半角英数字<br/> 最大桁数:128<br/> レシートに印字される番号を指定します。<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定任意<br/> serviceOptionType="online"(オンライン決済) : 指定できません<br/>
- $SERVICE_COMMAND : mixed
- 決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
- $SERVICE_TYPE : mixed
- 決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
- $serviceOptionType : mixed
- サービスオプションタイプ<br> 半角英数字<br/> - "barcode":バーコード決済<br/> - "online":オンライン決済<br/>
- $settleBizCode : mixed
- 決済事業者コード<br> 半角数字<br/> 最大桁数:5<br/> 決済事業者コードを指定します。<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定任意<br/> serviceOptionType="online"(オンライン決済) : 指定できません<br/>
- $storeId : mixed
- 店舗ID<br> 半角英数字<br/> 最大桁数:128<br/> 店舗IDを指定します。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定任意<br/> serviceOptionType="online"(オンライン決済) : 指定できません<br/>
- $terminalId : mixed
- 店舗端末ID<br> 半角英数字<br/> 最大桁数:128<br/> 店舗端末IDを指定します。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定任意<br/> serviceOptionType="online"(オンライン決済) : 指定できません<br/>
- __toString() : string
- ログ用文字列(マスク済み)を取得する<br>
- _setMaskedLog() : mixed
- ログ用文字列(マスク済み)を設定する<br>
- getAccountId() : string
- 会員IDを取得する。<br>
- getAmount() : string
- 返金金額を取得する<br>
- getCreateDate() : string
- 入会年月日を取得する<br>
- getFreeKey() : string
- キー情報を取得する<br>
- getMemo1() : string
- 取引メモ1を取得する<br>
- getMemo2() : string
- 取引メモ2を取得する<br>
- getMemo3() : string
- 取引メモ3を取得する<br>
- getOrderId() : string
- 取引IDを取得する<br>
- getReceiptData() : string
- レシートデータを取得する。<br>
- getReceiptNumber() : string
- レシート番号を取得する<br>
- getServiceCommand() : string
- 決済サービスコマンドを取得する<br>
- getServiceOptionType() : string
- サービスオプションタイプを取得する<br>
- getServiceType() : string
- 決済サービスタイプを取得する<br>
- getSettleBizCode() : string
- 決済事業者コードを取得する<br>
- getStoreId() : string
- 店舗IDを取得する<br>
- getTerminalId() : string
- 店舗端末IDを取得する<br>
- setAccountId() : mixed
- 会員IDを設定する。<br>
- setAmount() : mixed
- 返金金額を設定する<br>
- setCreateDate() : mixed
- 入会年月日を設定する<br>
- setFreeKey() : mixed
- キー情報を設定する<br>
- setMemo1() : mixed
- 取引メモ1を設定する<br>
- setMemo2() : mixed
- 取引メモ2を設定する<br>
- setMemo3() : mixed
- 取引メモ3を設定する<br>
- setOrderId() : mixed
- 取引IDを設定する<br>
- setReceiptData() : mixed
- レシートデータを設定する。<br>
- setReceiptNumber() : mixed
- レシート番号を設定する<br>
- setServiceOptionType() : mixed
- サービスオプションタイプを設定する<br>
- setSettleBizCode() : 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
PayNowIDオブジェクト
protected
PayNowIdParam
$payNowIdParam
$amount
返金金額<br> 半角数字<br/> 最大桁数:7<br/> 返金する金額を指定します。<br/> 例)250円*4個=1000円の買い物をし1個返品した場合には、返金金額に250円を指定します。<br/> - 1 以上かつ 9999999 以下<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定できません<br/> serviceOptionType="online"(オンライン決済) : 指定任意<br/> ※オンライン決済で指定しなかった場合は、全額返金になります。<br/>
private
mixed
$amount
$maskedLog
ログ用文字列(マスク済み)<br> 半角英数字<br>
private
mixed
$maskedLog
$orderId
取引ID<br> 半角英数字<br/> 最大桁数:100<br/> 返金対象の取引IDを指定する。<br/>
private
mixed
$orderId
$receiptNumber
レシート番号<br> 半角英数字<br/> 最大桁数:128<br/> レシートに印字される番号を指定します。<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定任意<br/> serviceOptionType="online"(オンライン決済) : 指定できません<br/>
private
mixed
$receiptNumber
$SERVICE_COMMAND
決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_COMMAND
= "Refund"
$SERVICE_TYPE
決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_TYPE
= "paypay"
$serviceOptionType
サービスオプションタイプ<br> 半角英数字<br/> - "barcode":バーコード決済<br/> - "online":オンライン決済<br/>
private
mixed
$serviceOptionType
$settleBizCode
決済事業者コード<br> 半角数字<br/> 最大桁数:5<br/> 決済事業者コードを指定します。<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定任意<br/> serviceOptionType="online"(オンライン決済) : 指定できません<br/>
private
mixed
$settleBizCode
$storeId
店舗ID<br> 半角英数字<br/> 最大桁数:128<br/> 店舗IDを指定します。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定任意<br/> serviceOptionType="online"(オンライン決済) : 指定できません<br/>
private
mixed
$storeId
$terminalId
店舗端末ID<br> 半角英数字<br/> 最大桁数:128<br/> 店舗端末IDを指定します。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/> <br/> serviceOptionType="barcode"(バーコード決済) : 指定任意<br/> serviceOptionType="online"(オンライン決済) : 指定できません<br/>
private
mixed
$terminalId
Methods
__toString()
ログ用文字列(マスク済み)を取得する<br>
public
__toString() : string
Return values
string —ログ用文字列(マスク済み)
_setMaskedLog()
ログ用文字列(マスク済み)を設定する<br>
public
_setMaskedLog(string $maskedLog) : mixed
Parameters
- $maskedLog : string
-
ログ用文字列(マスク済み)
Return values
mixed —getAccountId()
会員IDを取得する。<br>
public
getAccountId() : string
Return values
string —会員ID
getAmount()
返金金額を取得する<br>
public
getAmount() : string
Return values
string —返金金額
getCreateDate()
入会年月日を取得する<br>
public
getCreateDate() : string
Return values
string —入会年月日
getFreeKey()
キー情報を取得する<br>
public
getFreeKey() : string
Return values
string —キー情報
getMemo1()
取引メモ1を取得する<br>
public
getMemo1() : string
Return values
string —取引メモ1
getMemo2()
取引メモ2を取得する<br>
public
getMemo2() : string
Return values
string —取引メモ2
getMemo3()
取引メモ3を取得する<br>
public
getMemo3() : string
Return values
string —取引メモ3を設定する
getOrderId()
取引IDを取得する<br>
public
getOrderId() : string
Return values
string —取引ID
getReceiptData()
レシートデータを取得する。<br>
public
getReceiptData() : string
Return values
string —レシートデータ
getReceiptNumber()
レシート番号を取得する<br>
public
getReceiptNumber() : string
Return values
string —レシート番号
getServiceCommand()
決済サービスコマンドを取得する<br>
public
getServiceCommand() : string
Return values
string —決済サービスコマンド
getServiceOptionType()
サービスオプションタイプを取得する<br>
public
getServiceOptionType() : string
Return values
string —サービスオプションタイプ
getServiceType()
決済サービスタイプを取得する<br>
public
getServiceType() : string
Return values
string —決済サービスタイプ
getSettleBizCode()
決済事業者コードを取得する<br>
public
getSettleBizCode() : string
Return values
string —決済事業者コード
getStoreId()
店舗IDを取得する<br>
public
getStoreId() : string
Return values
string —店舗ID
getTerminalId()
店舗端末IDを取得する<br>
public
getTerminalId() : string
Return values
string —店舗端末ID
setAccountId()
会員IDを設定する。<br>
public
setAccountId(string $accountId) : mixed
Parameters
- $accountId : string
-
会員ID
Return values
mixed —setAmount()
返金金額を設定する<br>
public
setAmount(string $amount) : mixed
Parameters
- $amount : string
-
返金金額
Return values
mixed —setCreateDate()
入会年月日を設定する<br>
public
setCreateDate(string $createDate) : mixed
Parameters
- $createDate : string
-
入会年月日
Return values
mixed —setFreeKey()
キー情報を設定する<br>
public
setFreeKey(string $freeKey) : mixed
Parameters
- $freeKey : string
-
キー情報
Return values
mixed —setMemo1()
取引メモ1を設定する<br>
public
setMemo1(string $memo1) : mixed
Parameters
- $memo1 : string
-
取引メモ1
Return values
mixed —setMemo2()
取引メモ2を設定する<br>
public
setMemo2(string $memo2) : mixed
Parameters
- $memo2 : string
-
取引メモ2
Return values
mixed —setMemo3()
取引メモ3を設定する<br>
public
setMemo3(string $memo3) : mixed
Parameters
- $memo3 : string
-
取引メモ3
Return values
mixed —setOrderId()
取引IDを設定する<br>
public
setOrderId(string $orderId) : mixed
Parameters
- $orderId : string
-
取引ID
Return values
mixed —setReceiptData()
レシートデータを設定する。<br>
public
setReceiptData(string $receiptData) : mixed
Parameters
- $receiptData : string
-
レシートデータ
Return values
mixed —setReceiptNumber()
レシート番号を設定する<br>
public
setReceiptNumber(string $receiptNumber) : mixed
Parameters
- $receiptNumber : string
-
レシート番号
Return values
mixed —setServiceOptionType()
サービスオプションタイプを設定する<br>
public
setServiceOptionType(string $serviceOptionType) : mixed
Parameters
- $serviceOptionType : string
-
サービスオプションタイプ
Return values
mixed —setSettleBizCode()
決済事業者コードを設定する<br>
public
setSettleBizCode(string $settleBizCode) : mixed
Parameters
- $settleBizCode : string
-
決済事業者コード
Return values
mixed —setStoreId()
店舗IDを設定する<br>
public
setStoreId(string $storeId) : mixed
Parameters
- $storeId : string
-
店舗ID
Return values
mixed —setTerminalId()
店舗端末IDを設定する<br>
public
setTerminalId(string $terminalId) : mixed
Parameters
- $terminalId : string
-
店舗端末ID
Return values
mixed —existAccountBasicParam()
AccountBasicParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
protected
existAccountBasicParam() : mixed
Return values
mixed —existAccountParam()
AccountParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
protected
existAccountParam() : mixed
Return values
mixed —existBankAccountParam()
BankAccountParamがAccountParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、AccountParamに設定する。<br>
protected
existBankAccountParam() : mixed
Return values
mixed —existCardParam()
CardParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
protected
existCardParam() : mixed
Return values
mixed —existPayNowIdParam()
PayNowIdPramが設定されているか判定する。<br> 設定されていない場合はインスタンスを生成する。<br>
protected
existPayNowIdParam() : mixed
Return values
mixed —existRecurringChargeParam()
RecurringChargeParamがPayNowIdParamに設定されているか判定する。<br> 設定されていない場合はインスタンスを生成し、PayNowIdParamに設定する。<br>
protected
existRecurringChargeParam() : mixed