Dodo Payments Java API Library

The Dodo Payments Java SDK provides convenient access to the Dodo Payments REST API from applications written in Java.

The Dodo Payments Java SDK is similar to the Dodo Payments Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as Optional instead of nullable values, Stream instead of Sequence, and CompletableFuture instead of suspend functions.

It is generated with Stainless.

The REST API documentation can be found on docs.dodopayments.com. Javadocs are available on javadoc.io.

Installation

Gradle

implementation("com.dodopayments.api:dodo-payments-java:1.61.5")

Maven

<dependency>
  <groupId>com.dodopayments.api</groupId>
  <artifactId>dodo-payments-java</artifactId>
  <version>1.61.5</version>
</dependency>

Requirements

This library requires Java 8 or later.

Usage

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;

// Configures using the `dodopayments.apiKey`, `dodopayments.webhookKey` and `dodopayments.baseUrl` system properties
// Or configures using the `DODO_PAYMENTS_API_KEY`, `DODO_PAYMENTS_WEBHOOK_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

CheckoutSessionRequest params = CheckoutSessionRequest.builder()
    .addProductCart(CheckoutSessionRequest.ProductCart.builder()
        .productId("product_id")
        .quantity(0)
        .build())
    .build();
CheckoutSessionResponse checkoutSessionResponse = client.checkoutSessions().create(params);

Client configuration

Configure the client using system properties or environment variables:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

// Configures using the `dodopayments.apiKey`, `dodopayments.webhookKey` and `dodopayments.baseUrl` system properties
// Or configures using the `DODO_PAYMENTS_API_KEY`, `DODO_PAYMENTS_WEBHOOK_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

Or manually:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    .bearerToken("My Bearer Token")
    .build();

Or using a combination of the two approaches:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    // Configures using the `dodopayments.apiKey`, `dodopayments.webhookKey` and `dodopayments.baseUrl` system properties
    // Or configures using the `DODO_PAYMENTS_API_KEY`, `DODO_PAYMENTS_WEBHOOK_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
    .fromEnv()
    .bearerToken("My Bearer Token")
    .build();

See this table for the available options:

Setter	System property	Environment variable	Required	Default value
bearerToken	dodopayments.apiKey	DODO_PAYMENTS_API_KEY	true	-
webhookKey	dodopayments.webhookKey	DODO_PAYMENTS_WEBHOOK_KEY	false	-
baseUrl	dodopayments.baseUrl	DODO_PAYMENTS_BASE_URL	true	"https://live.dodopayments.com"

System properties take precedence over environment variables.

Tip

Don't create more than one client in the same application. Each client has a connection pool and thread pools, which are more efficient to share between requests.

Modifying configuration

To temporarily use a modified client configuration, while reusing the same connection and thread pools, call withOptions() on any client or service:

import com.dodopayments.api.client.DodoPaymentsClient;

DodoPaymentsClient clientWithOptions = client.withOptions(optionsBuilder -> {
    optionsBuilder.baseUrl("https://example.com");
    optionsBuilder.maxRetries(42);
});

The withOptions() method does not affect the original client or service.

Requests and responses

To send a request to the Dodo Payments API, build an instance of some Params class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.

For example, client.checkoutSessions().create(...) should be called with an instance of CheckoutSessionCreateParams, and it will return an instance of CheckoutSessionResponse.

Immutability

Each class in the SDK has an associated builder or factory method for constructing it.

Each class is immutable once constructed. If the class has an associated builder, then it has a toBuilder() method, which can be used to convert it back to a builder for making a modified copy.

Because each class is immutable, builder modification will never affect already built class instances.

Asynchronous execution

The default client is synchronous. To switch to asynchronous execution, call the async() method:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;
import java.util.concurrent.CompletableFuture;

// Configures using the `dodopayments.apiKey`, `dodopayments.webhookKey` and `dodopayments.baseUrl` system properties
// Or configures using the `DODO_PAYMENTS_API_KEY`, `DODO_PAYMENTS_WEBHOOK_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

CheckoutSessionRequest params = CheckoutSessionRequest.builder()
    .addProductCart(CheckoutSessionRequest.ProductCart.builder()
        .productId("product_id")
        .quantity(0)
        .build())
    .build();
CompletableFuture<CheckoutSessionResponse> checkoutSessionResponse = client.async().checkoutSessions().create(params);

Or create an asynchronous client from the beginning:

import com.dodopayments.api.client.DodoPaymentsClientAsync;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClientAsync;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;
import java.util.concurrent.CompletableFuture;

// Configures using the `dodopayments.apiKey`, `dodopayments.webhookKey` and `dodopayments.baseUrl` system properties
// Or configures using the `DODO_PAYMENTS_API_KEY`, `DODO_PAYMENTS_WEBHOOK_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
DodoPaymentsClientAsync client = DodoPaymentsOkHttpClientAsync.fromEnv();

CheckoutSessionRequest params = CheckoutSessionRequest.builder()
    .addProductCart(CheckoutSessionRequest.ProductCart.builder()
        .productId("product_id")
        .quantity(0)
        .build())
    .build();
CompletableFuture<CheckoutSessionResponse> checkoutSessionResponse = client.checkoutSessions().create(params);

The asynchronous client supports the same options as the synchronous one, except most methods return CompletableFutures.

Binary responses

The SDK defines methods that return binary responses, which are used for API responses that shouldn't necessarily be parsed, like non-JSON data.

These methods return HttpResponse:

import com.dodopayments.api.core.http.HttpResponse;
import com.dodopayments.api.models.invoices.payments.PaymentRetrieveParams;

HttpResponse payment = client.invoices().payments().retrieve("payment_id");

To save the response content to a file, use the Files.copy(...) method:

import com.dodopayments.api.core.http.HttpResponse;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;

try (HttpResponse response = client.invoices().payments().retrieve(params)) {
    Files.copy(
        response.body(),
        Paths.get(path),
        StandardCopyOption.REPLACE_EXISTING
    );
} catch (Exception e) {
    System.out.println("Something went wrong!");
    throw new RuntimeException(e);
}

Or transfer the response content to any OutputStream:

import com.dodopayments.api.core.http.HttpResponse;
import java.nio.file.Files;
import java.nio.file.Paths;

try (HttpResponse response = client.invoices().payments().retrieve(params)) {
    response.body().transferTo(Files.newOutputStream(Paths.get(path)));
} catch (Exception e) {
    System.out.println("Something went wrong!");
    throw new RuntimeException(e);
}

Raw responses

The SDK defines methods that deserialize responses into instances of Java classes. However, these methods don't provide access to the response headers, status code, or the raw response body.

To access this data, prefix any HTTP method call on a client or service with withRawResponse():

import com.dodopayments.api.core.http.Headers;
import com.dodopayments.api.core.http.HttpResponseFor;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;

CheckoutSessionRequest params = CheckoutSessionRequest.builder()
    .addProductCart(CheckoutSessionRequest.ProductCart.builder()
        .productId("product_id")
        .quantity(0)
        .build())
    .build();
HttpResponseFor<CheckoutSessionResponse> checkoutSessionResponse = client.checkoutSessions().withRawResponse().create(params);

int statusCode = checkoutSessionResponse.statusCode();
Headers headers = checkoutSessionResponse.headers();

You can still deserialize the response into an instance of a Java class if needed:

import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;

CheckoutSessionResponse parsedCheckoutSessionResponse = checkoutSessionResponse.parse();

Error handling

The SDK throws custom unchecked exception types:

• DodoPaymentsServiceException: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:

  Status	Exception
  400	BadRequestException
  401	UnauthorizedException
  403	PermissionDeniedException
  404	NotFoundException
  422	UnprocessableEntityException
  429	RateLimitException
  5xx	InternalServerException
  others	UnexpectedStatusCodeException

• DodoPaymentsIoException: I/O networking errors.

• DodoPaymentsRetryableException: Generic error indicating a failure that could be retried by the client.

• DodoPaymentsInvalidDataException: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.

• DodoPaymentsException: Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.

Pagination

The SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.

Auto-pagination

To iterate through all results across all pages, use the autoPager() method, which automatically fetches more pages as needed.

When using the synchronous client, the method returns an Iterable

import com.dodopayments.api.models.payments.PaymentListPage;
import com.dodopayments.api.models.payments.PaymentListResponse;

PaymentListPage page = client.payments().list();

// Process as an Iterable
for (PaymentListResponse payment : page.autoPager()) {
    System.out.println(payment);
}

// Process as a Stream
page.autoPager()
    .stream()
    .limit(50)
    .forEach(payment -> System.out.println(payment));

When using the asynchronous client, the method returns an AsyncStreamResponse:

import com.dodopayments.api.core.http.AsyncStreamResponse;
import com.dodopayments.api.models.payments.PaymentListPageAsync;
import com.dodopayments.api.models.payments.PaymentListResponse;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;

CompletableFuture<PaymentListPageAsync> pageFuture = client.async().payments().list();

pageFuture.thenRun(page -> page.autoPager().subscribe(payment -> {
    System.out.println(payment);
}));

// If you need to handle errors or completion of the stream
pageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {
    @Override
    public void onNext(PaymentListResponse payment) {
        System.out.println(payment);
    }

    @Override
    public void onComplete(Optional<Throwable> error) {
        if (error.isPresent()) {
            System.out.println("Something went wrong!");
            throw new RuntimeException(error.get());
        } else {
            System.out.println("No more!");
        }
    }
}));

// Or use futures
pageFuture.thenRun(page -> page.autoPager()
    .subscribe(payment -> {
        System.out.println(payment);
    })
    .onCompleteFuture()
    .whenComplete((unused, error) -> {
        if (error != null) {
            System.out.println("Something went wrong!");
            throw new RuntimeException(error);
        } else {
            System.out.println("No more!");
        }
    }));

Manual pagination

To access individual page items and manually request the next page, use the items(), hasNextPage(), and nextPage() methods:

import com.dodopayments.api.models.payments.PaymentListPage;
import com.dodopayments.api.models.payments.PaymentListResponse;

PaymentListPage page = client.payments().list();
while (true) {
    for (PaymentListResponse payment : page.items()) {
        System.out.println(payment);
    }

    if (!page.hasNextPage()) {
        break;
    }

    page = page.nextPage();
}

Logging

The SDK uses the standard OkHttp logging interceptor.

Enable logging by setting the DODO_PAYMENTS_LOG environment variable to info:

$ export DODO_PAYMENTS_LOG=info

Or to debug for more verbose logging:

$ export DODO_PAYMENTS_LOG=debug

ProGuard and R8

Although the SDK uses reflection, it is still usable with ProGuard and R8 because dodo-payments-java-core is published with a configuration file containing keep rules.

ProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.

Jackson

The SDK depends on Jackson for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.

The SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).

If the SDK threw an exception, but you're certain the version is compatible, then disable the version check using the checkJacksonVersionCompatibility on DodoPaymentsOkHttpClient or DodoPaymentsOkHttpClientAsync.

Caution

We make no guarantee that the SDK works correctly when the Jackson version check is disabled.

Network options

Retries

The SDK automatically retries 2 times by default, with a short exponential backoff between requests.

Only the following error types are retried:

• Connection errors (for example, due to a network connectivity problem)
• 408 Request Timeout
• 409 Conflict
• 429 Rate Limit
• 5xx Internal

The API may also explicitly instruct the SDK to retry or not retry a request.

To set a custom number of retries, configure the client using the maxRetries method:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    .maxRetries(4)
    .build();

Timeouts

Requests time out after 1 minute by default.

To set a custom timeout, configure the method call using the timeout method:

import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;

CheckoutSessionResponse checkoutSessionResponse = client.checkoutSessions().create(
  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
);

Or configure the default for all method calls at the client level:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import java.time.Duration;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    .timeout(Duration.ofSeconds(30))
    .build();

Proxies

To route requests through a proxy, configure the client using the proxy method:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import java.net.InetSocketAddress;
import java.net.Proxy;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    .proxy(new Proxy(
      Proxy.Type.HTTP, new InetSocketAddress(
        "https://example.com", 8080
      )
    ))
    .build();

HTTPS

Note

Most applications should not call these methods, and instead use the system defaults. The defaults include special optimizations that can be lost if the implementations are modified.

To configure how HTTPS connections are secured, configure the client using the sslSocketFactory, trustManager, and hostnameVerifier methods:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.
    .sslSocketFactory(yourSSLSocketFactory)
    .trustManager(yourTrustManager)
    .hostnameVerifier(yourHostnameVerifier)
    .build();

Environments

The SDK sends requests to the live_mode by default. To send requests to a different environment, configure the client like so:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    .testMode()
    .build();

Custom HTTP client

The SDK consists of three artifacts:

• dodo-payments-java-core
  • Contains core SDK logic
  • Does not depend on OkHttp
  • Exposes DodoPaymentsClient, DodoPaymentsClientAsync, DodoPaymentsClientImpl, and DodoPaymentsClientAsyncImpl, all of which can work with any HTTP client
• dodo-payments-java-client-okhttp
  • Depends on OkHttp
  • Exposes DodoPaymentsOkHttpClient and DodoPaymentsOkHttpClientAsync, which provide a way to construct DodoPaymentsClientImpl and DodoPaymentsClientAsyncImpl, respectively, using OkHttp
• dodo-payments-java
  • Depends on and exposes the APIs of both dodo-payments-java-core and dodo-payments-java-client-okhttp
  • Does not have its own logic

This structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.

Customized OkHttpClient

Tip

Try the available network options before replacing the default client.

To use a customized OkHttpClient:

1. Replace your dodo-payments-java dependency with dodo-payments-java-core
2. Copy dodo-payments-java-client-okhttp's OkHttpClient class into your code and customize it
3. Construct DodoPaymentsClientImpl or DodoPaymentsClientAsyncImpl, similarly to DodoPaymentsOkHttpClient or DodoPaymentsOkHttpClientAsync, using your customized client

Completely custom HTTP client

To use a completely custom HTTP client:

1. Replace your dodo-payments-java dependency with dodo-payments-java-core
2. Write a class that implements the HttpClient interface
3. Construct DodoPaymentsClientImpl or DodoPaymentsClientAsyncImpl, similarly to DodoPaymentsOkHttpClient or DodoPaymentsOkHttpClientAsync, using your new client class

Undocumented API functionality

The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.

Parameters

To set undocumented parameters, call the putAdditionalHeader, putAdditionalQueryParam, or putAdditionalBodyProperty methods on any Params class:

import com.dodopayments.api.core.JsonValue;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams;

CheckoutSessionCreateParams params = CheckoutSessionCreateParams.builder()
    .putAdditionalHeader("Secret-Header", "42")
    .putAdditionalQueryParam("secret_query_param", "42")
    .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))
    .build();

These can be accessed on the built object later using the _additionalHeaders(), _additionalQueryParams(), and _additionalBodyProperties() methods.

To set a documented parameter or property to an undocumented or not yet supported value, pass a JsonValue object to its setter:

import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;

CheckoutSessionCreateParams params = CheckoutSessionCreateParams.builder()
    .checkoutSessionRequest(CheckoutSessionRequest.builder()
        .addProductCart(CheckoutSessionRequest.ProductCart.builder()
            .productId("product_id")
            .quantity(0)
            .build())
        .build())
    .build();

The most straightforward way to create a JsonValue is using its from(...) method:

import com.dodopayments.api.core.JsonValue;
import java.util.List;
import java.util.Map;

// Create primitive JSON values
JsonValue nullValue = JsonValue.from(null);
JsonValue booleanValue = JsonValue.from(true);
JsonValue numberValue = JsonValue.from(42);
JsonValue stringValue = JsonValue.from("Hello World!");

// Create a JSON array value equivalent to `["Hello", "World"]`
JsonValue arrayValue = JsonValue.from(List.of(
  "Hello", "World"
));

// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`
JsonValue objectValue = JsonValue.from(Map.of(
  "a", 1,
  "b", 2
));

// Create an arbitrarily nested JSON equivalent to:
// {
//   "a": [1, 2],
//   "b": [3, 4]
// }
JsonValue complexValue = JsonValue.from(Map.of(
  "a", List.of(
    1, 2
  ),
  "b", List.of(
    3, 4
  )
));

Normally a Builder class's build method will throw IllegalStateException if any required parameter or property is unset.

To forcibly omit a required parameter or property, pass JsonMissing:

import com.dodopayments.api.core.JsonMissing;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;

CheckoutSessionCreateParams params = CheckoutSessionCreateParams.builder()
    .checkoutSessionRequest(CheckoutSessionRequest.builder()
        .addProductCart(CheckoutSessionRequest.ProductCart.builder()
            .productId("product_id")
            .quantity(0)
            .build())
        .build())
    .productCart(JsonMissing.of())
    .build();

Response properties

To access undocumented response properties, call the _additionalProperties() method:

import com.dodopayments.api.core.JsonValue;
import java.util.Map;

Map<String, JsonValue> additionalProperties = client.checkoutSessions().create(params)._additionalProperties();
JsonValue secretPropertyValue = additionalProperties.get("secretProperty");

String result = secretPropertyValue.accept(new JsonValue.Visitor<>() {
    @Override
    public String visitNull() {
        return "It's null!";
    }

    @Override
    public String visitBoolean(boolean value) {
        return "It's a boolean!";
    }

    @Override
    public String visitNumber(Number value) {
        return "It's a number!";
    }

    // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`
    // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden
});

To access a property's raw JSON value, which may be undocumented, call its _ prefixed method:

import com.dodopayments.api.core.JsonField;
import java.util.Optional;

JsonField<Object> field = client.checkoutSessions().create(params)._field();

if (field.isMissing()) {
  // The property is absent from the JSON response
} else if (field.isNull()) {
  // The property was set to literal null
} else {
  // Check if value was provided as a string
  // Other methods include `asNumber()`, `asBoolean()`, etc.
  Optional<String> jsonString = field.asString();

  // Try to deserialize into a custom type
  MyClass myObject = field.asUnknown().orElseThrow().convert(MyClass.class);
}

Response validation

In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a String, but the API could return something else.

By default, the SDK will not throw an exception in this case. It will throw DodoPaymentsInvalidDataException only if you directly access the property.

If you would prefer to check that the response is completely well-typed upfront, then either call validate():

import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;

CheckoutSessionResponse checkoutSessionResponse = client.checkoutSessions().create(params).validate();

Or configure the method call to validate the response using the responseValidation method:

import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;

CheckoutSessionResponse checkoutSessionResponse = client.checkoutSessions().create(
  params, RequestOptions.builder().responseValidation(true).build()
);

Or configure the default for all method calls at the client level:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    .responseValidation(true)
    .build();

FAQ

Why don't you use plain enum classes?

Java enum classes are not trivially forwards compatible. Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.

Why do you represent fields using JsonField<T> instead of just plain T?

Using JsonField<T> enables a few features:

• Allowing usage of undocumented API functionality
• Lazily validating the API response against the expected shape
• Representing absent vs explicitly null values

Why don't you use data classes?

It is not backwards compatible to add new fields to a data class and we don't want to introduce a breaking change every time we add a field to a class.

Why don't you use checked exceptions?

Checked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.

Checked exceptions:

• Are verbose to handle
• Encourage error handling at the wrong level of abstraction, where nothing can be done about the error
• Are tedious to propagate due to the function coloring problem
• Don't play well with lambdas (also due to the function coloring problem)

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.