Plaid logo
Docs
ALL DOCS

API

  • Overview
  • Libraries
  • API versioning
  • Postman Collection
  • Webhooks
Payments and Funding
  • Auth
  • Balance
  • Identity
  • Signal
  • Transfer
  • Investments Move
  • Payment Initiation
  • Virtual Accounts
Financial Insights
  • Transactions
  • Investments
  • Liabilities
  • Enrich
KYC/AML and anti-fraud
  • Look up Dashboard users
  • Identity Verification
  • Monitor
  • Beacon (beta)
Instant Onboarding
  • Layer
Credit and Underwriting
  • Consumer Report (by Plaid Check)
  • Assets
  • Statements
  • Income
Fundamentals
  • Items
  • Accounts
  • Institutions
  • Sandbox
  • Link
  • Users
  • Consent
  • Network
  • OAuth
Partnerships
  • Processor tokens
  • Processor partners
  • Reseller partners
Plaid logo
Docs
Close search modal
Ask Bill!
Ask Bill!
Hi! I'm Bill! You can ask me all about the Plaid API. Try asking questions like:
    Note: Bill isn't perfect. He's just a robot platypus that reads our docs for fun. You should treat his answers with the same healthy skepticism you might treat any other answer on the internet. This chat may be logged for quality and training purposes. Please don't send Bill any PII -- he's scared of intimacy. All chats with Bill are subject to Plaid's Privacy Policy.
    Plaid.com
    Log in
    Get API Keys
    Open nav

    Transfer

    API reference for Transfer account linking endpoints

    For how-to guidance, see the Transfer documentation.

    =*=*=*=

    Account Linking

    Account Linking
    /transfer/capabilities/getDetermine RTP eligibility for a Plaid Item
    /transfer/intent/createCreate a transfer intent and invoke Transfer UI (Transfer UI only)
    /transfer/intent/getRetrieve information about a transfer intent (Transfer UI only)
    /transfer/migrate_accountCreate an Item to use with Transfer from known account and routing numbers
    =*=*=*=

    /transfer/capabilities/get

    Get RTP eligibility information of a transfer

    Use the /transfer/capabilities/get endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by /transfer/migrate_account. To simulate RTP eligibility in Sandbox, log in using the username user_good and password pass_good and use the first two checking and savings accounts in the "First Platypus Bank" institution (ending in 0000 or 1111), which will return true. Any other account will return false.

    transfer/capabilities/get

    Request fields

    client_id
    stringstring
    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.
    secret
    stringstring
    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.
    access_token
    requiredstringrequired, string
    The Plaid access_token for the account that will be debited or credited.
    account_id
    requiredstringrequired, string
    The Plaid account_id corresponding to the end-user account that will be debited or credited.
    Select Language
    1const request: TransferCapabilitiesGetRequest = {
    2 access_token: 'access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',
    3 account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',
    4};
    5
    6try {
    7 const response = await client.transferCapabilitiesGet(request);
    8} catch (error) {
    9 // handle error
    10}
    transfer/capabilities/get

    Response fields and example

    institution_supported_networks
    objectobject
    Contains the RTP and RfP network and types supported by the linked Item's institution.
    rtp
    objectobject
    Contains the supported service types in RTP
    credit
    booleanboolean
    When true, the linked Item's institution supports RTP credit transfer.

    Default: false
    rfp
    objectobject
    Contains the supported service types in RfP
    debit
    booleanboolean
    When true, the linked Item's institution supports RfP debit transfer.

    Default: false
    request_id
    stringstring
    A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
    1{
    2 "institution_supported_networks": {
    3 "rtp": {
    4 "credit": true
    5 },
    6 "rfp": {
    7 "debit": true
    8 }
    9 },
    10 "request_id": "saKrIBuEB9qJZno"
    11}
    Was this helpful?
    =*=*=*=

    /transfer/intent/create

    Create a transfer intent object to invoke the Transfer UI

    Use the /transfer/intent/create endpoint to generate a transfer intent object and invoke the Transfer UI.

    transfer/intent/create

    Request fields

    client_id
    stringstring
    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.
    secret
    stringstring
    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_id
    stringstring
    The Plaid account_id corresponding to the end-user account that will be debited or credited.
    mode
    requiredstringrequired, string
    The direction of the flow of transfer funds.
    PAYMENT: Transfers funds from an end user's account to your business account.
    DISBURSEMENT: Transfers funds from your business account to an end user's account.


    Possible values: PAYMENT, DISBURSEMENT
    network
    stringstring
    The network or rails used for the transfer. Defaults to same-day-ach.
    For transfers submitted using ach, the Standard ACH cutoff is 8:30 PM Eastern Time.
    For transfers submitted using same-day-ach, the Same Day ACH cutoff is 3:30 PM Eastern Time. It is recommended to send the request 15 minutes prior to the cutoff to ensure that it will be processed in time for submission before the cutoff. If the transfer is processed after this cutoff but before the Standard ACH cutoff, it will be sent over Standard ACH rails and will not incur same-day charges.
    For transfers submitted using rtp, in the case that the account being credited does not support RTP, the transfer will be sent over ACH as long as an ach_class is provided in the request. If RTP isn't supported by the account and no ach_class is provided, the transfer will fail to be submitted.


    Possible values: ach, same-day-ach, rtp
    Default: same-day-ach
    amount
    requiredstringrequired, string
    The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling /transfer/authorization/create, specify the maximum amount to authorize. When calling /transfer/create, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling /transfer/create, the maximum amount authorized in the authorization_id will be sent.
    description
    requiredstringrequired, string
    A description for the underlying transfer. Maximum of 15 characters.

    Min length: 1
    Max length: 15
    ach_class
    stringstring
    Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see ACH SEC codes.
    Codes supported for credits: ccd, ppd Codes supported for debits: ccd, tel, web
    "ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts
    "ppd" - Prearranged Payment or Deposit - The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained in writing either in person or via an electronic document signing, e.g. Docusign, by the consumer. Can be used for credits or debits.
    "web" - Internet-Initiated Entry. The transfer debits a consumer’s bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits.
    "tel" - Telephone-Initiated Entry. The transfer debits a consumer. Debit authorization has been received orally over the telephone via a recorded call.


    Possible values: ccd, ppd, tel, web
    user
    requiredobjectrequired, object
    The legal name and other information for the account holder.
    legal_name
    requiredstringrequired, string
    The user's legal name.
    phone_number
    stringstring
    The user's phone number.
    email_address
    stringstring
    The user's email address.
    address
    objectobject
    The address associated with the account holder.
    street
    stringstring
    The street number and name (i.e., "100 Market St.").
    city
    stringstring
    Ex. "San Francisco"
    region
    stringstring
    The state or province (e.g., "CA").
    postal_code
    stringstring
    The postal code (e.g., "94103").
    country
    stringstring
    A two-letter country code (e.g., "US").
    metadata
    objectobject
    The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters
    iso_currency_code
    stringstring
    The currency of the transfer amount, e.g. "USD"
    Select Language
    1const request: TransferIntentCreateRequest = {
    2 account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',
    3 mode: 'PAYMENT'
    4 amount: '12.34',
    5 description: 'Desc',
    6 ach_class: 'ppd',
    7 origination_account_id: '9853defc-e703-463d-86b1-dc0607a45359',
    8 user: {
    9 legal_name: 'Anne Charleston',
    10 },
    11};
    12
    13try {
    14 const response = await client.transferIntentCreate(request);
    15} catch (error) {
    16 // handle error
    17}
    transfer/intent/create

    Response fields and example

    transfer_intent
    objectobject
    Represents a transfer intent within Transfer UI.
    id
    stringstring
    Plaid's unique identifier for the transfer intent object.
    created
    stringstring
    The datetime the transfer was created. This will be of the form 2006-01-02T15:04:05Z.

    Format: date-time
    status
    stringstring
    The status of the transfer intent.
    PENDING: The transfer intent is pending. SUCCEEDED: The transfer intent was successfully created. FAILED: The transfer intent was unable to be created.


    Possible values: PENDING, SUCCEEDED, FAILED
    account_id
    nullablestringnullable, string
    The Plaid account_id corresponding to the end-user account that will be debited or credited. Returned only if account_id was set on intent creation.
    funding_account_id
    stringstring
    The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.
    amount
    stringstring
    The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling /transfer/authorization/create, specify the maximum amount to authorize. When calling /transfer/create, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling /transfer/create, the maximum amount authorized in the authorization_id will be sent.
    mode
    stringstring
    The direction of the flow of transfer funds.
    PAYMENT: Transfers funds from an end user's account to your business account.
    DISBURSEMENT: Transfers funds from your business account to an end user's account.


    Possible values: PAYMENT, DISBURSEMENT
    network
    stringstring
    The network or rails used for the transfer. Defaults to same-day-ach.
    For transfers submitted using ach, the Standard ACH cutoff is 8:30 PM Eastern Time.
    For transfers submitted using same-day-ach, the Same Day ACH cutoff is 3:30 PM Eastern Time. It is recommended to send the request 15 minutes prior to the cutoff to ensure that it will be processed in time for submission before the cutoff. If the transfer is processed after this cutoff but before the Standard ACH cutoff, it will be sent over Standard ACH rails and will not incur same-day charges.
    For transfers submitted using rtp, in the case that the account being credited does not support RTP, the transfer will be sent over ACH as long as an ach_class is provided in the request. If RTP isn't supported by the account and no ach_class is provided, the transfer will fail to be submitted.


    Possible values: ach, same-day-ach, rtp
    Default: same-day-ach
    ach_class
    stringstring
    Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see ACH SEC codes.
    Codes supported for credits: ccd, ppd Codes supported for debits: ccd, tel, web
    "ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts
    "ppd" - Prearranged Payment or Deposit - The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained in writing either in person or via an electronic document signing, e.g. Docusign, by the consumer. Can be used for credits or debits.
    "web" - Internet-Initiated Entry. The transfer debits a consumer’s bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits.
    "tel" - Telephone-Initiated Entry. The transfer debits a consumer. Debit authorization has been received orally over the telephone via a recorded call.


    Possible values: ccd, ppd, tel, web
    user
    objectobject
    The legal name and other information for the account holder.
    legal_name
    stringstring
    The user's legal name.
    phone_number
    nullablestringnullable, string
    The user's phone number.
    email_address
    nullablestringnullable, string
    The user's email address.
    address
    nullableobjectnullable, object
    The address associated with the account holder.
    street
    nullablestringnullable, string
    The street number and name (i.e., "100 Market St.").
    city
    nullablestringnullable, string
    Ex. "San Francisco"
    region
    nullablestringnullable, string
    The state or province (e.g., "CA").
    postal_code
    nullablestringnullable, string
    The postal code (e.g., "94103").
    country
    nullablestringnullable, string
    A two-letter country code (e.g., "US").
    description
    stringstring
    A description for the underlying transfer. Maximum of 8 characters.
    metadata
    nullableobjectnullable, object
    The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters
    iso_currency_code
    stringstring
    The currency of the transfer amount, e.g. "USD"
    request_id
    stringstring
    A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
    1{
    2 "transfer_intent": {
    3 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",
    4 "funding_account_id": "9853defc-e703-463d-86b1-dc0607a45359",
    5 "ach_class": "ppd",
    6 "amount": "12.34",
    7 "iso_currency_code": "USD",
    8 "created": "2020-08-06T17:27:15Z",
    9 "description": "Desc",
    10 "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",
    11 "metadata": {
    12 "key1": "value1",
    13 "key2": "value2"
    14 },
    15 "mode": "PAYMENT",
    16 "origination_account_id": "9853defc-e703-463d-86b1-dc0607a45359",
    17 "status": "PENDING",
    18 "user": {
    19 "address": {
    20 "street": "100 Market Street",
    21 "city": "San Francisco",
    22 "region": "CA",
    23 "postal_code": "94103",
    24 "country": "US"
    25 },
    26 "email_address": "acharleston@email.com",
    27 "legal_name": "Anne Charleston",
    28 "phone_number": "123-456-7890"
    29 }
    30 },
    31 "request_id": "saKrIBuEB9qJZno"
    32}
    Was this helpful?
    =*=*=*=

    /transfer/intent/get

    Retrieve more information about a transfer intent

    Use the /transfer/intent/get endpoint to retrieve more information about a transfer intent.

    transfer/intent/get

    Request fields

    client_id
    stringstring
    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.
    secret
    stringstring
    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.
    transfer_intent_id
    requiredstringrequired, string
    Plaid's unique identifier for a transfer intent object.
    Select Language
    1const request: TransferIntentGetRequest = {
    2 transfer_intent_id: '460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9',
    3};
    4
    5try {
    6 const response = await client.transferIntentGet(request);
    7} catch (error) {
    8 // handle error
    9}
    transfer/intent/get

    Response fields and example

    transfer_intent
    objectobject
    Represents a transfer intent within Transfer UI.
    id
    stringstring
    Plaid's unique identifier for a transfer intent object.
    created
    stringstring
    The datetime the transfer was created. This will be of the form 2006-01-02T15:04:05Z.

    Format: date-time
    status
    stringstring
    The status of the transfer intent.
    PENDING: The transfer intent is pending. SUCCEEDED: The transfer intent was successfully created. FAILED: The transfer intent was unable to be created.


    Possible values: PENDING, SUCCEEDED, FAILED
    transfer_id
    nullablestringnullable, string
    Plaid's unique identifier for the transfer created through the UI. Returned only if the transfer was successfully created. Null value otherwise.
    failure_reason
    nullableobjectnullable, object
    The reason for a failed transfer intent. Returned only if the transfer intent status is failed. Null otherwise.
    error_type
    stringstring
    A broad categorization of the error.
    error_code
    stringstring
    A code representing the reason for a failed transfer intent (i.e., an API error or the authorization being declined).
    error_message
    stringstring
    A human-readable description of the code associated with a failed transfer intent.
    authorization_decision
    nullablestringnullable, string
    A decision regarding the proposed transfer.
    APPROVED – The proposed transfer has received the end user's consent and has been approved for processing by Plaid. The decision_rationale field is set if Plaid was unable to fetch the account information. You may proceed with the transfer, but further review is recommended (i.e., use Link in update mode to re-authenticate your user when decision_rationale.code is ITEM_LOGIN_REQUIRED). Refer to the code field in the decision_rationale object for details.
    DECLINED – Plaid reviewed the proposed transfer and declined processing. Refer to the code field in the decision_rationale object for details.


    Possible values: APPROVED, DECLINED
    authorization_decision_rationale
    nullableobjectnullable, object
    The rationale for Plaid's decision regarding a proposed transfer. It is always set for declined decisions, and may or may not be null for approved decisions.
    code
    stringstring
    A code representing the rationale for approving or declining the proposed transfer.
    If the rationale_code is null, the transfer passed the authorization check.
    Any non-null value for an approved transfer indicates that the the authorization check could not be run and that you should perform your own risk assessment on the transfer. The code will indicate why the check could not be run. Possible values for an approved transfer are:
    MANUALLY_VERIFIED_ITEM – Item created via a manual entry flow (i.e. Same Day Micro-deposit, Instant Micro-deposit, or database-based verification), limited information available.
    ITEM_LOGIN_REQUIRED – Unable to collect the account information due to Item staleness. Can be resolved by using Link and setting transfer.authorization_id in the request to /link/token/create.
    MIGRATED_ACCOUNT_ITEM - Item created via /transfer/migrate_account endpoint, limited information available.
    ERROR – Unable to collect the account information due to an unspecified error.
    The following codes indicate that the authorization decision was declined:
    NSF – Transaction likely to result in a return due to insufficient funds.
    RISK - Transaction is high-risk.
    TRANSFER_LIMIT_REACHED - One or several transfer limits are reached, e.g. monthly transfer limit. Check the accompanying description field to understand which limit has been reached.


    Possible values: NSF, RISK, TRANSFER_LIMIT_REACHED, MANUALLY_VERIFIED_ITEM, ITEM_LOGIN_REQUIRED, PAYMENT_PROFILE_LOGIN_REQUIRED, ERROR, MIGRATED_ACCOUNT_ITEM, null
    description
    stringstring
    A human-readable description of the code associated with a transfer approval or transfer decline.
    account_id
    nullablestringnullable, string
    The Plaid account_id for the account that will be debited or credited. Returned only if account_id was set on intent creation.
    funding_account_id
    stringstring
    The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.
    amount
    stringstring
    The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling /transfer/authorization/create, specify the maximum amount to authorize. When calling /transfer/create, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling /transfer/create, the maximum amount authorized in the authorization_id will be sent.
    mode
    stringstring
    The direction of the flow of transfer funds.
    PAYMENT: Transfers funds from an end user's account to your business account.
    DISBURSEMENT: Transfers funds from your business account to an end user's account.


    Possible values: PAYMENT, DISBURSEMENT
    network
    stringstring
    The network or rails used for the transfer. Defaults to same-day-ach.
    For transfers submitted using ach, the Standard ACH cutoff is 8:30 PM Eastern Time.
    For transfers submitted using same-day-ach, the Same Day ACH cutoff is 3:30 PM Eastern Time. It is recommended to send the request 15 minutes prior to the cutoff to ensure that it will be processed in time for submission before the cutoff. If the transfer is processed after this cutoff but before the Standard ACH cutoff, it will be sent over Standard ACH rails and will not incur same-day charges.
    For transfers submitted using rtp, in the case that the account being credited does not support RTP, the transfer will be sent over ACH as long as an ach_class is provided in the request. If RTP isn't supported by the account and no ach_class is provided, the transfer will fail to be submitted.


    Possible values: ach, same-day-ach, rtp
    Default: same-day-ach
    ach_class
    stringstring
    Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see ACH SEC codes.
    Codes supported for credits: ccd, ppd Codes supported for debits: ccd, tel, web
    "ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts
    "ppd" - Prearranged Payment or Deposit - The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained in writing either in person or via an electronic document signing, e.g. Docusign, by the consumer. Can be used for credits or debits.
    "web" - Internet-Initiated Entry. The transfer debits a consumer’s bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits.
    "tel" - Telephone-Initiated Entry. The transfer debits a consumer. Debit authorization has been received orally over the telephone via a recorded call.


    Possible values: ccd, ppd, tel, web
    user
    objectobject
    The legal name and other information for the account holder.
    legal_name
    stringstring
    The user's legal name.
    phone_number
    nullablestringnullable, string
    The user's phone number.
    email_address
    nullablestringnullable, string
    The user's email address.
    address
    nullableobjectnullable, object
    The address associated with the account holder.
    street
    nullablestringnullable, string
    The street number and name (i.e., "100 Market St.").
    city
    nullablestringnullable, string
    Ex. "San Francisco"
    region
    nullablestringnullable, string
    The state or province (e.g., "CA").
    postal_code
    nullablestringnullable, string
    The postal code (e.g., "94103").
    country
    nullablestringnullable, string
    A two-letter country code (e.g., "US").
    description
    stringstring
    A description for the underlying transfer. Maximum of 8 characters.
    metadata
    nullableobjectnullable, object
    The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters
    iso_currency_code
    stringstring
    The currency of the transfer amount, e.g. "USD"
    request_id
    stringstring
    A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
    1{
    2 "transfer_intent": {
    3 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",
    4 "funding_account_id": "9853defc-e703-463d-86b1-dc0607a45359",
    5 "ach_class": "ppd",
    6 "amount": "12.34",
    7 "iso_currency_code": "USD",
    8 "authorization_decision": "APPROVED",
    9 "authorization_decision_rationale": null,
    10 "created": "2019-12-09T17:27:15Z",
    11 "description": "Desc",
    12 "failure_reason": null,
    13 "guarantee_decision": null,
    14 "guarantee_decision_rationale": null,
    15 "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",
    16 "metadata": {
    17 "key1": "value1",
    18 "key2": "value2"
    19 },
    20 "mode": "DISBURSEMENT",
    21 "origination_account_id": "9853defc-e703-463d-86b1-dc0607a45359",
    22 "status": "SUCCEEDED",
    23 "transfer_id": "590ecd12-1dcc-7eae-4ad6-c28d1ec90df2",
    24 "user": {
    25 "address": {
    26 "street": "123 Main St.",
    27 "city": "San Francisco",
    28 "region": "California",
    29 "postal_code": "94053",
    30 "country": "US"
    31 },
    32 "email_address": "acharleston@email.com",
    33 "legal_name": "Anne Charleston",
    34 "phone_number": "510-555-0128"
    35 }
    36 },
    37 "request_id": "saKrIBuEB9qJZno"
    38}
    Was this helpful?
    =*=*=*=

    /transfer/migrate_account

    Migrate account into Transfers

    As an alternative to adding Items via Link, you can also use the /transfer/migrate_account endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide wire_routing_number. 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 Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to /transfer/migrate_account is not enabled by default; to obtain access, contact your Plaid Account Manager or Support.

    transfer/migrate_account

    Request fields

    client_id
    stringstring
    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.
    secret
    stringstring
    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_number
    requiredstringrequired, string
    The user's account number.
    routing_number
    requiredstringrequired, string
    The user's routing number.
    wire_routing_number
    stringstring
    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. This field must be set for the created item to be eligible for wire transfers.
    account_type
    requiredstringrequired, string
    The type of the bank account (checking or savings).
    Select Language
    1const request: TransferMigrateAccountRequest = {
    2 account_number: '100000000',
    3 routing_number: '121122676',
    4 account_type: 'checking',
    5};
    6try {
    7 const response = await plaidClient.transferMigrateAccount(request);
    8 const access_token = response.data.access_token;
    9} catch (error) {
    10 // handle error
    11}
    transfer/migrate_account

    Response fields and example

    access_token
    stringstring
    The Plaid access_token for the newly created Item.
    account_id
    stringstring
    The Plaid account_id for the newly created Item.
    request_id
    stringstring
    A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
    1{
    2 "access_token": "access-sandbox-435beced-94e8-4df3-a181-1dde1cfa19f0",
    3 "account_id": "zvyDgbeeDluZ43AJP6m5fAxDlgoZXDuoy5gjN",
    4 "request_id": "mdqfuVxeoza6mhu"
    5}
    Was this helpful?
    Developer community
    GitHub
    GitHub
    Stack Overflow
    Stack Overflow
    YouTube
    YouTube
    Discord
    Discord