AlipayxAuthorizeRequestDto
extends AbstractPaymentRequestDto
in package
決済サービスタイプ:alipayx、コマンド名:決済申込の要求Dtoクラス<br>
Tags
Table of Contents
- $payNowIdParam : PayNowIdParam
- PayNowIDオブジェクト
- $amount : mixed
- 決済金額<br> 半角数字<br/> 最大桁数:12<br/> 決済金額を指定します。<br/> - 1 以上かつ 999999999999(12桁) 以下<br/>
- $identityCode : mixed
- 識別コード<br> 半角英数字<br/> 最大桁数:64<br/> 識別コードを指定します。<br/> ※serviceOptionType="barcode":指定必須<br/> 上記以外、指定不可。<br/>
- $maskedLog : mixed
- ログ用文字列(マスク済み)<br> 半角英数字<br>
- $operatorId : mixed
- 従業員ID<br> 半角英数字<br/> 最大桁数:64<br/> 従業員IDを指定します。<br/> ※半角英数字、"-"(ハイフン)、 "_"(アンダースコア)も使用可能です。<br/>
- $orderDetail : mixed
- 商品詳細<br> 文字列<br/> 最大桁数:400<br/> 識別コードを指定します。<br/> - 最大文字数:400byte<br/>
- $orderId : mixed
- 取引ID<br> 半角英数字<br/> 最大桁数:100<br/> - マーチャント側で取引を一意に表す注文管理IDを指定します。<br/> - 申込処理ごとに一意である必要があります。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/>
- $orderTitle : mixed
- 商品名<br> 文字列<br/> 最大桁数:256<br/> 商品名を指定します。<br/> - 最大文字数:256byte<br/>
- $responseType : mixed
- レスポンスタイプ<br> 半角数字<br/> 最大桁数:1<br/> レスポンスのタイプを指定します。<br/> "0":取引確定時にレスポンスを返却する。<br/> "1":即時にレスポンスを返却する。(取引確定については、Confirmコマンドを利用する)<br/> <br/> serviceOptionType="barcode":指定任意<br/> 上記以外、指定不可。<br/> ※未指定の場合は、0:取引確定時にレスポンスを返却する。<br/>
- $scancodeType : mixed
- スキャンコードタイプ<br> 半角数字<br/> 最大桁数:1<br/> シーンのタイプを指定します。<br/> "0":サービスプロバイダー発行QR利用。<br/> "1":加盟店発行QR利用。<br/> <br/> serviceOptionType="scancode":指定任意<br/> 上記以外、指定不可。<br/> ※未指定の場合は、0:サービスプロバイダー発行QR利用。<br/>
- $SERVICE_COMMAND : mixed
- 決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
- $SERVICE_TYPE : mixed
- 決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
- $serviceOptionType : mixed
- サービスオプションタイプ<br> 半角英数字<br/> - "barcode":バーコード決済<br/> - "scancode":スキャンコード決済<br/>
- $storeId : mixed
- 店舗ID<br> 半角英数字<br/> 最大桁数:32<br/> 店舗IDを指定します。<br/> ※半角英数字、"-"(ハイフン)、 "_"(アンダースコア)も使用可能です。<br/>
- $storeName : mixed
- 店舗名<br> 文字列<br/> 最大桁数:128<br/> 店舗名を指定します。<br/> - 最大文字数:128byte<br/>
- $successRedirectUrl : mixed
- 決済成功時リダイレクトURL<br> 文字列<br/> 最大桁数:512<br/> 決済成功時にリダイレクトするURLを指定します。<br/> serviceOptionType="scancode"、かつ、scancodeType="1"の場合、指定任意<br/> 上記以外、指定不可。<br/>
- $terminalId : mixed
- 端末ID<br> 半角英数字<br/> 最大桁数:64<br/> 端末IDを指定します。<br/> ※半角英数字、"-"(ハイフン)、 "_"(アンダースコア)も使用可能です。<br/>
- $userAgent : mixed
- ユーザーエージェント<br> 文字列<br/> 最大桁数:1024<br/> ユーザーエージェントを指定します。<br/> - 最大文字数:1024byte<br/> serviceOptionType="scancode"、かつ、scancodeType="1"の場合、指定必須<br/> 上記以外、指定不可。<br/>
- $withCapture : mixed
- 与信同時売上フラグ<br> 英字(boolean)<br/> - true : 与信同時売上(設定可能な値は"true"のみです。)<br/> ※未指定の場合は、true:与信同時売上。<br/>
- __toString() : string
- ログ用文字列(マスク済み)を取得する<br>
- _setMaskedLog() : mixed
- ログ用文字列(マスク済み)を設定する<br>
- getAccountId() : string
- 会員IDを取得する。<br>
- getAmount() : string
- 決済金額を取得する<br>
- getCreateDate() : string
- 入会年月日を取得する<br>
- getFreeKey() : string
- キー情報を取得する<br>
- getIdentityCode() : string
- 識別コードを取得する<br>
- getMemo1() : string
- 取引メモ1を取得する<br>
- getMemo2() : string
- 取引メモ2を取得する<br>
- getMemo3() : string
- 取引メモ3を取得する<br>
- getOperatorId() : string
- 従業員IDを取得する<br>
- getOrderDetail() : string
- 商品詳細を取得する<br>
- getOrderId() : string
- 取引IDを取得する<br>
- getOrderTitle() : string
- 商品名を取得する<br>
- getReceiptData() : string
- レシートデータを取得する。<br>
- getResponseType() : string
- レスポンスタイプを取得する<br>
- getScancodeType() : string
- スキャンコードタイプを取得する<br>
- getServiceCommand() : string
- 決済サービスコマンドを取得する<br>
- getServiceOptionType() : string
- サービスオプションタイプを取得する<br>
- getServiceType() : string
- 決済サービスタイプを取得する<br>
- getStoreId() : string
- 店舗IDを取得する<br>
- getStoreName() : string
- 店舗名を取得する<br>
- getSuccessRedirectUrl() : string
- 決済成功時リダイレクトURLを取得する<br>
- getTerminalId() : string
- 端末IDを取得する<br>
- getUserAgent() : string
- ユーザーエージェントを取得する<br>
- getWithCapture() : string
- 与信同時売上フラグを取得する<br>
- setAccountId() : mixed
- 会員IDを設定する。<br>
- setAmount() : mixed
- 決済金額を設定する<br>
- setCreateDate() : mixed
- 入会年月日を設定する<br>
- setFreeKey() : mixed
- キー情報を設定する<br>
- setIdentityCode() : mixed
- 識別コードを設定する<br>
- setMemo1() : mixed
- 取引メモ1を設定する<br>
- setMemo2() : mixed
- 取引メモ2を設定する<br>
- setMemo3() : mixed
- 取引メモ3を設定する<br>
- setOperatorId() : mixed
- 従業員IDを設定する<br>
- setOrderDetail() : mixed
- 商品詳細を設定する<br>
- setOrderId() : mixed
- 取引IDを設定する<br>
- setOrderTitle() : mixed
- 商品名を設定する<br>
- setReceiptData() : mixed
- レシートデータを設定する。<br>
- setResponseType() : mixed
- レスポンスタイプを設定する<br>
- setScancodeType() : mixed
- スキャンコードタイプを設定する<br>
- setServiceOptionType() : mixed
- サービスオプションタイプを設定する<br>
- setStoreId() : mixed
- 店舗IDを設定する<br>
- setStoreName() : mixed
- 店舗名を設定する<br>
- setSuccessRedirectUrl() : mixed
- 決済成功時リダイレクトURLを設定する<br>
- setTerminalId() : mixed
- 端末IDを設定する<br>
- setUserAgent() : mixed
- ユーザーエージェントを設定する<br>
- setWithCapture() : 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
$amount
決済金額<br> 半角数字<br/> 最大桁数:12<br/> 決済金額を指定します。<br/> - 1 以上かつ 999999999999(12桁) 以下<br/>
private
mixed
$amount
$identityCode
識別コード<br> 半角英数字<br/> 最大桁数:64<br/> 識別コードを指定します。<br/> ※serviceOptionType="barcode":指定必須<br/> 上記以外、指定不可。<br/>
private
mixed
$identityCode
$maskedLog
ログ用文字列(マスク済み)<br> 半角英数字<br>
private
mixed
$maskedLog
$operatorId
従業員ID<br> 半角英数字<br/> 最大桁数:64<br/> 従業員IDを指定します。<br/> ※半角英数字、"-"(ハイフン)、 "_"(アンダースコア)も使用可能です。<br/>
private
mixed
$operatorId
$orderDetail
商品詳細<br> 文字列<br/> 最大桁数:400<br/> 識別コードを指定します。<br/> - 最大文字数:400byte<br/>
private
mixed
$orderDetail
$orderId
取引ID<br> 半角英数字<br/> 最大桁数:100<br/> - マーチャント側で取引を一意に表す注文管理IDを指定します。<br/> - 申込処理ごとに一意である必要があります。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/>
private
mixed
$orderId
$orderTitle
商品名<br> 文字列<br/> 最大桁数:256<br/> 商品名を指定します。<br/> - 最大文字数:256byte<br/>
private
mixed
$orderTitle
$responseType
レスポンスタイプ<br> 半角数字<br/> 最大桁数:1<br/> レスポンスのタイプを指定します。<br/> "0":取引確定時にレスポンスを返却する。<br/> "1":即時にレスポンスを返却する。(取引確定については、Confirmコマンドを利用する)<br/> <br/> serviceOptionType="barcode":指定任意<br/> 上記以外、指定不可。<br/> ※未指定の場合は、0:取引確定時にレスポンスを返却する。<br/>
private
mixed
$responseType
$scancodeType
スキャンコードタイプ<br> 半角数字<br/> 最大桁数:1<br/> シーンのタイプを指定します。<br/> "0":サービスプロバイダー発行QR利用。<br/> "1":加盟店発行QR利用。<br/> <br/> serviceOptionType="scancode":指定任意<br/> 上記以外、指定不可。<br/> ※未指定の場合は、0:サービスプロバイダー発行QR利用。<br/>
private
mixed
$scancodeType
$SERVICE_COMMAND
決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_COMMAND
= "Authorize"
$SERVICE_TYPE
決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
private
mixed
$SERVICE_TYPE
= "alipayx"
$serviceOptionType
サービスオプションタイプ<br> 半角英数字<br/> - "barcode":バーコード決済<br/> - "scancode":スキャンコード決済<br/>
private
mixed
$serviceOptionType
$storeId
店舗ID<br> 半角英数字<br/> 最大桁数:32<br/> 店舗IDを指定します。<br/> ※半角英数字、"-"(ハイフン)、 "_"(アンダースコア)も使用可能です。<br/>
private
mixed
$storeId
$storeName
店舗名<br> 文字列<br/> 最大桁数:128<br/> 店舗名を指定します。<br/> - 最大文字数:128byte<br/>
private
mixed
$storeName
$successRedirectUrl
決済成功時リダイレクトURL<br> 文字列<br/> 最大桁数:512<br/> 決済成功時にリダイレクトするURLを指定します。<br/> serviceOptionType="scancode"、かつ、scancodeType="1"の場合、指定任意<br/> 上記以外、指定不可。<br/>
private
mixed
$successRedirectUrl
$terminalId
端末ID<br> 半角英数字<br/> 最大桁数:64<br/> 端末IDを指定します。<br/> ※半角英数字、"-"(ハイフン)、 "_"(アンダースコア)も使用可能です。<br/>
private
mixed
$terminalId
$userAgent
ユーザーエージェント<br> 文字列<br/> 最大桁数:1024<br/> ユーザーエージェントを指定します。<br/> - 最大文字数:1024byte<br/> serviceOptionType="scancode"、かつ、scancodeType="1"の場合、指定必須<br/> 上記以外、指定不可。<br/>
private
mixed
$userAgent
$withCapture
与信同時売上フラグ<br> 英字(boolean)<br/> - true : 与信同時売上(設定可能な値は"true"のみです。)<br/> ※未指定の場合は、true:与信同時売上。<br/>
private
mixed
$withCapture
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 —キー情報
getIdentityCode()
識別コードを取得する<br>
public
getIdentityCode() : 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を設定する
getOperatorId()
従業員IDを取得する<br>
public
getOperatorId() : string
Return values
string —従業員ID
getOrderDetail()
商品詳細を取得する<br>
public
getOrderDetail() : string
Return values
string —商品詳細
getOrderId()
取引IDを取得する<br>
public
getOrderId() : string
Return values
string —取引ID
getOrderTitle()
商品名を取得する<br>
public
getOrderTitle() : string
Return values
string —商品名
getReceiptData()
レシートデータを取得する。<br>
public
getReceiptData() : string
Return values
string —レシートデータ
getResponseType()
レスポンスタイプを取得する<br>
public
getResponseType() : string
Return values
string —レスポンスタイプ
getScancodeType()
スキャンコードタイプを取得する<br>
public
getScancodeType() : 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 —決済サービスタイプ
getStoreId()
店舗IDを取得する<br>
public
getStoreId() : string
Return values
string —店舗ID
getStoreName()
店舗名を取得する<br>
public
getStoreName() : string
Return values
string —店舗名
getSuccessRedirectUrl()
決済成功時リダイレクトURLを取得する<br>
public
getSuccessRedirectUrl() : string
Return values
string —決済成功時リダイレクトURL
getTerminalId()
端末IDを取得する<br>
public
getTerminalId() : string
Return values
string —端末ID
getUserAgent()
ユーザーエージェントを取得する<br>
public
getUserAgent() : string
Return values
string —ユーザーエージェント
getWithCapture()
与信同時売上フラグを取得する<br>
public
getWithCapture() : string
Return values
string —与信同時売上フラグ
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 —setIdentityCode()
識別コードを設定する<br>
public
setIdentityCode(string $identityCode) : mixed
Parameters
- $identityCode : 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 —setOperatorId()
従業員IDを設定する<br>
public
setOperatorId(string $operatorId) : mixed
Parameters
- $operatorId : string
-
従業員ID
Return values
mixed —setOrderDetail()
商品詳細を設定する<br>
public
setOrderDetail(string $orderDetail) : mixed
Parameters
- $orderDetail : string
-
商品詳細
Return values
mixed —setOrderId()
取引IDを設定する<br>
public
setOrderId(string $orderId) : mixed
Parameters
- $orderId : string
-
取引ID
Return values
mixed —setOrderTitle()
商品名を設定する<br>
public
setOrderTitle(string $orderTitle) : mixed
Parameters
- $orderTitle : string
-
商品名
Return values
mixed —setReceiptData()
レシートデータを設定する。<br>
public
setReceiptData(string $receiptData) : mixed
Parameters
- $receiptData : string
-
レシートデータ
Return values
mixed —setResponseType()
レスポンスタイプを設定する<br>
public
setResponseType(string $responseType) : mixed
Parameters
- $responseType : string
-
レスポンスタイプ
Return values
mixed —setScancodeType()
スキャンコードタイプを設定する<br>
public
setScancodeType(string $scancodeType) : mixed
Parameters
- $scancodeType : string
-
スキャンコードタイプ
Return values
mixed —setServiceOptionType()
サービスオプションタイプを設定する<br>
public
setServiceOptionType(string $serviceOptionType) : mixed
Parameters
- $serviceOptionType : string
-
サービスオプションタイプ
Return values
mixed —setStoreId()
店舗IDを設定する<br>
public
setStoreId(string $storeId) : mixed
Parameters
- $storeId : string
-
店舗ID
Return values
mixed —setStoreName()
店舗名を設定する<br>
public
setStoreName(string $storeName) : mixed
Parameters
- $storeName : string
-
店舗名
Return values
mixed —setSuccessRedirectUrl()
決済成功時リダイレクトURLを設定する<br>
public
setSuccessRedirectUrl(string $successRedirectUrl) : mixed
Parameters
- $successRedirectUrl : string
-
決済成功時リダイレクトURL
Return values
mixed —setTerminalId()
端末IDを設定する<br>
public
setTerminalId(string $terminalId) : mixed
Parameters
- $terminalId : string
-
端末ID
Return values
mixed —setUserAgent()
ユーザーエージェントを設定する<br>
public
setUserAgent(string $userAgent) : mixed
Parameters
- $userAgent : string
-
ユーザーエージェント
Return values
mixed —setWithCapture()
与信同時売上フラグを設定する<br>
public
setWithCapture(string $withCapture) : mixed
Parameters
- $withCapture : 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