# class Veritrans::Tercerog::Mdk::AlipayxAuthorizeRequestDto

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

@author

  VeriTrans Inc.

### Constants

SERVICE_COMMAND

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

SERVICE_TYPE

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

### Public Class Methods

new() click to toggle source

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

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_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/alipayx_authorize_request_dto.rb, line 100
    def amount
      @amount = nil unless instance_variable_defined?(:@amount)
      @amount
    end

amount=(amount) click to toggle source

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

決済金額を指定します。

- 1 以上かつ 999999999999(12桁) 以下

@param

  amount 決済金額

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

device_type() click to toggle source

### デバイスタイプを取得する¶ ↑

@return

  デバイスタイプ

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

device_type=(device_type) click to toggle source

### デバイスタイプを設定する¶ ↑

デバイスのタイプを指定します。 “0”：PC “1”：スマートフォン “2”：加盟店アプリ

serviceOptionType=“online”：指定任意 上記以外、指定不可。 ※未指定の場合は、0：PC

@param

  #device_type デバイスタイプ

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

error_url() click to toggle source

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

@return

  決済失敗時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 434
    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を指定します。 ※未指定の場合は管理画面(MAP)から設定した「決済失敗時URL」を使用します。 ※serviceOptionType=“online”で未指定かつ、管理画面(MAP)の対象項目も未指定の場合はエラーとなります。

※serviceOptionType=“online”の場合、指定任意 上記以外、指定不可。

@param

  #error_url 決済失敗時URL

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

identity_code() click to toggle source

### 識別コードを取得する¶ ↑

@return

  識別コード

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 162
    def identity_code
      @identity_code = nil unless instance_variable_defined?(:@identity_code)
      @identity_code
    end

identity_code=(identity_code) click to toggle source

### 識別コードを設定する¶ ↑

識別コードを指定します。 ※serviceOptionType=“barcode”：指定必須 上記以外、指定不可。

@param

  #identity_code 識別コード

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 174
    def identity_code=(identity_code)
      @identity_code = identity_code
    end

operator_id() click to toggle source

### 従業員IDを取得する¶ ↑

@return

  従業員ID

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 287
    def operator_id
      @operator_id = nil unless instance_variable_defined?(:@operator_id)
      @operator_id
    end

operator_id=(operator_id) click to toggle source

### 従業員IDを設定する¶ ↑

従業員IDを指定します。 ※半角英数字、“-”（ハイフン）、 “_”（アンダースコア）も使用可能です。 ※serviceOptionType=“online”：指定不可 上記以外、指定任意

@param

  #operator_id 従業員ID

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 300
    def operator_id=(operator_id)
      @operator_id = operator_id
    end

order_detail() click to toggle source

### 商品詳細を取得する¶ ↑

@return

  商品詳細

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 203
    def order_detail
      @order_detail = nil unless instance_variable_defined?(:@order_detail)
      @order_detail
    end

order_detail=(order_detail) click to toggle source

### 商品詳細を設定する¶ ↑

商品詳細を指定します。

- 最大文字数:

※V1…400byte ※V2…256文字 ※指定必須

@param

  #order_detail 商品詳細

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 217
    def order_detail=(order_detail)
      @order_detail = order_detail
    end

order_id() click to toggle source

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

@return

  取引ID

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_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/alipayx_authorize_request_dto.rb, line 72
    def order_id=(order_id)
      @order_id = order_id
    end

order_title() click to toggle source

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

@return

  商品名

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 182
    def order_title
      @order_title = nil unless instance_variable_defined?(:@order_title)
      @order_title
    end

order_title=(order_title) click to toggle source

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

商品名を指定します。

- 最大文字数:256byte

※V1の場合、指定必須 ※V2の場合、serviceOptionTypeが“online”の場合は指定不可、serviceOptionTypeが“online”以外の場合は指定任意

@param

  #order_title 商品名

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 195
    def order_title=(order_title)
      @order_title = order_title
    end

push_url() click to toggle source

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

@return

  プッシュURL

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 457
    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を指定します。 ※未指定の場合は管理画面(MAP)から設定した「通知URL」を使用します。

※serviceOptionType=“scancode”、“online”：指定任意 上記以外、指定不可。

@param

  #push_url プッシュURL

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

response_type() click to toggle source

### レスポンスタイプを取得する¶ ↑

@return

  レスポンスタイプ

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 138
    def response_type
      @response_type = nil unless instance_variable_defined?(:@response_type)
      @response_type
    end

response_type=(response_type) click to toggle source

### レスポンスタイプを設定する¶ ↑

レスポンスのタイプを指定します。 “0”：取引確定時にレスポンスを返却する。 “1”：即時にレスポンスを返却する。（取引確定については、Confirmコマンドを利用する）

serviceOptionType=“barcode”：指定任意 上記以外、指定不可。 ※未指定の場合は、0：取引確定時にレスポンスを返却する。

@param

  #response_type レスポンスタイプ

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 154
    def response_type=(response_type)
      @response_type = response_type
    end

scancode_type() click to toggle source

### スキャンコードタイプを取得する¶ ↑

@return

  スキャンコードタイプ

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 308
    def scancode_type
      @scancode_type = nil unless instance_variable_defined?(:@scancode_type)
      @scancode_type
    end

scancode_type=(scancode_type) click to toggle source

### スキャンコードタイプを設定する¶ ↑

シーンのタイプを指定します。 “0”：サービスプロバイダー発行QR利用。 “1”：加盟店発行QR利用。

serviceOptionType=“scancode”：指定任意 上記以外、指定不可。 ※未指定の場合は、0：サービスプロバイダー発行QR利用。

@param

  #scancode_type スキャンコードタイプ

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

service_command() click to toggle source

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

@return

  決済サービスコマンド

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_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/alipayx_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”:バーコード決済（店舗スキャン型）

- “scancode”:バーコード決済（消費者スキャン型）

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

@param

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

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

store_id() click to toggle source

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

@return

  店舗ID

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 225
    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を指定します。 ※半角英数字、“-”（ハイフン）、 “_”（アンダースコア）も使用可能です。 ※指定する値はAlipayに登録されている必要があります。 ※未指定の場合は、加盟店ID(merchantId)が設定されます。

@param

  #store_id 店舗ID

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

store_name() click to toggle source

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

@return

  店舗名

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 246
    def store_name
      @store_name = nil unless instance_variable_defined?(:@store_name)
      @store_name
    end

store_name=(store_name) click to toggle source

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

店舗名を指定します。 ※指定する値はAlipayに登録されている必要があります。 ※未指定の場合は、マーチャント登録時に設定した値を使用します。

- 最大文字数:128byte

@param

  #store_name 店舗名

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 260
    def store_name=(store_name)
      @store_name = store_name
    end

success_redirect_url() click to toggle source

### 決済成功時リダイレクトURLを取得する¶ ↑

@return

  決済成功時リダイレクトURL

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 387
    def success_redirect_url
      @success_redirect_url = nil unless instance_variable_defined?(:@success_redirect_url)
      @success_redirect_url
    end

success_redirect_url=(success_redirect_url) click to toggle source

### 決済成功時リダイレクトURLを設定する¶ ↑

決済成功時にリダイレクトするURLを指定します。 ※未指定の場合は管理画面(MAP)から設定した「決済成功リダイレクトURL」を使用します。 ※V1の場合、 serviceOptionType=“scancode”、かつ、scancodeType=“1”の場合、指定任意 ※V2の場合、 serviceOptionType=“scancode”の場合、指定任意 上記以外、指定不可。

@param

  #success_redirect_url 決済成功時リダイレクトURL

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 403
    def success_redirect_url=(success_redirect_url)
      @success_redirect_url = success_redirect_url
    end

success_url() click to toggle source

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

@return

  決済完了時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 411
    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を指定します。 ※未指定の場合は管理画面(MAP)から設定した「決済完了時URL」を使用します。 ※serviceOptionType=“online”で未指定かつ、管理画面(MAP)の対象項目も未指定の場合はエラーとなります。

※serviceOptionType=“online”の場合、指定任意 上記以外、指定不可。

@param

  #success_url 決済完了時URL

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 426
    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/alipayx_authorize_request_dto.rb, line 268
    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を指定します。 ※半角英数字、“-”（ハイフン）、 “_”（アンダースコア）も使用可能です。

@param

  #terminal_id 端末ID

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

user_agent() click to toggle source

### ユーザーエージェントを取得する¶ ↑

@return

  ユーザーエージェント

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

user_agent=(user_agent) click to toggle source

### ユーザーエージェントを設定する¶ ↑

ユーザーエージェントを指定します。

- 最大文字数:1024byte

※V1の場合、 serviceOptionType=“scancode”、かつ、scancodeType=“1”の場合、指定必須 上記以外、指定不可。 ※V2の場合、 serviceOptionType=“scancode”、かつ、scancodeType=“0”の場合、指定任意 serviceOptionType=“scancode”、かつ、scancodeType=“1”の場合、指定必須 serviceOptionType=“online”、かつ、deviceType=“1”、“2”の場合、指定必須。 上記以外、指定不可。

serviceOptionType=“online”の場合、OSの種類（Android・iOS）の判別がつくような情報を設定いただくようにお願いします。判別が不可能な場合はエラーとなります。

@param

  #user_agent ユーザーエージェント

    # File tgMdk/lib/tg_mdk/mdk_dto/alipayx_authorize_request_dto.rb, line 379
    def user_agent=(user_agent)
      @user_agent = user_agent
    end

with_capture() click to toggle source

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

@return

  与信同時売上フラグ

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

with_capture=(with_capture) click to toggle source

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

- true : 与信同時売上（設定可能な値は“true”のみです。）

※未指定の場合は、true:与信同時売上。

@param

  #with_capture 与信同時売上フラグ

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