Show / Hide Table of Contents

# Class AlipayxAuthorizeRequestDto

決済サービスタイプ：alipayx、コマンド名：決済申込の要求Dtoクラス

##### Inheritance

object
MdkDtoBase
AbstractPaymentRequestDto
AlipayxAuthorizeRequestDto

##### Implements

IRequestDto

##### Inherited Members

AbstractPaymentRequestDto.PayNowIdParam
AbstractPaymentRequestDto.CncTokenParam
AbstractPaymentRequestDto.AccountId
AbstractPaymentRequestDto.CreateDate
AbstractPaymentRequestDto.FreeKey
AbstractPaymentRequestDto.Memo1
AbstractPaymentRequestDto.ReceiptData
AbstractPaymentRequestDto.ExistPayNowIdParam()
AbstractPaymentRequestDto.ExistAccountParam()
AbstractPaymentRequestDto.ExistAccountBasicParam()
AbstractPaymentRequestDto.ExistCardParam()
AbstractPaymentRequestDto.ExistRecurringChargeParam()
AbstractPaymentRequestDto.ExistBankAccountParam()
AbstractPaymentRequestDto.ExistCncTokenParam()
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)

###### Namespace: jp.veritrans.tercerog.mdk.dto

###### Assembly: cg-mdk-dto.dll

##### Syntax

    public class AlipayxAuthorizeRequestDto : AbstractPaymentRequestDto, IRequestDto

### Properties

#### Amount

決済金額

半角数字 最大桁数:12

決済金額を指定します。
- 1 以上かつ 999999999999(12桁) 以下

##### Declaration

    [JsonProperty("amount")]
    public string Amount { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### DeviceType

デバイスタイプ

半角数字 最大桁数:1

デバイスのタイプを指定します。
"0"：PC
"1"：スマートフォン
"2"：加盟店アプリ
serviceOptionType="online"：指定任意
上記以外、指定不可。
※未指定の場合は、0：PC

##### Declaration

    [JsonProperty("deviceType")]
    public string DeviceType { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### ErrorUrl

決済失敗時URL

文字列 最大桁数:1024

決済失敗後に、店舗側サイトに画面遷移を戻すためのURLを指定します。
※未指定の場合は管理画面(MAP)から設定した「決済失敗時URL」を使用します。
※serviceOptionType="online"で未指定かつ、管理画面(MAP)の対象項目も未指定の場合はエラーとなります。
※serviceOptionType="online"の場合、指定任意
上記以外、指定不可。

##### Declaration

    [JsonProperty("errorUrl")]
    public string ErrorUrl { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### IdentityCode

識別コード

半角英数字 最大桁数:64

識別コードを指定します。
※serviceOptionType="barcode"：指定必須
上記以外、指定不可。

##### Declaration

    [JsonProperty("identityCode")]
    public string IdentityCode { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### MaskedLog

ログ用文字列(マスク済み)を設定する @param maskedLog ログ用文字列(マスク済み)

##### Declaration

    [JsonIgnore]
    public override string MaskedLog { set; }

##### Property Value

Type | Description
--- | ---
string |

##### Overrides

AbstractPaymentRequestDto.MaskedLog

#### OperatorId

従業員ID

半角英数字 最大桁数:64

従業員IDを指定します。
※半角英数字、"-"（ハイフン）、 "_"（アンダースコア）も使用可能です。
※serviceOptionType="online"：指定不可
上記以外、指定任意

##### Declaration

    [JsonProperty("operatorId")]
    public string OperatorId { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### OrderDetail

商品詳細

文字列 最大桁数:400

商品詳細を指定します。
- 最大文字数:
※V1…400byte
※V2…256文字
※指定必須

##### Declaration

    [JsonProperty("orderDetail")]
    public string OrderDetail { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### OrderId

取引ID

半角英数字 最大桁数:100

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

##### Declaration

    [JsonProperty("orderId")]
    public string OrderId { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### OrderTitle

商品名

文字列 最大桁数:256

商品名を指定します。
- 最大文字数:256byte
※V1の場合、指定必須
※V2の場合、serviceOptionTypeが"online"の場合は指定不可、serviceOptionTypeが"online"以外の場合は指定任意

##### Declaration

    [JsonProperty("orderTitle")]
    public string OrderTitle { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### PushUrl

プッシュURL

文字列 最大桁数:1024

プッシュURLを指定します。
※未指定の場合は管理画面(MAP)から設定した「通知URL」を使用します。
※serviceOptionType="scancode"、"online"：指定任意
上記以外、指定不可。

##### Declaration

    [JsonProperty("pushUrl")]
    public string PushUrl { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### ResponseType

レスポンスタイプ

半角数字 最大桁数:1

レスポンスのタイプを指定します。
"0"：取引確定時にレスポンスを返却する。
"1"：即時にレスポンスを返却する。（取引確定については、Confirmコマンドを利用する）
serviceOptionType="barcode"：指定任意
上記以外、指定不可。
※未指定の場合は、0：取引確定時にレスポンスを返却する。

##### Declaration

    [JsonProperty("responseType")]
    public string ResponseType { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### ScancodeType

スキャンコードタイプ

半角数字 最大桁数:1

シーンのタイプを指定します。
"0"：サービスプロバイダー発行QR利用。
"1"：加盟店発行QR利用。
serviceOptionType="scancode"：指定任意
上記以外、指定不可。
※未指定の場合は、0：サービスプロバイダー発行QR利用。

##### Declaration

    [JsonProperty("scancodeType")]
    public string ScancodeType { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### ServiceCommand

決済サービスコマンド

##### Declaration

    [JsonIgnore]
    public override string ServiceCommand { get; }

##### Property Value

Type | Description
--- | ---
string |

##### Overrides

AbstractPaymentRequestDto.ServiceCommand

#### ServiceOptionType

サービスオプションタイプ

半角英数字

- "barcode":バーコード決済（店舗スキャン型）
- "scancode":バーコード決済（消費者スキャン型）
- "online":オンライン決済

##### Declaration

    [JsonProperty("serviceOptionType")]
    public string ServiceOptionType { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### ServiceType

決済サービスタイプ

##### Declaration

    [JsonIgnore]
    public override string ServiceType { get; }

##### Property Value

Type | Description
--- | ---
string |

##### Overrides

AbstractPaymentRequestDto.ServiceType

#### StoreId

店舗ID

半角英数字 最大桁数:32

店舗IDを指定します。
※半角英数字、"-"（ハイフン）、 "_"（アンダースコア）も使用可能です。
※指定する値はAlipayに登録されている必要があります。
※未指定の場合は、加盟店ID(merchantId)が設定されます。

##### Declaration

    [JsonProperty("storeId")]
    public string StoreId { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### StoreName

店舗名

文字列 最大桁数:128

店舗名を指定します。
※指定する値はAlipayに登録されている必要があります。
※未指定の場合は、マーチャント登録時に設定した値を使用します。
- 最大文字数:128byte

##### Declaration

    [JsonProperty("storeName")]
    public string StoreName { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### SuccessRedirectUrl

決済成功時リダイレクトURL

文字列 最大桁数:1024

決済成功時にリダイレクトするURLを指定します。
※未指定の場合は管理画面(MAP)から設定した「決済成功リダイレクトURL」を使用します。
※V1の場合、
serviceOptionType="scancode"、かつ、scancodeType="1"の場合、指定任意
※V2の場合、
serviceOptionType="scancode"の場合、指定任意
上記以外、指定不可。

##### Declaration

    [JsonProperty("successRedirectUrl")]
    public string SuccessRedirectUrl { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### SuccessUrl

決済完了時URL

文字列 最大桁数:1024

決済完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。
※未指定の場合は管理画面(MAP)から設定した「決済完了時URL」を使用します。
※serviceOptionType="online"で未指定かつ、管理画面(MAP)の対象項目も未指定の場合はエラーとなります。
※serviceOptionType="online"の場合、指定任意
上記以外、指定不可。

##### Declaration

    [JsonProperty("successUrl")]
    public string SuccessUrl { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### TerminalId

端末ID

半角英数字 最大桁数:64

端末IDを指定します。
※半角英数字、"-"（ハイフン）、 "_"（アンダースコア）も使用可能です。

##### Declaration

    [JsonProperty("terminalId")]
    public string TerminalId { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### UserAgent

ユーザーエージェント

文字列 最大桁数:1024

ユーザーエージェントを指定します。
- 最大文字数:1024byte
※V1の場合、
serviceOptionType="scancode"、かつ、scancodeType="1"の場合、指定必須
上記以外、指定不可。
※V2の場合、
serviceOptionType="scancode"、かつ、scancodeType="0"の場合、指定任意
serviceOptionType="scancode"、かつ、scancodeType="1"の場合、指定必須
serviceOptionType="online"、かつ、deviceType="1"、"2"の場合、指定必須。
上記以外、指定不可。
serviceOptionType="online"の場合、OSの種類（Android・iOS）の判別がつくような情報を設定いただくようにお願いします。判別が不可能な場合はエラーとなります。

##### Declaration

    [JsonProperty("userAgent")]
    public string UserAgent { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### WithCapture

与信同時売上フラグ

英字（boolean）

- true : 与信同時売上（設定可能な値は"true"のみです。）
※未指定の場合は、true:与信同時売上。

##### Declaration

    [JsonProperty("withCapture")]
    public string WithCapture { get; set; }

##### Property Value

Type | Description
--- | ---
string |

### Methods

#### ToString()

ログ用文字列(マスク済み)を取得する @return ログ用文字列(マスク済み)

##### Declaration

    public override string ToString()

##### Returns

Type | Description
--- | ---
string |

##### Overrides

object.ToString()

### Implements

IRequestDto