plaid

Terminate products for an Item

Changed on

The /item/products/terminate endpoint allows you to terminate an Item. Once terminated, the access_token associated with the Item is no longer valid, billing for the Item's products is ended, and relevant webhooks are fired.

/item/products/terminate is the recommended way to offboard users or disconnect accounts linked via Plaid.

post/item/products/terminate

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/item/products/terminate
  • 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.

access_tokenstring required

The access token associated with the Item for which data is being requested.

reason_code'FRAUD_FIRST_PARTY' | 'FRAUD_FALSE_IDENTITY' | 'FRAUD_ABUSE' | 'FRAUD_OTHER' | 'FRAUD_TRANSACTION' | 'CONSUMER_LOAN_PAID_OFF' | 'CONSUMER_ACCOUNT_CLOSED' | 'CONSUMER_CHARGE_OFF' | 'CONSUMER_PAYMENT_METHOD_SWITCHED' | 'USER_OFFBOARDING' | 'DUPLICATE_ITEM' | 'BILLING_TERMINATION' | 'OTHER' required

The reason for terminating products.

FRAUD_FIRST_PARTY: The end user who owns the connected bank account committed fraud using their real identity

FRAUD_FALSE_IDENTITY: The connection was created using a false or stolen identity

FRAUD_ABUSE: The end user is abusing the client's service or platform (for example, automation or excessive retries) through their connected account

FRAUD_OTHER: Fraud-related, but not covered by the specific fraud categories above; reason_note should clarify

FRAUD_TRANSACTION: Fraud occurred at the transaction level, such as an unauthorized transaction, card testing, chargeback, ACH return, or dispute

CONSUMER_LOAN_PAID_OFF: The end user paid off their loan and no longer needs the product

CONSUMER_ACCOUNT_CLOSED: The end user closed their account with the client and no longer needs the product

CONSUMER_CHARGE_OFF: The end user's account has been charged off

CONSUMER_PAYMENT_METHOD_SWITCHED: The end user switched to a different payment method and no longer needs the product

USER_OFFBOARDING: The user is offboarding from the client's service or platform

DUPLICATE_ITEM: This Item is a duplicate of another active Item for the same user

BILLING_TERMINATION: The client's billing or subscription relationship with the end user has ended

OTHER: None of the above; reason_note should clarify

reason_notestring nullable

Additional context or details about the reason for terminating products on the Item. Personally identifiable information, such as an email address or phone number, should not be included in the reason_note.

Response

success

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

  • a1bbca018160Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • warning

      removed from the request property allOf list

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new BILLING_TERMINATION enum value to the request property

    • info

      added the new CONSUMER_ACCOUNT_CLOSED enum value to the request property

    • info

      added the new CONSUMER_CHARGE_OFF enum value to the request property

    • info

      added the new CONSUMER_LOAN_PAID_OFF enum value to the request property

    • info

      added the new CONSUMER_PAYMENT_METHOD_SWITCHED enum value to the request property

    • info

      added the new DUPLICATE_ITEM enum value to the request property

    • info

      added the new FRAUD_ABUSE enum value to the request property

    • info

      added the new FRAUD_FALSE_IDENTITY enum value to the request property

    • info

      added the new FRAUD_FIRST_PARTY enum value to the request property

    • info

      added the new FRAUD_OTHER enum value to the request property

    • info

      added the new FRAUD_TRANSACTION enum value to the request property

    • info

      added the new OTHER enum value to the request property

    • info

      added the new USER_OFFBOARDING enum value to the request property