Plaid Java SDK

Version 9.0.0 introduced significant breaking changes. If you are upgrading from a version older than 9.0.0, you must address the following:

• Model Imports: Move from com.plaid.request.* and com.plaid.response.* to com.plaid.model.*.
• Request Structure: Request models now use builder syntax (e.g., new Request().param(value)) instead of constructor arguments. All with* setters have been renamed to plain setters (e.g., .withEndDate(date) becomes .endDate(date)).
• Enums: Country codes and products now use typed Enums (e.g., CountryCode.US, Products.AUTH) instead of Strings or singletons.
• Error Model: ErrorResponse is now Error, and ErrorType is now Error.ErrorTypeEnum.
• Account Model: Account is now AccountBase.
• Client Methods: Remove .service() from endpoint queries. Endpoints starting with get are now named {Model}Get (e.g., accountsBalanceGet).

The library uses Retrofit and OkHttp. You can execute calls synchronously using .execute() or asynchronously using .enqueue() with a callback. Required request parameters are passed via the request object's builder methods.

// Synchronously exchange a Link public_token for an API access_token
ItemPublicTokenExchangeRequest request = new ItemPublicTokenExchangeRequest().publicToken("the_link_public_token");
Response<ItemPublicTokenExchangeResponse> response = plaidClient
    .itemPublicTokenExchange(request).execute();

if (response.isSuccessful()) {
  accessToken = response.body().getAccessToken();
}

// Asynchronously do the same thing
ItemPublicTokenExchangeRequest request = new ItemPublicTokenExchangeRequest().publicToken(publicToken);
plaidClient
    .itemPublicTokenExchange(request)
    .enqueue(new Callback<ItemPublicTokenExchangeResponse>() {
        @Override
        public void onResponse(Call<ItemPublicTokenExchangeResponse> call, Response<ItemPublicTokenExchangeResponse> response) {
          if (response.isSuccessful()) {
            accessToken = response.body().getAccessToken();
          }
        }

        @Override
        public void onFailure(Call<ItemPublicTokenExchangeResponse> call, Throwable t) {
          // handle the failure as needed
        }
    });