See full changelog for the OpenAPI schema (OAS) here.
- Updating to OAS 2020-09-14_1.419.0
- Update
/signal/decision/reportdescription- Overwriting
initiatedfield is now supported and no longer returns anINVALID_FIELDerror
- Overwriting
- Add
frequencyto/transactions/enrich
- Remove
category,category_id,transaction_type,name,payment_metafields from Base Report insights
- Add
card_switchto/link/token/create
- Add
consumer_report_permissible_purposetolink/token/create
- Update
currencyonpayment/reverseandamount_refundedonpayment/get
- Updating to OAS 2020-09-14_1.413.0
- Add
statementsto/link/token/createrequest
- Add
hosted_link_urlto/link/token/createresponse - Add
hosted_link.delivery_methodto/link/token/create
- Add
link_sessionsto/link/token/get - Add
LINK:SESSION_FINISHEDwebhook
- Updating to OAS 2020-09-14_1.410.1
- Add
statementsto the list of supported Plaid products in the/link/token/createendpoint
- add
/credit/relay/pdf/getendpoint
- Add
original_client_idto/transfer/balance/get - Mark
typeoptional in/transfer/balance/getrequest
- Add
statustodocument_referencein/credit/payroll_income/risk_signals/get
- Add
consumer_report_user_identityto/user/create
- Add comment explaining availability of
confidence_levelfield for/transactions/*endpoints
- Added insights fields to
/cra/base_report/get
- Update identity/match user.address such that none of the fields are required
- Add
AddressDataNullableNoRequiredFields
- Allowing null failure_reason for refunds to be displayed
- Add
failure_reasonto/wallet/transaction/getand/wallet/transaction/listendpoint in virtual accounts.
- Add
parsing_configto/link/token/create
- Add
failure_reasonfield to refunds for failed and returned refunds
- Add
area_codematch status to the response of theidentity_verification/getandidentity_verification/listendpoint
- Add
POST /cra/bank_income/get
- Add
cra/base_report/getendpoint
- Add
base_reportfield to/link/token/createand corresponding Base Report webhooks
- Make CreditBankIncomeWebhookUpdateResponse visible
- Remove extraneous
Itemfield from/processor/transactions/getresponse - Reference new
/processor/token/webhook/updateendpoint in processor Transactions routes.
- Document cash management account support
- Fix document capitalization of
confidence_levelfield in/transactions/enrich
- Add
/beacon/report/create
- Add
POST /beacon/user/create - Add
POST /beacon/user/get
- Made
/statements/listand/statements/downloadAPIs for Plaid's Statements PDF beta product available in client SDKs
- Add
date_of_birthandaddressfields todocumentary_verification.documents[].extracted_datain the response of all of the identity verification endpoints:identity_verification/createidentity_verification/getidentity_verification/listidentity_verification/retry
- Update the following about identity/match name, phone number, email, and address score descriptions:
- Ensure consistent language across all fields
- Include score recommended "match" threshold for all fields.
- Update the
async_updatefield description.
- Mark a few response fields as always present in the identity verification API:
selfie_check.selfies[].capture.image_urlselfie_check.selfies[].capture.video_urlrisk_check.identity_abuse_signalsrisk_check.identity_abuse_signals.synthetic_identity.scorerisk_check.identity_abuse_signals.stolen_identity.score
- Documentation updates for the
/link/token/createendpoint
- Add
confidence_levelfield to Counterparty and PersonalFinanceCategory for/transactions/enrich
- Remove the
core_attributesfield insignal_insightsof /transfer/authorization/create
-
Update the
pending_manual_verificationfield's description in/auth/getresponse -
Updating to openapi-generator v6.1 to enable autoload support
-
Updating to OAS 2020-09-14_1.391.1
- Update the description of
/investments/transactions/get
- Update the
async_updateoption to be visible in/investments/transactions/get
- Update the
signal_insightsfield's description in/transfers/authorization/createrequest
- Add
transfer_idfield to/transfers/sweep/listrequest
- Add
InvestmentsHistoricalUpdateWebhook, aHISTORICAL_UPDATEwebhook of typeINVESTMENTS_TRANSACTIONS.
- Add
statusfield to a sweep object. Addstatusfield to/transfers/sweep/listrequest
- [Breaking] Remove
asset_report_tokenas required field in/asset_report/getand mark as nullable
- Allow empty
maskon themetafield of overridden accounts in the sandbox custom user configuration object schema.
- Mark
regionandpostal_codefields as nullable in/identity_verification/create,/identity_verification/retry, and/link/token/create
- Add payloads for processor Transactions webhooks.
- Mark
next_origination_datenullable
- Updating to OAS 2020-09-14_1.385.1
- Add expiration time description to
transfer/authorization/createidempotency_keyparameter
- Add
userfield to/identity_verification/retry - Add
client_user_idfield to/identity_verification/create - Deprecate
user.client_user_idfield in/identity_verification/create - [Breaking] Renamed
IdentityVerificationRequestUserobject toIdentityVerificationCreateRequestUser
- Remove
maxLengthconstraint fromclient_user_idfield for/processor/signal/evaluateand/signal/evaluaterequests
- Add
test_clock_idtotransfer/authorization/createrequest
- Update
InvestmentsAuthOwnertitle
- Add
account_idtobank_accountsandtransactionsin/credit/bank_statements/uploads/getresponse
- Add
transfer/diligence/document/uploadendpoint
- Add
amountto/transfer/sweep/listrequest
- Add
signal_insightsto/transfer/authorization/createrequest
- Add definitions for
/sandbox/bank_income/fire_webhook
- Update validation
sweep_idfor/transfers/sweep/getto allow UUID or 8 character hexadecimal string
- Updating to OAS 2020-09-14_1.379.0
- Add
schemeto/wallet/transaction/getand/wallet/transaction/list
- Fix issue in which
request_idwas erroneously not listed as required inItemActivityListResponse
- Add
reroute_to_credentialsto/link/token/createauth request
- Add definitions for
/investments/auth/get
- Add
required_if_supported_productsto/link/token/createrequest
- Add hidden
account_typeto/transactions/enrichrequest and response - Add hidden
account_subtypeto/transactions/enrichrequest and response
- Add
num_bank_statements_uploadedtodocument_income_resultsobject in/credit/sessions/getresponse
- Add
income_sourceenum to/transactions/enrichcounterparty_typefield
- Update
oauthdescriptions for/institutions/getand/institutions/search
- Add
/credit/bank_statements/uploads/getendpoint
- Add support for address and date of birth in
virtual-accounts/#wallettransactionexecuteendpoint
- Modify
/transactions/enrichfielduser_idtoclient_user_id - Modify
/transactions/enrichfieldaccount_idtoclient_account_id
- Update docs for
/transactions/enrichresponse to include non-null example values forlatandlonfields
- Update descriptions for
PAYMENT_STATUS_EXECUTEDandPAYMENT_STATUS_INITIATED - Update description for
PaymentAmountCurrency
- Add
user_idandaccount_idfields to/transactions/enrichrequest and resposne
- Update descriptions for
/credit/payroll_income/risk_signals/getandINCOME_VERIFICATION_RISK_SIGNALSwebhook
- Add test_clock_id to
/transfer/simulate - [Breaking change for Go] Make
virtual_timeoptional in/sandbox/transfer/test_clock/create
- Add test_clock_id to
/sandbox/transfer/simulateand/sandbox/transfer/sweep/simulateendpoints
- Update
transfer/diligence/submitcopy
- Updating to OAS 2020-09-14_1.370.0
- Add
investments/refreshendpoint
- Update
descriptionfield in/transfer/createto have max length of 15
- Add new
CreditBankIncomeCategoryvalue
- Fix
/processor/transactionsroutes doc links
- Add
/processor/token/permissions/getendpoint - Add
/processor/token/permissions/setendpoint
- Add
transfer/diligence/submitendpoint
- Update
client_user_iddescription for Identity Verification endpoints - Update
userdescription for Identity Match via Identity Verification Data use case
- Add
/transfer/balance/getendpoint
- Added
LinkEventsWebhookschema
- Add
credit_funds_sourcefield for authorizations and transfers - Make
funding_account_idnullable in various /transfer API responses
- Update
notificationsPayload.customFieldsdatatype from an object to an array of objects
- Added
warningsto/processor/signal/evaluateresponse.
- Added
/processor/identity/matchendpoint.
- Adds a
selfie_checkobject to the response schema of all the identity verification endpoints:identity_verification/createidentity_verification/getidentity_verification/listidentity_verification/retry
- Update
INCOME_VERIFICATION_RISK_SIGNALSwith webhook tag
- Add
ASSETS: PRODUCT_READYandASSETS: ERRORwebhooks to/sandbox/item/fire_webhookendpoint
- Removed explicit
additionalProperties: truemarker for request objects and objects used only within request objects, primarily impacting the Payment Initiation API. This will result in more strict type checking for those objects, but should not be a breaking change.
- Update
transfer/authorization/createcopy
- Add new
INCOME_VERIFICATION_RISK_SIGNALSwebhook
- Remove
settled_amount - Rename
expected_settlement_scheduleasexpected_sweep_settlement_schedule
- [Breaking] Converts several types that were incorrectly typed as
numbertointeger. In some languages, this will change the type used for this field, which may be a breaking change for some Plaid integrations. The following fields are impacted:
For all products:
PlaidError.status
For Liabilities:
PSLFStatus.payments_madePSLFStatus.payments_remaining
For Identity Verification and Monitor:
DocumentaryVerificationDocument.DocumentAnalysis.attemptEntityScreeningHitAnalysis.search_terms_versionEntityWatchlistScreeningSearchTerms.search_terms_versionIdentityVerificationTemplateReference.version
The following client library languages are impacted:
- Go: Type changes from Float64 to Int32
- Java: Type changes from Double to Integer
- Python: Type changes from float to int
- Ruby: Type changes from Float to Integer
- Update
/identity/match's score description to explicitly mention that null values are returned if input is missing from either the financial institution or the API - Update
/identity/matchsample response to includeis_business_name_detected
- Make the
warningsfield inSignalEvaluateResponsenon-nullable
- Add
STARTEDandINTERNAL_ERRORto bank income and employment/credit/sessions/getstatus
- Change invalid format
datetimetodateoninitiated_datefield - Update
SignalWarningdescriptions
Fix npm publish
- Releasing new
/credit/payroll_income/risk_signals/getendpoint
- Revert
sweep_amountdescription
- Update
sweep_amountdescription
- Internal changes
- Updating to OAS 2020-09-14_1.345.1
- Update
/transactions/enrichfieldis_recurringfield to be optional.bool
- Fix bug in which
environmentfield was incorrectly missing from Assets webhooks.
- Add recurrence and is_recurring fields to
/transactions/enrich
- Update incorrect required fields for
/watchlist_screening/entity/update
- Update
ownersdescription for/credit/bank_income/getand/beta/credit/v1/bank_employment/get
- Make comment about
webhookfield in/link/token/createrequest more explicit
- Make VOA in /credit/freddie_mac/reports/get optional
- Update
warningsdescription for/credit/bank_income/getand/beta/credit/v1/bank_employment/get
- Updated Asset endpoint descriptions related to Verification of Employment
- Updating to OAS 2020-09-14_1.343.0
- Add new
warningsfield to the response of/signal/evaluate
- Add
report_typeto assets webhook docs - Make
add_onspublic in assets docs for /asset_report/create - Make
fast_reportpublic in assets docs for /asset_report/get
- Add
risk_checkattribute to all Identity Verification responses
- Update examples for
entity_idin/transactions/enrich
- Create
optionsin/link_delivery/create - Create
recipientwithinoptionsfield - Move
communication_methodsfrom top level torecipient - Add
first_nameinrecipient
- Add
callback_typeto link delivery webhooks
- Make
communication_methodsoptional in/link_delivery/create
- Remove beta description from
/transactions/enrichendpoint docs
- Add
transaction_idto/payment-initiation/#payment_status_update - Add
payment_idandwallet_idto/virtual-accounts/#wallet_transaction_status_update
- Modify documentation for credit categories in the
/asset_report/getbased on GTM feedback
- Update description for the
addressfield in/payment_initiation/recipient/create.
- Add annually recurring frequency to
/transactions/recurring/get
- Make documentation for credit categories in the
/asset_report/getendpoint public
- Add bank employment results to
/credit/sessions/get
- Add
signalto Products array.
- Add options to
/credit/payroll_income/refreshto allow item-level refresh
- Updated
amount.valuedescription field with new minimum requirement for/payment_initiation/payment/reverseand/wallet/transaction/execute
- Add 'employment' as an available product in the request to
/partner/customer/create
- [Breaking] Renamed Identity Verification UserName objects to IdentityVerificationRequestUserName and IdentityVerificationResponseUserName
- Updating to OAS 2020-09-14_1.334.0
- Add "entity_id" field to /transactions/enrich
- Add "add_ons" field to asset_report/create
- [Breaking] Remove
/wallet/transaction/listendpoint- [Note] Determined that
/wallet/transaction/listis unused
- [Note] Determined that
Add LinkDeliveryCallbackWebhook, LinkUserDeliveryStatusWebhook for Link Delivery.
- [Breaking] Remove
options.wallet_idfield in/payment_initiation/payment/createand/payment_initiation/consent/createrequest.- [Note] Determined that this field is unused.
- Undeprecated the
legal_namefield in the/link/token/createrequest.
- Add
income_verificationas a supported product in the request for/partner/customer/create.
- Add
networkfield to/transfer/intent/createrequest. - Updated
referenceminLength for/wallet/transaction/executerequest and/payment_initiation/payment/reverserequest.
- Add
access_tokensanditem_idsto/link_delivery/getresponse
- Add optional
persistent_account_idfield to account responses
- Add
employmentfields to/link/token/create
- Add
redacted_atfield in Identity Verification response and Documentary Verification Document component - Update
original_frontfield in Identity Verification Document Images to be nullable in redacted Identity Verification sessions
- Add
earliest_deposit_dateand changelast_deposit_datetolatest_deposit_datefor/beta/credit/v1/bank_employment/get
- Add
redirect_uristo/partner/customer/createrequest.
- Add
wallet_idfield to/wallet/transaction/getand/wallet/transaction/listresponses
- Update
link_delivery/getto removepublic_tokensfrom the response
- Update
link_delivery/createto acceptcommunication_methodsand deprecatedelivery_methodanddelivery_destination
- Fix the
refund_idexample. - Update address objects to reflect that in rare instances,
citymay benull.
- Add partner webhook event type
- Mark
phone_number_verified_timeandemail_address_verified_timeas deprecated, since it is no longer required to provide these fields to enable to enable the Returning User Experience.
- Introduce
expected_settlement_datefield in the Transfer object
- Add
/beta/credit/v1/bank_employment/getendpoint
- Add
updatedfield to/credit/audit_copy_token/updateresponse - Add
SchemaVersionto VOE and VOA schemas for/credit/freddie_mac/reports/get
- Introduce
funding_account_idfield in the Transfer API - Remove deprecated
origination_account_idfield from the Transfer documentation
- Use more strict validation for
payment_idandrecipient_idfields in API
- Use more strict validation for payment
consent_idfield in API
- Add
statusto Wallet schema
- Updating to OAS 2020-09-14_1.214.0
- Add
/credit/freddie_mac/reports/getendpoint
- Reflect that
days_requestedfield in Bank Income Verification object in/link/token/createrequest is required when using Bank Income. - Reflect that
is_update_modefield in Bank Income Verification object in/link/token/createrequest defaults tofalse. - Update description to reflect that Document Income object in
/link/token/createrequest is not required, even when using Document Income.
- Update
PartnerEndCustomerStatusenum values.
- Add
/credit/audit_copy_token/updateendpoint - Add
report_typeto AssetReportCreateRequest
- Fix
US_MBSlist code which was mistakenly documented asUS_MBCfor screening individuals with Monitor - Document
TR_CMBlist code for screening individuals with Monitor - Document
IZ_WBKlist code for screening individuals and entities with Monitor
- Add
/partner/customer/oauth_institutions/getendpoint.
- Update example response for
/credit/bank_income/get
- Documentation updates for Investments APIs and Bank Transfer APIs.
- Add validation on
originator_client_idandredirect_urifor/transfer/originator/createandtransfer/originator/getrequest
- Add
company_nameto TransferOriginatorGetResponse
- Updating to OAS 2020-09-14_1.210.4
- Add
recurring_transfer_idto Transfer
- Make
id_numbersfield hidden in/user/createrequest
- Make
transfer_idsrequired in RecurringTransfer
- Change the
/transactions/enrichoptions.include_legacy_categoriesfield tooptions.include_legacy_category - Make documentation for the
/transactions/enrichoptions.include_legacy_categoryrequest field visible - Make documentation for the
/transactions/enrichlegacy_categoryandlegacy_category_idresponse fields visible - Add
directionto required fields forClientProvidedTransaction
- Add
/transfer/capabilities/getendpoint to fetch RTP eligibility for a linked plaid item
- Renamed the
NullableRecurringTransfertype toRecurringTransferNullabletype
Add nullable property to date_of_birth, phone_number_verified_time, and email_address_verified_time fields within LinkTokenCreateRequestUser to resolve undesireable client library behavior in certain languages.
- add
NullableRecurringTransferfield - replace
RecurringTransferwithNullableRecurringTransferforTransferRecurringCreateResponse - and
Decisionin required fields forTransferRecurringCreateResponse - add required fields for
TransferRecurringSchedule
- Add
total_amountsfield to/credit/bank_income/getresponse - Deprecate
amount,iso_currency_code, andunofficial_currency_codeat top levels in/credit/bank_income/getresponse
- Add
id_numbersfield to/user/createrequest
- Add
RECURRING_NEW_TRANSFERwebhook event. - Add
RECURRING_TRANSFER_SKIPPEDwebhook event. - Add
RECURRING_CANCELLEDwebhook event.
- make
idempotency_keyfield for/transfer/recurring/createnon-nullable
- Add
descriptionfield forRecurringTransferobject - Make
TransferRecurringStatusnon-nullable
- Make all mentions of relay tokens lowercase
- Updated external URLs for Credit Relay endpoints, and marked them as beta in the summary
- Add more enums values to
pay_ratefield in/credit/payroll_income/getresponse - Add
pay_basisfield to/credit/payroll_income/get
- Updated Credit Relay Token descriptions
- Add
FUNDS_SWEEPas atypeenum for theWalletTransactionobject
- Make
test_clock_idnon-nullable intest_clock.
- Update
CounterpartyTypeto renamedelivery_marketplacetomarketplace - Update
CounterpartyTypeto addpayment_terminal
- Update the
transactions/enrichtransaction description example to match the request.
- Add
/sandbox/transfer/test_clock/listfor recurring transfer - rm
decisionanddecision_rationalefromRecurringTransfer - add
decisionanddecision_rationaleinTransferRecurringCreateResponse - rename
frozen_timestamptovirtual_time - not requiring
client_idandsecretfor recurring transfer APIs
- Use a nested
optionsfield for optional request params totransactions/enrich - Make nullable fields required for
transactions/enrich
- Update supported payment scheme options for
/payment_initiation/payment/create– Update description of/payment_initiation/recipient/createto mention non-Eurozone countries. – Update/payment_initiation/payment/creatementioning new currencies and non-Eurozone markets. – RemovedCHFandCZKfrom the list of supported currencies.
- Add website and logo_url to the
Counterpartyobject for the Enrich product. - Update descriptions for logo_url field in
Counterparty,TransactionCounterparty,EnrichmentsandEnhancements.
- Update field descriptions and response examples for
transactions/enrich
- Add support for optional request parameters in /transactions/enrich
- Add
locationfield toClientProvidedTransactionobject - Add
mccfield toClientProvidedTransactionobject - Add
date_postedfield toClientProvidedTransactionobject
- Document partial refunds
- Update description for
/payment_initiation/payment/reverseendpoint - Update description for
/payment_initiation/payment/getendpoint
- Updating to OAS 2020-09-14_1.205.3
- Update description for
/signal/evaluateendpoint
- Update response examples, descriptions, and formatting for
/transactions/enrichendpoint
- Update descriptions for
CUSIPandISINfields in the investmentsSecuritytype to reflect CGS license requirements
- Add
/transactions/enrichendpoint, the EA version of/beta/transactions/v1/enhance.
- Remove
/income/verification/refreshendpoint
- Add 7 brand new recurring transfer APIs
- Add
/transfer/recurring/create - Add
/transfer/recurring/list - Add
/transfer/recurring/get - Add
/transfer/recurring/cancel - Add
/sandbox/transfer/test_clock/create - Add
/sandbox/transfer/test_clock/advance - Add
/sandbox/transfer/test_clock/get
- IdentityMatchResponse
PhoneNumberMatchScoreandEmailAddressMatchScoreusescoreinstead ofscores
- Add
/partner/customer/removeendpoint
- Internal changes
- New Transfer API routes for hosted onboarding of TPS end-customers
- Add
refundsfield toTransferobject - Add
refund_idfield toTransferEventobject - Fix typo for
transfer/getandtransfer/refund/get
- Add support for partial refunds
- Add
amountfield to/payment_initiation/payment/reverserequest - Add
amount_refundedfield to/payment_initiation/payment/getand/payment_initiation/payment/listresponses
- Add
risk_summaryandpage_numberto/beta/credit/payroll_income/risk_signals/get
- Renamed
/wallet/transactions/listinto/wallet/transaction/listas endpoint
/transfer/authorization/createand/transfer/createmay not returnaccount_idin response.
- Add
SYNC_UPDATES_AVAILABLEsupport to/sandbox/item/fire_webhook
- Make
ProductStatusobject nullable to reflect Sandbox-specific behavior. - Clarify documentation for
SYNC_UPDATES_AVAILABLEwebhook.
- Internal changes
- Add
deleted_atto/payment_profile/getresponse.
- Change
start_datetostart_timefor/wallet/transaction/listresponse.
- Update list of available products for
/partner/customer/create.
- Add
institution_nameandinstitution_idfields to/credit/payroll_income/getresponse.
- Add
options.start_dateandoptions.end_dateto/wallet/transaction/listendpoint. - Add
last_status_updateandpayment_idfield toWalletTransaction. - Add
transaction_idfield toPaymentInitiationPayment
- Add
originator_client_idto Transfer API endpoints
- Deprecate
origination_account_idfrom/transfer/authorization/createendpoint.
- Add
asset_under_managementfield toPartnerCustomerCreateRequest.
- Updating to OAS 2020-09-14_1.205.3
- Update description for
/signal/evaluateendpoint
- Update response examples, descriptions, and formatting for
/transactions/enrichendpoint
- Update descriptions for
CUSIPandISINfields in the investmentsSecuritytype to reflect CGS license requirements
- Add
/transactions/enrichendpoint, the EA version of/beta/transactions/v1/enhance.
- Remove
/income/verification/refreshendpoint
- Add 7 brand new recurring transfer APIs
- Add
/transfer/recurring/create - Add
/transfer/recurring/list - Add
/transfer/recurring/get - Add
/transfer/recurring/cancel - Add
/sandbox/transfer/test_clock/create - Add
/sandbox/transfer/test_clock/advance - Add
/sandbox/transfer/test_clock/get
- IdentityMatchResponse
PhoneNumberMatchScoreandEmailAddressMatchScoreusescoreinstead ofscores
- Add
/partner/customer/removeendpoint
- Internal changes
- New Transfer API routes for hosted onboarding of TPS end-customers
- Add
refundsfield toTransferobject - Add
refund_idfield toTransferEventobject - Fix typo for
transfer/getandtransfer/refund/get
- Add support for partial refunds
- Add
amountfield to/payment_initiation/payment/reverserequest - Add
amount_refundedfield to/payment_initiation/payment/getand/payment_initiation/payment/listresponses
- Add
risk_summaryandpage_numberto/beta/credit/payroll_income/risk_signals/get
- Renamed
/wallet/transactions/listinto/wallet/transaction/listas endpoint
/transfer/authorization/createand/transfer/createmay not returnaccount_idin response.
- Add
SYNC_UPDATES_AVAILABLEsupport to/sandbox/item/fire_webhook
- Make
ProductStatusobject nullable to reflect Sandbox-specific behavior. - Clarify documentation for
SYNC_UPDATES_AVAILABLEwebhook.
- Internal changes
- Add
deleted_atto/payment_profile/getresponse.
- Change
start_datetostart_timefor/wallet/transaction/listresponse.
- Update list of available products for
/partner/customer/create.
- Add
institution_nameandinstitution_idfields to/credit/payroll_income/getresponse.
- Add
options.start_dateandoptions.end_dateto/wallet/transaction/listendpoint. - Add
last_status_updateandpayment_idfield toWalletTransaction. - Add
transaction_idfield toPaymentInitiationPayment
- Add
originator_client_idto Transfer API endpoints
- Deprecate
origination_account_idfrom/transfer/authorization/createendpoint.
- Add
asset_under_managementfield toPartnerCustomerCreateRequest.
- Updating to OAS 2020-09-14_1.197.3
- Move from Ruby 2.4.0 to Ruby 3, incorporating #440
- Consolidate usages of
ErrorintoPlaidError - Rename
LOGIN_REQUIREDfrom transfer authorizationsdecision_rationaletoITEM_LOGIN_REQUIRED - Update
IdentityVerificationRequestUser.date_of_birthto be required to match the existing behavior of the API.
- Update supported
CountryCode's inlink/token/createdocs.
- ach_class optional
- add rtp network option
- Add newly supported languages for Link
- Add
PAYMENT_PROFILE_LOGIN_REQUIREDto transfer authorizationdecision_rationale.code.
- Add
institution_namefield topayroll_income_resultof/credit/sessions/get
- Add requirements for
logoinPartnerCustomerCreateRequest.
- Deprecate webhook status
VERIFICATION_STATUS_PENDING_APPROVALinincome_verificationapis.
- Add a note in the description of
/transfer/authorization/create
- Added endpoint
/sandbox/payment_profile/reset_login
- Consolidate usages of
ErrorintoPlaidError - Add a
PlaidErrorTypeenum
- Fix typo for
income_verificationin/sandbox/public_token/createoptions
- Update field descriptions in
/partner/customer/*responses. - Make
PartnerEndCustomerWithSecretsextendPartnerEndCustomer. - Fix documentation links in
/partner/customer/*endpoints.
- Add
/partner/customer/enableendpoint
- Rename
LOGIN_REQUIREDfrom transfer authorizationsdecision_rationaletoITEM_LOGIN_REQUIRED
- Add
/fdx/notificationsendpoint.
- Add
USER_REPORTED_NO_INCOMEto CreditSessionBankIncomeStatus
- Update description for
payment_profile_tokenfield
- Add
income_verficationfield to/sandbox/public_token/create
- Add
document_income_resultfield tocredit/sessions/get
- Remove
payment_profile_idfrom/payment_profile/*,/transfer/authorization/create, and/transfer/createendpoints and replace withpayment_profile_token
- Removed auditor_id from /credit/audit_copy/token/create
- Add length boundary for the
client_user_idfield inuser/create
- Add
SchemaVersionfield to Freddie Mac Verification of Assets Schema
- Add
non-custodial walletto account subtypes supported for investments - Add
tradeinvestment transaction subtype as a subtype oftransferinvestment transaction type
- Add
errorsfield tocredit/sessions/get
- Add
payroll_income_resultfield tocredit/sessions/get
- Update
IdentityVerificationRequestUser.date_of_birthto be required to match the existing behavior of the API.
- Add support for
USER_INPUT_TIMEOUTas a value forforce_errorin the sandbox custom user schema.
- Make
payment_idnot required in/link/token/createunder thepayment_initiationfield.
- Add
beacon_session_idfield in req of /transfer/authorization/create endpoint.
- Add
/link/oauth/correlation_id/exchangeendpoint.
- Updating to OAS 2020-09-14_1.181.1
- Update
report_tokensin/credit/relay/createendpoint request to be a list of strings instead a list of objects
- Add
credit/sessions/getendpoint
- Remove
DateandDateNullabletypes in identity_verification and monitor endpoints. Replace withISO8601DateandISO8601DateNullableinstead.
- Remove
idempotency_keyfield from resp of /transfer/authorization/create endpoint.
- Change
institution_price_as_offield on the Holdings object to nullable
- Add
AUTHORISINGwallet transaction status
- Add
/partner/customer/getendpoint. - Add
statusto the response for/partner/customer/create.
- Add
settledas a valid event type for/sandbox/transfer/simulate
- Replace
ASSET_TRANSACTION_DESCRIPTIONwithASSET_TRANSACTION_DESCRIPTONin Freddie Mac Asset Report
- Add
ownership_typeto Asset Report account object, to reflect actual API behavior. - Update and clarify docs, including update to reflect new Transfers cutoff times.
- Add
settledas a possible Transfer status andswept_settledas a possible Transfer sweep status - Add
settledandswept_settledas new Transfer event types - Add
settledfield to Transfer sweep object - Add
standard_return_windowandunauthorized_return_windowfields to Transfer object
- Add
optionsanddays_to_includedtoAssetReportGetRequest
- Add
recipient_idfield examples to the/wallet/create,/wallet/get, and/wallet/listresponses
- Set
employment_report_tokenfield in the/credit/employment/getendpoint to be not required
- Add
maskto themetafield of overridden accounts in the sandbox custom user configuration object schema.
- Remove
MiddleNameand addVALIDATION_SOURCESto Freddie Mac Asset Report
- Add
adyenas processor partner
- Add
environmentas an attribute to all webhook payloads
- Add
idempotency_keyfield in req/resp of /transfer/authorization/create endpoint.
- Removed
/asset_report/relay/endpoints
- Add payroll institution to /credit/income/precheck endpoint.
- Add
recipient_idto the/wallet/create,/wallet/get, and/wallet/listresponses
- Fix that
client_idandsecretwere erroneously marked asrequiredfor the request bodies of some endpoints. (These fields can be sent in the header and thus are not required in bodies).
- Add
with_guaranteefield in request of/transfer/authorization/create
- Add
issuing_regionas a field in the extracted data to documentary verification documents/identity_verification/create,/identity_verification/get,/identity_verification/listand/identity_verification/retryresponses.
- Add
bacs/ibanrecommendation for/payment_initiation/recipient/create
- Update descriptions for
/payment_profile/create,/payment_profile/getand/payment_profile/remove
-- Add counterparties to /beta/transactions/v1/enhance response
- Added
MICRODEPOSIT_ERRORwhich was returned by the API but missing from the error type enum. - Various fixes to typos and descriptions
- Add authorization code
MIGRATED_ACCOUNT_ITEMfor Items created via/transfer/migrate_accountendpoint
- Add
updated_atfield to Payroll Item entries in/credit/payroll_income/get
- removed LoanRoleType, ReportIdentifierType, and ReportDateTime fields from
/credit/asset_report/freddie_mac/get
- Remove deprecated reverse_swept enum value from documentation
- Update example response for the
wallet/listendpoint
- Add details for
IdentityMatchResponsefor/identity/matchendpoint
- Update descriptions for
HOLDINGS: DEFAULT_UPDATEandINVESTMENT_TRANSACTIONS: DEFAULT_UPDATEwebhooks
- Removed report_type from the request to
/credit/asset_report/freddie_mae/get
- Add documentation for credit categories in the
/asset_report/getendpoint
- Remove redundant parameters from the
/transfer/createendpoint from docs and mark them as deprecated
- Add the following new currencies for the
/payment_initiationAPI route group: PLN, SEK, DKK, NOK, CHF, CZK
- Update description for
/payment_initiation/payment/reverseto indicate that this endpoint only works with virtual accounts - Update description for
/wallet/transaction/executeto indicate that settlement will take seconds to days
- Remove verification fields from
/credit/payroll_income/getand/income/verification/paystubs/get
- Remove pull_id field from
/credit/payroll_income/get
- Update external documentation links for the
/wallet/API route group - Update
/payment_initiation/payment/reversedescription to cover which payments are eligible for refunds - Update
/payment_initiation/payment/createreference field description to indicate that references should be unique and will be adjusted automatically - Update
PaymentInitiationPaymentStatusdescription to indicate that payments may take seconds to days to settle depending on the payment rail used - Update
WalletTransactionStatusdescription to indicate that transactions may take seconds to days to settle depending on the payment rail used
- Make
is_savings_or_money_market_accountfield inSignalEvaluateCoreAttributesnullable
- Add new endpoint
/credit/asset_report/freddie_mac
- Add
/link_delivery/createendpoint - Add
/link_delivery/getendpoint
- Fix minimum and maximum values in
/signal/evaluatescores
- Make holdings
institution_price_as_ofnon-nullable
- Add
WalletTransactionStatusUpdateWebhookobject - Update
WalletTransactionStatusto include an additionalSETTLEDenum - Update
PaymentInitiationPaymentStatusto include an additionalPAYMENT_STATUS_SETTLEDenum
- Updating to OAS 2020-09-14_1.161.5
- Reverts the changes made in 2020-09-14_1.157.0
- Update description for webhook
USER_PERMISSION_REVOKED
- Bug fix: Put quotes around the '529' account type to prevent generated client libraries from treating it as an integer.
- Add
RECURRING_TRANSACTIONS_UPDATEto description of sandbox webhook testing endpoint
- Change the Item schema to refer to
PlaidErrorrather thanErrorto avoid namespace conflicts in client libraries.
- Add required fields back to AssetReport schema
- Remove
access_tokenrequest parameter from/beta/partner/v1/customers/create
- Add
userfields to the/link/token/createuserobject.
- Add
RECURRING_TRANSACTIONS_UPDATEwebhook specification - Fix typo in
/sandbox/item/fire_webhookdescription
- Add x-plaid-validation for Credit Relay Tokens
- Add
addressandid_numberfields to the/link/token/createuserobject.
- Update and add schemas referred by
AssetReportGetResponse
- Add
payment_profile_idto/transfer/authorization/createand/transfer/create - Make
access_tokenandaccount_idoptional in/transfer/authorization/createand/transfer/create
- Add
payment_profile_idas a field undertransferfor/link/token/create
- Create
/credit/bank_income/pdf/getto allow customers to retrieve the bank income product as a PDF
-- Add personal_finance_category_icon_url to /beta/transactions/v1/enhance response
-- Add new endpoint /beta/partner/v1/customers/create
- Add
form1099sas part of thecredit/payroll_income/getresponse. - Add
Credit1099object and corresponding subtypes.
- Update required fields list for guaranteed ACH customers
- Mark
verificationfield underpaystubsobject in/credit/payroll_income/getas deprecated
- Make
user_presentunder/transfer/authorization/createnullable
- Update fields description for guaranteed ACH customers
- Add
gave_consentas a field underidentity_verificationfor/link/token/create - Remove
identity_verification.consent, which is deprecated, from documentation for/link/token/create
- Add
user_presenta an optional field under/transfer/authorization/create, update fields description for guaranteed ACH customers
- Remove deprecated
reversedstatus from Transfer schema - Remove deprecated
reverse_sweptstatus from Transfer Event schema
- Add new endpoints
/credit/relay/get,/credit/relay/refreshand/credit/relay/remove
- Updating to OAS 2020-09-14_1.146.0
- make item_logins field not required
- Make changes to IdentityMatchRequest to support options data
- Remove unsupported error_code (
PRODUCTS_NOT_SUPPORTED) for theforce_errorconfig in Sandbox
- Make changes to support crypto in Investments product
- Add new endpoints
/payment_profile/getand/payment_profile/remove
- Bug fix: add
identity_verificationtoProductsarray
- Add a new endpoint
/payment_profile/create
- Add
stated_income_sourcesas a field underincome_verificationfor/link/token/create
- Add
binas a field underinstitution_metadatafor/link/token/create
- Add
internationalIBAN numbers toWalletNumbersfield in/wallet/getand/wallet/listresponses. - Wrap the
ibanfield in theWalletTransactionCounterpartyNumbersunder new fieldinternational.
- Add new
identity/matchendpoint, andIdentityMatchRequestandIdentityMatchResponse
- Update comment for the
recipient.namefield with recommendation to avoid long strings and special characters.
- Reverts the changes made in 2020-09-14_1.135.0. ProductAccess and AccountProductAccess once again have all fields explicitly defined.
- Add
productsinasset_report/createendpoint.
- Convert ProductAccess and AccountProductAccess to optional.Map
- Rename
merchant_websiteandmerchant_logo_urlin/beta/transactions/v1/enhancetowebsiteandlogo_url
- Update
/credit/payroll_income/getresponse to have apull_idinstead of anincome_report_tokenand addpull_idto/credit/employment/getresponse
- Made several fields nullable for
/signal/evaluate
- Add
/credit/audit_copy_token/removeto invalidate Audit Copy tokens
- Updating to OAS 2020-09-14_1.131.3
- Update external URL for
/transfer/migrate_accountendpoint
- Add
TRANSFER_LIMIT_REACHEDto enumTransferAuthorizationDecisionRationaleCode
- Update
/payment_initiation/consent/*external docs URLs
- Add
ibantocounterparty'snumbersfield in/wallet/transaction/execute
- Update description of
/user/createto make it more clear what would happen when a client calls the user creation endpoint with the same client_user_id multiple times.
- Add
signal_descriptionfor each risk signal in/beta/credit/payroll_income/risk_signals/get - Change
DocumentRiskSignalInstitutionMetadatato be nullable
- Fix category rules formatting
- Change description in
UserCustomPasswordto reflect that only top level fields are optional not all fields
- Move Category Rules description to
include_personal_finance_categoryflag
- Updating to OAS 2020-09-14_1.128.4
- Add
identity_verificationas a new optional parameter for/link/token/create
- Add category rules beta to
personal_finance_categoryfield description in/transactions/get
- Updating to OAS 2020-09-14_1.128.2
- Update description of
/investments/transactions/getendpoint - Update description of
cost_basisfield
- Add
merchant_websiteandmerchant_logo_urlto/beta/transactions/v1/enhanceresponse
- Add
auth_type_select_enabled,automated_microdeposits_enabled,instant_match_enabled, andsame_day_microdeposits_enabledto/link/token/create - Marked
flow_typeparameter as deprecated
- Add
consent_idfilter to/payment_initiation/payment/list - Add
consent_idto/link/token/create
- Added
/credit/relay/createendpoint
- Add
accountsobject to/credit/payroll_income/getresponse
- Added
include_fast_reportinasset_report/createendpoint. Addedfast_reportinasset_report/getendpoint
- Removed
reversedandreverse_sweptfrom possible event_type values in TransferEventListRequest docs
- Change
tokenstoreport_tokensin/credit/audit_copy_token/createrequest
- Add
request_idto all Identity Verification and Monitor responses
- Added sample user_id to INCOME_VERIFICATION webhook
- Pre-release API refinements to Monitor and Flow endpoints
- 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
- Updating to OAS 2020-09-14_1.105.1
- Expose Faraday::Connection object for additional configuration options
- Removed
client_idandsecretas required fields from/transfer/intent/{get,create}to match actual API behavior.
- Add
/credit/payroll_income/refreshendpoint
- Added
/signal/prepare
- Add
/transactions/recurring/deactivateendpoint
- 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
- Updating to OAS 2020-09-14_1.94.0
- 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
- Ruby library 14.13.0 was erroneously released as a
minorversion; 14.13.0 changes will be re-released as amajorversion shortly.
- Updating to OAS 2020-09-14_1.77.1
- Many enum fields have been de-anonymized and renamed, new names can be found in the
2020-09-14_1.64.15change message
- 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
- Fix issue where library did not correctly detect if app is a Rails app.
- 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.
- Updating to OAS 2020-09-14_1.62.1
- Added a release step to the
Makefileto purge previously released version of plaid-ruby in the current release.
- 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.4
- 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 enum values being returned from endpoints. Previously, if there were new enum values endpoint calls would fail.
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-ruby 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.
Generated from OAS version 2020-09-14_1.16.4. See full changelog here.
See full changelog here.
- Remove validation for
maxPropertiesdue to generator bug.
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 ruby generator.
The minimum required ruby version is 2.4.0.
Ruby Migration Guide:
From:
client = Plaid::Client.new(env: :sandbox,
client_id: client_id,
secret: secret)To:
configuration = Plaid::Configuration.new
configuration.server_index = Plaid::Configuration::Environment["sandbox"]
configuration.api_key["PLAID-CLIENT-ID"] = ENV["PLAID_RUBY_CLIENT_ID"]
configuration.api_key["PLAID-SECRET"] = ENV["PLAID_RUBY_SECRET"]
configuration.api_key["Plaid-Version"] = "2020-09-14"
api_client = Plaid::ApiClient.new(
configuration
)
client = Plaid::PlaidApi.new(api_client)All endpoint requests now take a request model and the functions have been renamed to include _.
From:
response = client.auth.get(access_token)To:
auth_get_request = Plaid::AuthGetRequest.new
auth_get_request.access_token = access_token
or
auth_get_request = Plaid::AuthGetRequest.new({:access_token => access_token})
response = client.auth_get(auth_get_request)From:
begin
client.auth.get(auth_get_request)
rescue Plaid::PlaidAPIError => e
raise e if e.error_code != 'PRODUCT_NOT_READY'
sleep 1
endTo:
begin
client.auth_get(auth_get_request)
rescue Plaid::ApiError => e
json_response = JSON.parse(e.response_body)
if json_response["error_code"] != "PRODUCT_NOT_READY"
end- Add support for
optionsto/payment_initiation/payment/create
- Add Standing Orders support to Payment Initiation
- Add
update_typetoItemmodel.
- Add support for providing a payment initiation schedule
- Add back the (now deprecated)
/item/public_token/createendpoint - Add back the (now deprecated)
/payment_initiation/payment/token/createendpoint
BREAKING CHANGES:
- Update minimum required Ruby version to 2.4
- 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 (#301)
link/token/get
- Add
merchant_nametoTransaction(#294)
BREAKING CHANGES:
- Removes the public key as input to
Client. The public key is no longer needed by the API. (#287) - Add link/token/create support (#293)
- Add support for more options (
override_username,override_password) in the/sandbox/public_token/createendpoint (219)
- Add support for optional user fields for
/item/add_token/createendpoint (278) - Add support for credit card liabilities (286)
BREAKING CHANGES:
RATE_LIMIT_EXCEEDEDPlaid error types will be correctly mapped toRateLimitExceededError(285)INSTITUTION_ERRORPlaid error types will be correctly mapped toInstitutionError(275)- Enable payment recipient to be created with BACS (288)
- Adds support for
/sandbox/item/set_verification_status - Removes support for deprecated
/item/access_token/update_versionendpoint
BREAKING CHANGES:
- Removes
client.item.update_version
- Add client_user_id to Item add token endpoint (#274)
- Add support for Item add token endpoint (BETA) (#269)
/item/add_token/create
- Add transaction_code to Transaction class (#264)
- Add OAuth support to /institutions endpoints (#261)
- Add support for transactions refresh product (#258)
/transactions/refresh
- Add support for deposit switch product (#251)
- Add support for generic processor token (#256)
- Add support for webhook verification (#249)
- Add support for new UK Payment Initiation product (#246)
/payment_initiation/recipient/create/payment_initiation/recipient/get/payment_initiation/recipient/list/payment_initiation/payment/create/payment_initiation/payment/token/create/payment_initiation/payment/get/payment_initiation/payment/list
- Add
consent_expiration_timeto the Item interface (#247)
- Add support for new Ocrolus Partnership
- Update Assets schema for international address support
- Add binding for the new liabilities product
- Deprecate direct integration as it is no longer supported
- Add bindings for the new investments product.
- Add support for 2019-05-29 API version
- Remove unnecessary log line
- Add support for include_institution_data to /institutions/search endpoint.
- Add support for include_institution_data to /institutions/get endpoint.
- Add support for include_institution data to /institutions/get_by_id endpoint.
- Fix error models to support assets-related errors.
- Assets + Insights reports
- Add bindings for the new assets product.
- Use
Plaid-Versionheader to request the certain compatible API version. - Change Auth-related data structures to conform to the API.
- Include currency-related fields for transaction and account objects.
- Introduce true response objects instead of deep nested hashes. Any of the
three syntaxes can be used interchangeably for any API response:
response['foo']['bar'],response[:foo][:bar], orresponse.foo.bar. - Add Dwolla and Apex products.
- Make
/item/removethe primary Item removal endpoint - Add #options parameter to
/institutions/get - Handle network errors with
PlaidServerError
- Refactored the entire library to support Plaid's new API. Use the transition guide to update your integration. Version 3.x.x of this gem is mirrored at plaid-legacy.
- Add
/institutions/alland/institutions/all/searchendpoints, see UPGRADING.md
- Add
Transaction#reference_number(@ericbirdsall). - Fix webhook codes and add risk and income webhooks.
- Documentation fixes (@ishmael).
- Fix
Transaction#to_sbehavior (@michel-tricot). - PATCH
/:product/stepflow. - Use the same client in
User#upgrade(@betesh). - Webhook object (@zshannon).
processor_tokenaccess inUser.exchange_token(@gylaz).- Raise
ServerErrorin case server returned an empty response body.
- Use
~> 1.0spec for multi_json dependency. - Support
stripe_bank_account_tokeninUser.exchange_token.
- Use
:productioninstead of:apito signify production environment inPlaid::Client#env=. User#mfa_stepallows to specify options now (thanks @gcweeks).- Implemented
User#update_webhook.
- Rewrite everything.