Show / Hide Table of Contents

# Class PaypayAuthorizeRequestDto

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

##### Inheritance

object
MdkDtoBase
AbstractPaymentRequestDto
PaypayAuthorizeRequestDto

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

### Properties

#### AccountingType

課金種別

半角数字 最大桁数:1

- 0:都度決済
- 1:随時決済
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定任意※1
（エージェント接続） ： 指定任意
（PayPay直接接続） ： 指定任意（※2）
※1 オンライン決済で未指定の場合、"0"(都度決済)になります。
※2 onlinePaymentType="1"（スマートペイメント）の場合、指定可能な値は"0"(都度決済)のみになります。

##### Declaration

    [JsonProperty("accountingType")]
    public string AccountingType { get; set; }

##### Property Value

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

#### Amount

決済金額

半角数字 最大桁数:7

決済金額を指定します。
- 1 以上かつ 9999999(7桁) 以下
accountingType="1"（随時決済） ： 指定できません

##### Declaration

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

##### Property Value

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

#### CancelUrl

決済キャンセル時URL

URL 最大桁数:1024

決済キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定します。
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定任意※
※onlinePaymentType="1"（スマートペイメント） ： 指定できません
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

##### Declaration

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

##### Property Value

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

#### ErrorUrl

決済エラー時URL

URL 最大桁数:1024

決済キャンセルエラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定任意※
※onlinePaymentType="1"（スマートペイメント） ： 指定できません
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

##### Declaration

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

##### Property Value

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

#### ExtendParameterType

拡張パラメータフラグ

半角英数字 最大桁数:1

応答電文、結果通知およびリダイレクトする時のパラメータの設定タイプを指定します。
- 0 : デフォルトタイプの設定
- 1 : 拡張タイプの設定（今後パラメタが追加される可能性があります。）
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定任意※
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
登録申請した値が無い場合は、"0"を指定します。

##### Declaration

    [JsonProperty("extendParameterType")]
    public string ExtendParameterType { get; set; }

##### Property Value

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

#### ItemId

商品ID

半角英数字 最大桁数:32

マーチャントシステム内で商品やサービスを特定するID
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定必須
※onlinePaymentType="1"（スマートペイメント）の場合は指定任意

##### Declaration

    [JsonProperty("itemId")]
    public string ItemId { get; set; }

##### Property Value

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

#### ItemName

商品名

文字列

商品名を指定します。
- 最大文字数
serviceOptionType="barcode"（バーコード決済） ： 128byte
serviceOptionType="online"（オンライン決済） ： 40byte
serviceOptionType="barcode"（バーコード決済） ： 指定必須
serviceOptionType="online"（オンライン決済） ： 指定任意

##### 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

#### OneTimeCode

ワンタイムコード

半角数字 最大桁数:32

ユーザの端末から読み取ったバーコード情報を指定します。
serviceOptionType="barcode"（バーコード決済） ： 指定必須
serviceOptionType="online"（オンライン決済） ： 指定できません

##### Declaration

    [JsonProperty("oneTimeCode")]
    public string OneTimeCode { get; set; }

##### Property Value

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

#### OnlinePaymentType

オンライン決済タイプ

半角英数字 最大桁数:1

- "1": スマートペイメント
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済）
（エージェント接続） ： 指定できません
（PayPay直接接続） ： 指定任意（※1）
※1 指定可能な値は"1"（スマートペイメント）のみ。

##### Declaration

    [JsonProperty("onlinePaymentType")]
    public string OnlinePaymentType { get; set; }

##### Property Value

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

#### OrderId

取引ID

半角英数字 最大桁数:100

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

##### Declaration

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

##### Property Value

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

#### Provider

接続先事業者

半角英数字 最大桁数:1

決済処理で接続する決済事業者を指定します。
- 0 : エージェントへ接続
- 1 : PayPayへ直接接続
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定任意※
※未指定の場合は、加盟店登録設定で有効になっている決済事業者に接続します。

##### Declaration

    [JsonProperty("provider")]
    public string Provider { get; set; }

##### Property Value

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

#### PushUrl

プッシュ先URL

URL 最大桁数:1024

プッシュURLを指定します。
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定任意※
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

##### Declaration

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

##### Property Value

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

#### ReceiptNumber

レシート番号

半角英数字 最大桁数:128

レシートに印字される番号を指定します。
serviceOptionType="barcode"（バーコード決済） ： 指定任意
serviceOptionType="online"（オンライン決済） ： 指定できません

##### Declaration

    [JsonProperty("receiptNumber")]
    public string ReceiptNumber { 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":バーコード決済
- "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

#### SettleBizCode

決済事業者コード

半角数字 最大桁数:5

決済事業者コードを指定します。
serviceOptionType="barcode"（バーコード決済） ： 指定任意
serviceOptionType="online"（オンライン決済） ： 指定できません

##### Declaration

    [JsonProperty("settleBizCode")]
    public string SettleBizCode { get; set; }

##### Property Value

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

#### StoreId

店舗ID

半角英数字 最大桁数:128

店舗IDを指定します。
- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。
serviceOptionType="barcode"（バーコード決済） ： 指定必須
serviceOptionType="online"（オンライン決済）
（エージェント接続） ： 指定できません
（PayPay直接接続） ： 指定任意

##### Declaration

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

##### Property Value

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

#### SuccessUrl

決済完了時URL

URL 最大桁数:1024

決済完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定任意※
※onlinePaymentType="1"（スマートペイメント） ： 指定できません
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

##### Declaration

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

##### Property Value

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

#### TerminalId

店舗端末ID

半角英数字 最大桁数:128

店舗端末IDを指定します。
- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。
serviceOptionType="barcode"（バーコード決済） ： 指定必須
serviceOptionType="online"（オンライン決済）
（エージェント接続） ： 指定できません
（PayPay直接接続） ： 指定任意

##### Declaration

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

##### Property Value

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

#### TransitionType

遷移種別

半角英数字 最大桁数:1

ユーザ導線における外部ブラウザの起動を回避するかどうかを指定します。
- 1 : アプリから遷移(WebLink)
- 2 : アプリから遷移(DeepLink)
serviceOptionType="barcode"（バーコード決済） ： 指定できません
serviceOptionType="online"（オンライン決済） ： 指定任意※
※accountingType="1"（随時決済） ： 指定できません

##### Declaration

    [JsonProperty("transitionType")]
    public string TransitionType { get; set; }

##### Property Value

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

#### WithCapture

与信同時売上フラグ

英字（boolean）

- true : 与信同時売上
- false : 与信のみ
serviceOptionType="barcode"（バーコード決済） ： 指定任意（※1）
serviceOptionType="online"（オンライン決済）（※2）
（エージェント接続） ： 指定できません（※3）
（PayPay直接接続） ： 指定任意（※4）
※1 指定可能な値は"true"のみ。未指定の場合は、"true"を設定します。
※2 accountingType="1"（随時決済）で指定があった場合には指定値を無視して処理します。
※3 指定があった場合には指定値を無視して処理します。
※4 未指定の場合は、"false"を設定します。 onlinePaymentType="1"（スマートペイメント）で指定があった場合には指定値を無視して処理します。

##### 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