Show / Hide Table of Contents

# Class TenpayAuthorizeRequestDto

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

##### Inheritance

object
MdkDtoBase
AbstractPaymentRequestDto
TenpayAuthorizeRequestDto

##### 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 TenpayAuthorizeRequestDto : AbstractPaymentRequestDto, IRequestDto

### Properties

#### Amount

決済金額

半角数字 最大桁数:7

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

##### Declaration

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

##### Property Value

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

#### AuthorizationCode

承認コード

半角英数字 最大桁数:128

バーコード決済を利用する際のQRコード、バーコードの値を指定します。
serviceOptionType="barcode"：指定必須
上記以外、指定不可。

##### Declaration

    [JsonProperty("authorizationCode")]
    public string AuthorizationCode { get; set; }

##### Property Value

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

#### CancelUrl

決済キャンセル時URL

URL 最大桁数:256

決済キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定します。
serviceOptionType="scancode"、かつ、scancodeType="1"：指定任意
上記以外、指定不可。
※ 未指定の場合は、マーチャント登録時に設定した値を使用

##### Declaration

    [JsonProperty("cancelUrl")]
    public string CancelUrl { get; set; }

##### Property Value

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

#### DeviceInfo

デバイス情報

文字列 最大桁数:32

デバイス情報を指定します。
- 最大文字数:32byte

##### Declaration

    [JsonProperty("deviceInfo")]
    public string DeviceInfo { get; set; }

##### Property Value

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

#### ErrorUrl

決済エラー時URL

URL 最大桁数:256

決済失敗時に、店舗側サイトに画面遷移を戻すためのURLを指定します。
serviceOptionType="scancode"、かつ、scancodeType="1"：指定任意
上記以外、指定不可。
※ 未指定の場合は、マーチャント登録時に設定した値を使用

##### Declaration

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

##### Property Value

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

#### ItemDetail

商品詳細

文字列 最大桁数:1000

商品詳細
- 最大文字数：1000byte

##### Declaration

    [JsonProperty("itemDetail")]
    public string ItemDetail { get; set; }

##### Property Value

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

#### ItemLabel

商品タグ

文字列 最大桁数:32

商品に付与できるタグ情報。
- 最大文字数:32byte

##### Declaration

    [JsonProperty("itemLabel")]
    public string ItemLabel { get; set; }

##### Property Value

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

#### ItemName

商品名

文字列 最大桁数:32

商品名
- 最大文字数：32byte

##### Declaration

    [JsonProperty("itemName")]
    public string ItemName { 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

#### Openid

ユーザータグ

文字列 最大桁数:128

ユーザータグを指定します。
serviceOptionType="scancode"、かつ、scancodeType="1"：指定任意
※subOpenidが未指定の場合は指定必須。
上記以外、指定不可。

##### Declaration

    [JsonProperty("openid")]
    public string Openid { get; set; }

##### Property Value

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

#### OrderId

取引ID

半角英数字 最大桁数:100

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

##### Declaration

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

##### Property Value

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

#### ProductId

製品ID

文字列 最大桁数:32

製品IDを指定します。
- 最大文字数：32byte
serviceOptionType="scancode"、かつ、scancodeType="0"：指定必須
上記以外、指定不可。

##### Declaration

    [JsonProperty("productId")]
    public string ProductId { get; set; }

##### Property Value

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

#### ResponseType

レスポンスタイプ

半角数字 最大桁数:1

レスポンスのタイプを指定します。
"0"：取引確定時にレスポンスを返却する。
"1"：即時にレスポンスを返却する。
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":スキャンコード決済

##### 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を指定します。
- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。

##### Declaration

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

##### Property Value

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

#### StoreName

店舗名

文字列 最大桁数:64

店舗名を指定します。
- 最大文字数：64byte

##### Declaration

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

##### Property Value

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

#### SubOpenid

サブユーザータグ

文字列 最大桁数:128

サブユーザータグを指定します。
serviceOptionType="scancode"、かつ、scancodeType="1"：指定任意
※openidが未指定の場合は指定必須。
上記以外、指定不可。

##### Declaration

    [JsonProperty("subOpenid")]
    public string SubOpenid { get; set; }

##### Property Value

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

#### SuccessUrl

決済完了時URL

URL 最大桁数:256

決済完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。
serviceOptionType="scancode"、かつ、scancodeType="1"：指定任意
上記以外、指定不可。
※ 未指定の場合は、マーチャント登録時に設定した値を使用

##### Declaration

    [JsonProperty("successUrl")]
    public string SuccessUrl { 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