# class Veritrans::Tercerog::Mdk::EmAuthorizeRequestDto

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

@author

  VeriTrans Inc.

### Constants

SERVICE_COMMAND

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

SERVICE_TYPE

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

### Public Class Methods

new() click to toggle source

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

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

### Public Instance Methods

amount() click to toggle source

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

@return

  決済金額

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

amount=(amount) click to toggle source

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

- 支払金額となります。

- 例）2100

@param

  amount 決済金額

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

cancel_limit() click to toggle source

### 支払取消期限を取得する¶ ↑

@return

  支払取消期限

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 504
    def cancel_limit
      @cancel_limit = nil unless instance_variable_defined?(:@cancel_limit)
      @cancel_limit
    end

cancel_limit=(cancel_limit) click to toggle source

### 支払取消期限を設定する¶ ↑

- 決済後、該当の支払を返金（取消）することができる期限。

- YYYYMMDDhhmmss の形式

- 例）20060901235959

@param

  #cancel_limit 支払取消期限

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 516
    def cancel_limit=(cancel_limit)
      @cancel_limit = cancel_limit
    end

cancel_url() click to toggle source

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

@return

  キャンセルURL

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

cancel_url=(cancel_url) click to toggle source

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

- PaSoRi決済時、確認画面等でキャンセルボタンが押された場合に遷移されるURL

@param

  #cancel_url キャンセルURL

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

complete_mail_add_info() click to toggle source

### 完了メール付加情報を取得する¶ ↑

@return

  完了メール付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 226
    def complete_mail_add_info
      @complete_mail_add_info = nil unless instance_variable_defined?(:@complete_mail_add_info)
      @complete_mail_add_info
    end

complete_mail_add_info=(complete_mail_add_info) click to toggle source

### 完了メール付加情報を設定する¶ ↑

- 決済完了メールに追加される文字列（遷移先URL 等）

@param

  #complete_mail_add_info 完了メール付加情報

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

complete_mail_flag() click to toggle source

### 完了メール送信要否を取得する¶ ↑

@return

  完了メール送信要否

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 262
    def complete_mail_flag
      @complete_mail_flag = nil unless instance_variable_defined?(:@complete_mail_flag)
      @complete_mail_flag
    end

complete_mail_flag=(complete_mail_flag) click to toggle source

### 完了メール送信要否を設定する¶ ↑

- 決済完了時にメールを送信するか否かを設定します。

- 0： 送信不要　1： 送信要

@param

  #complete_mail_flag 完了メール送信要否

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 273
    def complete_mail_flag=(complete_mail_flag)
      @complete_mail_flag = complete_mail_flag
    end

complete_notice_url() click to toggle source

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

@return

  決済完了通知URL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 375
    def complete_notice_url
      @complete_notice_url = nil unless instance_variable_defined?(:@complete_notice_url)
      @complete_notice_url
    end

complete_notice_url=(complete_notice_url) click to toggle source

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

- Edy Viewer にて支払いを完了した後に遷移するURL

@param

  #complete_notice_url 決済完了通知URL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 385
    def complete_notice_url=(complete_notice_url)
      @complete_notice_url = complete_notice_url
    end

complete_return_kind() click to toggle source

### 決済完了戻り先種別を取得する¶ ↑

@return

  決済完了戻り先種別

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 337
    def complete_return_kind
      @complete_return_kind = nil unless instance_variable_defined?(:@complete_return_kind)
      @complete_return_kind
    end

complete_return_kind=(complete_return_kind) click to toggle source

### 決済完了戻り先種別を設定する¶ ↑

- モバイルSuica でアプリ終了時に遷移する先の種別

- 1： ローカルメニュー

- 2： モバイルSuica アプリを終了し「決済完了戻り先URL」へ遷移

@param

  #complete_return_kind 決済完了戻り先種別

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 349
    def complete_return_kind=(complete_return_kind)
      @complete_return_kind = complete_return_kind
    end

complete_return_url() click to toggle source

### 決済完了戻り先URLを取得する¶ ↑

@return

  決済完了戻り先URL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 357
    def complete_return_url
      @complete_return_url = nil unless instance_variable_defined?(:@complete_return_url)
      @complete_return_url
    end

complete_return_url=(complete_return_url) click to toggle source

### 決済完了戻り先URLを設定する¶ ↑

- モバイルSuicaでアプリ終了時に遷移する先のURL

@param

  #complete_return_url 決済完了戻り先URL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 367
    def complete_return_url=(complete_return_url)
      @complete_return_url = complete_return_url
    end

complete_screen_add_info() click to toggle source

### 完了画面付加情報を取得する¶ ↑

@return

  完了画面付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 300
    def complete_screen_add_info
      @complete_screen_add_info = nil unless instance_variable_defined?(:@complete_screen_add_info)
      @complete_screen_add_info
    end

complete_screen_add_info=(complete_screen_add_info) click to toggle source

### 完了画面付加情報を設定する¶ ↑

- 決済完了画面に表示する付加情報を設定します。

- モバイルSuica で決済完了画面に表示される文字列

@param

  #complete_screen_add_info 完了画面付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 311
    def complete_screen_add_info=(complete_screen_add_info)
      @complete_screen_add_info = complete_screen_add_info
    end

confirm_screen_add_info() click to toggle source

### 内容確認画面付加情報を取得する¶ ↑

@return

  内容確認画面付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 281
    def confirm_screen_add_info
      @confirm_screen_add_info = nil unless instance_variable_defined?(:@confirm_screen_add_info)
      @confirm_screen_add_info
    end

confirm_screen_add_info=(confirm_screen_add_info) click to toggle source

### 内容確認画面付加情報を設定する¶ ↑

- 内容確認画面に表示する付加情報を設定します。

- モバイルSuica で決済内容確認画面に表示される文字列

@param

  #confirm_screen_add_info 内容確認画面付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 292
    def confirm_screen_add_info=(confirm_screen_add_info)
      @confirm_screen_add_info = confirm_screen_add_info
    end

failure_url() click to toggle source

### 失敗時URLを取得する¶ ↑

@return

  失敗時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 448
    def failure_url
      @failure_url = nil unless instance_variable_defined?(:@failure_url)
      @failure_url
    end

failure_url=(failure_url) click to toggle source

### 失敗時URLを設定する¶ ↑

- PaSoRi決済時、決済が失敗した場合に遷移されるURL

@param

  #failure_url 失敗時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 458
    def failure_url=(failure_url)
      @failure_url = failure_url
    end

forward_mail_flag() click to toggle source

### 転送メール送信要否を取得する¶ ↑

@return

  転送メール送信要否

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 168
    def forward_mail_flag
      @forward_mail_flag = nil unless instance_variable_defined?(:@forward_mail_flag)
      @forward_mail_flag
    end

forward_mail_flag=(forward_mail_flag) click to toggle source

### 転送メール送信要否を設定する¶ ↑

- 決済依頼メール、決済完了メールのコピーメール又はBCCメールをマーチャントメールアドレス（merchant_mail_addr）に送信するか否かを設定します。

- 0： 送信不要

- 1： 送信要

@param

  #forward_mail_flag 転送メール送信要否

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 180
    def forward_mail_flag=(forward_mail_flag)
      @forward_mail_flag = forward_mail_flag
    end

free() click to toggle source

### 備考を取得する¶ ↑

@return

  備考

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 412
    def free
      @free = nil unless instance_variable_defined?(:@free)
      @free
    end

free=(free) click to toggle source

### 備考を設定する¶ ↑

- 備考(商品詳細など)

@param

  free 備考

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 422
    def free=(free)
      @free = free
    end

hiragana_id() click to toggle source

### ひらがなIDを取得する¶ ↑

@return

  ひらがなID

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 560
    def hiragana_id
      @hiragana_id = nil unless instance_variable_defined?(:@hiragana_id)
      @hiragana_id
    end

hiragana_id=(hiragana_id) click to toggle source

### ひらがなIDを設定する¶ ↑

- ユーザが入力したひらがなID

- BitCash決済のみ使用

@param

  #hiragana_id ひらがなID

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 571
    def hiragana_id=(hiragana_id)
      @hiragana_id = hiragana_id
    end

mail_addr() click to toggle source

### メールアドレスを取得する¶ ↑

@return

  メールアドレス

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 150
    def mail_addr
      @mail_addr = nil unless instance_variable_defined?(:@mail_addr)
      @mail_addr
    end

mail_addr=(mail_addr) click to toggle source

### メールアドレスを設定する¶ ↑

- 決済依頼メールを送信する消費者の携帯電話メールアドレスとなります。

@param

  #mail_addr メールアドレス

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 160
    def mail_addr=(mail_addr)
      @mail_addr = mail_addr
    end

member_store_settle_entry_time() click to toggle source

### 加盟店決済受付時刻を取得する¶ ↑

@return

  加盟店決済受付時刻

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 484
    def member_store_settle_entry_time
      @member_store_settle_entry_time = nil unless instance_variable_defined?(:@member_store_settle_entry_time)
      @member_store_settle_entry_time
    end

member_store_settle_entry_time=(member_store_settle_entry_time) click to toggle source

### 加盟店決済受付時刻を設定する¶ ↑

- 加盟店側で当該決済を受付た時刻

- YYYYMMDDhhmmss の形式

- 例）20060901235959

@param

  #member_store_settle_entry_time 加盟店決済受付時刻

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 496
    def member_store_settle_entry_time=(member_store_settle_entry_time)
      @member_store_settle_entry_time = member_store_settle_entry_time
    end

merchant_mail_addr() click to toggle source

### マーチャントメールアドレスを取得する¶ ↑

@return

  マーチャントメールアドレス

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 188
    def merchant_mail_addr
      @merchant_mail_addr = nil unless instance_variable_defined?(:@merchant_mail_addr)
      @merchant_mail_addr
    end

merchant_mail_addr=(merchant_mail_addr) click to toggle source

### マーチャントメールアドレスを設定する¶ ↑

- 決済依頼メール、決済完了メールのコピーメール又はBCC メール先マーチャントメールアドレス。

- 以下の文字も使用できます。

- “.”(ドット)、“-”(ハイフン)、“_”(アンダースコア)、“@”(アットマーク) ||= nil

@param

  #merchant_mail_addr マーチャントメールアドレス

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 200
    def merchant_mail_addr=(merchant_mail_addr)
      @merchant_mail_addr = merchant_mail_addr
    end

option_params() click to toggle source

### 拡張パラメータリストを取得する¶ ↑

@return

  拡張パラメータリスト

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 599
    def option_params
      @option_params = nil unless instance_variable_defined?(:@option_params)
      @option_params
    end

option_params=(option_params) click to toggle source

### 拡張パラメータリストを設定する¶ ↑

@param

  #option_params 拡張パラメータリスト

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 608
    def option_params=(option_params)
      @option_params = option_params
    end

order_id() click to toggle source

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

@return

  取引ID

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

order_id=(order_id) click to toggle source

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

- ※Suicaに限り40桁を上限とする。

@param

  #order_id 取引ID

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

rating() click to toggle source

### 商品レイティングを取得する¶ ↑

@return

  商品レイティング

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 579
    def rating
      @rating = nil unless instance_variable_defined?(:@rating)
      @rating
    end

rating=(rating) click to toggle source

### 商品レイティングを設定する¶ ↑

- 商品レイティングによって以下の値を指定

- STの場合：19 EXの場合：99

- BitCash決済のみ使用

@param

  rating 商品レイティング

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 591
    def rating=(rating)
      @rating = rating
    end

request_mail_add_info() click to toggle source

### 依頼メール付加情報を取得する¶ ↑

@return

  依頼メール付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 208
    def request_mail_add_info
      @request_mail_add_info = nil unless instance_variable_defined?(:@request_mail_add_info)
      @request_mail_add_info
    end

request_mail_add_info=(request_mail_add_info) click to toggle source

### 依頼メール付加情報を設定する¶ ↑

- 支払依頼メールに追加される文字列（商品情報等）です。

@param

  #request_mail_add_info 依頼メール付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 218
    def request_mail_add_info=(request_mail_add_info)
      @request_mail_add_info = request_mail_add_info
    end

sales_type() click to toggle source

### 販売区分を取得する¶ ↑

@return

  販売区分

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 393
    def sales_type
      @sales_type = nil unless instance_variable_defined?(:@sales_type)
      @sales_type
    end

sales_type=(sales_type) click to toggle source

### 販売区分を設定する¶ ↑

- Edy で任意に登録する販売区分

- 1：物販、　2：デジタル

@param

  #sales_type 販売区分

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 404
    def sales_type=(sales_type)
      @sales_type = sales_type
    end

screen_title() click to toggle source

### 画面タイトルを取得する¶ ↑

@return

  画面タイトル

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 319
    def screen_title
      @screen_title = nil unless instance_variable_defined?(:@screen_title)
      @screen_title
    end

screen_title=(screen_title) click to toggle source

### 画面タイトルを設定する¶ ↑

- モバイルSuica で決済完了画面・決済確認画面等で「商品・サービス名」に表示されます。

@param

  #screen_title 画面タイトル

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 329
    def screen_title=(screen_title)
      @screen_title = screen_title
    end

service_command() click to toggle source

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

@return

  決済サービスコマンド

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 49
    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/em_authorize_request_dto.rb, line 58
    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

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

- 決済サービスのオプションを指定します

- 例）

- モバイルEdy： “edy-mobile”

- パソリ(PC)： “edy-pc”

- モバイルEdyダイレクト： “edy-direct”

- Suicaモバイル(メール)： “suica-mobile-mail”

- モバイルSuicaアプリ： “suica-mobile-app”

- Suicaメール決済(PC)： “suica-pc-mail”

- Suica PCアプリ： “suica-pc-app”

- モバイルWaonアプリ決済：waon-mobile

- パソリ(PC)：waon-pc

- BitCash決済：bitcash-api

@param

  #service_option_type 決済サービスオプション

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 80
    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/em_authorize_request_dto.rb, line 40
    def service_type
      @service_type = nil unless instance_variable_defined?(:@service_type)
      @service_type
    end

settlement_limit() click to toggle source

### 決済期限を取得する¶ ↑

@return

  決済期限

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 129
    def settlement_limit
      @settlement_limit = nil unless instance_variable_defined?(:@settlement_limit)
      @settlement_limit
    end

settlement_limit=(settlement_limit) click to toggle source

### 決済期限を設定する¶ ↑

- 支払の期限となります。

- 支払期限を過ぎた決済については、消費者はアプリ上から確認できます。

- YYYYMMDDhhmmss の形式

- 例）20060901235959

@param

  #settlement_limit 決済期限

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 142
    def settlement_limit=(settlement_limit)
      @settlement_limit = settlement_limit
    end

shop_name() click to toggle source

### ショップ名を取得する¶ ↑

@return

  ショップ名

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

shop_name=(shop_name) click to toggle source

### ショップ名を設定する¶ ↑

- Edy で使用する店舗名

@param

  #shop_name ショップ名

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 254
    def shop_name=(shop_name)
      @shop_name = shop_name
    end

success_url() click to toggle source

### 成功時URLを取得する¶ ↑

@return

  成功時URL

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

success_url=(success_url) click to toggle source

### 成功時URLを設定する¶ ↑

- PaSoRi決済時、決済が成功した場合に遷移されるURL

@param

  #success_url 成功時URL

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

transaction_kind() click to toggle source

### 取引種別を取得する¶ ↑

@return

  取引種別

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 524
    def transaction_kind
      @cancel_transaction_kindlimit = nil unless instance_variable_defined?(:@cancel_transaction_kindlimit)
      @cancel_transaction_kindlimit
    end

transaction_kind=(transaction_kind) click to toggle source

### 取引種別を設定する¶ ↑

@param

  #transaction_kind 取引種別

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 533
    def transaction_kind=(transaction_kind)
      @transaction_kind = transaction_kind
    end

user_id() click to toggle source

### ユーザIDを取得する¶ ↑

@return

  ユーザID

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 541
    def user_id
      @user_id = nil unless instance_variable_defined?(:@user_id)
      @user_id
    end

user_id=(user_id) click to toggle source

### ユーザIDを設定する¶ ↑

- 取引対象利用者を一意に特定可能なIDを指定します。

- RFC2822に準拠する。

@param

  #user_id ユーザID

    # File tgMdk/lib/tg_mdk/mdk_dto/em_authorize_request_dto.rb, line 552
    def user_id=(user_id)
      @user_id = user_id
    end