See full changelog for the OpenAPI schema (OAS) here.
- Updating to OAS 2020-09-14_1.121.0
- Add TimestampNullable type
- Removed
Uploaded,CreatedandAPPROVAL_STATUS_APPROVEDenum strings fromPayrollItemStatusfield.
- Add
returnedto TransferStatus enum - Add
return_sweptto TransferSweepStatus enum - Add
returnedandreturn_sweptto TransferEventType enum
- Added
employee_typeandlast_paystub_dateto/credit/employment/getresponse
- Make
/payment_initiation/consent/createAPI more strict
- Add
/credit/audit_copy_token/createendpoint
- Add
/wallet/listendpoint
- Updating to OAS 2020-09-14_1.115.2
- Update description fields to fix formatting errors
- Reflect that
error.suggested_actionisnullable
- Update OpenAPI spec
- Added
income_report_tokento/credit/payroll_income/getresponse
- Add
/wallet/createendpoint
- Add beta
additional_consented_productsfield to/link/token/create
- Updated
/transactions/recurring/getdescription
- Add webhooks for new Monitor and Identity Verification products
- Add endpoints for new Monitor and Identity Verification products
- Remove
emi_recipient_idfrom Payment Initiation Recipient
- Add optional
ibanandbacsfields tooptionsin the/payment_initiation/consent/createrequest
- Updated
/transactions/syncdescription
- Add more accurate enum documentations to
/transactions/recurring/getAPI doc
- Additional documentation for
/transactions/sync
- Remove deprecated field
createdAtfrom/application/getresponse
- Add field validation to
BankTransferDirection
- Remove deprecated field
createdAtfrom/application/getresponse
- Add external doc link to
transactions/recurring/get
- Updating the API doc for Recurring Transactions
- Add
DisplayNamein/application/getresponse
- Updated sample responses for all Transfer endpoints
- Changing
beta/transactions/rules/routes tobeta/transactions/rules/v1
- Fixing
InsitututionMetadatatypo toInstitutionMetadatain private/beta/credit/payroll_income/risk_signals/getendpoint response
- Added
require_guarantee,guarantee_decision, andguarantee_decision_rationaleto/transfer/intentin order to support Guarantee when using Transfer UI.
- Add additional supported
typeenums inWalletTransaction.
- Add Additional History billing information for /asset_report/create.
- Add
user_idto income verification webhook payload
- Make
consent_idfield nullable inPaymentInitiationPayment.
- Replace
initiated_refundswithrefund_idsin the/payment_initiation/payment/getand/payment_initiation/payment/listresponses
- Added
/beta/credit/payroll_income/risk_signals/getendpoint (currently private)
- Remove unsupported ACH classes from
bank_transfer/andtransfer/endpoints.
- Add
enable_multiple_itemsparameter for bank income.
- Fix typo in
institution_nameparameter for credit endpoints.
- Added
referenceandidempotency_keyfields to thepayment_initiation/payment/reverserequest.
- Added
is_update_modetoincome_verificationin the/link/token/createbody
- Consolidate item schemas
- Removed
client_idandsecretas required fields from/transfer/intent/{get,create}to match actual API behavior.
- Add
/credit/payroll_income/refreshendpoint
- Added
/signal/prepare
- Added
/watchlist_screening/individual/list(currently private) - Added
/watchlist_screening/individual/create(currently private) - Added
/watchlist_screening/individual/get(currently private) - Added
/watchlist_screening/individual/update(currently private) - Added
/watchlist_screening/individual/history/list(currently private) - Added
/watchlist_screening/individual/review/list(currently private) - Added
/watchlist_screening/individual/review/create(currently private) - Added
/watchlist_screening/individual/hit/list(currently private) - Added
/watchlist_screening/entity/list(currently private) - Added
/watchlist_screening/entity/create(currently private) - Added
/watchlist_screening/entity/get(currently private) - Added
/watchlist_screening/entity/update(currently private) - Added
/watchlist_screening/entity/history/list(currently private) - Added
/watchlist_screening/entity/hit/list(currently private) - Added
/watchlist_screening/entity/review/list(currently private) - Added
/watchlist_screening/entity/review/create(currently private) - Added
/watchlist_screening/individual/program/list(currently private) - Added
/watchlist_screening/individual/program/get(currently private) - Added
/watchlist_screening/entity/program/list(currently private) - Added
/watchlist_screening/entity/program/get(currently private) - Added
/dashboard_user/list(currently private) - Added
/dashboard_user/get(currently private) - Added
/identity_verification/list(currently private) - Added
/identity_verification/get(currently private) - Added
/identity_verification/retry(currently private) - Modified
/identity_verification/create(currently private)
- Add endpoint for
/credit/bank_income/refresh
- Add
include_original_description,include_personal_finance_categoryoptions to/transactions/syncrequest.
- API changes for /credit/employment/get
- Add
gustoas processor partner
- Add
user_tokenas a request parameter for/sandbox/public_token/create
- Remove
auth,transactions_updates,investments_updates, andidentityas required fields from Item status to match actual API behavior.
- Updating to OAS 2020-09-14_1.97.0
- [Beta] Rename some
Creditrefs that were preventing client library generation from completing successfully
- remove unused
payroll_income_idfrom/credit/payroll_income/getfield - add status object to items in
/credit/payroll_income/getresponse body
- Add
TransferEventsUpdateWebhookschema
- Add
institution_dataparameter to/link/token/create
- Tidy up YAML
- Add
highnoteprocessor to/processor/token/create
- Add
use_case,company_legal_name,city,region,country_code,postal_codeas a required response field ofApplication
- Remove
income_verification_idfrom income webhook example - Fix incorrect URL for
/user/createendpoint
- Remove deprecated
income_verification_idfrom income webhooks - Standardize income webhook casing
- Add several new fields to
/signal/evaluateresponse
- Add
/sandbox/transfer/fire_webhookendpoint
- Mark certain Income endpoints as deprecated in favor of the new
/credit/*endpoints.
- Add
checkoutprocessor to/processor/token/create
- Add
webhook_typeparameter to/sandbox/item/fire_webhook - Support for investments transactions, investments holdings and liabilities
DEFAULT_UPDATEwebhooks
- Add new warning type to
/credit/bank_income/getresponse
- Add
marqetaandsolidas Auth processor partners - Fix schema of
causeparameter for Asset Reports - Fix some invalid examples
- Add
/credit/employment/getendpoint - Add optional
access_tokensarray to/credit/payroll_income/precheckrequest
- Update description of
/sandbox/item/fire_webhook
- Update description of
accounts/get
- Added
AUTH_DATA_UPDATEwebhook code as valid input to/sandbox/item/fire_webhook - Update description for
/sandbox/item/fire_webhook
- Add
/transfer/migrate_accountendpoint
- Fix operationId for
/credit/payroll_income/precheck
- Remove deprecated fields from
/item/application/list
- Add
wire_routing_numberparameter to/bank_transfer/migrate_account
- Specify minimum length of 1 for
descriptiononTransferIntentCreateRequest
- Add
consent_idsupport in the Institutions Search request
- Add
apex_clearingas a processor partner
- Introduce Credit Payroll Income APIs
- Introduce Credit Precheck API
- Add
/identity_verification/createendpoint, kept private for now
- Add
statusfield toConnectedApplication
- Updating to OAS 2020-09-14_1.84.5
- Added missing
asset_report_idfield to/asset_report/relay/refresh
- Change summary description and url for
/credit/bank_income/get
- Slight wording change for
/credit/bank_income/getresponse fields
- Move
user_tokento top level oflink/token/createrequest
- Correct typo in enum value for Investment subtypes (
person->pension)
- Fix schema to properly handle personal finance categories in
/transactions/get
- Add
user_tokenparameter tolink/token/create
- Add new fields to
/credit/bank_income/getresponse
- Remove
permitteddecision for/transfer/authorization/create
- Add beta field
consented_productsto/item/get/endpoint response
- Revamp LinkTokenCreate.IncomeVerificationOptions for GA
- Add
/transaction/rules/create,/transaction/rules/listand/transaction/rules/removeendpoints
- Added
/user/createendpoint
- Updating to OAS 2020-09-14_1.79.0
- Many enum fields have been de-anonymized and renamed, new names can be found in the
2020-09-14_1.64.15change message - Non integer numbers are now
float64fields
- Update to include all changes up to
2020-09-14_1.77.4(Undo revert from1.78.xupdates)
- Remove the word "Asset" before "Relay" in every asset report relay related responses and request objects
- Add "AssetReport" at the beginning of relay related responses and request objects to match the same pattern as other assets related objects
- Add
ProductAccessfields for upcoming partner
- Updating to OAS 2020-09-14_1.78.2
- Java library 10.1.0 was erroneously released as a
minorversion; 10.1.0 changes will be re-released as amajorversion shortly.
- Updating to OAS 2020-09-14_1.77.1
- Fix extraneous field in enum that caused issue in code generation
- Added
asset_report_idto the example for/asset_report/relay/refresh
- Explicitly set
format: doublefor non-integer numbers so generated fields prefer float64
- Add three new endpoints for Assets:
/asset_report/relay/create,/asset_report/relay/get, and/asset_report/relay/rmeove
- Added
/asset_report/relay/refreshendpoint
- Add
recurring_transactionsto list of products
- Add new endpoint for
/credit/bank_income/get
- Updated documentation URLs for all product endpoints. They can now be found
at
/docs/api/products/<product-name>/#endpointinstead of/docs/api/products/#endpoint
- internal changes
- Remove deprecated
income_verification_idfrom/sandbox/income/fire_webhook
- Reorder processors enum
- Added
/beta/transactions/v1/enhanceendpoint
- Added
statusobject to sample responses for/institutions/getandinstitutions/searchendpoints
- Mark
include_personal_finance_category_betaproperty as deprecated. - Add new argument
include_personal_finance_categoryto TransactionsGetRequestOptions. - Update docs for
/transactions/getrequest and response, referencing personal_finance_category taxonomy csv file.
- internal changes
- Removed unused
/income/verification/summary/getendpoint
- Added Payment Consent endpoints
- Removed unused
/income/verification/paystub/getendpoint
- De-anonymized enums:
PaymentInitiationPaymentReverseResponse.properties.status=>PaymentInitiationRefundStatusPaymentInitiationPaymentCreateResponse.properties.status=>PaymentInitiationPaymentCreateStatusPaymentInitiationRefund.properties.status=>PaymentInitiationRefundStatusPaymentAmount.properties.currency=>PaymentAmountCurrencyInvestmentTransaction.properties.type=>InvestmentTransactionTypeInvestmentTransaction.properties.subtype=>InvestmentTransactionSubtypeTransferAuthorizationDecisionRationale.properties.code=>TransferAuthorizationDecisionRationaleCodeTransferAuthorizationGuaranteeDecisionRationale.properties.code=>TransferAuthorizationGuaranteeDecisionRationaleCodeTransferAuthorization.properties.decision=>TransferAuthorizationDecisionTransferEventListRequest.properties.transfer_type=>TransferEventListTransferTypeBankTransferEventListRequest.properties.bank_transfer_type=>BankTransferEventListBankTransferTypeBankTransferEventListRequest.properties.direction=>BankTransferEventListDirectionTransferIntentCreate.properties.status=>TransferIntentStatusTransferIntentGet.properties.status=>TransferIntentStatusTransferIntentGet.properties.authorization_decision=>TransferIntentAuthorizationDecision
IncomeVerificationPrecheckMilitaryInfo.properties.branchis now a string field (previously enum)
- Made
last_statement_balanceandminimum_payment_amountnullablefor credit card liabilities schema to reflect existing API behavior.
- Made
last_payment_amountandlast_statement_issue_datenullablefor credit card liabilities schema to reflect existing API behavior. - Fix transfers examples to reflect more consistent usage of
regionfield.
- Updating to OAS 2020-09-14_1.64.13
- Split
AccountSubtypeenums and objects into per-endpoint ones to more accurately represent allowed values.DepositoryFilter's account subtypes usesDepositoryAccountSubtypesCreditFilter's account subtypes usesCreditAccountSubtypesLoanFilter's account subtypes usesLoanAccountSubtypesInvestmentFilter's account subtypes usesInvestmentAccountSubtypes
- Deprecate
idempotency_keyparameter in transfer/create
- Removed the unused
required_product_accessandoptional_product_accessparameters fromRequestedScopes
- Fix some examples that were not consistent with their schemas
- Add
adjustmentsas an investments transaction type to make OpenAPI file consistent with values returned by the API - Clarify description field for
marital_statusto reflect possible values
- Updated the external docs URL for Bank Transfers sandbox endpoints
- De-anonymized the object filters under
LinkTokenCreateRequestAccountSubtypes, as anonymous objects aren't compatible with the generated CLibs. - De-anonymized some misc. objects
PaymentInitiationMetadata/properties/maximum_payment_amountPaystubOverride/properties/employerPaystubOverride/properties/employeePaystubOverride/properties/employee/properties/addressLiabilitiesDefaultUpdateWebhook/properties/account_ids_with_updated_liabilities
- Updated the description of the historical_balances array
- Add new possible enums for income verification earnings breakdown canonical description
- Hid a few product enum values that are deprecated or no longer valid for certain request fields. This affects the documentation only.
- Make guarantee fields required in Transfer endpoints
- Updated description for
failure_reasonfield in Transfer endpoints
- Make
repayment_idrequired in/transfer/repayment/return/listendpoint
- Update description for legal name field in
BankTransferUser
- Update descriptions for
/transfer/repayment/listand/transfer/repayment/return/listendpoints
- Remove
scheme_automatic_downgradefrom/payment_initiation/payment/create
- Update description for
/sandbox/transfer/sweep/simulateendpoint
- Refactor account subtype enums for greater specificity. This has no changes to the API but is a major semver change for Python, Node, Go, and Java client library interfaces to the AccountSubtype object within account filtering contexts in
/link/token/create. TheAccountSubtypenamespace in this context is now prefixed with the AccountType. (Example for Node: Old:AccountSubtype.checkingNew:DepositoryAccountSubtype.checking)
- Update description for
datetimeandauthorized_datetimefields in Transactions endpoints
- Make
sweep_id/sweep_amountfields on Transfer Event nullable
- Set
institution_statusto be nullable inInstitutionsGetResponse
- Update external docs URLs for Transfer and Bank Transfer endpoints
- Update description for
ach_return_codefield in Transfer endpoints
- Add
join_dateto/application/getand/item/application/list - Remove
created_atfrom/application/get
- Updated various description fields for Income
- Add
employmentas an available product in Product array.
- Add
minItemsandminLengthvalidation to various fields in/institution/*request schemas
- Add guarantee_decision and guarantee_decision rationale fields to the transfer API
- Add repayment-related resources to the transfer API
- Remove
receiver_pendingandreceiver_postedfrom bank transfer event types. - Remove
BankTransferReceiverDetailsfrom bank transfer event types.
- Update description formatting for
sweepandamountfields for sweep endpoints
- Added
NEW_ACCOUNTS_AVAILABLEwebhook code as valid input to/sandbox/item/fire_webhook - Update description for
/sandbox/item/fire_webhook
- Set the
minimumfor thecountandoffsetfields inInstitutionsGetRequest - Set
products,routing_numbers, andoauthfields to be nullable inInstitutionsGetRequestOptions - Set
productsto be nullable inInstitutionsSearchRequest - Set
oauth,include_auth_metadata, andinclude_payment_initiation_metadatafields to be nullable inInstitutionsSearchRequestOptions - Set
payment_idfield to be nullable inInstitutionsSearchPaymentInitiationOptions
- Adds
DOCUMENT_TYPE_NONEenum value for document metadata
- Relax length restrictions on the
currencyfield in thePayschema
- Use new payment statuses in
PaymentStatusUpdateWebhook
- Updating to OAS 2020-09-14_1.61.0
- Updating to OAS 2020-09-14_1.58.1
- Updating to OAS 2020-09-14_1.54.2
- Updating to OAS 2020-09-14_1.46.1
- Updating to OAS 2020-09-14_1.44.0
- Updating to OAS 2020-09-14_1.40.3
- Updating to OAS 2020-09-14_1.36.1
- Updating to OAS 2020-09-14_1.34.1
- Fixed an issue with enums in this library. The library is supposed to be able to gracefully handle new values being returned from the endpoint. Previously, if there were new enum values this library would crash. Now it coerces it into an
ENUM_UNKNOWNvalue.
Updating to OAS 2020-09-14_1.33.0.
Updating to OAS 2020-09-14_1.31.1.
Updating to OAS 2020-09-14_1.26.1.
The official release of the plaid-java generated library. Refer to the beta migration guide for tips on migrating from older version of the libraries.
This particular version is pinned to OpenAPI version 2020-09-14_1.20.6.
Type fixes, see full changelog here.
This version represents a transition in how we maintain our external client libraries. We are now using an API spec written in OpenAPI 3.0.0 and running our definition file through OpenAPITool's java generator. All tests have been rewritten to support the new format.
Change CountryCodes to enum:
- from:
Arrays.list("US") - to:
Arrays.list(CountryCode.US)
Rename model imports:
- from:
com.plaid.request.ModelNameandcom.plaid.response.ModelName - to:
com.plaid.model.ModelName
Rename products:
- from:
com.plaid.client.request.common.Product - to:
com.plaid.model.Products
Rename Error model:
- from:
com.plaid.client.model.ErrorResponse - to:
com.plaid.client.model.Error - from:
ErrorResponse.ErrorType - to:
Error.ErrorTypeEnum
Rename Account model:
- from:
import com.plaid.client.model.Account - to:
import com.plaid.client.model.AccountBase
Rename Payment Initiation Models:
- from:
import com.plaid.client.model.paymentinitiation. - to:
import com.plaid.client.model.PaymentInitiation${Model}
Request Model Structure:
- All request models changed from having their options passed as function arguments
new AuthGetRequest(accessToken) - To now having builder syntax
new AuthGetRequest().accessToken(accessToken). - All
with$VARNAMEchained setters are now setters have been converted to${}options.
Response Model Structure:
- Model response properties are no longer connected to their parent response.
- Most other getters/setters stayed the same outside of a few capitalization changes.
Plaid Client changes:
- Remove all occurrences of
service()attached toclient()endpoint queries. - Endpoints that start with
getare now ${Model}Get.
- Add deposit switch support for
/link/token/create
- Add support for
optionsto/payment_initiation/payment/create
- Add
last_updated_datetimeto/accounts/balance/get
- Add mortgage object to Liabilities
- Add Standing Orders support to Payment Initiation
- Add Bank Transfers endpoints to the library
- The library has been pinned to the '2020-09-14' API release. Visit the docs to see what changed.
- the
/item/public_token/createendpoint has been disabled in favor of the /link/token/create endpoint - The
/item/add_token/create endpointhas been disabled in favor of the /link/token/create - The
/payment_initiation/payment/token/createendpoint has been disabled in favor of the /link/token/create endpoint - The
/item/removeendpoint will no longer return aremovedboolean. - The
/institutions/get,/institutions/get_by_id, and/institutions/searchnow requirecountry_codesto be passed in.
- Add support for Link Token get endpoint (#239)
/link/token/get
- expose Gson builder on Plaid Client.
- [BREAKING] Add BACS support to
/recipient/create - Remove unnecessary
finals from classes - Adds support for
routingNumbersfield onInstitution
- Alter required fields for
link/token/createendpoint. - Downgrade okhttp3 version due to dependency management issue.
- Add support for the
merchantNamefield onTransaction
- [BREAKING] Remove
publicKeyfrom the library, because it is no longer needed by the API - Add support for the
/link/token/createendpoint
- Add remaining per-product
InstitutionStatusfields - Add support for the
paymentChannelfield onTransaction - Add support for the
/sandbox/item/set_verification_statusendpoint
- Add optional fields to the /item/add_token/create User object
- Add support for /item/add_token/create endpoint
- Add item status for the investment product.
- Add transaction_code field to the Transaction object.
- Add support for Transactions Refresh endpoint:
/transactions/refresh
- Add authorized_date field to Transactions object
- Add support for webhook_verification
- Add support for deposit switch endpoints
- Add support for UK Payment Initiation
- Add VerificationStatus to Account object
- Add consent expiration time to ItemStatus
- Add support for Credit liabilities.
- Add support for Account subtype filtering in Institution Search.
- Remove support for deprecated endpoint
/item/access_token/update_version.
- Add support for Student loan liabilities.
- Add support for Investments.
- Add support for 2019-05-29 API version
- Allow more robust customization of underlying OkHttpClient used by PlaidClient.
- Add support for
/sandbox/item/fire_webhookendpoint (#140)
- Deprecate direct integration as it is no longer supported
- Replace
/item/deletewith/item/remove - Add support for include_institution_data for /institutions/search, /institutions/get, /institutions/get_by_id (#134)
- Fix transaction get request handling. (#132)
- Add support for Asset Reports with Insights (#130)
- Add support for filtering asset reports (#125)
- Add support for asset report refresh (#126)
- Add support for /asset_report/audit_copy/get (#127)
- Allow
TransactionGetRequest.Optionsto be subclassed (#110)
- Add Assets as a product (#109)
- Add
/item/removeendpoint anditemRemove(), an alias for/item/deleteanditemDelete()respectively (#99)
- Add
INSTITUTION_ERRORErrorType(#96)
- Add
getItemIdmethod toItemAccessTokenUpdateVersionResponse(#95) - Fix failing Sandbox unit tests
- Fix Apex and Dwolla
processor_tokenreturn values (#91)
- Add support for Apex and Dwolla processor tokens (#87)
- Add
getItemId()method toItemPublicTokenExchangeResponse(#82) - Add
incomeGetto support Income (fixed #79) - Make
TransactionsGetResponseinner classes static (fixed #81)
- Initial release for Plaid's updated API