Stripe Java client library
The official Stripe Java client library.
Installation
Requirements
- Java 1.8 or later
Gradle users
Add this dependency to your project's build file:
implementation "com.stripe:stripe-java:17.11.0"
Maven users
Add this dependency to your project's POM:
<dependency>
<groupId>com.stripe</groupId>
<artifactId>stripe-java</artifactId>
<version>17.11.0</version>
</dependency>
Others
You'll need to manually install the following JARs:
- The Stripe JAR from https://github.com/stripe/stripe-java/releases/latest
- Google Gson from https://repo1.maven.org/maven2/com/google/code/gson/gson/2.8.5/gson-2.8.5.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.
You can also refer to the online Javadoc.
Usage
StripeExample.java
import java.util.HashMap;
import java.util.Map;
import com.stripe.Stripe;
import com.stripe.exception.StripeException;
import com.stripe.model.Customer;
import com.stripe.net.RequestOptions;
public class StripeExample {
public static void main(String[] args) {
Stripe.apiKey = "sk_test_...";
Map<String, Object> customerMap = new HashMap<String, Object>();
customerMap.put("description", "Example descriptipn");
customerMap.put("email", "test@example.com");
customerMap.put("payment_method", "pm_card_visa"); // obtained via Stripe.js
try {
Customer customer = Customer.create(customerMap);
System.out.println(customer);
} catch (StripeException e) {
e.printStackTrace();
}
}
}
See the project's functional tests for more examples.
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 = new RequestOptionsBuilder()
.setApiKey("sk_test_...")
.setIdempotencyKey("a1b2c3...")
.setStripeAccount("acct_...")
.build();
Customer.list(null, requestOptions);
Customer.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:
Stripe.setMaxNetworkRetries(2);
Or on a finer grain level using RequestOptions:
RequestOptions options = RequestOptions.builder()
.setMaxNetworkRetries(2)
.build();
Customer.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:
Stripe.setConnectTimeout(30 * 1000); // in milliseconds
Stripe.setReadTimeout(80 * 1000);
Or on a finer grain level using RequestOptions:
RequestOptions options = RequestOptions.builder()
.setConnectTimeout(30 * 1000) // in milliseconds
.setReadTimeout(80 * 1000)
.build();
Customer.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.
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
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.