VeriTrans 4G MDK

AlipayAuthorizeRequestDto extends AbstractPaymentRequestDto
in package

決済サービスタイプ:Alipay、コマンド名:与信の要求Dtoクラス<br>

Tags
author

Veritrans, Inc.

Table of Contents

$payNowIdParam  : PayNowIdParam
PayNowIDオブジェクト
$amount  : mixed
決済金額<br> 半角数字<br/> 最大桁数:7<br/> 決済金額を日本円と中国元で指定します。<br/> - 日本円(JPY):1 - 9999999<br/> - 中国元(CNY):100 - 5000000<br/> 取引金額を100倍した値を指定します。(amount=決済金額×100)<br/> 上限金額は中国元換算で50,000元。<br/> (例 <br/> 日本円:1円の場合は1を指定します。<br/> 中国元:1.99元の場合は199を指定します。)<br/>
$commodityDescription  : mixed
商品詳細<br> 文字列<br/> 最大桁数:200<br/> 商品詳細<br/> - 文字列200桁以内<br/> <br/> payType=0(オンライン決済):指定任意 <br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定任意(商品詳細を指定する場合は商品IDの指定が必須)<br/>
$commodityId  : mixed
商品ID<br> 半角英数字<br/> 最大桁数:64<br/> マーチャントシステム内で商品やサービスを特定するID<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定任意<br/>
$commodityName  : mixed
商品名<br> 文字列<br/> 最大桁数:100<br/> 商品名<br/> - 文字列100桁以内<br/> <br/> payType=0(オンライン決済):指定必須<br/> payType=1(バーコード決済(店舗スキャン型)):指定必須<br/> payType=2(バーコード決済(消費者スキャン型)):指定必須<br/>
$currency  : mixed
通貨<br> 英字<br/> 最大桁数:10<br/> 決済通貨を指定します。<br/> "JPY":日本円<br/> "CNY":中国元(オンライン決済のみ)<br/>
$deviceType  : mixed
デバイスタイプ<br> 半角数字<br/> 最大桁数:1<br/> デバイスのタイプを指定します。<br/> "0":PC<br/> "1":スマートフォン<br/> <br/> payType=0(オンライン決済):指定任意<br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/> <br/> ※未指定の場合は、0:PC<br/>
$errorUrl  : mixed
決済エラー時URL<br> URL(半角)<br/> 最大桁数:256<br/> 決済エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> - 半角256文字以内<br/> <br/> payType=0(オンライン決済):指定必須<br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/>
$identityCode  : mixed
ユーザ識別コード<br> 半角英数字<br/> 最大桁数:32<br/> 消費者をAlipayユーザとして識別するためのコードを指定します。<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定必須<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/>
$maskedLog  : mixed
ログ用文字列(マスク済み)<br> 半角英数字<br>
$orderId  : mixed
取引ID<br> 半角英数字<br/> 最大桁数:100<br/> - マーチャント側で取引を一意に表す注文管理IDを指定します。<br/> - 申込処理ごとに一意である必要があります。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/>
$payType  : mixed
決済種別<br> 半角数字<br/> 最大桁数:1<br/> 決済種別を指定します。<br/> "0":オンライン決済<br/> "1":バーコード決済(店舗スキャン型)<br/> "2":バーコード決済(消費者スキャン型)<br/> ※未指定の場合は、0:オンライン決済。<br/>
$responseType  : mixed
レスポンスタイプ<br> 半角数字<br/> 最大桁数:1<br/> レスポンスのタイプを指定します。<br/> "0":取引確定時にレスポンスを返却する。<br/> "1":即時にレスポンスを返却する。(取引確定については、Confirmコマンドを利用する)<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定任意<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/> <br/> ※未指定の場合は、0:取引確定時にレスポンスを返却する。<br/>
$SERVICE_COMMAND  : mixed
決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>
$SERVICE_TYPE  : mixed
決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>
$storeId  : mixed
店舗ID<br> 半角英数字<br/> 最大桁数:64<br/> 店舗IDを指定します。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定任意<br/> payType=2(バーコード決済(消費者スキャン型)):指定任意<br/>
$storeName  : mixed
店舗名<br> 文字列<br/> 最大桁数:64<br/> 店舗名を指定します。<br/> - 最大文字数:64byte<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定任意<br/> payType=2(バーコード決済(消費者スキャン型)):指定任意<br/>
$successUrl  : mixed
決済完了時URL<br> URL(半角)<br/> 最大桁数:256<br/> 決済完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> - 半角256文字以内<br/> <br/> payType=0(オンライン決済):指定必須<br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/>
$withCapture  : mixed
与信同時売上フラグ<br> 英字(boolean)<br/> - true : 与信同時売上(設定可能な値は"true"のみです。)<br/> ※未指定の場合は、true:与信同時売上。<br/>
__toString()  : string
ログ用文字列(マスク済み)を取得する<br>
_setMaskedLog()  : mixed
ログ用文字列(マスク済み)を設定する<br>
getAccountId()  : string
会員IDを取得する。<br>
getAmount()  : string
決済金額を取得する<br>
getCommodityDescription()  : string
商品詳細を取得する<br>
getCommodityId()  : string
商品IDを取得する<br>
getCommodityName()  : string
商品名を取得する<br>
getCreateDate()  : string
入会年月日を取得する<br>
getCurrency()  : string
通貨を取得する<br>
getDeviceType()  : string
デバイスタイプを取得する<br>
getErrorUrl()  : string
決済エラー時URLを取得する<br>
getFreeKey()  : string
キー情報を取得する<br>
getIdentityCode()  : string
ユーザ識別コードを取得する<br>
getMemo1()  : string
取引メモ1を取得する<br>
getMemo2()  : string
取引メモ2を取得する<br>
getMemo3()  : string
取引メモ3を取得する<br>
getOrderId()  : string
取引IDを取得する<br>
getPayType()  : string
決済種別を取得する<br>
getReceiptData()  : string
レシートデータを取得する。<br>
getResponseType()  : string
レスポンスタイプを取得する<br>
getServiceCommand()  : string
決済サービスコマンドを取得する<br>
getServiceType()  : string
決済サービスタイプを取得する<br>
getStoreId()  : string
店舗IDを取得する<br>
getStoreName()  : string
店舗名を取得する<br>
getSuccessUrl()  : string
決済完了時URLを取得する<br>
getWithCapture()  : string
与信同時売上フラグを取得する<br>
setAccountId()  : mixed
会員IDを設定する。<br>
setAmount()  : mixed
決済金額を設定する<br>
setCommodityDescription()  : mixed
商品詳細を設定する<br>
setCommodityId()  : mixed
商品IDを設定する<br>
setCommodityName()  : mixed
商品名を設定する<br>
setCreateDate()  : mixed
入会年月日を設定する<br>
setCurrency()  : mixed
通貨を設定する<br>
setDeviceType()  : mixed
デバイスタイプを設定する<br>
setErrorUrl()  : mixed
決済エラー時URLを設定する<br>
setFreeKey()  : mixed
キー情報を設定する<br>
setIdentityCode()  : mixed
ユーザ識別コードを設定する<br>
setMemo1()  : mixed
取引メモ1を設定する<br>
setMemo2()  : mixed
取引メモ2を設定する<br>
setMemo3()  : mixed
取引メモ3を設定する<br>
setOrderId()  : mixed
取引IDを設定する<br>
setPayType()  : mixed
決済種別を設定する<br>
setReceiptData()  : mixed
レシートデータを設定する。<br>
setResponseType()  : mixed
レスポンスタイプを設定する<br>
setStoreId()  : mixed
店舗IDを設定する<br>
setStoreName()  : mixed
店舗名を設定する<br>
setSuccessUrl()  : mixed
決済完了時URLを設定する<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

$amount

決済金額<br> 半角数字<br/> 最大桁数:7<br/> 決済金額を日本円と中国元で指定します。<br/> - 日本円(JPY):1 - 9999999<br/> - 中国元(CNY):100 - 5000000<br/> 取引金額を100倍した値を指定します。(amount=決済金額×100)<br/> 上限金額は中国元換算で50,000元。<br/> (例 <br/> 日本円:1円の場合は1を指定します。<br/> 中国元:1.99元の場合は199を指定します。)<br/>

private mixed $amount

$commodityDescription

商品詳細<br> 文字列<br/> 最大桁数:200<br/> 商品詳細<br/> - 文字列200桁以内<br/> <br/> payType=0(オンライン決済):指定任意 <br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定任意(商品詳細を指定する場合は商品IDの指定が必須)<br/>

private mixed $commodityDescription

$commodityId

商品ID<br> 半角英数字<br/> 最大桁数:64<br/> マーチャントシステム内で商品やサービスを特定するID<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定任意<br/>

private mixed $commodityId

$commodityName

商品名<br> 文字列<br/> 最大桁数:100<br/> 商品名<br/> - 文字列100桁以内<br/> <br/> payType=0(オンライン決済):指定必須<br/> payType=1(バーコード決済(店舗スキャン型)):指定必須<br/> payType=2(バーコード決済(消費者スキャン型)):指定必須<br/>

private mixed $commodityName

$currency

通貨<br> 英字<br/> 最大桁数:10<br/> 決済通貨を指定します。<br/> "JPY":日本円<br/> "CNY":中国元(オンライン決済のみ)<br/>

private mixed $currency

$deviceType

デバイスタイプ<br> 半角数字<br/> 最大桁数:1<br/> デバイスのタイプを指定します。<br/> "0":PC<br/> "1":スマートフォン<br/> <br/> payType=0(オンライン決済):指定任意<br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/> <br/> ※未指定の場合は、0:PC<br/>

private mixed $deviceType

$errorUrl

決済エラー時URL<br> URL(半角)<br/> 最大桁数:256<br/> 決済エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> - 半角256文字以内<br/> <br/> payType=0(オンライン決済):指定必須<br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/>

private mixed $errorUrl

$identityCode

ユーザ識別コード<br> 半角英数字<br/> 最大桁数:32<br/> 消費者をAlipayユーザとして識別するためのコードを指定します。<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定必須<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/>

private mixed $identityCode

$orderId

取引ID<br> 半角英数字<br/> 最大桁数:100<br/> - マーチャント側で取引を一意に表す注文管理IDを指定します。<br/> - 申込処理ごとに一意である必要があります。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/>

private mixed $orderId

$payType

決済種別<br> 半角数字<br/> 最大桁数:1<br/> 決済種別を指定します。<br/> "0":オンライン決済<br/> "1":バーコード決済(店舗スキャン型)<br/> "2":バーコード決済(消費者スキャン型)<br/> ※未指定の場合は、0:オンライン決済。<br/>

private mixed $payType

$responseType

レスポンスタイプ<br> 半角数字<br/> 最大桁数:1<br/> レスポンスのタイプを指定します。<br/> "0":取引確定時にレスポンスを返却する。<br/> "1":即時にレスポンスを返却する。(取引確定については、Confirmコマンドを利用する)<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定任意<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/> <br/> ※未指定の場合は、0:取引確定時にレスポンスを返却する。<br/>

private mixed $responseType

$SERVICE_COMMAND

決済サービスコマンド<br> 半角英数字<br> 必須項目、固定値<br>

private mixed $SERVICE_COMMAND = "Authorize"

$SERVICE_TYPE

決済サービスタイプ<br> 半角英数字<br> 必須項目、固定値<br>

private mixed $SERVICE_TYPE = "alipay"

$storeId

店舗ID<br> 半角英数字<br/> 最大桁数:64<br/> 店舗IDを指定します。<br/> - 半角英数字、“-”(ハイフン)、“_”(アンダースコア)も使用可能です。<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定任意<br/> payType=2(バーコード決済(消費者スキャン型)):指定任意<br/>

private mixed $storeId

$storeName

店舗名<br> 文字列<br/> 最大桁数:64<br/> 店舗名を指定します。<br/> - 最大文字数:64byte<br/> <br/> payType=0(オンライン決済):指定できません<br/> payType=1(バーコード決済(店舗スキャン型)):指定任意<br/> payType=2(バーコード決済(消費者スキャン型)):指定任意<br/>

private mixed $storeName

$successUrl

決済完了時URL<br> URL(半角)<br/> 最大桁数:256<br/> 決済完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。<br/> - 半角256文字以内<br/> <br/> payType=0(オンライン決済):指定必須<br/> payType=1(バーコード決済(店舗スキャン型)):指定できません<br/> payType=2(バーコード決済(消費者スキャン型)):指定できません<br/>

private mixed $successUrl

$withCapture

与信同時売上フラグ<br> 英字(boolean)<br/> - true : 与信同時売上(設定可能な値は"true"のみです。)<br/> ※未指定の場合は、true:与信同時売上。<br/>

private mixed $withCapture = "true"

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

決済金額

getCommodityDescription()

商品詳細を取得する<br>

public getCommodityDescription() : string
Return values
string

商品詳細

getCommodityId()

商品IDを取得する<br>

public getCommodityId() : string
Return values
string

商品ID

getCommodityName()

商品名を取得する<br>

public getCommodityName() : string
Return values
string

商品名

getCreateDate()

入会年月日を取得する<br>

public getCreateDate() : string
Return values
string

入会年月日

getDeviceType()

デバイスタイプを取得する<br>

public getDeviceType() : string
Return values
string

デバイスタイプ

getErrorUrl()

決済エラー時URLを取得する<br>

public getErrorUrl() : string
Return values
string

決済エラー時URL

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を設定する

getPayType()

決済種別を取得する<br>

public getPayType() : string
Return values
string

決済種別

getReceiptData()

レシートデータを取得する。<br>

public getReceiptData() : string
Return values
string

レシートデータ

getResponseType()

レスポンスタイプを取得する<br>

public getResponseType() : string
Return values
string

レスポンスタイプ

getServiceCommand()

決済サービスコマンドを取得する<br>

public getServiceCommand() : string
Return values
string

決済サービスコマンド

getServiceType()

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

public getServiceType() : string
Return values
string

決済サービスタイプ

getStoreName()

店舗名を取得する<br>

public getStoreName() : string
Return values
string

店舗名

getSuccessUrl()

決済完了時URLを取得する<br>

public getSuccessUrl() : string
Return values
string

決済完了時URL

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

setCommodityDescription()

商品詳細を設定する<br>

public setCommodityDescription(string $commodityDescription) : mixed
Parameters
$commodityDescription : string

商品詳細

Return values
mixed

setCommodityId()

商品IDを設定する<br>

public setCommodityId(string $commodityId) : mixed
Parameters
$commodityId : string

商品ID

Return values
mixed

setCommodityName()

商品名を設定する<br>

public setCommodityName(string $commodityName) : mixed
Parameters
$commodityName : string

商品名

Return values
mixed

setCreateDate()

入会年月日を設定する<br>

public setCreateDate(string $createDate) : mixed
Parameters
$createDate : string

入会年月日

Return values
mixed

setCurrency()

通貨を設定する<br>

public setCurrency(string $currency) : mixed
Parameters
$currency : string

通貨

Return values
mixed

setDeviceType()

デバイスタイプを設定する<br>

public setDeviceType(string $deviceType) : mixed
Parameters
$deviceType : string

デバイスタイプ

Return values
mixed

setErrorUrl()

決済エラー時URLを設定する<br>

public setErrorUrl(string $errorUrl) : mixed
Parameters
$errorUrl : string

決済エラー時URL

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

setOrderId()

取引IDを設定する<br>

public setOrderId(string $orderId) : mixed
Parameters
$orderId : string

取引ID

Return values
mixed

setPayType()

決済種別を設定する<br>

public setPayType(string $payType) : mixed
Parameters
$payType : 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

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

setSuccessUrl()

決済完了時URLを設定する<br>

public setSuccessUrl(string $successUrl) : mixed
Parameters
$successUrl : string

決済完了時URL

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
Return values
mixed

Search results