# class Veritrans::Tercerog::Mdk::EmRefundRequestDto

# 決済サービスタイプ：電子マネー、コマンド名：返金の要求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_refund_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_refund_request_dto.rb, line 98
    def amount
      @amount = nil unless instance_variable_defined?(:@amount)
      @amount
    end

amount=(amount) click to toggle source

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

- 返金金額となります。決済金額以下を指定する必要があります。

- 例）1800

@param

  amount 金額

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

cancel_mail_addr() click to toggle source

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

@return

  取消通知メールアドレス

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 231
    def cancel_mail_addr
      @cancel_mail_addr = nil unless instance_variable_defined?(:@cancel_mail_addr)
      @cancel_mail_addr
    end

cancel_mail_addr=(cancel_mail_addr) click to toggle source

### 取消通知メールアドレスを設定する¶ ↑

- 返金・新規返金を利用者に通知するためのメールアドレスを指定します。

@param

  #cancel_mail_addr 取消通知メールアドレス

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 241
    def cancel_mail_addr=(cancel_mail_addr)
      @cancel_mail_addr = cancel_mail_addr
    end

cancel_url() click to toggle source

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

@return

  キャンセルURL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 415
    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_refund_request_dto.rb, line 425
    def cancel_url=(cancel_url)
      @cancel_url = cancel_url
    end

complete_screen_add_info() click to toggle source

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

@return

  完了画面付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 306
    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_refund_request_dto.rb, line 317
    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_refund_request_dto.rb, line 287
    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_refund_request_dto.rb, line 298
    def confirm_screen_add_info=(confirm_screen_add_info)
      @confirm_screen_add_info = confirm_screen_add_info
    end

edy_gift_name() click to toggle source

### Edy個別ギフト名称を取得する¶ ↑

@return

  Edy個別ギフト名称

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 361
    def edy_gift_name
      @edy_gift_name = nil unless instance_variable_defined?(:@edy_gift_name)
      @edy_gift_name
    end

edy_gift_name=(edy_gift_name) click to toggle source

### Edy個別ギフト名称を設定する¶ ↑

- Edyギフト画面で表示されるギフト名称の後に、個別ギフト名称を指定します。

@param

  #edy_gift_name Edy個別ギフト名称

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 371
    def edy_gift_name=(edy_gift_name)
      @edy_gift_name = edy_gift_name
    end

failure_url() click to toggle source

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

@return

  失敗時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 397
    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_refund_request_dto.rb, line 407
    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_refund_request_dto.rb, line 191
    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_refund_request_dto.rb, line 203
    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_refund_request_dto.rb, line 343
    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_refund_request_dto.rb, line 353
    def free=(free)
      @free = free
    end

mail_addr() click to toggle source

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

@return

  メールアドレス

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 173
    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_refund_request_dto.rb, line 183
    def mail_addr=(mail_addr)
      @mail_addr = mail_addr
    end

merchant_mail_addr() click to toggle source

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

@return

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

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 211
    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_refund_request_dto.rb, line 223
    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_refund_request_dto.rb, line 433
    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_refund_request_dto.rb, line 442
    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_refund_request_dto.rb, line 77
    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を指定します。

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

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

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

@param

  #order_id 取引ID

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

order_kind() click to toggle source

### オーダー種別を取得する¶ ↑

@return

  オーダー種別

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 117
    def order_kind
      @order_kind = nil unless instance_variable_defined?(:@order_kind)
      @order_kind
    end

order_kind=(order_kind) click to toggle source

### オーダー種別を設定する¶ ↑

- 返金請求オーダーの種別を指定します。

@param

  #order_kind オーダー種別

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 127
    def order_kind=(order_kind)
      @order_kind = order_kind
    end

refund_order_id() click to toggle source

### 返金対象取引IDを取得する¶ ↑

@return

  返金対象取引ID

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 135
    def refund_order_id
      @refund_order_id = nil unless instance_variable_defined?(:@refund_order_id)
      @refund_order_id
    end

refund_order_id=(refund_order_id) click to toggle source

### 返金対象取引IDを設定する¶ ↑

- 返金を依頼する決済請求の取引IDを指定します。

@param

  #refund_order_id 返金対象取引ID

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 145
    def refund_order_id=(refund_order_id)
      @refund_order_id = refund_order_id
    end

request_mail_add_info() click to toggle source

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

@return

  依頼メール付加情報

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 249
    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_refund_request_dto.rb, line 259
    def request_mail_add_info=(request_mail_add_info)
      @request_mail_add_info = request_mail_add_info
    end

request_mail_flag() click to toggle source

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

@return

  依頼メール送信要否

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 267
    def request_mail_flag
      @request_mail_flag = nil unless instance_variable_defined?(:@request_mail_flag)
      @request_mail_flag
    end

request_mail_flag=(request_mail_flag) click to toggle source

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

- Suicaポケット発行メールの送信要否を設定します。

- 0： 送信不要

- 1： 送信要

@param

  #request_mail_flag 依頼メール送信要否

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 279
    def request_mail_flag=(request_mail_flag)
      @request_mail_flag = request_mail_flag
    end

screen_title() click to toggle source

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

@return

  画面タイトル

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 325
    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_refund_request_dto.rb, line 335
    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_refund_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_refund_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”

@param

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

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 69
    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_refund_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_refund_request_dto.rb, line 153
    def settlement_limit
      @settlement_limit = nil unless instance_variable_defined?(:@settlement_limit)
      @settlement_limit
    end

settlement_limit=(settlement_limit) click to toggle source

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

- 返金・新規返金の受取期限となります。

- YYYYMMDDhhmmssの形式

- 例）20060901235901

@param

  #settlement_limit 決済期限

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

success_url() click to toggle source

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

@return

  成功時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/em_refund_request_dto.rb, line 379
    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_refund_request_dto.rb, line 389
    def success_url=(success_url)
      @success_url = success_url
    end