Stripe Java client library
The official Stripe Java client library.
Requirements
- Java 1.8 or later
Gradle users
Add this dependency to your project’s build file:
implementation "com.stripe:stripe-java:26.1.0"
Maven users
Add this dependency to your project’s POM:
<dependency>
<groupId>com.stripe</groupId>
<artifactId>stripe-java</artifactId>
<version>26.1.0</version>
</dependency>
Others
You’ll need to manually install the following JARs:
- The Stripe JAR
- Google Gson from https://repo1.maven.org/maven2/com/google/code/gson/gson/2.10.1/gson-2.10.1.jar.
ProGuard
If you’re planning on using ProGuard, make sure that you exclude the Stripe
client library. You can do this by adding the following to your proguard.cfg
file:
-keep class com.stripe.** { *; }
Documentation
Please see the Java API docs for the most up-to-date documentation.
See video demonstrations covering how to use the library.
You can also refer to the online Javadoc.
Per-request Configuration
All of the request methods accept an optional RequestOptions
object. This is
used if you want to set an idempotency key, if you are
using Stripe Connect, or if you want to pass the secret API
key on each method.
RequestOptions requestOptions = RequestOptions.builder()
.setApiKey("sk_test_...")
.setIdempotencyKey("a1b2c3...")
.setStripeAccount("acct_...")
.build();
client.customers().list(requestOptions);
client.customers().retrieve("cus_123456789", requestOptions);
Configuring automatic retries
The library can be configured to automatically retry requests that fail due to an intermittent network problem or other knowingly non-deterministic errors. This can be enabled globally:
StripeClient client = StripeClient.builder()
.setMaxNetworkRetries(2)
.build();
Or on a finer grain level using RequestOptions
:
RequestOptions options = RequestOptions.builder()
.setMaxNetworkRetries(2)
.build();
client.customers().create(params, options);
Idempotency keys are added to requests to guarantee that retries are safe.
Configuring Timeouts
Connect and read timeouts can be configured globally:
StripeClient client = StripeClient.builder()
.setConnectTimeout(30 * 1000); // in milliseconds
.setReadTimeout(80 * 1000);
.build();
Or on a finer grain level using RequestOptions
:
RequestOptions options = RequestOptions.builder()
.setConnectTimeout(30 * 1000) // in milliseconds
.setReadTimeout(80 * 1000)
.build();
client.customers().create(params, options);
Please take care to set conservative read timeouts. Some API requests can take some time, and a short timeout increases the likelihood of a problem within our servers.
Configuring DNS Cache TTL
We cannot guarantee that the IP address of the Stripe API will be static.
Commonly, default JVM configurations can have their DNS cache TTL set to
forever. If Stripe’s IP address changes, your application’s requests to
Stripe will all fail until the JVM restarts. Therefore we recommend that
you modify the JVM’s networkaddress.cache.ttl
property
to 60
seconds.
Parameters
To pass undocumented parameters to Stripe using stripe-java you need to use the putExtraParam()
method, as shown below:
CustomerCreateParams params =
CustomerCreateParams.builder()
.setEmail("jenny.rosen@example.com")
.putExtraParam("secret_feature_enabled", "true")
.putExtraParam("secret_parameter[primary]", "primary value")
.putExtraParam("secret_parameter[secondary]", "secondary value")
.build();
client.customers().create(params);
Properties
To retrieve undocumented properties from Stripe using Java you can use an option in the library to return the raw JSON object and return the property as a native type. An example of this is shown below:
final Customer customer = client.customers().retrieve("cus_1234");
Boolean featureEnabled =
customer.getRawJsonObject()
.getAsJsonPrimitive("secret_feature_enabled")
.getAsBoolean();
String primaryValue =
customer.getRawJsonObject()
.getAsJsonObject("secret_parameter")
.getAsJsonPrimitive("primary")
.getAsString();
String secondaryValue =
customer.getRawJsonObject()
.getAsJsonObject("secret_parameter")
.getAsJsonPrimitive("secondary")
.getAsString();
Writing a plugin
If you’re writing a plugin that uses the library, we’d appreciate it if you
identified using Stripe.setAppInfo()
:
Stripe.setAppInfo("MyAwesomePlugin", "1.2.34", "https://myawesomeplugin.info");
This information is passed along when the library makes calls to the Stripe API.
Request latency telemetry
By default, the library sends request latency telemetry to Stripe. These numbers help Stripe improve the overall latency of its API for all users.
You can disable this behavior if you prefer:
Stripe.enableTelemetry = false;
Development
JDK 17 is required to build the Stripe Java library. By default, tests use the same Java runtime as the build.
To use a custom version of Java runtime for tests set the JAVA_TEST_HOME
environment variable to runtime’s
home directory.
The test suite depends on stripe-mock, so make sure to fetch and run it from a background terminal (stripe-mock’s README also contains instructions for installing via Homebrew and other methods):
go get -u github.com/stripe/stripe-mock
stripe-mock
To run all checks (tests and code formatting):
./gradlew check
To run the tests:
./gradlew test
You can run particular tests by passing --tests Class#method
. Make sure you
use the fully qualified class name. For example:
./gradlew test --tests com.stripe.model.AccountTest
./gradlew test --tests com.stripe.functional.CustomerTest
./gradlew test --tests com.stripe.functional.CustomerTest.testCustomerCreate
The library uses Spotless along with google-java-format for code formatting. Code must be formatted before PRs are submitted, otherwise CI will fail. Run the formatter with:
./gradlew spotlessApply
The library uses Project Lombok. While it is not a requirement, you might want to install a plugin for your favorite IDE to facilitate development.