PaypalCaptureRequestDto
extends AbstractPaymentRequestDto
in package
決済サービスタイプ:Paypal、コマンド名:売上の要求Dtoクラス
Tags
Table of Contents
- $payNowIdParam : PayNowIdParam
- PayNowIDオブジェクト
- $action : mixed
- アクションタイプ<br> 半角英数字<br> 10 文字以内<br> set: 売上請求処理<br> get: 売上請求確認処理<br> do : 売上請求完了処理<br> capture : 売上請求完了処理<br> ※"capture"は 与信を行った場合にのみ、実行可能<br>
- $amount : mixed
- 取引金額<br> 半角数字<br> 日本円を設定します。<br> ただし、$10,000 USD を上限とした金額を設定します。<br>
- $cancelUrl : mixed
- 取消URL<br> 半角英数字<br> 1024文字以内<br> 消費者がPayPal上で支払いをキャンセルした場合に遷移するマーチャントのURLを設定します。<br> 半角英数字のほかに、URLとして使用できる文字を使用できます。("."など)<br>
- $headerImageUrl : mixed
- ヘッダーイメージURL<br> 半角英数字<br> 127文字以内<br> PayPal画面のヘッダーに表示する画像のURLを設定します。<br> 半角英数字のほかに、URLとして使用できる文字を使用できます。("."など)<br>
- $maskedLog : mixed
- ログ用文字列(マスク済み)<br> 半角英数字<br>
- $optionParams : mixed
- 拡張パラメータ<br> 並列処理用の拡張パラメータを保持する。
- $orderDescription : mixed
- オーダー説明<br> 文字列<br> 127Byte以内<br> 商品の説明を設定します。<br> ※文字コードは"UTF-8"とします。<br>
- $orderId : mixed
- 取引ID<br> 半角英数字<br> 100 文字以内<br> 決済請求、予授権完了時に採番した取引IDを指定指定します。<br> “.”(ドット)、“-”(ハイフン)、“_”(アンダースコア)も使用できます。<br>
- $payerId : mixed
- 顧客番号<br> 半角英数字<br> 13文字以内<br> 顧客番号を設定します。<br> PayPalから処理が戻ってきたとき、URL(戻り先URL)に付加されています。<br>
- $returnUrl : mixed
- 戻り先URL<br> 半角英数字<br> 1024文字以内<br> 消費者がPayPal上での操作が完了したときの遷移するマーチャントのURLを設定します。<br> 半角英数字のほかに、URLとして使用できる文字を使用できます。("."など)<br>
- $SERVICE_COMMAND : mixed
- 決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
- $SERVICE_TYPE : mixed
- 決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
- $shipCity : mixed
- 配送先市区町村名<br> 文字列<br> 40Byte以内<br> 配送先市区町村名を設定します。<br> ※文字コードは"UTF-8"とします。<br> 配送先フラグに"1"を設定した場合は必須。<br>
- $shipCountry : mixed
- 配送先国コード<br> 半角英数字<br> 2文字以内<br> 配送先コードを設定します。<br>
- $shipName : mixed
- 配送先氏名<br> 文字列<br> 32Byte以内<br> 配送先氏名を設定します。<br> ※文字コードは"UTF-8"とします。<br> 配送先フラグに"1"を設定した場合は必須。<br>
- $shipPhone : mixed
- 配送先電話番号<br> 半角英数字<br> 20文字以内<br> 配送先電話番号を設定します。<br> 全角文字を除く文字列を設定します。<br>
- $shippingFlag : mixed
- 配送先フラグ<br> 半角英数字<br> 1文字以内<br> 配送先情報を有効とするかを設定します。<br> "0": 配送先の設定を無効にする。<br> "1": 配送先の設定を有効にする。<br>
- $shipPostalCode : mixed
- 配送先郵便番号<br> 半角英数字<br> 20文字以内<br> 配送先郵便番号を設定します。<br> 全角文字を除く文字列を設定します。<br> 配送先フラグに"1"を設定した場合は必須。<br>
- $shipState : mixed
- 配送先州名<br> 文字列<br> 40Byte以内<br> 配送先州名を設定します。<br> ※文字コードは"UTF-8"とします。<br>
- $shipStreet1 : mixed
- 配送先住所1<br> 文字列<br> 100Byte以内<br> 配送先住所1を設定します。<br> ※文字コードは"UTF-8"とします。<br> 配送先フラグに"1"を設定した場合は必須。<br>
- $shipStreet2 : mixed
- 配送先住所2<br> 文字列<br> 100Byte以内<br> 配送先住所2を設定します。<br> ※文字コードは"UTF-8"とします。<br>
- $token : mixed
- トークン<br> 半角英数字<br> 20文字以内<br> トークンを設定します。<br>
- __toString() : string
- ログ用文字列(マスク済み)を取得する<br>
- _setMaskedLog() : mixed
- ログ用文字列(マスク済み)を設定する<br>
- getAccountId() : string
- 会員IDを取得する。<br>
- getAction() : string
- アクションタイプを取得する<br>
- getAmount() : string
- 取引金額を取得する<br>
- getCancelUrl() : string
- 取消URLを取得する<br>
- getCreateDate() : string
- 入会年月日を取得する<br>
- getFreeKey() : string
- キー情報を取得する<br>
- getHeaderImageUrl() : string
- ヘッダーイメージURLを取得する<br>
- getMemo1() : string
- 取引メモ1を取得する<br>
- getMemo2() : string
- 取引メモ2を取得する<br>
- getMemo3() : string
- 取引メモ3を取得する<br>
- getOptionParams() : OptionParams
- 拡張パラメータリストを取得する<br>
- getOrderDescription() : string
- オーダー説明を取得する<br>
- getOrderId() : string
- 取引IDを取得する<br>
- getPayerId() : string
- 顧客番号を取得する<br>
- getReceiptData() : string
- レシートデータを取得する。<br>
- getReturnUrl() : string
- 戻り先URLを取得する<br>
- getServiceCommand() : string
- 決済サービスコマンドを取得する<br>
- getServiceType() : string
- 決済サービスタイプを取得する<br>
- getShipCity() : string
- 配送先市区町村名を取得する<br>
- getShipCountry() : string
- 配送先国コードを取得する<br>
- getShipName() : string
- 配送先氏名を取得する<br>
- getShipPhone() : string
- 配送先電話番号を取得する<br>
- getShippingFlag() : string
- 配送先フラグを取得する<br>
- getShipPostalCode() : string
- 配送先郵便番号を取得する<br>
- getShipState() : string
- 配送先州名を取得する<br>
- getShipStreet1() : string
- 配送先住所1を取得する<br>
- getShipStreet2() : string
- 配送先住所2を取得する<br>
- getToken() : string
- トークンを取得する<br>
- setAccountId() : mixed
- 会員IDを設定する。<br>
- setAction() : mixed
- アクションタイプを設定する<br>
- setAmount() : mixed
- 取引金額を設定する<br>
- setCancelUrl() : mixed
- 取消URLを設定する<br>
- setCreateDate() : mixed
- 入会年月日を設定する<br>
- setFreeKey() : mixed
- キー情報を設定する<br>
- setHeaderImageUrl() : mixed
- ヘッダーイメージURLを設定する<br>
- setMemo1() : mixed
- 取引メモ1を設定する<br>
- setMemo2() : mixed
- 取引メモ2を設定する<br>
- setMemo3() : mixed
- 取引メモ3を設定する<br>
- setOptionParams() : mixed
- 拡張パラメータリストを設定する<br>
- setOrderDescription() : mixed
- オーダー説明を設定する<br>
- setOrderId() : mixed
- 取引IDを設定する<br>
- setPayerId() : mixed
- 顧客番号を設定する<br>
- setReceiptData() : mixed
- レシートデータを設定する。<br>
- setReturnUrl() : mixed
- 戻り先URLを設定する<br>
- setShipCity() : mixed
- 配送先市区町村名を設定する<br>
- setShipCountry() : mixed
- 配送先国コードを設定する<br>
- setShipName() : mixed
- 配送先氏名を設定する<br>
- setShipPhone() : mixed
- 配送先電話番号を設定する<br>
- setShippingFlag() : mixed
- 配送先フラグを設定する<br>
- setShipPostalCode() : mixed
- 配送先郵便番号を設定する<br>
- setShipState() : mixed
- 配送先州名を設定する<br>
- setShipStreet1() : mixed
- 配送先住所1を設定する<br>
- setShipStreet2() : mixed
- 配送先住所2を設定する<br>
- setToken() : 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
PayNowIDオブジェクト
protected
PayNowIdParam
$payNowIdParam
$action
アクションタイプ<br> 半角英数字<br> 10 文字以内<br> set: 売上請求処理<br> get: 売上請求確認処理<br> do : 売上請求完了処理<br> capture : 売上請求完了処理<br> ※"capture"は 与信を行った場合にのみ、実行可能<br>
private
mixed
$action
$amount
取引金額<br> 半角数字<br> 日本円を設定します。<br> ただし、$10,000 USD を上限とした金額を設定します。<br>
private
mixed
$amount
$cancelUrl
取消URL<br> 半角英数字<br> 1024文字以内<br> 消費者がPayPal上で支払いをキャンセルした場合に遷移するマーチャントのURLを設定します。<br> 半角英数字のほかに、URLとして使用できる文字を使用できます。("."など)<br>
private
mixed
$cancelUrl
$headerImageUrl
ヘッダーイメージURL<br> 半角英数字<br> 127文字以内<br> PayPal画面のヘッダーに表示する画像のURLを設定します。<br> 半角英数字のほかに、URLとして使用できる文字を使用できます。("."など)<br>
private
mixed
$headerImageUrl
$maskedLog
ログ用文字列(マスク済み)<br> 半角英数字<br>
private
mixed
$maskedLog
$optionParams
拡張パラメータ<br> 並列処理用の拡張パラメータを保持する。
private
mixed
$optionParams
$orderDescription
オーダー説明<br> 文字列<br> 127Byte以内<br> 商品の説明を設定します。<br> ※文字コードは"UTF-8"とします。<br>
private
mixed
$orderDescription
$orderId
取引ID<br> 半角英数字<br> 100 文字以内<br> 決済請求、予授権完了時に採番した取引IDを指定指定します。<br> “.”(ドット)、“-”(ハイフン)、“_”(アンダースコア)も使用できます。<br>
private
mixed
$orderId
$payerId
顧客番号<br> 半角英数字<br> 13文字以内<br> 顧客番号を設定します。<br> PayPalから処理が戻ってきたとき、URL(戻り先URL)に付加されています。<br>
private
mixed
$payerId
$returnUrl
戻り先URL<br> 半角英数字<br> 1024文字以内<br> 消費者がPayPal上での操作が完了したときの遷移するマーチャントのURLを設定します。<br> 半角英数字のほかに、URLとして使用できる文字を使用できます。("."など)<br>
private
mixed
$returnUrl
$SERVICE_COMMAND
決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_COMMAND
= "Capture"
$SERVICE_TYPE
決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_TYPE
= "paypal"
$shipCity
配送先市区町村名<br> 文字列<br> 40Byte以内<br> 配送先市区町村名を設定します。<br> ※文字コードは"UTF-8"とします。<br> 配送先フラグに"1"を設定した場合は必須。<br>
private
mixed
$shipCity
$shipCountry
配送先国コード<br> 半角英数字<br> 2文字以内<br> 配送先コードを設定します。<br>
private
mixed
$shipCountry
$shipName
配送先氏名<br> 文字列<br> 32Byte以内<br> 配送先氏名を設定します。<br> ※文字コードは"UTF-8"とします。<br> 配送先フラグに"1"を設定した場合は必須。<br>
private
mixed
$shipName
$shipPhone
配送先電話番号<br> 半角英数字<br> 20文字以内<br> 配送先電話番号を設定します。<br> 全角文字を除く文字列を設定します。<br>
private
mixed
$shipPhone
$shippingFlag
配送先フラグ<br> 半角英数字<br> 1文字以内<br> 配送先情報を有効とするかを設定します。<br> "0": 配送先の設定を無効にする。<br> "1": 配送先の設定を有効にする。<br>
private
mixed
$shippingFlag
$shipPostalCode
配送先郵便番号<br> 半角英数字<br> 20文字以内<br> 配送先郵便番号を設定します。<br> 全角文字を除く文字列を設定します。<br> 配送先フラグに"1"を設定した場合は必須。<br>
private
mixed
$shipPostalCode
$shipState
配送先州名<br> 文字列<br> 40Byte以内<br> 配送先州名を設定します。<br> ※文字コードは"UTF-8"とします。<br>
private
mixed
$shipState
$shipStreet1
配送先住所1<br> 文字列<br> 100Byte以内<br> 配送先住所1を設定します。<br> ※文字コードは"UTF-8"とします。<br> 配送先フラグに"1"を設定した場合は必須。<br>
private
mixed
$shipStreet1
$shipStreet2
配送先住所2<br> 文字列<br> 100Byte以内<br> 配送先住所2を設定します。<br> ※文字コードは"UTF-8"とします。<br>
private
mixed
$shipStreet2
$token
トークン<br> 半角英数字<br> 20文字以内<br> トークンを設定します。<br>
private
mixed
$token
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
getAction()
アクションタイプを取得する<br>
public
getAction() : string
Return values
string —アクションタイプ
getAmount()
取引金額を取得する<br>
public
getAmount() : string
Return values
string —取引金額
getCancelUrl()
取消URLを取得する<br>
public
getCancelUrl() : string
Return values
string —取消URL
getCreateDate()
入会年月日を取得する<br>
public
getCreateDate() : string
Return values
string —入会年月日
getFreeKey()
キー情報を取得する<br>
public
getFreeKey() : string
Return values
string —キー情報
getHeaderImageUrl()
ヘッダーイメージURLを取得する<br>
public
getHeaderImageUrl() : string
Return values
string —ヘッダーイメージURL
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を設定する
getOptionParams()
拡張パラメータリストを取得する<br>
public
getOptionParams() : OptionParams
Return values
OptionParams —拡張パラメータリスト
getOrderDescription()
オーダー説明を取得する<br>
public
getOrderDescription() : string
Return values
string —オーダー説明
getOrderId()
取引IDを取得する<br>
public
getOrderId() : string
Return values
string —取引ID
getPayerId()
顧客番号を取得する<br>
public
getPayerId() : string
Return values
string —顧客番号
getReceiptData()
レシートデータを取得する。<br>
public
getReceiptData() : string
Return values
string —レシートデータ
getReturnUrl()
戻り先URLを取得する<br>
public
getReturnUrl() : string
Return values
string —戻り先URL
getServiceCommand()
決済サービスコマンドを取得する<br>
public
getServiceCommand() : string
Return values
string —決済サービスコマンド
getServiceType()
決済サービスタイプを取得する<br>
public
getServiceType() : string
Return values
string —決済サービスタイプ
getShipCity()
配送先市区町村名を取得する<br>
public
getShipCity() : string
Return values
string —配送先市区町村名
getShipCountry()
配送先国コードを取得する<br>
public
getShipCountry() : string
Return values
string —配送先国コード
getShipName()
配送先氏名を取得する<br>
public
getShipName() : string
Return values
string —配送先氏名
getShipPhone()
配送先電話番号を取得する<br>
public
getShipPhone() : string
Return values
string —配送先電話番号
getShippingFlag()
配送先フラグを取得する<br>
public
getShippingFlag() : string
Return values
string —配送先フラグ
getShipPostalCode()
配送先郵便番号を取得する<br>
public
getShipPostalCode() : string
Return values
string —配送先郵便番号
getShipState()
配送先州名を取得する<br>
public
getShipState() : string
Return values
string —配送先州名
getShipStreet1()
配送先住所1を取得する<br>
public
getShipStreet1() : string
Return values
string —配送先住所1
getShipStreet2()
配送先住所2を取得する<br>
public
getShipStreet2() : string
Return values
string —配送先住所2
getToken()
トークンを取得する<br>
public
getToken() : string
Return values
string —トークン
setAccountId()
会員IDを設定する。<br>
public
setAccountId(string $accountId) : mixed
Parameters
- $accountId : string
-
会員ID
Return values
mixed —setAction()
アクションタイプを設定する<br>
public
setAction(string $action) : mixed
Parameters
- $action : string
-
アクションタイプ
Return values
mixed —setAmount()
取引金額を設定する<br>
public
setAmount(string $amount) : mixed
Parameters
- $amount : string
-
取引金額
Return values
mixed —setCancelUrl()
取消URLを設定する<br>
public
setCancelUrl(string $cancelUrl) : mixed
Parameters
- $cancelUrl : string
-
取消URL
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 —setHeaderImageUrl()
ヘッダーイメージURLを設定する<br>
public
setHeaderImageUrl(string $headerImageUrl) : mixed
Parameters
- $headerImageUrl : string
-
ヘッダーイメージURL
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 —setOptionParams()
拡張パラメータリストを設定する<br>
public
setOptionParams(OptionParams $optionParams) : mixed
Parameters
- $optionParams : OptionParams
-
拡張パラメータリスト
Return values
mixed —setOrderDescription()
オーダー説明を設定する<br>
public
setOrderDescription(string $orderDescription) : mixed
Parameters
- $orderDescription : string
-
オーダー説明
Return values
mixed —setOrderId()
取引IDを設定する<br>
public
setOrderId(string $orderId) : mixed
Parameters
- $orderId : string
-
取引ID
Return values
mixed —setPayerId()
顧客番号を設定する<br>
public
setPayerId(string $payerId) : mixed
Parameters
- $payerId : string
-
顧客番号
Return values
mixed —setReceiptData()
レシートデータを設定する。<br>
public
setReceiptData(string $receiptData) : mixed
Parameters
- $receiptData : string
-
レシートデータ
Return values
mixed —setReturnUrl()
戻り先URLを設定する<br>
public
setReturnUrl(string $returnUrl) : mixed
Parameters
- $returnUrl : string
-
戻り先URL
Return values
mixed —setShipCity()
配送先市区町村名を設定する<br>
public
setShipCity(string $shipCity) : mixed
Parameters
- $shipCity : string
-
配送先市区町村名
Return values
mixed —setShipCountry()
配送先国コードを設定する<br>
public
setShipCountry(string $shipCountry) : mixed
Parameters
- $shipCountry : string
-
配送先国コード
Return values
mixed —setShipName()
配送先氏名を設定する<br>
public
setShipName(string $shipName) : mixed
Parameters
- $shipName : string
-
配送先氏名
Return values
mixed —setShipPhone()
配送先電話番号を設定する<br>
public
setShipPhone(string $shipPhone) : mixed
Parameters
- $shipPhone : string
-
配送先電話番号
Return values
mixed —setShippingFlag()
配送先フラグを設定する<br>
public
setShippingFlag(string $shippingFlag) : mixed
Parameters
- $shippingFlag : string
-
配送先フラグ
Return values
mixed —setShipPostalCode()
配送先郵便番号を設定する<br>
public
setShipPostalCode(string $shipPostalCode) : mixed
Parameters
- $shipPostalCode : string
-
配送先郵便番号
Return values
mixed —setShipState()
配送先州名を設定する<br>
public
setShipState(string $shipState) : mixed
Parameters
- $shipState : string
-
配送先州名
Return values
mixed —setShipStreet1()
配送先住所1を設定する<br>
public
setShipStreet1(string $shipStreet1) : mixed
Parameters
- $shipStreet1 : string
-
配送先住所1
Return values
mixed —setShipStreet2()
配送先住所2を設定する<br>
public
setShipStreet2(string $shipStreet2) : mixed
Parameters
- $shipStreet2 : string
-
配送先住所2
Return values
mixed —setToken()
トークンを設定する<br>
public
setToken(string $token) : mixed
Parameters
- $token : string
-
トークン
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