Plaid Core Exchange Changelog

See the following changelist for updates to the Core Exchange specification. Core Exchange uses the same version numbers as FDX.

v6.3 Core Exchange API specification

Enhanced Pagination: Added pageKey query parameter and nextPageKey response property for improved pagination across all paginated endpoints:

• GET /accounts
• GET /accounts/{accountId}/payment-networks
• GET /accounts/{accountId}/statements
• GET /accounts/{accountId}/transactions

New Deposit Account Types: Added support for specialized savings accounts:

• FIRSTHOMESAVINGSACCOUNT - First Home Savings Account type
• HIGHINTERESTSAVINGSACCOUNT - High Interest Savings Account type

Enhanced Contact Information: Improved contact data support with new fields:

• Account Holder Relationships: Added AUTHORIZED_SIGNER relationship type for account holders
• Phone Number Enhancements:
  • New phone types: BOTH, PERSONAL
  • Added network property for mobile network information
  • Added primary property to identify primary contact numbers
  • Enhanced country code validation with new pattern ^\\+?[1-9][0-9]{0,2}$

Enhanced Loan Account Details: Added optional properties for loan accounts:

• currentSchool - Current educational institution for student loans
• loanProviderName - Name of the loan provider

Transaction Enhancements:

• Added cardNumberDisplay property for all transaction types to show masked card numbers
• Added date filtering with startDate and endDate query parameters for statements and transactions endpoints

Contact Phone Number Field Changes:

• Increased maximum length for telephones[].country from 3 to 4 characters
• Modified payee field structure in deposit transactions (removed maxLength constraint and changed type structure)

Schema Cleanup: Removed unused TelephoneNumberType schema

v6.2 Core Exchange API specification

• Digital Wallet Support: Added support for DIGITAL_WALLET account category across all account types and transactions
• New Currency Support: Added support for ZWG (Zimbabwean Gold) currency code across all account types, transactions, and investment holdings
• Investment Account Enhancement: Added PREPAID account type for investment accounts
• Digital Wallet Account Descriptor: New DigitalWalletDescriptor schema added to the /accounts endpoint response

Pagination Changes: Removed optional totalElements property from paginated responses in the following endpoints:

• GET /accounts
• GET /accounts/{accountId}/payment-networks
• GET /accounts/{accountId}/statements
• GET /accounts/{accountId}/transactions

Statement Status Cleanup: Removed the following enum values from statement status:

• AVAILABLE
• FAILED
• PROCESSING

v6.1 Core Exchange API specification

• Minor updates and improvements to existing schemas

• Internal improvements and optimizations

v6.0 Core Exchange API specification

US_FEDNOW (Federal Reserve Instant Payment System) is now an accepted PaymentNetworkType in the /payment-networks endpoint

Breaking changes

• In the response for the /accounts/{accountId} endpoint, the account object is no longer wrapped with a named property (ex. depositAccount). The discriminator value accountCategory is now required on each account type.

The accountCategory may be any of the following:

• ANNUITY_ACCOUNT
• COMMERCIAL_ACCOUNT
• DEPOSIT_ACCOUNT
• INSURANCE_ACCOUNT
• INVESTMENT_ACCOUNT
• LOAN_ACCOUNT
• LOC_ACCOUNT

(These values have not changed since prior versions v5.2 and v5.3.)

• In the response for the /accounts/{accountId}/transactions endpoint, the transaction object is no longer wrapped with a named property (ex. depositTransaction). The discriminator value accountCategory is now required on each transaction object.

An implementer’s mapping of each transaction must set the required the accountCategory property.

The accountCategory may be any of the following:

• DEPOSIT_ACCOUNT

• INVESTMENT_ACCOUNT

• LOAN_ACCOUNT

• LOC_ACCOUNT

• The holding object in investment accounts now supports an array of securityIds with id/idType pairs. (These pairs have replaced the securityId/securityIdType keys as identifiers.)

Breaking changes

In AccountWithDetails (response for /accounts/{accountId} endpoint) removing the seven xxxAccount properties and requiring discriminator value accountCategory: on each account type, one of ANNUITY_ACCOUNT, COMMERCIAL_ACCOUNT, DEPOSIT_ACCOUNT, INSURANCE_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT or LOC_ACCOUNT. These values have not changed since prior versions v5.2 and v5.3

An implementer’s mapping of each account must set the required accountCategory property. The account object is no longer wrapped with a named property (ex. depositAccount).

V5.3 Core Exchange API specification

• A new account type (CommercialAccountType) was added. The following account types are classified as commercial accounts:
  • COMMERCIALDEPOSIT
  • COMMERCIALINVESTMENT
  • COMMERCIALLOAN
  • COMMERCIALLINEOFCREDIT
• Commercial account type includes a new descriptor: CommercialAccountDescriptor.

Breaking changes

• The ISO 3166 country code standard was updated to ISO 3166-1 alpha-2.
• The list of ISO 4217 currency codes was updated. (As of January 1, 2023)
• Note: Some country codes (AN, CS) and currency codes (HRK) were removed in the updated version, making this a breaking change. (Please see the ISO standards for more information.)

Breaking changes

• Plaid will not provide balance product support for the new CommercialAccountType.

V5.2 Core Exchange API specification

• None

• None

V5.1 Core Exchange API specification

• For the endpoints that Plaid supports, FDX introduces minor enum, model, and formatting changes in this version.

Breaking changes:

• None

• Plaid introduces support and documentation for FDX Digital Assets.

V5.0 Core Exchange API specification

• For the endpoints that Plaid supports, FDX introduces minor enum, model, and formatting changes in this version.

Breaking changes:

• The state property on an Address was renamed to the more inclusive region.
• The specification requires timestamps on transactions be in ISO 8601 format.

• Plaid introduces support and documentation for FDX investment models, including investment accounts, investment holdings, and investment transactions.

v4.6

• None

• Plaid introduces Core Exchange in this version by choosing a subset of FDX endpoints to support and adding Plaid-specific documentation.