class Veritrans::Tercerog::Mdk::PaypalCaptureRequestDto

決済サービスタイプ:Paypal、コマンド名:売上の要求Dtoクラス

@author

VeriTrans Inc.

Constants

SERVICE_COMMAND

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

SERVICE_TYPE

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

Public Class Methods

new() click to toggle source

コンストラクタ

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

Public Instance Methods

action() click to toggle source

アクションタイプを取得する

@return

アクションタイプ

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

アクションタイプを設定する

  • set: 売上請求処理

  • get: 売上請求確認処理

  • do : 売上請求完了処理

  • capture : 売上請求完了処理

  •  ※“capture”は 与信を行った場合にのみ、実行可能

@param

action アクションタイプ

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

取引金額を取得する

@return

取引金額

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

取引金額を設定する

  • 日本円を設定します。

  • ただし、$10,000 USD を上限とした金額を設定します。

@param

amount 取引金額

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 88
def amount=(amount)
  @amount = amount
end
cancel_url() click to toggle source

取消URLを取得する

@return

取消URL

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

取消URLを設定する

  • 消費者がPayPal上で支払いをキャンセルした場合に遷移するマーチャントのURLを設定します。

  • 半角英数字のほかに、URLとして使用できる文字を使用できます。(“.”など)

@param

#cancel_url 取消URL

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 148
def cancel_url=(cancel_url)
  @cancel_url = cancel_url
end
header_image_url() click to toggle source

ヘッダーイメージURLを取得する

@return

ヘッダーイメージURL

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

ヘッダーイメージURLを設定する

  • PayPal画面のヘッダーに表示する画像のURLを設定します。

  • 半角英数字のほかに、URLとして使用できる文字を使用できます。(“.”など)

@param

#header_image_url ヘッダーイメージURL

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 167
def header_image_url=(header_image_url)
  @header_image_url = header_image_url
end
option_params() click to toggle source

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

@return

拡張パラメータリスト

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 406
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/paypal_capture_request_dto.rb, line 415
def option_params=(option_params)
  @option_params = option_params
end
order_description() click to toggle source

オーダー説明を取得する

@return

オーダー説明

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

オーダー説明を設定する

  • 商品の説明を設定します。

  • ※文字コードは“UTF-8”とします。

@param

#order_description オーダー説明

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 186
def order_description=(order_description)
  @order_description = order_description
end
order_id() click to toggle source

取引IDを取得する

@return

取引ID

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 58
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/paypal_capture_request_dto.rb, line 69
def order_id=(order_id)
  @order_id = order_id
end
payer_id() click to toggle source

顧客番号を取得する

@return

顧客番号

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

顧客番号を設定する

  • 顧客番号を設定します。

  • PayPalから処理が戻ってきたとき、URL(戻り先URL)に付加されています。

@param

#payer_id 顧客番号

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 380
def payer_id=(payer_id)
  @payer_id = payer_id
end
return_url() click to toggle source

戻り先URLを取得する

@return

戻り先URL

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

戻り先URLを設定する

  • 消費者がPayPal上での操作が完了したときの遷移するマーチャントのURLを設定します。

  • 半角英数字のほかに、URLとして使用できる文字を使用できます。(“.”など)

@param

#return_url 戻り先URL

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 129
def return_url=(return_url)
  @return_url = return_url
end
service_command() click to toggle source

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

@return

決済サービスコマンド

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 49
def service_command
  @service_command = nil unless instance_variable_defined?(:@service_command)
  @service_command
end
service_type() click to toggle source

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

@return

決済サービスタイプ

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 40
def service_type
  @service_type = nil unless instance_variable_defined?(:@service_type)
  @service_type
end
ship_city() click to toggle source

配送先市区町村名を取得する

@return

配送先市区町村名

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

配送先市区町村名を設定する

  • 配送先市区町村名を設定します。

  • ※文字コードは“UTF-8”とします。

  • 配送先フラグに“1”を設定した場合は必須。

@param

#ship_city 配送先市区町村名

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 285
def ship_city=(ship_city)
  @ship_city = ship_city
end
ship_country() click to toggle source

配送先国コードを取得する

@return

配送先国コード

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

配送先国コードを設定する

  • 配送先コードを設定します。

@param

#ship_country 配送先国コード

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 322
def ship_country=(ship_country)
  @ship_country = ship_country
end
ship_name() click to toggle source

配送先氏名を取得する

@return

配送先氏名

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

配送先氏名を設定する

  • 配送先氏名を設定します。

  • ※文字コードは“UTF-8”とします。

  • 配送先フラグに“1”を設定した場合は必須。

@param

#ship_name 配送先氏名

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 226
def ship_name=(ship_name)
  @ship_name = ship_name
end
ship_phone() click to toggle source

配送先電話番号を取得する

@return

配送先電話番号

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

配送先電話番号を設定する

  • 配送先電話番号を設定します。

  • 全角文字を除く文字列を設定します。

@param

#ship_phone 配送先電話番号

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 361
def ship_phone=(ship_phone)
  @ship_phone = ship_phone
end
ship_postal_code() click to toggle source

配送先郵便番号を取得する

@return

配送先郵便番号

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

配送先郵便番号を設定する

  • 配送先郵便番号を設定します。

  • 全角文字を除く文字列を設定します。

  • 配送先フラグに“1”を設定した場合は必須。

@param

#ship_postal_code 配送先郵便番号

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 342
def ship_postal_code=(ship_postal_code)
  @ship_postal_code = ship_postal_code
end
ship_state() click to toggle source

配送先州名を取得する

@return

配送先州名

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

配送先州名を設定する

  • 配送先州名を設定します。

  • ※文字コードは“UTF-8”とします。

@param

#ship_state 配送先州名

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 304
def ship_state=(ship_state)
  @ship_state = ship_state
end
ship_street1() click to toggle source

配送先住所1を取得する

@return

配送先住所1

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

配送先住所1を設定する

  • 配送先住所1を設定します。

  • ※文字コードは“UTF-8”とします。

  • 配送先フラグに“1”を設定した場合は必須。

@param

#ship_street1 配送先住所1

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 246
def ship_street1=(ship_street1)
  @ship_street1 = ship_street1
end
ship_street2() click to toggle source

配送先住所2を取得する

@return

配送先住所2

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

配送先住所2を設定する

  • 配送先住所2を設定します。

  • ※文字コードは“UTF-8”とします。

@param

#ship_street2 配送先住所2

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 265
def ship_street2=(ship_street2)
  @ship_street2 = ship_street2
end
shipping_flag() click to toggle source

配送先フラグを取得する

@return

配送先フラグ

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

配送先フラグを設定する

  • 配送先情報を有効とするかを設定します。

  • “0”: 配送先の設定を無効にする。

  • “1”: 配送先の設定を有効にする。

@param

#shipping_flag 配送先フラグ

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 206
def shipping_flag=(shipping_flag)
  @shipping_flag = shipping_flag
end
token() click to toggle source

トークンを取得する

@return

トークン

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

トークンを設定する

  • トークンを設定します。

@param

token トークン

# File tgMdk/lib/tg_mdk/mdk_dto/paypal_capture_request_dto.rb, line 398
def token=(token)
  @token = token
end