plaid

(Deprecated) Migrate account into Bank Transfers

Changed on

As an alternative to adding Items via Link, you can also use the /bank_transfer/migrate_account endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as /accounts/balance/get, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to /bank_transfer/migrate_account is not enabled by default; to obtain access, contact your Plaid account manager.

post/bank_transfer/migrate_account

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/bank_transfer/migrate_account
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

account_numberstring required

The user's account number.

routing_numberstring required

The user's routing number.

wire_routing_numberstring

The user's wire transfer routing number. This is the ABA number; for some institutions, this may differ from the ACH number used in routing_number.

account_typestring required

The type of the bank account (checking or savings).

Response

OK

access_tokenstring required

The Plaid access_token for the newly created Item.

account_idstring required

The Plaid account_id for the newly created Item.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • 94406d9a4d27Revision changes
    • info

      endpoint deprecated