Package com.stripe.model
Class ExchangeRate
java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.ExchangeRate
- All Implemented Interfaces:
HasId
,StripeObjectInterface
Exchange Rate
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).
If you want a guarantee that the charge is made with a certain exchange rate you expect is
current, you can pass in exchange_rate
to charges endpoints. If the value is no longer up
to date, the charge won't go through. Please refer to our Exchange Rates API guide for more details.
-
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
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) Returns a list of objects that contain the rates at which foreign currencies are converted to one another.static ExchangeRateCollection
list
(ExchangeRateListParams params, RequestOptions options) Returns a list of objects that contain the rates at which foreign currencies are converted to one another.static ExchangeRateCollection
Returns a list of objects that contain the rates at which foreign currencies are converted to one another.static ExchangeRateCollection
list
(Map<String, Object> params, RequestOptions options) Returns a list of objects that contain the rates at which foreign currencies are converted to one another.static ExchangeRate
Retrieves the exchange rates from the given currency to every supported currency.static ExchangeRate
retrieve
(String rateId, RequestOptions options) Retrieves the exchange rates from the given currency to every supported currency.static ExchangeRate
retrieve
(String rateId, ExchangeRateRetrieveParams params, RequestOptions options) Retrieves the exchange rates from the given currency to every supported currency.static ExchangeRate
Retrieves the exchange rates from the given currency to every supported currency.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, classUrl, classUrl, fullUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Constructor Details
-
ExchangeRate
public ExchangeRate()
-
-
Method Details
-
list
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
public static ExchangeRateCollection list(Map<String, Object> params, RequestOptions options) throws StripeExceptionReturns 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
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
public static ExchangeRateCollection list(ExchangeRateListParams params, RequestOptions options) throws StripeException 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
Retrieves the exchange rates from the given currency to every supported currency.- Throws:
StripeException
-
retrieve
Retrieves the exchange rates from the given currency to every supported currency.- Throws:
StripeException
-
retrieve
public static ExchangeRate retrieve(String rateId, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves the exchange rates from the given currency to every supported currency.- Throws:
StripeException
-
retrieve
public static ExchangeRate retrieve(String rateId, ExchangeRateRetrieveParams params, RequestOptions options) throws StripeException 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.
-