# class Veritrans::Tercerog::Mdk::PaypayAuthorizeRequestDto

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

@author

  VeriTrans Inc.

### Constants

SERVICE_COMMAND

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

SERVICE_TYPE

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

### Public Class Methods

new() click to toggle source

### コンストラクタ¶ ↑

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 17
    def initialize
      @service_type = SERVICE_TYPE
      @service_command = SERVICE_COMMAND
    end

### Public Instance Methods

accounting_type() click to toggle source

### 課金種別を取得する¶ ↑

@return

  課金種別

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 99
    def accounting_type
      @accounting_type = nil unless instance_variable_defined?(:@accounting_type)
      @accounting_type
    end

accounting_type=(accounting_type) click to toggle source

### 課金種別を設定する¶ ↑

- 0:都度決済

- 1:随時決済

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

@param

  #accounting_type 課金種別

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 117
    def accounting_type=(accounting_type)
      @accounting_type = accounting_type
    end

amount() click to toggle source

### 決済金額を取得する¶ ↑

@return

  決済金額

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 146
    def amount
      @amount = nil unless instance_variable_defined?(:@amount)
      @amount
    end

amount=(amount) click to toggle source

### 決済金額を設定する¶ ↑

決済金額を指定します。

- 1 以上かつ 9999999(7桁) 以下

accountingType=“1”（随時決済） ： 指定できません

@param

  amount 決済金額

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 159
    def amount=(amount)
      @amount = amount
    end

cancel_url() click to toggle source

### 決済キャンセル時URLを取得する¶ ↑

@return

  決済キャンセル時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 355
    def cancel_url
      @cancel_url = nil unless instance_variable_defined?(:@cancel_url)
      @cancel_url
    end

cancel_url=(cancel_url) click to toggle source

### 決済キャンセル時URLを設定する¶ ↑

決済キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定します。

serviceOptionType=“barcode”（バーコード決済） ： 指定できません serviceOptionType=“online”（オンライン決済） ： 指定任意※ ※onlinePaymentType=“1”,“2”（スマートペイメント） ： 指定できません ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

@param

  #cancel_url 決済キャンセル時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 370
    def cancel_url=(cancel_url)
      @cancel_url = cancel_url
    end

error_url() click to toggle source

### 決済エラー時URLを取得する¶ ↑

@return

  決済エラー時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 378
    def error_url
      @error_url = nil unless instance_variable_defined?(:@error_url)
      @error_url
    end

error_url=(error_url) click to toggle source

### 決済エラー時URLを設定する¶ ↑

決済キャンセルエラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。

serviceOptionType=“barcode”（バーコード決済） ： 指定できません serviceOptionType=“online”（オンライン決済） ： 指定任意※ ※onlinePaymentType=“1”,“2”（スマートペイメント） ： 指定できません ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

@param

  #error_url 決済エラー時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 393
    def error_url=(error_url)
      @error_url = error_url
    end

extend_parameter_type() click to toggle source

### 拡張パラメータフラグを取得する¶ ↑

@return

  拡張パラメータフラグ

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 471
    def extend_parameter_type
      @extend_parameter_type = nil unless instance_variable_defined?(:@extend_parameter_type)
      @extend_parameter_type
    end

extend_parameter_type=(extend_parameter_type) click to toggle source

### 拡張パラメータフラグを設定する¶ ↑

応答電文、結果通知およびリダイレクトする時のパラメータの設定タイプを指定します。

- 0 : デフォルトタイプの設定

- 1 : 拡張タイプの設定（今後パラメタが追加される可能性があります。）

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

@param

  #extend_parameter_type 拡張パラメータフラグ

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 488
    def extend_parameter_type=(extend_parameter_type)
      @extend_parameter_type = extend_parameter_type
    end

item_id() click to toggle source

### 商品IDを取得する¶ ↑

@return

  商品ID

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 310
    def item_id
      @item_id = nil unless instance_variable_defined?(:@item_id)
      @item_id
    end

item_id=(item_id) click to toggle source

### 商品IDを設定する¶ ↑

マーチャントシステム内で商品やサービスを特定するID

serviceOptionType=“barcode”（バーコード決済） ： 指定できません serviceOptionType=“online”（オンライン決済）： 指定必須※ ※onlinePaymentType=“1”,“2”（スマートペイメント）の場合は指定任意

@param

  #item_id 商品ID

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 324
    def item_id=(item_id)
      @item_id = item_id
    end

item_name() click to toggle source

### 商品名を取得する¶ ↑

@return

  商品名

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 286
    def item_name
      @item_name = nil unless instance_variable_defined?(:@item_name)
      @item_name
    end

item_name=(item_name) click to toggle source

### 商品名を設定する¶ ↑

商品名を指定します。

- 最大文字数

serviceOptionType=“barcode”（バーコード決済） ： 128byte 　　serviceOptionType=“online”（オンライン決済） ： 40byte

serviceOptionType=“barcode”（バーコード決済） ： 指定必須 serviceOptionType=“online”（オンライン決済） ： 指定任意

@param

  #item_name 商品名

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 302
    def item_name=(item_name)
      @item_name = item_name
    end

one_time_code() click to toggle source

### ワンタイムコードを取得する¶ ↑

@return

  ワンタイムコード

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 125
    def one_time_code
      @one_time_code = nil unless instance_variable_defined?(:@one_time_code)
      @one_time_code
    end

one_time_code=(one_time_code) click to toggle source

### ワンタイムコードを設定する¶ ↑

ユーザの端末から読み取ったバーコード情報を指定します。

serviceOptionType=“barcode”（バーコード決済） ： 指定必須 serviceOptionType=“online”（オンライン決済） ： 指定できません

@param

  #one_time_code ワンタイムコード

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 138
    def one_time_code=(one_time_code)
      @one_time_code = one_time_code
    end

online_payment_type() click to toggle source

### オンライン決済タイプを取得する¶ ↑

@return

  オンライン決済タイプ

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 496
    def online_payment_type
      @online_payment_type = nil unless instance_variable_defined?(:@online_payment_type)
      @online_payment_type
    end

online_payment_type=(online_payment_type) click to toggle source

### オンライン決済タイプを設定する¶ ↑

- “1”: 決済サービス(スマートペイメント)

- “2”: 集金サービス(スマートペイメント)

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

@param

  #online_payment_type オンライン決済タイプ

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 513
    def online_payment_type=(online_payment_type)
      @online_payment_type = online_payment_type
    end

order_id() click to toggle source

### 取引IDを取得する¶ ↑

@return

  取引ID

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 60
    def order_id
      @order_id = nil unless instance_variable_defined?(:@order_id)
      @order_id
    end

order_id=(order_id) click to toggle source

### 取引IDを設定する¶ ↑

- マーチャント側で取引を一意に表す注文管理IDを指定します。

- 申込処理ごとに一意である必要があります。

- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。

@param

  #order_id 取引ID

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 72
    def order_id=(order_id)
      @order_id = order_id
    end

pay_timeout_datetime() click to toggle source

### 支払い可能期限を取得する¶ ↑

@return

  支払い可能期限

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 521
    def pay_timeout_datetime
      @pay_timeout_datetime = nil unless instance_variable_defined?(:@pay_timeout_datetime)
      @pay_timeout_datetime
    end

pay_timeout_datetime=(pay_timeout_datetime) click to toggle source

### 支払い可能期限を設定する¶ ↑

支払い可能期限を指定します。

serviceOptionType=“barcode”（バーコード決済） ： 指定できません serviceOptionType=“online”（オンライン決済） 　　（エージェント接続） ： 指定できません 　　（PayPay直接接続） ： 指定任意（※1） ※1 onlinePaymentType=“1”,“2”（スマートペイメント） のときのみ指定可能。

@param

  #pay_timeout_datetime 支払い可能期限

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 537
    def pay_timeout_datetime=(pay_timeout_datetime)
      @pay_timeout_datetime = pay_timeout_datetime
    end

provider() click to toggle source

### 接続先事業者を取得する¶ ↑

@return

  接続先事業者

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 423
    def provider
      @provider = nil unless instance_variable_defined?(:@provider)
      @provider
    end

provider=(provider) click to toggle source

### 接続先事業者を設定する¶ ↑

決済処理で接続する決済事業者を指定します。

- 0 : エージェントへ接続

- 1 : PayPayへ直接接続

serviceOptionType=“barcode”（バーコード決済） ： 指定できません serviceOptionType=“online”（オンライン決済） ： 指定任意※ ※未指定の場合は、加盟店登録設定で有効になっている決済事業者に接続します。

@param

  provider 接続先事業者

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 439
    def provider=(provider)
      @provider = provider
    end

push_url() click to toggle source

### プッシュ先URLを取得する¶ ↑

@return

  プッシュ先URL

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 401
    def push_url
      @push_url = nil unless instance_variable_defined?(:@push_url)
      @push_url
    end

push_url=(push_url) click to toggle source

### プッシュ先URLを設定する¶ ↑

プッシュURLを指定します。

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

@param

  #push_url プッシュ先URL

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 415
    def push_url=(push_url)
      @push_url = push_url
    end

receipt_number() click to toggle source

### レシート番号を取得する¶ ↑

@return

  レシート番号

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 244
    def receipt_number
      @receipt_number = nil unless instance_variable_defined?(:@receipt_number)
      @receipt_number
    end

receipt_number=(receipt_number) click to toggle source

### レシート番号を設定する¶ ↑

レシートに印字される番号を指定します。

serviceOptionType=“barcode”（バーコード決済） ： 指定任意 serviceOptionType=“online”（オンライン決済） ： 指定できません

@param

  #receipt_number レシート番号

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 257
    def receipt_number=(receipt_number)
      @receipt_number = receipt_number
    end

service_command() click to toggle source

### 決済サービスコマンドを取得する¶ ↑

@return

  決済サービスコマンド

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 51
    def service_command
      @service_command = nil unless instance_variable_defined?(:@service_command)
      @service_command
    end

service_option_type() click to toggle source

### サービスオプションタイプを取得する¶ ↑

@return

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

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 80
    def service_option_type
      @service_option_type = nil unless instance_variable_defined?(:@service_option_type)
      @service_option_type
    end

service_option_type=(service_option_type) click to toggle source

### サービスオプションタイプを設定する¶ ↑

- “barcode”:バーコード決済

- “online”:オンライン決済

@param

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

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 91
    def service_option_type=(service_option_type)
      @service_option_type = service_option_type
    end

service_type() click to toggle source

### 決済サービスタイプを取得する¶ ↑

@return

  決済サービスタイプ

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 42
    def service_type
      @service_type = nil unless instance_variable_defined?(:@service_type)
      @service_type
    end

settle_biz_code() click to toggle source

### 決済事業者コードを取得する¶ ↑

@return

  決済事業者コード

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 265
    def settle_biz_code
      @settle_biz_code = nil unless instance_variable_defined?(:@settle_biz_code)
      @settle_biz_code
    end

settle_biz_code=(settle_biz_code) click to toggle source

### 決済事業者コードを設定する¶ ↑

決済事業者コードを指定します。

serviceOptionType=“barcode”（バーコード決済） ： 指定任意 serviceOptionType=“online”（オンライン決済） ： 指定できません

@param

  #settle_biz_code 決済事業者コード

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 278
    def settle_biz_code=(settle_biz_code)
      @settle_biz_code = settle_biz_code
    end

store_id() click to toggle source

### 店舗IDを取得する¶ ↑

@return

  店舗ID

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 196
    def store_id
      @store_id = nil unless instance_variable_defined?(:@store_id)
      @store_id
    end

store_id=(store_id) click to toggle source

### 店舗IDを設定する¶ ↑

店舗IDを指定します。

- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。

serviceOptionType=“barcode”（バーコード決済） ： 指定必須 serviceOptionType=“online”（オンライン決済） 　　（エージェント接続） ： 指定できません 　　（PayPay直接接続） ： 指定任意

@param

  #store_id 店舗ID

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 212
    def store_id=(store_id)
      @store_id = store_id
    end

success_url() click to toggle source

### 決済完了時URLを取得する¶ ↑

@return

  決済完了時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 332
    def success_url
      @success_url = nil unless instance_variable_defined?(:@success_url)
      @success_url
    end

success_url=(success_url) click to toggle source

### 決済完了時URLを設定する¶ ↑

決済完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。

serviceOptionType=“barcode”（バーコード決済） ： 指定できません serviceOptionType=“online”（オンライン決済） ： 指定任意※ ※onlinePaymentType=“1”,“2”（スマートペイメント） ： 指定できません ※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

@param

  #success_url 決済完了時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 347
    def success_url=(success_url)
      @success_url = success_url
    end

terminal_id() click to toggle source

### 店舗端末IDを取得する¶ ↑

@return

  店舗端末ID

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 220
    def terminal_id
      @terminal_id = nil unless instance_variable_defined?(:@terminal_id)
      @terminal_id
    end

terminal_id=(terminal_id) click to toggle source

### 店舗端末IDを設定する¶ ↑

店舗端末IDを指定します。

- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。

serviceOptionType=“barcode”（バーコード決済） ： 指定必須 serviceOptionType=“online”（オンライン決済） 　　（エージェント接続） ： 指定できません 　　（PayPay直接接続） ： 指定任意

@param

  #terminal_id 店舗端末ID

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 236
    def terminal_id=(terminal_id)
      @terminal_id = terminal_id
    end

transition_type() click to toggle source

### 遷移種別を取得する¶ ↑

@return

  遷移種別

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 447
    def transition_type
      @transition_type = nil unless instance_variable_defined?(:@transition_type)
      @transition_type
    end

transition_type=(transition_type) click to toggle source

### 遷移種別を設定する¶ ↑

ユーザ導線における外部ブラウザの起動を回避するかどうかを指定します。

- 1 : アプリから遷移(WebLink)

- 2 : アプリから遷移(DeepLink)

serviceOptionType=“barcode”（バーコード決済） ： 指定できません serviceOptionType=“online”（オンライン決済） ： 指定任意※ ※accountingType=“1”（随時決済） ： 指定できません

@param

  #transition_type 遷移種別

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 463
    def transition_type=(transition_type)
      @transition_type = transition_type
    end

with_capture() click to toggle source

### 与信同時売上フラグを取得する¶ ↑

@return

  与信同時売上フラグ

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 167
    def with_capture
      @with_capture = nil unless instance_variable_defined?(:@with_capture)
      @with_capture
    end

with_capture=(with_capture) click to toggle source

### 与信同時売上フラグを設定する¶ ↑

- true : 与信同時売上

- false : 与信のみ

serviceOptionType=“barcode”（バーコード決済） ： 指定任意（※1） serviceOptionType=“online”（オンライン決済）（※2） 　　（エージェント接続） ： 指定できません（※3） 　　（PayPay直接接続） ： 指定任意（※4）

※1 指定可能な値は“true”のみ。未指定の場合は、“true”を設定します。 ※2 accountingType=“1”（随時決済）で指定があった場合には指定値を無視して処理します。 ※3 指定があった場合には指定値を無視して処理します。 ※4 未指定の場合は、“false”を設定します。 onlinePaymentType=“1”,“2”（スマートペイメント）で指定があった場合には指定値を無視して処理します。

@param

  #with_capture 与信同時売上フラグ

    # File tgMdk/lib/tg_mdk/mdk_dto/paypay_authorize_request_dto.rb, line 188
    def with_capture=(with_capture)
      @with_capture = with_capture
    end