com.stripe.model.ExchangeRate Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.param.ExchangeRateListParams;
import com.stripe.param.ExchangeRateRetrieveParams;
import java.math.BigDecimal;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* {@code 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.
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class ExchangeRate extends ApiResource implements HasId {
/**
* Unique identifier for the object. Represented as the three-letter ISO currency code in lowercase.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* String representing the object's type. Objects of the same type share the same value.
*
*
Equal to {@code exchange_rate}.
*/
@SerializedName("object")
String object;
/**
* 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.
*/
@SerializedName("rates")
Map rates;
/**
* 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.
*/
public static ExchangeRateCollection list(Map params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* 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.
*/
public static ExchangeRateCollection list(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/exchange_rates";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, ExchangeRateCollection.class);
}
/**
* 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.
*/
public static ExchangeRateCollection list(ExchangeRateListParams params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* 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.
*/
public static ExchangeRateCollection list(ExchangeRateListParams params, RequestOptions options)
throws StripeException {
String path = "/v1/exchange_rates";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, ExchangeRateCollection.class);
}
/** Retrieves the exchange rates from the given currency to every supported currency. */
public static ExchangeRate retrieve(String rateId) throws StripeException {
return retrieve(rateId, (Map) null, (RequestOptions) null);
}
/** Retrieves the exchange rates from the given currency to every supported currency. */
public static ExchangeRate retrieve(String rateId, RequestOptions options)
throws StripeException {
return retrieve(rateId, (Map) null, options);
}
/** Retrieves the exchange rates from the given currency to every supported currency. */
public static ExchangeRate retrieve(
String rateId, Map params, RequestOptions options) throws StripeException {
String path = String.format("/v1/exchange_rates/%s", ApiResource.urlEncodeId(rateId));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, ExchangeRate.class);
}
/** Retrieves the exchange rates from the given currency to every supported currency. */
public static ExchangeRate retrieve(
String rateId, ExchangeRateRetrieveParams params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/exchange_rates/%s", ApiResource.urlEncodeId(rateId));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, ExchangeRate.class);
}
}