Class: Stripe::ExchangeRate

Inherits:
APIResource show all
Extended by:
Gem::Deprecate, APIOperations::List
Defined in:
lib/stripe/resources/exchange_rate.rb

Overview

Deprecated

The ‘ExchangeRate` APIs are deprecated. Please use the [FX Quotes API](docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.

‘ExchangeRate` objects allow you to determine the rates that Stripe is currently using to convert from one currency to another. Since this number is variable throughout the day, there are various reasons why you might want to know the current rate (for example, to dynamically price an item for a user with a default payment in a foreign currency).

Please refer to our [Exchange Rates API](stripe.com/docs/fx-rates) guide for more details.

*[Note: this integration path is supported but no longer recommended]* Additionally, you can guarantee that a charge is made with an exchange rate that you expect is current. To do so, you must pass in the exchange_rate to charges endpoints. If the value is no longer up to date, the charge won’t go through. Please refer to our [Using with charges](stripe.com/docs/exchange-rates) guide for more details.

 

*This Exchange Rates API is a Beta Service and is subject to Stripe’s terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*

  • *localize prices for processing payments on Stripe*

  • *reconcile Stripe transactions*

  • *determine how much money to send to a connected account*

  • *determine app fees to charge a connected account*

*Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe’s terms of service.*

Constant Summary collapse

OBJECT_NAME = 
"exchange_rate"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::List

list

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#id ⇒ Object (readonly)

Unique identifier for the object. Represented as the three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html) in lowercase.



43
44
45
 
# File 'lib/stripe/resources/exchange_rate.rb', line 43

def id
  @id
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



45
46
47
 
# File 'lib/stripe/resources/exchange_rate.rb', line 45

def object
  @object
end

#rates ⇒ Object (readonly)

Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.



47
48
49
 
# File 'lib/stripe/resources/exchange_rate.rb', line 47

def rates
  @rates
end

Class Method Details

.field_remappings ⇒ Object 



65
66
67
 
# File 'lib/stripe/resources/exchange_rate.rb', line 65

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



61
62
63
 
# File 'lib/stripe/resources/exchange_rate.rb', line 61

def self.inner_class_types
  @inner_class_types = {}
end

.list(params = {}, opts = {}) ⇒ Object

Deprecated

The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.



52
53
54
 
# File 'lib/stripe/resources/exchange_rate.rb', line 52

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/exchange_rates", params: params, opts: opts)
end

.object_name ⇒ Object 



38
39
40
 
# File 'lib/stripe/resources/exchange_rate.rb', line 38

def self.object_name
  "exchange_rate"
end