class Veritrans::Tercerog::Mdk::TenpayAuthorizeRequestDto

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

@author

VeriTrans Inc.

Constants

SERVICE_COMMAND

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

SERVICE_TYPE

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

Public Class Methods

new() click to toggle source

コンストラクタ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_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/tenpay_authorize_request_dto.rb, line 99
def amount
  @amount = nil unless instance_variable_defined?(:@amount)
  @amount
end
amount=(amount) click to toggle source

決済金額を設定する

決済金額を指定します。

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

@param

amount 決済金額

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 110
def amount=(amount)
  @amount = amount
end
authorization_code() click to toggle source

承認コードを取得する

@return

承認コード

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 213
def authorization_code
  @authorization_code = nil unless instance_variable_defined?(:@authorization_code)
  @authorization_code
end
authorization_code=(authorization_code) click to toggle source

承認コードを設定する

バーコード決済を利用する際のQRコード、バーコードの値を指定します。

serviceOptionType=“barcode”:指定必須 上記以外、指定不可。

@param

#authorization_code 承認コード

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 226
def authorization_code=(authorization_code)
  @authorization_code = authorization_code
end
cancel_url() click to toggle source

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

@return

決済キャンセル時URL

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 408
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=“scancode”、かつ、scancodeType=“1”:指定任意 上記以外、指定不可。 ※ 未指定の場合は、マーチャント登録時に設定した値を使用

@param

#cancel_url 決済キャンセル時URL

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 422
def cancel_url=(cancel_url)
  @cancel_url = cancel_url
end
device_info() click to toggle source

デバイス情報を取得する

@return

デバイス情報

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 137
def device_info
  @device_info = nil unless instance_variable_defined?(:@device_info)
  @device_info
end
device_info=(device_info) click to toggle source

デバイス情報を設定する

デバイス情報を指定します。

  • 最大文字数:32byte

@param

#device_info デバイス情報

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 148
def device_info=(device_info)
  @device_info = device_info
end
error_url() click to toggle source

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

@return

決済エラー時URL

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 430
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=“scancode”、かつ、scancodeType=“1”:指定任意 上記以外、指定不可。 ※ 未指定の場合は、マーチャント登録時に設定した値を使用

@param

#error_url 決済エラー時URL

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 444
def error_url=(error_url)
  @error_url = error_url
end
item_detail() click to toggle source

商品詳細を取得する

@return

商品詳細

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 175
def item_detail
  @item_detail = nil unless instance_variable_defined?(:@item_detail)
  @item_detail
end
item_detail=(item_detail) click to toggle source

商品詳細を設定する

商品詳細

  • 最大文字数:1000byte

@param

#item_detail 商品詳細

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 186
def item_detail=(item_detail)
  @item_detail = item_detail
end
item_label() click to toggle source

商品タグを取得する

@return

商品タグ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 194
def item_label
  @item_label = nil unless instance_variable_defined?(:@item_label)
  @item_label
end
item_label=(item_label) click to toggle source

商品タグを設定する

商品に付与できるタグ情報。

  • 最大文字数:32byte

@param

#item_label 商品タグ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 205
def item_label=(item_label)
  @item_label = item_label
end
item_name() click to toggle source

商品名を取得する

@return

商品名

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 156
def item_name
  @item_name = nil unless instance_variable_defined?(:@item_name)
  @item_name
end
item_name=(item_name) click to toggle source

商品名を設定する

商品名

  • 最大文字数:32byte

@param

#item_name 商品名

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 167
def item_name=(item_name)
  @item_name = item_name
end
openid() click to toggle source

ユーザータグを取得する

@return

ユーザータグ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 342
def openid
  @openid = nil unless instance_variable_defined?(:@openid)
  @openid
end
openid=(openid) click to toggle source

ユーザータグを設定する

ユーザータグを指定します。

serviceOptionType=“scancode”、かつ、scancodeType=“1”:指定任意 ※subOpenidが未指定の場合は指定必須。 上記以外、指定不可。

@param

openid ユーザータグ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 356
def openid=(openid)
  @openid = openid
end
order_id() click to toggle source

取引IDを取得する

@return

取引ID

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_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/tenpay_authorize_request_dto.rb, line 72
def order_id=(order_id)
  @order_id = order_id
end
product_id() click to toggle source

製品IDを取得する

@return

製品ID

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 320
def product_id
  @product_id = nil unless instance_variable_defined?(:@product_id)
  @product_id
end
product_id=(product_id) click to toggle source

製品IDを設定する

製品IDを指定します。

  • 最大文字数:32byte

serviceOptionType=“scancode”、かつ、scancodeType=“0”:指定必須 上記以外、指定不可。

@param

#product_id 製品ID

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 334
def product_id=(product_id)
  @product_id = product_id
end
response_type() click to toggle source

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

@return

レスポンスタイプ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 234
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”:即時にレスポンスを返却する。

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

@param

#response_type レスポンスタイプ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 250
def response_type=(response_type)
  @response_type = response_type
end
scancode_type() click to toggle source

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

@return

スキャンコードタイプ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 296
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/tenpay_authorize_request_dto.rb, line 312
def scancode_type=(scancode_type)
  @scancode_type = scancode_type
end
service_command() click to toggle source

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

@return

決済サービスコマンド

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_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/tenpay_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”:スキャンコード決済

@param

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

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_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/tenpay_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/tenpay_authorize_request_dto.rb, line 258
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を指定します。

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

@param

#store_id 店舗ID

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 269
def store_id=(store_id)
  @store_id = store_id
end
store_name() click to toggle source

店舗名を取得する

@return

店舗名

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 277
def store_name
  @store_name = nil unless instance_variable_defined?(:@store_name)
  @store_name
end
store_name=(store_name) click to toggle source

店舗名を設定する

店舗名を指定します。

  • 最大文字数:64byte

@param

#store_name 店舗名

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 288
def store_name=(store_name)
  @store_name = store_name
end
sub_openid() click to toggle source

サブユーザータグを取得する

@return

サブユーザータグ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 364
def sub_openid
  @sub_openid = nil unless instance_variable_defined?(:@sub_openid)
  @sub_openid
end
sub_openid=(sub_openid) click to toggle source

サブユーザータグを設定する

サブユーザータグを指定します。

serviceOptionType=“scancode”、かつ、scancodeType=“1”:指定任意 ※openidが未指定の場合は指定必須。 上記以外、指定不可。

@param

#sub_openid サブユーザータグ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 378
def sub_openid=(sub_openid)
  @sub_openid = sub_openid
end
success_url() click to toggle source

決済完了時URLを取得する

@return

決済完了時URL

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 386
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=“scancode”、かつ、scancodeType=“1”:指定任意 上記以外、指定不可。 ※ 未指定の場合は、マーチャント登録時に設定した値を使用

@param

#success_url 決済完了時URL

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 400
def success_url=(success_url)
  @success_url = success_url
end
with_capture() click to toggle source

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

@return

与信同時売上フラグ

# File tgMdk/lib/tg_mdk/mdk_dto/tenpay_authorize_request_dto.rb, line 118
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/tenpay_authorize_request_dto.rb, line 129
def with_capture=(with_capture)
  @with_capture = with_capture
end