Class ExchangeRate
- All Implemented Interfaces:
HasId
,StripeActiveObject
,StripeObjectInterface
ExchangeRate
APIs are deprecated. Please use the 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 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 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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
Field Summary
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON, INTERNAL_GSON
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
getId()
Unique identifier for the object.String representing the object's type.getRates()
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.int
hashCode()
static ExchangeRateCollection
list
(ExchangeRateListParams params) Deprecated.static ExchangeRateCollection
list
(ExchangeRateListParams params, RequestOptions options) Deprecated.static ExchangeRateCollection
Deprecated.static ExchangeRateCollection
list
(Map<String, Object> params, RequestOptions options) Deprecated.static ExchangeRate
Deprecated.static ExchangeRate
retrieve
(String rateId, RequestOptions options) Deprecated.static ExchangeRate
retrieve
(String rateId, ExchangeRateRetrieveParams params, RequestOptions options) Deprecated.static ExchangeRate
Deprecated.void
Unique identifier for the object.void
String representing the object's type.void
setRates
(Map<String, BigDecimal> rates) 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.Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, setResponseGetter, urlEncode, urlEncodeId
Methods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.stripe.model.StripeActiveObject
trySetResponseGetter
-
Constructor Details
-
ExchangeRate
public ExchangeRate()
-
-
Method Details
-
list
@Deprecated public static ExchangeRateCollection list(Map<String, Object> params) throws StripeExceptionDeprecated.[Deprecated] TheExchangeRate
APIs are deprecated. Please use the 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.
- Throws:
StripeException
-
list
@Deprecated public static ExchangeRateCollection list(Map<String, Object> params, RequestOptions options) throws StripeExceptionDeprecated.[Deprecated] TheExchangeRate
APIs are deprecated. Please use the 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.
- Throws:
StripeException
-
list
@Deprecated public static ExchangeRateCollection list(ExchangeRateListParams params) throws StripeException Deprecated.[Deprecated] TheExchangeRate
APIs are deprecated. Please use the 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.
- Throws:
StripeException
-
list
@Deprecated public static ExchangeRateCollection list(ExchangeRateListParams params, RequestOptions options) throws StripeException Deprecated.[Deprecated] TheExchangeRate
APIs are deprecated. Please use the 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.
- Throws:
StripeException
-
retrieve
Deprecated.[Deprecated] TheExchangeRate
APIs are deprecated. Please use the FX Quotes API instead.Retrieves the exchange rates from the given currency to every supported currency.
- Throws:
StripeException
-
retrieve
@Deprecated public static ExchangeRate retrieve(String rateId, RequestOptions options) throws StripeException Deprecated.[Deprecated] TheExchangeRate
APIs are deprecated. Please use the FX Quotes API instead.Retrieves the exchange rates from the given currency to every supported currency.
- Throws:
StripeException
-
retrieve
@Deprecated public static ExchangeRate retrieve(String rateId, Map<String, Object> params, RequestOptions options) throws StripeExceptionDeprecated.[Deprecated] TheExchangeRate
APIs are deprecated. Please use the FX Quotes API instead.Retrieves the exchange rates from the given currency to every supported currency.
- Throws:
StripeException
-
retrieve
@Deprecated public static ExchangeRate retrieve(String rateId, ExchangeRateRetrieveParams params, RequestOptions options) throws StripeException Deprecated.[Deprecated] TheExchangeRate
APIs are deprecated. Please use the FX Quotes API instead.Retrieves the exchange rates from the given currency to every supported currency.
- Throws:
StripeException
-
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
exchange_rate
. -
getRates
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. -
setId
Unique identifier for the object. Represented as the three-letter ISO currency code in lowercase. -
setObject
String representing the object's type. Objects of the same type share the same value.Equal to
exchange_rate
. -
setRates
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. -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object. Represented as the three-letter ISO currency code in lowercase.
-