Package com.plaid.client.request

Interface PlaidApi

public interface PlaidApi

  • Method Details

    • accountsBalanceGet

      @Headers("Content-Type:application/json") @POST("accounts/balance/get") retrofit2.Call<AccountsGetResponse> accountsBalanceGet​(@Body AccountsBalanceGetRequest accountsBalanceGetRequest)
      Retrieve real-time balance data The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.
      Parameters:
      accountsBalanceGetRequest - (required)
      Returns:
      Call<AccountsGetResponse>
      See Also:
      Retrieve real-time balance data Documentation

    • accountsGet

      @Headers("Content-Type:application/json") @POST("accounts/get") retrofit2.Call<AccountsGetResponse> accountsGet​(@Body AccountsGetRequest accountsGetRequest)
      Retrieve accounts The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.
      Parameters:
      accountsGetRequest - (required)
      Returns:
      Call<AccountsGetResponse>
      See Also:
      Retrieve accounts Documentation

    • applicationGet

      @Headers("Content-Type:application/json") @POST("application/get") retrofit2.Call<ApplicationGetResponse> applicationGet​(@Body ApplicationGetRequest applicationGetRequest)
      Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
      Parameters:
      applicationGetRequest - (required)
      Returns:
      Call<ApplicationGetResponse>

    • assetReportAuditCopyCreate

      @Headers("Content-Type:application/json") @POST("asset_report/audit_copy/create") retrofit2.Call<AssetReportAuditCopyCreateResponse> assetReportAuditCopyCreate​(@Body AssetReportAuditCopyCreateRequest assetReportAuditCopyCreateRequest)
      Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
      Parameters:
      assetReportAuditCopyCreateRequest - (required)
      Returns:
      Call<AssetReportAuditCopyCreateResponse>
      See Also:
      Create Asset Report Audit Copy Documentation

    • assetReportAuditCopyGet

      @Headers("Content-Type:application/json") @POST("asset_report/audit_copy/get") retrofit2.Call<AssetReportGetResponse> assetReportAuditCopyGet​(@Body AssetReportAuditCopyGetRequest assetReportAuditCopyGetRequest)
      Retrieve an Asset Report Audit Copy `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/asset_report/audit_copy/create` must provide the `audit_copy_token` to the auditor. This token can then be used to call `/asset_report/audit_copy/create`.
      Parameters:
      assetReportAuditCopyGetRequest - (required)
      Returns:
      Call<AssetReportGetResponse>
      See Also:
      Retrieve an Asset Report Audit Copy Documentation

    • assetReportAuditCopyRemove

      @Headers("Content-Type:application/json") @POST("asset_report/audit_copy/remove") retrofit2.Call<AssetReportAuditCopyRemoveResponse> assetReportAuditCopyRemove​(@Body AssetReportAuditCopyRemoveRequest assetReportAuditCopyRemoveRequest)
      Remove Asset Report Audit Copy The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
      Parameters:
      assetReportAuditCopyRemoveRequest - (required)
      Returns:
      Call<AssetReportAuditCopyRemoveResponse>
      See Also:
      Remove Asset Report Audit Copy Documentation

    • assetReportCreate

      @Headers("Content-Type:application/json") @POST("asset_report/create") retrofit2.Call<AssetReportCreateResponse> assetReportCreate​(@Body AssetReportCreateRequest assetReportCreateRequest)
      Create an Asset Report The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#Assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
      Parameters:
      assetReportCreateRequest - (required)
      Returns:
      Call<AssetReportCreateResponse>
      See Also:
      Create an Asset Report Documentation

    • assetReportFilter

      @Headers("Content-Type:application/json") @POST("asset_report/filter") retrofit2.Call<AssetReportFilterResponse> assetReportFilter​(@Body AssetReportFilterRequest assetReportFilterRequest)
      Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
      Parameters:
      assetReportFilterRequest - (required)
      Returns:
      Call<AssetReportFilterResponse>
      See Also:
      Filter Asset Report Documentation

    • assetReportGet

      @Headers("Content-Type:application/json") @POST("asset_report/get") retrofit2.Call<AssetReportGetResponse> assetReportGet​(@Body AssetReportGetRequest assetReportGetRequest)
      Retrieve an Asset Report The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
      Parameters:
      assetReportGetRequest - (required)
      Returns:
      Call<AssetReportGetResponse>
      See Also:
      Retrieve an Asset Report Documentation

    • assetReportPdfGet

      @Headers("Content-Type:application/json") @POST("asset_report/pdf/get") retrofit2.Call<okhttp3.ResponseBody> assetReportPdfGet​(@Body AssetReportPDFGetRequest assetReportPDFGetRequest)
      Retrieve a PDF Asset Report The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
      Parameters:
      assetReportPDFGetRequest - (required)
      Returns:
      Call<ResponseBody>
      See Also:
      Retrieve a PDF Asset Report Documentation

    • assetReportRefresh

      @Headers("Content-Type:application/json") @POST("asset_report/refresh") retrofit2.Call<AssetReportRefreshResponse> assetReportRefresh​(@Body AssetReportRefreshRequest assetReportRefreshRequest)
      Refresh an Asset Report An Asset Report is an immutable snapshot of a user's assets. In order to \"refresh\" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available. The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with your original `/asset_report/create` request, but the original `days_requested` value and the values of any parameters in the `options` object can be overridden with new values. To change these arguments, simply supply new values for them in your request to `/asset_report/refresh`. Submit an empty string (\"\") for any previously-populated fields you would like set as empty.
      Parameters:
      assetReportRefreshRequest - (required)
      Returns:
      Call<AssetReportRefreshResponse>
      See Also:
      Refresh an Asset Report Documentation

    • assetReportRemove

      @Headers("Content-Type:application/json") @POST("asset_report/remove") retrofit2.Call<AssetReportRemoveResponse> assetReportRemove​(@Body AssetReportRemoveRequest assetReportRemoveRequest)
      Delete an Asset Report The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report.
      Parameters:
      assetReportRemoveRequest - (required)
      Returns:
      Call<AssetReportRemoveResponse>
      See Also:
      Delete an Asset Report Documentation

    • authGet

      @Headers("Content-Type:application/json") @POST("auth/get") retrofit2.Call<AuthGetResponse> authGet​(@Body AuthGetRequest authGetRequest)
      Retrieve auth data The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
      Parameters:
      authGetRequest - (required)
      Returns:
      Call<AuthGetResponse>
      See Also:
      Retrieve auth data Documentation

    • bankTransferBalanceGet

      @Headers("Content-Type:application/json") @POST("bank_transfer/balance/get") retrofit2.Call<BankTransferBalanceGetResponse> bankTransferBalanceGet​(@Body BankTransferBalanceGetRequest bankTransferBalanceGetRequest)
      Get balance of your Bank Transfer account Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
      Parameters:
      bankTransferBalanceGetRequest - (required)
      Returns:
      Call<BankTransferBalanceGetResponse>
      See Also:
      Get balance of your Bank Transfer account Documentation

    • bankTransferCancel

      @Headers("Content-Type:application/json") @POST("bank_transfer/cancel") retrofit2.Call<BankTransferCancelResponse> bankTransferCancel​(@Body BankTransferCancelRequest bankTransferCancelRequest)
      Cancel a bank transfer Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.
      Parameters:
      bankTransferCancelRequest - (required)
      Returns:
      Call<BankTransferCancelResponse>
      See Also:
      Cancel a bank transfer Documentation

    • bankTransferCreate

      @Headers("Content-Type:application/json") @POST("bank_transfer/create") retrofit2.Call<BankTransferCreateResponse> bankTransferCreate​(@Body BankTransferCreateRequest bankTransferCreateRequest)
      Create a bank transfer Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
      Parameters:
      bankTransferCreateRequest - (required)
      Returns:
      Call<BankTransferCreateResponse>
      See Also:
      Create a bank transfer Documentation

    • bankTransferEventList

      @Headers("Content-Type:application/json") @POST("bank_transfer/event/list") retrofit2.Call<BankTransferEventListResponse> bankTransferEventList​(@Body BankTransferEventListRequest bankTransferEventListRequest)
      List bank transfer events Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
      Parameters:
      bankTransferEventListRequest - (required)
      Returns:
      Call<BankTransferEventListResponse>
      See Also:
      List bank transfer events Documentation

    • bankTransferEventSync

      @Headers("Content-Type:application/json") @POST("bank_transfer/event/sync") retrofit2.Call<BankTransferEventSyncResponse> bankTransferEventSync​(@Body BankTransferEventSyncRequest bankTransferEventSyncRequest)
      Sync bank transfer events `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
      Parameters:
      bankTransferEventSyncRequest - (required)
      Returns:
      Call<BankTransferEventSyncResponse>
      See Also:
      Sync bank transfer events Documentation

    • bankTransferGet

      @Headers("Content-Type:application/json") @POST("bank_transfer/get") retrofit2.Call<BankTransferGetResponse> bankTransferGet​(@Body BankTransferGetRequest bankTransferGetRequest)
      Retrieve a bank transfer The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
      Parameters:
      bankTransferGetRequest - (required)
      Returns:
      Call<BankTransferGetResponse>
      See Also:
      Retrieve a bank transfer Documentation

    • bankTransferList

      @Headers("Content-Type:application/json") @POST("bank_transfer/list") retrofit2.Call<BankTransferListResponse> bankTransferList​(@Body BankTransferListRequest bankTransferListRequest)
      List bank transfers Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers.
      Parameters:
      bankTransferListRequest - (required)
      Returns:
      Call<BankTransferListResponse>
      See Also:
      List bank transfers Documentation

    • bankTransferMigrateAccount

      @Headers("Content-Type:application/json") @POST("bank_transfer/migrate_account") retrofit2.Call<BankTransferMigrateAccountResponse> bankTransferMigrateAccount​(@Body BankTransferMigrateAccountRequest bankTransferMigrateAccountRequest)
      Migrate account into Bank Transfers 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.
      Parameters:
      bankTransferMigrateAccountRequest - (required)
      Returns:
      Call<BankTransferMigrateAccountResponse>
      See Also:
      Migrate account into Bank Transfers Documentation

    • bankTransferSweepGet

      @Headers("Content-Type:application/json") @POST("bank_transfer/sweep/get") retrofit2.Call<BankTransferSweepGetResponse> bankTransferSweepGet​(@Body BankTransferSweepGetRequest bankTransferSweepGetRequest)
      Retrieve a sweep The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
      Parameters:
      bankTransferSweepGetRequest - (required)
      Returns:
      Call<BankTransferSweepGetResponse>
      See Also:
      Retrieve a sweep Documentation

    • bankTransferSweepList

      @Headers("Content-Type:application/json") @POST("bank_transfer/sweep/list") retrofit2.Call<BankTransferSweepListResponse> bankTransferSweepList​(@Body BankTransferSweepListRequest bankTransferSweepListRequest)
      List sweeps The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
      Parameters:
      bankTransferSweepListRequest - (required)
      Returns:
      Call<BankTransferSweepListResponse>
      See Also:
      List sweeps Documentation

    • categoriesGet

      @Headers("Content-Type:application/json") @POST("categories/get") retrofit2.Call<CategoriesGetResponse> categoriesGet​(@Body java.lang.Object body)
      Get Categories Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
      Parameters:
      body - (required)
      Returns:
      Call<CategoriesGetResponse>
      See Also:
      Get Categories Documentation

    • createPaymentToken

      @Deprecated @Headers("Content-Type:application/json") @POST("payment_initiation/payment/token/create") retrofit2.Call<PaymentInitiationPaymentTokenCreateResponse> createPaymentToken​(@Body PaymentInitiationPaymentTokenCreateRequest paymentInitiationPaymentTokenCreateRequest)
      Deprecated.
      Create payment token The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
      Parameters:
      paymentInitiationPaymentTokenCreateRequest - (required)
      Returns:
      Call<PaymentInitiationPaymentTokenCreateResponse>
      See Also:
      Create payment token Documentation

    • depositSwitchAltCreate

      @Headers("Content-Type:application/json") @POST("deposit_switch/alt/create") retrofit2.Call<DepositSwitchAltCreateResponse> depositSwitchAltCreate​(@Body DepositSwitchAltCreateRequest depositSwitchAltCreateRequest)
      Create a deposit switch without using Plaid Exchange This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
      Parameters:
      depositSwitchAltCreateRequest - (required)
      Returns:
      Call<DepositSwitchAltCreateResponse>
      See Also:
      Create a deposit switch without using Plaid Exchange Documentation

    • depositSwitchCreate

      @Headers("Content-Type:application/json") @POST("deposit_switch/create") retrofit2.Call<DepositSwitchCreateResponse> depositSwitchCreate​(@Body DepositSwitchCreateRequest depositSwitchCreateRequest)
      Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
      Parameters:
      depositSwitchCreateRequest - (required)
      Returns:
      Call<DepositSwitchCreateResponse>
      See Also:
      Create a deposit switch Documentation

    • depositSwitchGet

      @Headers("Content-Type:application/json") @POST("deposit_switch/get") retrofit2.Call<DepositSwitchGetResponse> depositSwitchGet​(@Body DepositSwitchGetRequest depositSwitchGetRequest)
      Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
      Parameters:
      depositSwitchGetRequest - (required)
      Returns:
      Call<DepositSwitchGetResponse>
      See Also:
      Retrieve a deposit switch Documentation

    • depositSwitchTokenCreate

      @Headers("Content-Type:application/json") @POST("deposit_switch/token/create") retrofit2.Call<DepositSwitchTokenCreateResponse> depositSwitchTokenCreate​(@Body DepositSwitchTokenCreateRequest depositSwitchTokenCreateRequest)
      Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
      Parameters:
      depositSwitchTokenCreateRequest - (required)
      Returns:
      Call<DepositSwitchTokenCreateResponse>
      See Also:
      Create a deposit switch token Documentation

    • employersSearch

      @Headers("Content-Type:application/json") @POST("employers/search") retrofit2.Call<EmployersSearchResponse> employersSearch​(@Body EmployersSearchRequest employersSearchRequest)
      Search employer database `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
      Parameters:
      employersSearchRequest - (required)
      Returns:
      Call<EmployersSearchResponse>
      See Also:
      Search employer database Documentation

    • employmentVerificationGet

      @Headers("Content-Type:application/json") @POST("employment/verification/get") retrofit2.Call<EmploymentVerificationGetResponse> employmentVerificationGet​(@Body EmploymentVerificationGetRequest employmentVerificationGetRequest)
      Retrieve a summary of an individual's employment information. `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.
      Parameters:
      employmentVerificationGetRequest - (required)
      Returns:
      Call<EmploymentVerificationGetResponse>

    • identityGet

      @Headers("Content-Type:application/json") @POST("identity/get") retrofit2.Call<IdentityGetResponse> identityGet​(@Body IdentityGetRequest identityGetRequest)
      Retrieve identity data The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
      Parameters:
      identityGetRequest - (required)
      Returns:
      Call<IdentityGetResponse>
      See Also:
      Retrieve identity data Documentation

    • incomeVerificationCreate

      @Deprecated @Headers("Content-Type:application/json") @POST("income/verification/create") retrofit2.Call<IncomeVerificationCreateResponse> incomeVerificationCreate​(@Body IncomeVerificationCreateRequest incomeVerificationCreateRequest)
      Deprecated.
      Create an income verification instance `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
      Parameters:
      incomeVerificationCreateRequest - (required)
      Returns:
      Call<IncomeVerificationCreateResponse>
      See Also:
      Create an income verification instance Documentation

    • incomeVerificationDocumentsDownload

      @Headers("Content-Type:application/json") @POST("income/verification/documents/download") retrofit2.Call<okhttp3.ResponseBody> incomeVerificationDocumentsDownload​(@Body IncomeVerificationDocumentsDownloadRequest incomeVerificationDocumentsDownloadRequest)
      Download the original documents used for income verification `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is ZIP file in binary data. If a document_id is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header.
      Parameters:
      incomeVerificationDocumentsDownloadRequest - (required)
      Returns:
      Call<ResponseBody>
      See Also:
      Download the original documents used for income verification Documentation

    • incomeVerificationPaystubGet

      @Deprecated @Headers("Content-Type:application/json") @POST("income/verification/paystub/get") retrofit2.Call<IncomeVerificationPaystubGetResponse> incomeVerificationPaystubGet​(@Body IncomeVerificationPaystubGetRequest incomeVerificationPaystubGetRequest)
      Deprecated.
      (Deprecated) Retrieve information from a single paystub used for income verification
      Parameters:
      incomeVerificationPaystubGetRequest - (required)
      Returns:
      Call<IncomeVerificationPaystubGetResponse>

    • incomeVerificationPaystubsGet

      @Headers("Content-Type:application/json") @POST("income/verification/paystubs/get") retrofit2.Call<IncomeVerificationPaystubsGetResponse> incomeVerificationPaystubsGet​(@Body IncomeVerificationPaystubsGetRequest incomeVerificationPaystubsGetRequest)
      Retrieve information from the paystubs used for income verification `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
      Parameters:
      incomeVerificationPaystubsGetRequest - (required)
      Returns:
      Call<IncomeVerificationPaystubsGetResponse>
      See Also:
      Retrieve information from the paystubs used for income verification Documentation

    • incomeVerificationPrecheck

      @Headers("Content-Type:application/json") @POST("income/verification/precheck") retrofit2.Call<IncomeVerificationPrecheckResponse> incomeVerificationPrecheck​(@Body IncomeVerificationPrecheckRequest incomeVerificationPrecheckRequest)
      Check a user's eligibility for the income verification product `/income/verification/precheck` returns whether a given user is supportable by the income product
      Parameters:
      incomeVerificationPrecheckRequest - (required)
      Returns:
      Call<IncomeVerificationPrecheckResponse>

    • incomeVerificationRefresh

      @Headers("Content-Type:application/json") @POST("income/verification/refresh") retrofit2.Call<IncomeVerificationRefreshResponse> incomeVerificationRefresh​(@Body IncomeVerificationRefreshRequest incomeVerificationRefreshRequest)
      Refresh an income verification `/income/verification/refresh` refreshes a given income verification.
      Parameters:
      incomeVerificationRefreshRequest - (required)
      Returns:
      Call<IncomeVerificationRefreshResponse>
      See Also:
      Refresh an income verification Documentation

    • incomeVerificationSummaryGet

      @Headers("Content-Type:application/json") @POST("income/verification/summary/get") retrofit2.Call<IncomeVerificationSummaryGetResponse> incomeVerificationSummaryGet​(@Body IncomeVerificationSummaryGetRequest incomeVerificationSummaryGetRequest)
      Retrieve a summary of information derived from income verification `/income/verification/summary/get` returns a verification summary for the income that was verified for an end user. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
      Parameters:
      incomeVerificationSummaryGetRequest - (required)
      Returns:
      Call<IncomeVerificationSummaryGetResponse>
      See Also:
      Retrieve a summary of information derived from income verification Documentation

    • incomeVerificationTaxformsGet

      @Headers("Content-Type:application/json") @POST("income/verification/taxforms/get") retrofit2.Call<IncomeVerificationTaxformsGetResponse> incomeVerificationTaxformsGet​(@Body IncomeVerificationTaxformsGetRequest incomeVerificationTaxformsGetRequest)
      Retrieve information from the tax documents used for income verification `/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
      Parameters:
      incomeVerificationTaxformsGetRequest - (required)
      Returns:
      Call<IncomeVerificationTaxformsGetResponse>
      See Also:
      Retrieve information from the tax documents used for income verification Documentation

    • institutionsGet

      @Headers("Content-Type:application/json") @POST("institutions/get") retrofit2.Call<InstitutionsGetResponse> institutionsGet​(@Body InstitutionsGetRequest institutionsGetRequest)
      Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
      Parameters:
      institutionsGetRequest - (required)
      Returns:
      Call<InstitutionsGetResponse>
      See Also:
      Get details of all supported institutions Documentation

    • institutionsGetById

      @Headers("Content-Type:application/json") @POST("institutions/get_by_id") retrofit2.Call<InstitutionsGetByIdResponse> institutionsGetById​(@Body InstitutionsGetByIdRequest institutionsGetByIdRequest)
      Get details of an institution Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
      Parameters:
      institutionsGetByIdRequest - (required)
      Returns:
      Call<InstitutionsGetByIdResponse>
      See Also:
      Get details of an institution Documentation

    • institutionsSearch

      @Headers("Content-Type:application/json") @POST("institutions/search") retrofit2.Call<InstitutionsSearchResponse> institutionsSearch​(@Body InstitutionsSearchRequest institutionsSearchRequest)
      Search institutions Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
      Parameters:
      institutionsSearchRequest - (required)
      Returns:
      Call<InstitutionsSearchResponse>
      See Also:
      Search institutions Documentation

    • investmentsHoldingsGet

      @Headers("Content-Type:application/json") @POST("investments/holdings/get") retrofit2.Call<InvestmentsHoldingsGetResponse> investmentsHoldingsGet​(@Body InvestmentsHoldingsGetRequest investmentsHoldingsGetRequest)
      Get Investment holdings The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
      Parameters:
      investmentsHoldingsGetRequest - (required)
      Returns:
      Call<InvestmentsHoldingsGetResponse>
      See Also:
      Get Investment holdings Documentation

    • investmentsTransactionsGet

      @Headers("Content-Type:application/json") @POST("investments/transactions/get") retrofit2.Call<InvestmentsTransactionsGetResponse> investmentsTransactionsGet​(@Body InvestmentsTransactionsGetRequest investmentsTransactionsGetRequest)
      Get investment transactions The `/investments/transactions/get` endpoint allows developers to retrieve user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
      Parameters:
      investmentsTransactionsGetRequest - (required)
      Returns:
      Call<InvestmentsTransactionsGetResponse>
      See Also:
      Get investment transactions Documentation

    • itemAccessTokenInvalidate

      @Headers("Content-Type:application/json") @POST("item/access_token/invalidate") retrofit2.Call<ItemAccessTokenInvalidateResponse> itemAccessTokenInvalidate​(@Body ItemAccessTokenInvalidateRequest itemAccessTokenInvalidateRequest)
      Invalidate access_token By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`.
      Parameters:
      itemAccessTokenInvalidateRequest - (required)
      Returns:
      Call<ItemAccessTokenInvalidateResponse>
      See Also:
      Invalidate access_token Documentation

    • itemApplicationList

      @Headers("Content-Type:application/json") @POST("item/application/list") retrofit2.Call<ItemApplicationListResponse> itemApplicationList​(@Body ItemApplicationListRequest itemApplicationListRequest)
      List a user’s connected applications List a user’s connected applications
      Parameters:
      itemApplicationListRequest - (required)
      Returns:
      Call<ItemApplicationListResponse>

    • itemApplicationScopesUpdate

      @Headers("Content-Type:application/json") @POST("item/application/scopes/update") retrofit2.Call<ItemApplicationScopesUpdateResponse> itemApplicationScopesUpdate​(@Body ItemApplicationScopesUpdateRequest itemApplicationScopesUpdateRequest)
      Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application.
      Parameters:
      itemApplicationScopesUpdateRequest - (required)
      Returns:
      Call<ItemApplicationScopesUpdateResponse>

    • itemCreatePublicToken

      @Headers("Content-Type:application/json") @POST("item/public_token/create") retrofit2.Call<ItemPublicTokenCreateResponse> itemCreatePublicToken​(@Body ItemPublicTokenCreateRequest itemPublicTokenCreateRequest)
      Create public token Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
      Parameters:
      itemPublicTokenCreateRequest - (required)
      Returns:
      Call<ItemPublicTokenCreateResponse>
      See Also:
      Create public token Documentation

    • itemGet

      @Headers("Content-Type:application/json") @POST("item/get") retrofit2.Call<ItemGetResponse> itemGet​(@Body ItemGetRequest itemGetRequest)
      Retrieve an Item Returns information about the status of an Item.
      Parameters:
      itemGetRequest - (required)
      Returns:
      Call<ItemGetResponse>
      See Also:
      Retrieve an Item Documentation

    • itemImport

      @Headers("Content-Type:application/json") @POST("item/import") retrofit2.Call<ItemImportResponse> itemImport​(@Body ItemImportRequest itemImportRequest)
      Import Item `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).
      Parameters:
      itemImportRequest - (required)
      Returns:
      Call<ItemImportResponse>

    • itemPublicTokenExchange

      @Headers("Content-Type:application/json") @POST("item/public_token/exchange") retrofit2.Call<ItemPublicTokenExchangeResponse> itemPublicTokenExchange​(@Body ItemPublicTokenExchangeRequest itemPublicTokenExchangeRequest)
      Exchange public token for an access token Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
      Parameters:
      itemPublicTokenExchangeRequest - (required)
      Returns:
      Call<ItemPublicTokenExchangeResponse>
      See Also:
      Exchange public token for an access token Documentation

    • itemRemove

      @Headers("Content-Type:application/json") @POST("item/remove") retrofit2.Call<ItemRemoveResponse> itemRemove​(@Body ItemRemoveRequest itemRemoveRequest)
      Remove an Item The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token` associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.
      Parameters:
      itemRemoveRequest - (required)
      Returns:
      Call<ItemRemoveResponse>
      See Also:
      Remove an Item Documentation

    • itemWebhookUpdate

      @Headers("Content-Type:application/json") @POST("item/webhook/update") retrofit2.Call<ItemWebhookUpdateResponse> itemWebhookUpdate​(@Body ItemWebhookUpdateRequest itemWebhookUpdateRequest)
      Update Webhook URL The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
      Parameters:
      itemWebhookUpdateRequest - (required)
      Returns:
      Call<ItemWebhookUpdateResponse>
      See Also:
      Update Webhook URL Documentation

    • liabilitiesGet

      @Headers("Content-Type:application/json") @POST("liabilities/get") retrofit2.Call<LiabilitiesGetResponse> liabilitiesGet​(@Body LiabilitiesGetRequest liabilitiesGetRequest)
      Retrieve Liabilities data The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
      Parameters:
      liabilitiesGetRequest - (required)
      Returns:
      Call<LiabilitiesGetResponse>
      See Also:
      Retrieve Liabilities data Documentation

    • linkTokenCreate

      @Headers("Content-Type:application/json") @POST("link/token/create") retrofit2.Call<LinkTokenCreateResponse> linkTokenCreate​(@Body LinkTokenCreateRequest linkTokenCreateRequest)
      Create Link Token The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
      Parameters:
      linkTokenCreateRequest - (required)
      Returns:
      Call<LinkTokenCreateResponse>
      See Also:
      Create Link Token Documentation

    • linkTokenGet

      @Headers("Content-Type:application/json") @POST("link/token/get") retrofit2.Call<LinkTokenGetResponse> linkTokenGet​(@Body LinkTokenGetRequest linkTokenGetRequest)
      Get Link Token The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes.
      Parameters:
      linkTokenGetRequest - (required)
      Returns:
      Call<LinkTokenGetResponse>
      See Also:
      Get Link Token Documentation

    • paymentInitiationPaymentCreate

      @Headers("Content-Type:application/json") @POST("payment_initiation/payment/create") retrofit2.Call<PaymentInitiationPaymentCreateResponse> paymentInitiationPaymentCreate​(@Body PaymentInitiationPaymentCreateRequest paymentInitiationPaymentCreateRequest)
      Create a payment After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
      Parameters:
      paymentInitiationPaymentCreateRequest - (required)
      Returns:
      Call<PaymentInitiationPaymentCreateResponse>
      See Also:
      Create a payment Documentation

    • paymentInitiationPaymentGet

      @Headers("Content-Type:application/json") @POST("payment_initiation/payment/get") retrofit2.Call<PaymentInitiationPaymentGetResponse> paymentInitiationPaymentGet​(@Body PaymentInitiationPaymentGetRequest paymentInitiationPaymentGetRequest)
      Get payment details The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
      Parameters:
      paymentInitiationPaymentGetRequest - (required)
      Returns:
      Call<PaymentInitiationPaymentGetResponse>
      See Also:
      Get payment details Documentation

    • paymentInitiationPaymentList

      @Headers("Content-Type:application/json") @POST("payment_initiation/payment/list") retrofit2.Call<PaymentInitiationPaymentListResponse> paymentInitiationPaymentList​(@Body PaymentInitiationPaymentListRequest paymentInitiationPaymentListRequest)
      List payments The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters.
      Parameters:
      paymentInitiationPaymentListRequest - (required)
      Returns:
      Call<PaymentInitiationPaymentListResponse>
      See Also:
      List payments Documentation

    • paymentInitiationPaymentReverse

      @Headers("Content-Type:application/json") @POST("payment_initiation/payment/reverse") retrofit2.Call<PaymentInitiationPaymentReverseResponse> paymentInitiationPaymentReverse​(@Body PaymentInitiationPaymentReverseRequest paymentInitiationPaymentReverseRequest)
      Reverse an existing payment Reverse a previously initiated payment. A payment can only be reversed once and will be refunded to the original sender's account.
      Parameters:
      paymentInitiationPaymentReverseRequest - (required)
      Returns:
      Call<PaymentInitiationPaymentReverseResponse>
      See Also:
      Reverse an existing payment Documentation

    • paymentInitiationRecipientCreate

      @Headers("Content-Type:application/json") @POST("payment_initiation/recipient/create") retrofit2.Call<PaymentInitiationRecipientCreateResponse> paymentInitiationRecipientCreate​(@Body PaymentInitiationRecipientCreateRequest paymentInitiationRecipientCreateRequest)
      Create payment recipient Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
      Parameters:
      paymentInitiationRecipientCreateRequest - (required)
      Returns:
      Call<PaymentInitiationRecipientCreateResponse>
      See Also:
      Create payment recipient Documentation

    • paymentInitiationRecipientGet

      @Headers("Content-Type:application/json") @POST("payment_initiation/recipient/get") retrofit2.Call<PaymentInitiationRecipientGetResponse> paymentInitiationRecipientGet​(@Body PaymentInitiationRecipientGetRequest paymentInitiationRecipientGetRequest)
      Get payment recipient Get details about a payment recipient you have previously created.
      Parameters:
      paymentInitiationRecipientGetRequest - (required)
      Returns:
      Call<PaymentInitiationRecipientGetResponse>
      See Also:
      Get payment recipient Documentation

    • paymentInitiationRecipientList

      @Headers("Content-Type:application/json") @POST("payment_initiation/recipient/list") retrofit2.Call<PaymentInitiationRecipientListResponse> paymentInitiationRecipientList​(@Body PaymentInitiationRecipientListRequest paymentInitiationRecipientListRequest)
      List payment recipients The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
      Parameters:
      paymentInitiationRecipientListRequest - (required)
      Returns:
      Call<PaymentInitiationRecipientListResponse>
      See Also:
      List payment recipients Documentation

    • processorApexProcessorTokenCreate

      @Headers("Content-Type:application/json") @POST("processor/apex/processor_token/create") retrofit2.Call<ProcessorTokenCreateResponse> processorApexProcessorTokenCreate​(@Body ProcessorApexProcessorTokenCreateRequest processorApexProcessorTokenCreateRequest)
      Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
      Parameters:
      processorApexProcessorTokenCreateRequest - (required)
      Returns:
      Call<ProcessorTokenCreateResponse>
      See Also:
      Create Apex bank account token Documentation

    • processorAuthGet

      @Headers("Content-Type:application/json") @POST("processor/auth/get") retrofit2.Call<ProcessorAuthGetResponse> processorAuthGet​(@Body ProcessorAuthGetRequest processorAuthGetRequest)
      Retrieve Auth data The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that's associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available.
      Parameters:
      processorAuthGetRequest - (required)
      Returns:
      Call<ProcessorAuthGetResponse>
      See Also:
      Retrieve Auth data Documentation

    • processorBalanceGet

      @Headers("Content-Type:application/json") @POST("processor/balance/get") retrofit2.Call<ProcessorBalanceGetResponse> processorBalanceGet​(@Body ProcessorBalanceGetRequest processorBalanceGetRequest)
      Retrieve Balance data The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.
      Parameters:
      processorBalanceGetRequest - The `/processor/balance/get` endpoint returns the real-time balance for the account associated with a given `processor_token`. The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account. Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of `null`. (required)
      Returns:
      Call<ProcessorBalanceGetResponse>
      See Also:
      Retrieve Balance data Documentation

    • processorBankTransferCreate

      @Headers("Content-Type:application/json") @POST("processor/bank_transfer/create") retrofit2.Call<ProcessorBankTransferCreateResponse> processorBankTransferCreate​(@Body ProcessorBankTransferCreateRequest processorBankTransferCreateRequest)
      Create a bank transfer as a processor Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
      Parameters:
      processorBankTransferCreateRequest - (required)
      Returns:
      Call<ProcessorBankTransferCreateResponse>
      See Also:
      Create a bank transfer as a processor Documentation

    • processorIdentityGet

      @Headers("Content-Type:application/json") @POST("processor/identity/get") retrofit2.Call<ProcessorIdentityGetResponse> processorIdentityGet​(@Body ProcessorIdentityGetRequest processorIdentityGetRequest)
      Retrieve Identity data The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
      Parameters:
      processorIdentityGetRequest - (required)
      Returns:
      Call<ProcessorIdentityGetResponse>
      See Also:
      Retrieve Identity data Documentation

    • processorStripeBankAccountTokenCreate

      @Headers("Content-Type:application/json") @POST("processor/stripe/bank_account_token/create") retrofit2.Call<ProcessorStripeBankAccountTokenCreateResponse> processorStripeBankAccountTokenCreate​(@Body ProcessorStripeBankAccountTokenCreateRequest processorStripeBankAccountTokenCreateRequest)
      Create Stripe bank account token Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/).
      Parameters:
      processorStripeBankAccountTokenCreateRequest - (required)
      Returns:
      Call<ProcessorStripeBankAccountTokenCreateResponse>
      See Also:
      Create Stripe bank account token Documentation

    • processorTokenCreate

      @Headers("Content-Type:application/json") @POST("processor/token/create") retrofit2.Call<ProcessorTokenCreateResponse> processorTokenCreate​(@Body ProcessorTokenCreateRequest processorTokenCreateRequest)
      Create processor token Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations.
      Parameters:
      processorTokenCreateRequest - (required)
      Returns:
      Call<ProcessorTokenCreateResponse>
      See Also:
      Create processor token Documentation

    • sandboxBankTransferFireWebhook

      @Headers("Content-Type:application/json") @POST("sandbox/bank_transfer/fire_webhook") retrofit2.Call<SandboxBankTransferFireWebhookResponse> sandboxBankTransferFireWebhook​(@Body SandboxBankTransferFireWebhookRequest sandboxBankTransferFireWebhookRequest)
      Manually fire a Bank Transfer webhook Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
      Parameters:
      sandboxBankTransferFireWebhookRequest - (required)
      Returns:
      Call<SandboxBankTransferFireWebhookResponse>
      See Also:
      Manually fire a Bank Transfer webhook Documentation

    • sandboxBankTransferSimulate

      @Headers("Content-Type:application/json") @POST("sandbox/bank_transfer/simulate") retrofit2.Call<SandboxBankTransferSimulateResponse> sandboxBankTransferSimulate​(@Body SandboxBankTransferSimulateRequest sandboxBankTransferSimulateRequest)
      Simulate a bank transfer event in Sandbox Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
      Parameters:
      sandboxBankTransferSimulateRequest - (required)
      Returns:
      Call<SandboxBankTransferSimulateResponse>
      See Also:
      Simulate a bank transfer event in Sandbox Documentation

    • sandboxIncomeFireWebhook

      @Headers("Content-Type:application/json") @POST("sandbox/income/fire_webhook") retrofit2.Call<SandboxIncomeFireWebhookResponse> sandboxIncomeFireWebhook​(@Body SandboxIncomeFireWebhookRequest sandboxIncomeFireWebhookRequest)
      Manually fire an Income webhook Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox environment.
      Parameters:
      sandboxIncomeFireWebhookRequest - (required)
      Returns:
      Call<SandboxIncomeFireWebhookResponse>
      See Also:
      Manually fire an Income webhook Documentation

    • sandboxItemFireWebhook

      @Headers("Content-Type:application/json") @POST("sandbox/item/fire_webhook") retrofit2.Call<SandboxItemFireWebhookResponse> sandboxItemFireWebhook​(@Body SandboxItemFireWebhookRequest sandboxItemFireWebhookRequest)
      Fire a test webhook The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions `DEFAULT_UPDATE` webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.
      Parameters:
      sandboxItemFireWebhookRequest - (required)
      Returns:
      Call<SandboxItemFireWebhookResponse>
      See Also:
      Fire a test webhook Documentation

    • sandboxItemResetLogin

      @Headers("Content-Type:application/json") @POST("sandbox/item/reset_login") retrofit2.Call<SandboxItemResetLoginResponse> sandboxItemResetLogin​(@Body SandboxItemResetLoginRequest sandboxItemResetLoginRequest)
      Force a Sandbox Item into an error state `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
      Parameters:
      sandboxItemResetLoginRequest - (required)
      Returns:
      Call<SandboxItemResetLoginResponse>
      See Also:
      Force a Sandbox Item into an error state Documentation

    • sandboxItemSetVerificationStatus

      @Headers("Content-Type:application/json") @POST("sandbox/item/set_verification_status") retrofit2.Call<SandboxItemSetVerificationStatusResponse> sandboxItemSetVerificationStatus​(@Body SandboxItemSetVerificationStatusRequest sandboxItemSetVerificationStatusRequest)
      Set verification status for Sandbox account The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
      Parameters:
      sandboxItemSetVerificationStatusRequest - (required)
      Returns:
      Call<SandboxItemSetVerificationStatusResponse>
      See Also:
      Set verification status for Sandbox account Documentation

    • sandboxOauthSelectAccounts

      @Headers("Content-Type:application/json") @POST("sandbox/oauth/select_accounts") retrofit2.Call<java.lang.Object> sandboxOauthSelectAccounts​(@Body SandboxOauthSelectAccountsRequest sandboxOauthSelectAccountsRequest)
      Save the selected accounts when connecting to the Platypus Oauth institution
      Parameters:
      sandboxOauthSelectAccountsRequest - (required)
      Returns:
      Call<Object>

    • sandboxProcessorTokenCreate

      @Headers("Content-Type:application/json") @POST("sandbox/processor_token/create") retrofit2.Call<SandboxProcessorTokenCreateResponse> sandboxProcessorTokenCreate​(@Body SandboxProcessorTokenCreateRequest sandboxProcessorTokenCreateRequest)
      Create a test Item and processor token Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
      Parameters:
      sandboxProcessorTokenCreateRequest - (required)
      Returns:
      Call<SandboxProcessorTokenCreateResponse>
      See Also:
      Create a test Item and processor token Documentation

    • sandboxPublicTokenCreate

      @Headers("Content-Type:application/json") @POST("sandbox/public_token/create") retrofit2.Call<SandboxPublicTokenCreateResponse> sandboxPublicTokenCreate​(@Body SandboxPublicTokenCreateRequest sandboxPublicTokenCreateRequest)
      Create a test Item Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
      Parameters:
      sandboxPublicTokenCreateRequest - (required)
      Returns:
      Call<SandboxPublicTokenCreateResponse>
      See Also:
      Create a test Item Documentation

    • sandboxTransferSimulate

      @Headers("Content-Type:application/json") @POST("sandbox/transfer/simulate") retrofit2.Call<SandboxTransferSimulateResponse> sandboxTransferSimulate​(@Body SandboxTransferSimulateRequest sandboxTransferSimulateRequest)
      Simulate a transfer event in Sandbox Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
      Parameters:
      sandboxTransferSimulateRequest - (required)
      Returns:
      Call<SandboxTransferSimulateResponse>
      See Also:
      Simulate a transfer event in Sandbox Documentation

    • signalDecisionReport

      @Headers("Content-Type:application/json") @POST("signal/decision/report") retrofit2.Call<SignalDecisionReportResponse> signalDecisionReport​(@Body SignalDecisionReportRequest signalDecisionReportRequest)
      Report whether you initiated an ACH transaction After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.
      Parameters:
      signalDecisionReportRequest - (required)
      Returns:
      Call<SignalDecisionReportResponse>
      See Also:
      Report whether you initiated an ACH transaction Documentation

    • signalEvaluate

      @Headers("Content-Type:application/json") @POST("signal/evaluate") retrofit2.Call<SignalEvaluateResponse> signalEvaluate​(@Body SignalEvaluateRequest signalEvaluateRequest)
      Evaluate a planned ACH transaction Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause.
      Parameters:
      signalEvaluateRequest - (required)
      Returns:
      Call<SignalEvaluateResponse>
      See Also:
      Evaluate a planned ACH transaction Documentation

    • signalReturnReport

      @Headers("Content-Type:application/json") @POST("signal/return/report") retrofit2.Call<SignalReturnReportResponse> signalReturnReport​(@Body SignalReturnReportRequest signalReturnReportRequest)
      Report a return for an ACH transaction Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
      Parameters:
      signalReturnReportRequest - (required)
      Returns:
      Call<SignalReturnReportResponse>
      See Also:
      Report a return for an ACH transaction Documentation

    • transactionsGet

      @Headers("Content-Type:application/json") @POST("transactions/get") retrofit2.Call<TransactionsGetResponse> transactionsGet​(@Body TransactionsGetRequest transactionsGetRequest)
      Get transaction data The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
      Parameters:
      transactionsGetRequest - (required)
      Returns:
      Call<TransactionsGetResponse>
      See Also:
      Get transaction data Documentation

    • transactionsRecurringGet

      @Headers("Content-Type:application/json") @POST("transactions/recurring/get") retrofit2.Call<TransactionsRecurringGetResponse> transactionsRecurringGet​(@Body TransactionsRecurringGetRequest transactionsRecurringGetRequest)
      Get streams of recurring transactions The `/transactions/recurring/get` endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts. The product is currently in beta. To request access, contact [email protected].
      Parameters:
      transactionsRecurringGetRequest - (required)
      Returns:
      Call<TransactionsRecurringGetResponse>

    • transactionsRefresh

      @Headers("Content-Type:application/json") @POST("transactions/refresh") retrofit2.Call<TransactionsRefreshResponse> transactionsRefresh​(@Body TransactionsRefreshRequest transactionsRefreshRequest)
      Refresh transaction data `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
      Parameters:
      transactionsRefreshRequest - (required)
      Returns:
      Call<TransactionsRefreshResponse>
      See Also:
      Refresh transaction data Documentation

    • transferAuthorizationCreate

      @Headers("Content-Type:application/json") @POST("transfer/authorization/create") retrofit2.Call<TransferAuthorizationCreateResponse> transferAuthorizationCreate​(@Body TransferAuthorizationCreateRequest transferAuthorizationCreateRequest)
      Create a transfer authorization Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer, make an authorization request with an `amount` less than the available balance in the account. - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
      Parameters:
      transferAuthorizationCreateRequest - (required)
      Returns:
      Call<TransferAuthorizationCreateResponse>
      See Also:
      Create a transfer authorization Documentation

    • transferCancel

      @Headers("Content-Type:application/json") @POST("transfer/cancel") retrofit2.Call<TransferCancelResponse> transferCancel​(@Body TransferCancelRequest transferCancelRequest)
      Cancel a transfer Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/transfer/get` is `true`.
      Parameters:
      transferCancelRequest - (required)
      Returns:
      Call<TransferCancelResponse>
      See Also:
      Cancel a transfer Documentation

    • transferCreate

      @Headers("Content-Type:application/json") @POST("transfer/create") retrofit2.Call<TransferCreateResponse> transferCreate​(@Body TransferCreateRequest transferCreateRequest)
      Create a transfer Use the `/transfer/create` endpoint to initiate a new transfer.
      Parameters:
      transferCreateRequest - (required)
      Returns:
      Call<TransferCreateResponse>
      See Also:
      Create a transfer Documentation

    • transferEventList

      @Headers("Content-Type:application/json") @POST("transfer/event/list") retrofit2.Call<TransferEventListResponse> transferEventList​(@Body TransferEventListRequest transferEventListRequest)
      List transfer events Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
      Parameters:
      transferEventListRequest - (required)
      Returns:
      Call<TransferEventListResponse>
      See Also:
      List transfer events Documentation

    • transferEventSync

      @Headers("Content-Type:application/json") @POST("transfer/event/sync") retrofit2.Call<TransferEventSyncResponse> transferEventSync​(@Body TransferEventSyncRequest transferEventSyncRequest)
      Sync transfer events `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.
      Parameters:
      transferEventSyncRequest - (required)
      Returns:
      Call<TransferEventSyncResponse>
      See Also:
      Sync transfer events Documentation

    • transferGet

      @Headers("Content-Type:application/json") @POST("transfer/get") retrofit2.Call<TransferGetResponse> transferGet​(@Body TransferGetRequest transferGetRequest)
      Retrieve a transfer The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
      Parameters:
      transferGetRequest - (required)
      Returns:
      Call<TransferGetResponse>
      See Also:
      Retrieve a transfer Documentation

    • transferList

      @Headers("Content-Type:application/json") @POST("transfer/list") retrofit2.Call<TransferListResponse> transferList​(@Body TransferListRequest transferListRequest)
      List transfers Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
      Parameters:
      transferListRequest - (required)
      Returns:
      Call<TransferListResponse>
      See Also:
      List transfers Documentation

    • webhookVerificationKeyGet

      @Headers("Content-Type:application/json") @POST("webhook_verification_key/get") retrofit2.Call<WebhookVerificationKeyGetResponse> webhookVerificationKeyGet​(@Body WebhookVerificationKeyGetRequest webhookVerificationKeyGetRequest)
      Get webhook verification key Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
      Parameters:
      webhookVerificationKeyGetRequest - (required)
      Returns:
      Call<WebhookVerificationKeyGetResponse>
      See Also:
      Get webhook verification key Documentation