https://github.com/libninjacom/openapi-generator-plaid-go

Last synced: about 1 month ago
JSON representation
Host: GitHub
URL: https://github.com/libninjacom/openapi-generator-plaid-go
Owner: libninjacom
Created: 2022-06-13T14:05:43.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2022-06-13T14:05:45.000Z (about 4 years ago)
Last Synced: 2025-02-23T09:13:31.968Z (over 1 year ago)
Language: Shell
Size: 1.08 MB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Security: docs/Security.md
Awesome Lists containing this project

README

          # Go API client for openapi

The Plaid REST API. Please see https://plaid.com/docs/api for more details.

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 2020-09-14_1.64.13

- Package version: 1.0.0

- Build package: org.openapitools.codegen.languages.GoClientCodegen

For more information, please visit [https://plaid.com](https://plaid.com)

## Installation

Install the following dependencies:

```shell

go get github.com/stretchr/testify/assert

go get golang.org/x/oauth2

go get golang.org/x/net/context

```

Put the package under your project folder and add the following in import:

```golang

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

```

To use a proxy, set the environment variable `HTTP_PROXY`:

```golang

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.

```golang

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.

```golang

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{

	"basePath": "v2",

})

```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.

An operation is uniquely identified by `"{classname}Service.{nickname}"` string.

Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.

```

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{

	"{classname}Service.{nickname}": 2,

})

ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{

	"{classname}Service.{nickname}": {

		"port": "8443",

	},

})

```

## Documentation for API Endpoints

All URIs are relative to *https://production.plaid.com*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*PlaidApi* | [**AccountsBalanceGet**](docs/PlaidApi.md#accountsbalanceget) | **Post** /accounts/balance/get | Retrieve real-time balance data

*PlaidApi* | [**AccountsGet**](docs/PlaidApi.md#accountsget) | **Post** /accounts/get | Retrieve accounts

*PlaidApi* | [**ApplicationGet**](docs/PlaidApi.md#applicationget) | **Post** /application/get | Retrieve information about a Plaid application

*PlaidApi* | [**AssetReportAuditCopyCreate**](docs/PlaidApi.md#assetreportauditcopycreate) | **Post** /asset_report/audit_copy/create | Create Asset Report Audit Copy

*PlaidApi* | [**AssetReportAuditCopyGet**](docs/PlaidApi.md#assetreportauditcopyget) | **Post** /asset_report/audit_copy/get | Retrieve an Asset Report Audit Copy

*PlaidApi* | [**AssetReportAuditCopyRemove**](docs/PlaidApi.md#assetreportauditcopyremove) | **Post** /asset_report/audit_copy/remove | Remove Asset Report Audit Copy

*PlaidApi* | [**AssetReportCreate**](docs/PlaidApi.md#assetreportcreate) | **Post** /asset_report/create | Create an Asset Report

*PlaidApi* | [**AssetReportFilter**](docs/PlaidApi.md#assetreportfilter) | **Post** /asset_report/filter | Filter Asset Report

*PlaidApi* | [**AssetReportGet**](docs/PlaidApi.md#assetreportget) | **Post** /asset_report/get | Retrieve an Asset Report

*PlaidApi* | [**AssetReportPdfGet**](docs/PlaidApi.md#assetreportpdfget) | **Post** /asset_report/pdf/get | Retrieve a PDF Asset Report

*PlaidApi* | [**AssetReportRefresh**](docs/PlaidApi.md#assetreportrefresh) | **Post** /asset_report/refresh | Refresh an Asset Report

*PlaidApi* | [**AssetReportRemove**](docs/PlaidApi.md#assetreportremove) | **Post** /asset_report/remove | Delete an Asset Report

*PlaidApi* | [**AuthGet**](docs/PlaidApi.md#authget) | **Post** /auth/get | Retrieve auth data

*PlaidApi* | [**BankTransferBalanceGet**](docs/PlaidApi.md#banktransferbalanceget) | **Post** /bank_transfer/balance/get | Get balance of your Bank Transfer account

*PlaidApi* | [**BankTransferCancel**](docs/PlaidApi.md#banktransfercancel) | **Post** /bank_transfer/cancel | Cancel a bank transfer

*PlaidApi* | [**BankTransferCreate**](docs/PlaidApi.md#banktransfercreate) | **Post** /bank_transfer/create | Create a bank transfer

*PlaidApi* | [**BankTransferEventList**](docs/PlaidApi.md#banktransfereventlist) | **Post** /bank_transfer/event/list | List bank transfer events

*PlaidApi* | [**BankTransferEventSync**](docs/PlaidApi.md#banktransfereventsync) | **Post** /bank_transfer/event/sync | Sync bank transfer events

*PlaidApi* | [**BankTransferGet**](docs/PlaidApi.md#banktransferget) | **Post** /bank_transfer/get | Retrieve a bank transfer

*PlaidApi* | [**BankTransferList**](docs/PlaidApi.md#banktransferlist) | **Post** /bank_transfer/list | List bank transfers

*PlaidApi* | [**BankTransferMigrateAccount**](docs/PlaidApi.md#banktransfermigrateaccount) | **Post** /bank_transfer/migrate_account | Migrate account into Bank Transfers

*PlaidApi* | [**BankTransferSweepGet**](docs/PlaidApi.md#banktransfersweepget) | **Post** /bank_transfer/sweep/get | Retrieve a sweep

*PlaidApi* | [**BankTransferSweepList**](docs/PlaidApi.md#banktransfersweeplist) | **Post** /bank_transfer/sweep/list | List sweeps

*PlaidApi* | [**CategoriesGet**](docs/PlaidApi.md#categoriesget) | **Post** /categories/get | Get Categories

*PlaidApi* | [**CreatePaymentToken**](docs/PlaidApi.md#createpaymenttoken) | **Post** /payment_initiation/payment/token/create | Create payment token

*PlaidApi* | [**DepositSwitchAltCreate**](docs/PlaidApi.md#depositswitchaltcreate) | **Post** /deposit_switch/alt/create | Create a deposit switch without using Plaid Exchange

*PlaidApi* | [**DepositSwitchCreate**](docs/PlaidApi.md#depositswitchcreate) | **Post** /deposit_switch/create | Create a deposit switch

*PlaidApi* | [**DepositSwitchGet**](docs/PlaidApi.md#depositswitchget) | **Post** /deposit_switch/get | Retrieve a deposit switch

*PlaidApi* | [**DepositSwitchTokenCreate**](docs/PlaidApi.md#depositswitchtokencreate) | **Post** /deposit_switch/token/create | Create a deposit switch token

*PlaidApi* | [**EmployersSearch**](docs/PlaidApi.md#employerssearch) | **Post** /employers/search | Search employer database

*PlaidApi* | [**EmploymentVerificationGet**](docs/PlaidApi.md#employmentverificationget) | **Post** /employment/verification/get | Retrieve a summary of an individual's employment information

*PlaidApi* | [**IdentityGet**](docs/PlaidApi.md#identityget) | **Post** /identity/get | Retrieve identity data

*PlaidApi* | [**IncomeVerificationCreate**](docs/PlaidApi.md#incomeverificationcreate) | **Post** /income/verification/create | (Deprecated) Create an income verification instance

*PlaidApi* | [**IncomeVerificationDocumentsDownload**](docs/PlaidApi.md#incomeverificationdocumentsdownload) | **Post** /income/verification/documents/download | Download the original documents used for income verification

*PlaidApi* | [**IncomeVerificationPaystubGet**](docs/PlaidApi.md#incomeverificationpaystubget) | **Post** /income/verification/paystub/get | (Deprecated) Retrieve information from a single paystub used for income verification

*PlaidApi* | [**IncomeVerificationPaystubsGet**](docs/PlaidApi.md#incomeverificationpaystubsget) | **Post** /income/verification/paystubs/get | Retrieve information from the paystubs used for income verification

*PlaidApi* | [**IncomeVerificationPrecheck**](docs/PlaidApi.md#incomeverificationprecheck) | **Post** /income/verification/precheck | Check digital income verification eligibility and optimize conversion

*PlaidApi* | [**IncomeVerificationRefresh**](docs/PlaidApi.md#incomeverificationrefresh) | **Post** /income/verification/refresh | Refresh an income verification

*PlaidApi* | [**IncomeVerificationSummaryGet**](docs/PlaidApi.md#incomeverificationsummaryget) | **Post** /income/verification/summary/get | (Deprecated) Retrieve a summary of information derived from income verification

*PlaidApi* | [**IncomeVerificationTaxformsGet**](docs/PlaidApi.md#incomeverificationtaxformsget) | **Post** /income/verification/taxforms/get | Retrieve information from the tax documents used for income verification

*PlaidApi* | [**InstitutionsGet**](docs/PlaidApi.md#institutionsget) | **Post** /institutions/get | Get details of all supported institutions

*PlaidApi* | [**InstitutionsGetById**](docs/PlaidApi.md#institutionsgetbyid) | **Post** /institutions/get_by_id | Get details of an institution

*PlaidApi* | [**InstitutionsSearch**](docs/PlaidApi.md#institutionssearch) | **Post** /institutions/search | Search institutions

*PlaidApi* | [**InvestmentsHoldingsGet**](docs/PlaidApi.md#investmentsholdingsget) | **Post** /investments/holdings/get | Get Investment holdings

*PlaidApi* | [**InvestmentsTransactionsGet**](docs/PlaidApi.md#investmentstransactionsget) | **Post** /investments/transactions/get | Get investment transactions

*PlaidApi* | [**ItemAccessTokenInvalidate**](docs/PlaidApi.md#itemaccesstokeninvalidate) | **Post** /item/access_token/invalidate | Invalidate access_token

*PlaidApi* | [**ItemApplicationList**](docs/PlaidApi.md#itemapplicationlist) | **Post** /item/application/list | List a user’s connected applications

*PlaidApi* | [**ItemApplicationScopesUpdate**](docs/PlaidApi.md#itemapplicationscopesupdate) | **Post** /item/application/scopes/update | Update the scopes of access for a particular application

*PlaidApi* | [**ItemCreatePublicToken**](docs/PlaidApi.md#itemcreatepublictoken) | **Post** /item/public_token/create | Create public token

*PlaidApi* | [**ItemGet**](docs/PlaidApi.md#itemget) | **Post** /item/get | Retrieve an Item

*PlaidApi* | [**ItemImport**](docs/PlaidApi.md#itemimport) | **Post** /item/import | Import Item

*PlaidApi* | [**ItemPublicTokenExchange**](docs/PlaidApi.md#itempublictokenexchange) | **Post** /item/public_token/exchange | Exchange public token for an access token

*PlaidApi* | [**ItemRemove**](docs/PlaidApi.md#itemremove) | **Post** /item/remove | Remove an Item

*PlaidApi* | [**ItemWebhookUpdate**](docs/PlaidApi.md#itemwebhookupdate) | **Post** /item/webhook/update | Update Webhook URL

*PlaidApi* | [**LiabilitiesGet**](docs/PlaidApi.md#liabilitiesget) | **Post** /liabilities/get | Retrieve Liabilities data

*PlaidApi* | [**LinkTokenCreate**](docs/PlaidApi.md#linktokencreate) | **Post** /link/token/create | Create Link Token

*PlaidApi* | [**LinkTokenGet**](docs/PlaidApi.md#linktokenget) | **Post** /link/token/get | Get Link Token

*PlaidApi* | [**PaymentInitiationPaymentCreate**](docs/PlaidApi.md#paymentinitiationpaymentcreate) | **Post** /payment_initiation/payment/create | Create a payment

*PlaidApi* | [**PaymentInitiationPaymentGet**](docs/PlaidApi.md#paymentinitiationpaymentget) | **Post** /payment_initiation/payment/get | Get payment details

*PlaidApi* | [**PaymentInitiationPaymentList**](docs/PlaidApi.md#paymentinitiationpaymentlist) | **Post** /payment_initiation/payment/list | List payments

*PlaidApi* | [**PaymentInitiationPaymentReverse**](docs/PlaidApi.md#paymentinitiationpaymentreverse) | **Post** /payment_initiation/payment/reverse | Reverse an existing payment

*PlaidApi* | [**PaymentInitiationRecipientCreate**](docs/PlaidApi.md#paymentinitiationrecipientcreate) | **Post** /payment_initiation/recipient/create | Create payment recipient

*PlaidApi* | [**PaymentInitiationRecipientGet**](docs/PlaidApi.md#paymentinitiationrecipientget) | **Post** /payment_initiation/recipient/get | Get payment recipient

*PlaidApi* | [**PaymentInitiationRecipientList**](docs/PlaidApi.md#paymentinitiationrecipientlist) | **Post** /payment_initiation/recipient/list | List payment recipients

*PlaidApi* | [**ProcessorApexProcessorTokenCreate**](docs/PlaidApi.md#processorapexprocessortokencreate) | **Post** /processor/apex/processor_token/create | Create Apex bank account token

*PlaidApi* | [**ProcessorAuthGet**](docs/PlaidApi.md#processorauthget) | **Post** /processor/auth/get | Retrieve Auth data

*PlaidApi* | [**ProcessorBalanceGet**](docs/PlaidApi.md#processorbalanceget) | **Post** /processor/balance/get | Retrieve Balance data

*PlaidApi* | [**ProcessorBankTransferCreate**](docs/PlaidApi.md#processorbanktransfercreate) | **Post** /processor/bank_transfer/create | Create a bank transfer as a processor

*PlaidApi* | [**ProcessorIdentityGet**](docs/PlaidApi.md#processoridentityget) | **Post** /processor/identity/get | Retrieve Identity data

*PlaidApi* | [**ProcessorStripeBankAccountTokenCreate**](docs/PlaidApi.md#processorstripebankaccounttokencreate) | **Post** /processor/stripe/bank_account_token/create | Create Stripe bank account token

*PlaidApi* | [**ProcessorTokenCreate**](docs/PlaidApi.md#processortokencreate) | **Post** /processor/token/create | Create processor token

*PlaidApi* | [**SandboxBankTransferFireWebhook**](docs/PlaidApi.md#sandboxbanktransferfirewebhook) | **Post** /sandbox/bank_transfer/fire_webhook | Manually fire a Bank Transfer webhook

*PlaidApi* | [**SandboxBankTransferSimulate**](docs/PlaidApi.md#sandboxbanktransfersimulate) | **Post** /sandbox/bank_transfer/simulate | Simulate a bank transfer event in Sandbox

*PlaidApi* | [**SandboxIncomeFireWebhook**](docs/PlaidApi.md#sandboxincomefirewebhook) | **Post** /sandbox/income/fire_webhook | Manually fire an Income webhook

*PlaidApi* | [**SandboxItemFireWebhook**](docs/PlaidApi.md#sandboxitemfirewebhook) | **Post** /sandbox/item/fire_webhook | Fire a test webhook

*PlaidApi* | [**SandboxItemResetLogin**](docs/PlaidApi.md#sandboxitemresetlogin) | **Post** /sandbox/item/reset_login | Force a Sandbox Item into an error state

*PlaidApi* | [**SandboxItemSetVerificationStatus**](docs/PlaidApi.md#sandboxitemsetverificationstatus) | **Post** /sandbox/item/set_verification_status | Set verification status for Sandbox account

*PlaidApi* | [**SandboxOauthSelectAccounts**](docs/PlaidApi.md#sandboxoauthselectaccounts) | **Post** /sandbox/oauth/select_accounts | Save the selected accounts when connecting to the Platypus Oauth institution

*PlaidApi* | [**SandboxProcessorTokenCreate**](docs/PlaidApi.md#sandboxprocessortokencreate) | **Post** /sandbox/processor_token/create | Create a test Item and processor token

*PlaidApi* | [**SandboxPublicTokenCreate**](docs/PlaidApi.md#sandboxpublictokencreate) | **Post** /sandbox/public_token/create | Create a test Item

*PlaidApi* | [**SandboxTransferRepaymentSimulate**](docs/PlaidApi.md#sandboxtransferrepaymentsimulate) | **Post** /sandbox/transfer/repayment/simulate | Trigger the creation of a repayment

*PlaidApi* | [**SandboxTransferSimulate**](docs/PlaidApi.md#sandboxtransfersimulate) | **Post** /sandbox/transfer/simulate | Simulate a transfer event in Sandbox

*PlaidApi* | [**SandboxTransferSweepSimulate**](docs/PlaidApi.md#sandboxtransfersweepsimulate) | **Post** /sandbox/transfer/sweep/simulate | Simulate creating a sweep

*PlaidApi* | [**SignalDecisionReport**](docs/PlaidApi.md#signaldecisionreport) | **Post** /signal/decision/report | Report whether you initiated an ACH transaction

*PlaidApi* | [**SignalEvaluate**](docs/PlaidApi.md#signalevaluate) | **Post** /signal/evaluate | Evaluate a planned ACH transaction

*PlaidApi* | [**SignalReturnReport**](docs/PlaidApi.md#signalreturnreport) | **Post** /signal/return/report | Report a return for an ACH transaction

*PlaidApi* | [**TransactionsGet**](docs/PlaidApi.md#transactionsget) | **Post** /transactions/get | Get transaction data

*PlaidApi* | [**TransactionsRecurringGet**](docs/PlaidApi.md#transactionsrecurringget) | **Post** /transactions/recurring/get | Get streams of recurring transactions

*PlaidApi* | [**TransactionsRefresh**](docs/PlaidApi.md#transactionsrefresh) | **Post** /transactions/refresh | Refresh transaction data

*PlaidApi* | [**TransactionsSync**](docs/PlaidApi.md#transactionssync) | **Post** /transactions/sync | Get incremental transaction updates on an Item

*PlaidApi* | [**TransferAuthorizationCreate**](docs/PlaidApi.md#transferauthorizationcreate) | **Post** /transfer/authorization/create | Create a transfer authorization

*PlaidApi* | [**TransferCancel**](docs/PlaidApi.md#transfercancel) | **Post** /transfer/cancel | Cancel a transfer

*PlaidApi* | [**TransferCreate**](docs/PlaidApi.md#transfercreate) | **Post** /transfer/create | Create a transfer

*PlaidApi* | [**TransferEventList**](docs/PlaidApi.md#transfereventlist) | **Post** /transfer/event/list | List transfer events

*PlaidApi* | [**TransferEventSync**](docs/PlaidApi.md#transfereventsync) | **Post** /transfer/event/sync | Sync transfer events

*PlaidApi* | [**TransferGet**](docs/PlaidApi.md#transferget) | **Post** /transfer/get | Retrieve a transfer

*PlaidApi* | [**TransferIntentCreate**](docs/PlaidApi.md#transferintentcreate) | **Post** /transfer/intent/create | Create a transfer intent object to invoke the Transfer UI

*PlaidApi* | [**TransferIntentGet**](docs/PlaidApi.md#transferintentget) | **Post** /transfer/intent/get | Retrieve more information about a transfer intent

*PlaidApi* | [**TransferList**](docs/PlaidApi.md#transferlist) | **Post** /transfer/list | List transfers

*PlaidApi* | [**TransferRepaymentList**](docs/PlaidApi.md#transferrepaymentlist) | **Post** /transfer/repayment/list | Lists historical repayments

*PlaidApi* | [**TransferRepaymentReturnList**](docs/PlaidApi.md#transferrepaymentreturnlist) | **Post** /transfer/repayment/return/list | List the returns included in a repayment

*PlaidApi* | [**TransferSweepGet**](docs/PlaidApi.md#transfersweepget) | **Post** /transfer/sweep/get | Retrieve a sweep

*PlaidApi* | [**TransferSweepList**](docs/PlaidApi.md#transfersweeplist) | **Post** /transfer/sweep/list | List sweeps

*PlaidApi* | [**WalletGet**](docs/PlaidApi.md#walletget) | **Post** /wallet/get | Fetch an e-wallet

*PlaidApi* | [**WalletTransactionExecute**](docs/PlaidApi.md#wallettransactionexecute) | **Post** /wallet/transaction/execute | Execute a transaction using an e-wallet

*PlaidApi* | [**WalletTransactionsList**](docs/PlaidApi.md#wallettransactionslist) | **Post** /wallet/transactions/list | List e-wallet transactions

*PlaidApi* | [**WebhookVerificationKeyGet**](docs/PlaidApi.md#webhookverificationkeyget) | **Post** /webhook_verification_key/get | Get webhook verification key

## Documentation For Models

 - [ACHClass](docs/ACHClass.md)

 - [APR](docs/APR.md)

 - [AccountAccess](docs/AccountAccess.md)

 - [AccountAssets](docs/AccountAssets.md)

 - [AccountAssetsAllOf](docs/AccountAssetsAllOf.md)

 - [AccountBalance](docs/AccountBalance.md)

 - [AccountBase](docs/AccountBase.md)

 - [AccountFilter](docs/AccountFilter.md)

 - [AccountFiltersResponse](docs/AccountFiltersResponse.md)

 - [AccountIdentity](docs/AccountIdentity.md)

 - [AccountIdentityAllOf](docs/AccountIdentityAllOf.md)

 - [AccountProductAccess](docs/AccountProductAccess.md)

 - [AccountProductAccessNullable](docs/AccountProductAccessNullable.md)

 - [AccountSelectionCardinality](docs/AccountSelectionCardinality.md)

 - [AccountSubtype](docs/AccountSubtype.md)

 - [AccountType](docs/AccountType.md)

 - [AccountsBalanceGetRequest](docs/AccountsBalanceGetRequest.md)

 - [AccountsBalanceGetRequestOptions](docs/AccountsBalanceGetRequestOptions.md)

 - [AccountsGetRequest](docs/AccountsGetRequest.md)

 - [AccountsGetRequestOptions](docs/AccountsGetRequestOptions.md)

 - [AccountsGetResponse](docs/AccountsGetResponse.md)

 - [Address](docs/Address.md)

 - [AddressData](docs/AddressData.md)

 - [AddressDataNullable](docs/AddressDataNullable.md)

 - [AddressNullable](docs/AddressNullable.md)

 - [Application](docs/Application.md)

 - [ApplicationGetRequest](docs/ApplicationGetRequest.md)

 - [ApplicationGetResponse](docs/ApplicationGetResponse.md)

 - [AssetReport](docs/AssetReport.md)

 - [AssetReportAuditCopyCreateRequest](docs/AssetReportAuditCopyCreateRequest.md)

 - [AssetReportAuditCopyCreateResponse](docs/AssetReportAuditCopyCreateResponse.md)

 - [AssetReportAuditCopyGetRequest](docs/AssetReportAuditCopyGetRequest.md)

 - [AssetReportAuditCopyRemoveRequest](docs/AssetReportAuditCopyRemoveRequest.md)

 - [AssetReportAuditCopyRemoveResponse](docs/AssetReportAuditCopyRemoveResponse.md)

 - [AssetReportCreateRequest](docs/AssetReportCreateRequest.md)

 - [AssetReportCreateRequestOptions](docs/AssetReportCreateRequestOptions.md)

 - [AssetReportCreateResponse](docs/AssetReportCreateResponse.md)

 - [AssetReportFilterRequest](docs/AssetReportFilterRequest.md)

 - [AssetReportFilterResponse](docs/AssetReportFilterResponse.md)

 - [AssetReportGetRequest](docs/AssetReportGetRequest.md)

 - [AssetReportGetResponse](docs/AssetReportGetResponse.md)

 - [AssetReportItem](docs/AssetReportItem.md)

 - [AssetReportPDFGetRequest](docs/AssetReportPDFGetRequest.md)

 - [AssetReportRefreshRequest](docs/AssetReportRefreshRequest.md)

 - [AssetReportRefreshRequestOptions](docs/AssetReportRefreshRequestOptions.md)

 - [AssetReportRefreshResponse](docs/AssetReportRefreshResponse.md)

 - [AssetReportRemoveRequest](docs/AssetReportRemoveRequest.md)

 - [AssetReportRemoveResponse](docs/AssetReportRemoveResponse.md)

 - [AssetReportTransaction](docs/AssetReportTransaction.md)

 - [AssetReportTransactionAllOf](docs/AssetReportTransactionAllOf.md)

 - [AssetReportUser](docs/AssetReportUser.md)

 - [AssetsErrorWebhook](docs/AssetsErrorWebhook.md)

 - [AssetsProductReadyWebhook](docs/AssetsProductReadyWebhook.md)

 - [AuthGetNumbers](docs/AuthGetNumbers.md)

 - [AuthGetRequest](docs/AuthGetRequest.md)

 - [AuthGetRequestOptions](docs/AuthGetRequestOptions.md)

 - [AuthGetResponse](docs/AuthGetResponse.md)

 - [AuthMetadata](docs/AuthMetadata.md)

 - [AuthSupportedMethods](docs/AuthSupportedMethods.md)

 - [AutomaticallyVerifiedWebhook](docs/AutomaticallyVerifiedWebhook.md)

 - [BankInitiatedReturnRisk](docs/BankInitiatedReturnRisk.md)

 - [BankTransfer](docs/BankTransfer.md)

 - [BankTransferBalance](docs/BankTransferBalance.md)

 - [BankTransferBalanceGetRequest](docs/BankTransferBalanceGetRequest.md)

 - [BankTransferBalanceGetResponse](docs/BankTransferBalanceGetResponse.md)

 - [BankTransferCancelRequest](docs/BankTransferCancelRequest.md)

 - [BankTransferCancelResponse](docs/BankTransferCancelResponse.md)

 - [BankTransferCreateRequest](docs/BankTransferCreateRequest.md)

 - [BankTransferCreateResponse](docs/BankTransferCreateResponse.md)

 - [BankTransferDirection](docs/BankTransferDirection.md)

 - [BankTransferEvent](docs/BankTransferEvent.md)

 - [BankTransferEventListRequest](docs/BankTransferEventListRequest.md)

 - [BankTransferEventListResponse](docs/BankTransferEventListResponse.md)

 - [BankTransferEventSyncRequest](docs/BankTransferEventSyncRequest.md)

 - [BankTransferEventSyncResponse](docs/BankTransferEventSyncResponse.md)

 - [BankTransferEventType](docs/BankTransferEventType.md)

 - [BankTransferFailure](docs/BankTransferFailure.md)

 - [BankTransferGetRequest](docs/BankTransferGetRequest.md)

 - [BankTransferGetResponse](docs/BankTransferGetResponse.md)

 - [BankTransferListRequest](docs/BankTransferListRequest.md)

 - [BankTransferListResponse](docs/BankTransferListResponse.md)

 - [BankTransferMigrateAccountRequest](docs/BankTransferMigrateAccountRequest.md)

 - [BankTransferMigrateAccountResponse](docs/BankTransferMigrateAccountResponse.md)

 - [BankTransferNetwork](docs/BankTransferNetwork.md)

 - [BankTransferStatus](docs/BankTransferStatus.md)

 - [BankTransferSweep](docs/BankTransferSweep.md)

 - [BankTransferSweepGetRequest](docs/BankTransferSweepGetRequest.md)

 - [BankTransferSweepGetResponse](docs/BankTransferSweepGetResponse.md)

 - [BankTransferSweepListRequest](docs/BankTransferSweepListRequest.md)

 - [BankTransferSweepListResponse](docs/BankTransferSweepListResponse.md)

 - [BankTransferType](docs/BankTransferType.md)

 - [BankTransferUser](docs/BankTransferUser.md)

 - [BankTransfersEventsUpdateWebhook](docs/BankTransfersEventsUpdateWebhook.md)

 - [CategoriesGetResponse](docs/CategoriesGetResponse.md)

 - [Category](docs/Category.md)

 - [Cause](docs/Cause.md)

 - [ConnectedApplication](docs/ConnectedApplication.md)

 - [CountryCode](docs/CountryCode.md)

 - [CreditAccountSubtype](docs/CreditAccountSubtype.md)

 - [CreditCardLiability](docs/CreditCardLiability.md)

 - [CreditFilter](docs/CreditFilter.md)

 - [CustomerInitiatedReturnRisk](docs/CustomerInitiatedReturnRisk.md)

 - [Deductions](docs/Deductions.md)

 - [DeductionsBreakdown](docs/DeductionsBreakdown.md)

 - [DeductionsTotal](docs/DeductionsTotal.md)

 - [DefaultUpdateWebhook](docs/DefaultUpdateWebhook.md)

 - [DepositSwitchAddressData](docs/DepositSwitchAddressData.md)

 - [DepositSwitchAltCreateRequest](docs/DepositSwitchAltCreateRequest.md)

 - [DepositSwitchAltCreateResponse](docs/DepositSwitchAltCreateResponse.md)

 - [DepositSwitchCreateRequest](docs/DepositSwitchCreateRequest.md)

 - [DepositSwitchCreateRequestOptions](docs/DepositSwitchCreateRequestOptions.md)

 - [DepositSwitchCreateResponse](docs/DepositSwitchCreateResponse.md)

 - [DepositSwitchGetRequest](docs/DepositSwitchGetRequest.md)

 - [DepositSwitchGetResponse](docs/DepositSwitchGetResponse.md)

 - [DepositSwitchStateUpdateWebhook](docs/DepositSwitchStateUpdateWebhook.md)

 - [DepositSwitchTargetAccount](docs/DepositSwitchTargetAccount.md)

 - [DepositSwitchTargetUser](docs/DepositSwitchTargetUser.md)

 - [DepositSwitchTokenCreateRequest](docs/DepositSwitchTokenCreateRequest.md)

 - [DepositSwitchTokenCreateResponse](docs/DepositSwitchTokenCreateResponse.md)

 - [DepositoryAccountSubtype](docs/DepositoryAccountSubtype.md)

 - [DepositoryFilter](docs/DepositoryFilter.md)

 - [DistributionBreakdown](docs/DistributionBreakdown.md)

 - [DocType](docs/DocType.md)

 - [DocumentMetadata](docs/DocumentMetadata.md)

 - [Earnings](docs/Earnings.md)

 - [EarningsBreakdown](docs/EarningsBreakdown.md)

 - [EarningsBreakdownCanonicalDescription](docs/EarningsBreakdownCanonicalDescription.md)

 - [EarningsTotal](docs/EarningsTotal.md)

 - [Email](docs/Email.md)

 - [Employee](docs/Employee.md)

 - [EmployeeIncomeSummaryFieldString](docs/EmployeeIncomeSummaryFieldString.md)

 - [Employer](docs/Employer.md)

 - [EmployerIncomeSummaryFieldString](docs/EmployerIncomeSummaryFieldString.md)

 - [EmployerVerification](docs/EmployerVerification.md)

 - [EmployersSearchRequest](docs/EmployersSearchRequest.md)

 - [EmployersSearchResponse](docs/EmployersSearchResponse.md)

 - [EmploymentDetails](docs/EmploymentDetails.md)

 - [EmploymentVerification](docs/EmploymentVerification.md)

 - [EmploymentVerificationGetRequest](docs/EmploymentVerificationGetRequest.md)

 - [EmploymentVerificationGetResponse](docs/EmploymentVerificationGetResponse.md)

 - [EmploymentVerificationStatus](docs/EmploymentVerificationStatus.md)

 - [Error](docs/Error.md)

 - [ExternalPaymentOptions](docs/ExternalPaymentOptions.md)

 - [ExternalPaymentRefundDetails](docs/ExternalPaymentRefundDetails.md)

 - [ExternalPaymentScheduleBase](docs/ExternalPaymentScheduleBase.md)

 - [ExternalPaymentScheduleGet](docs/ExternalPaymentScheduleGet.md)

 - [ExternalPaymentScheduleRequest](docs/ExternalPaymentScheduleRequest.md)

 - [HealthIncident](docs/HealthIncident.md)

 - [HistoricalBalance](docs/HistoricalBalance.md)

 - [HistoricalUpdateWebhook](docs/HistoricalUpdateWebhook.md)

 - [Holding](docs/Holding.md)

 - [HoldingsDefaultUpdateWebhook](docs/HoldingsDefaultUpdateWebhook.md)

 - [HoldingsOverride](docs/HoldingsOverride.md)

 - [IdentityGetRequest](docs/IdentityGetRequest.md)

 - [IdentityGetRequestOptions](docs/IdentityGetRequestOptions.md)

 - [IdentityGetResponse](docs/IdentityGetResponse.md)

 - [IncidentUpdate](docs/IncidentUpdate.md)

 - [IncomeBreakdown](docs/IncomeBreakdown.md)

 - [IncomeBreakdownType](docs/IncomeBreakdownType.md)

 - [IncomeOverride](docs/IncomeOverride.md)

 - [IncomeSummary](docs/IncomeSummary.md)

 - [IncomeSummaryFieldNumber](docs/IncomeSummaryFieldNumber.md)

 - [IncomeSummaryFieldString](docs/IncomeSummaryFieldString.md)

 - [IncomeVerificationCreateRequest](docs/IncomeVerificationCreateRequest.md)

 - [IncomeVerificationCreateRequestOptions](docs/IncomeVerificationCreateRequestOptions.md)

 - [IncomeVerificationCreateResponse](docs/IncomeVerificationCreateResponse.md)

 - [IncomeVerificationDocumentsDownloadRequest](docs/IncomeVerificationDocumentsDownloadRequest.md)

 - [IncomeVerificationPaystubGetRequest](docs/IncomeVerificationPaystubGetRequest.md)

 - [IncomeVerificationPaystubGetResponse](docs/IncomeVerificationPaystubGetResponse.md)

 - [IncomeVerificationPaystubsGetRequest](docs/IncomeVerificationPaystubsGetRequest.md)

 - [IncomeVerificationPaystubsGetResponse](docs/IncomeVerificationPaystubsGetResponse.md)

 - [IncomeVerificationPrecheckConfidence](docs/IncomeVerificationPrecheckConfidence.md)

 - [IncomeVerificationPrecheckEmployer](docs/IncomeVerificationPrecheckEmployer.md)

 - [IncomeVerificationPrecheckEmployerAddress](docs/IncomeVerificationPrecheckEmployerAddress.md)

 - [IncomeVerificationPrecheckEmployerAddressData](docs/IncomeVerificationPrecheckEmployerAddressData.md)

 - [IncomeVerificationPrecheckMilitaryInfo](docs/IncomeVerificationPrecheckMilitaryInfo.md)

 - [IncomeVerificationPrecheckRequest](docs/IncomeVerificationPrecheckRequest.md)

 - [IncomeVerificationPrecheckResponse](docs/IncomeVerificationPrecheckResponse.md)

 - [IncomeVerificationPrecheckUser](docs/IncomeVerificationPrecheckUser.md)

 - [IncomeVerificationRefreshRequest](docs/IncomeVerificationRefreshRequest.md)

 - [IncomeVerificationRefreshResponse](docs/IncomeVerificationRefreshResponse.md)

 - [IncomeVerificationStatusWebhook](docs/IncomeVerificationStatusWebhook.md)

 - [IncomeVerificationSummaryGetRequest](docs/IncomeVerificationSummaryGetRequest.md)

 - [IncomeVerificationSummaryGetResponse](docs/IncomeVerificationSummaryGetResponse.md)

 - [IncomeVerificationTaxformsGetRequest](docs/IncomeVerificationTaxformsGetRequest.md)

 - [IncomeVerificationTaxformsGetResponse](docs/IncomeVerificationTaxformsGetResponse.md)

 - [IncomeVerificationWebhookStatus](docs/IncomeVerificationWebhookStatus.md)

 - [InflowModel](docs/InflowModel.md)

 - [InitialUpdateWebhook](docs/InitialUpdateWebhook.md)

 - [Institution](docs/Institution.md)

 - [InstitutionStatus](docs/InstitutionStatus.md)

 - [InstitutionsGetByIdRequest](docs/InstitutionsGetByIdRequest.md)

 - [InstitutionsGetByIdRequestOptions](docs/InstitutionsGetByIdRequestOptions.md)

 - [InstitutionsGetByIdResponse](docs/InstitutionsGetByIdResponse.md)

 - [InstitutionsGetRequest](docs/InstitutionsGetRequest.md)

 - [InstitutionsGetRequestOptions](docs/InstitutionsGetRequestOptions.md)

 - [InstitutionsGetResponse](docs/InstitutionsGetResponse.md)

 - [InstitutionsSearchAccountFilter](docs/InstitutionsSearchAccountFilter.md)

 - [InstitutionsSearchPaymentInitiationOptions](docs/InstitutionsSearchPaymentInitiationOptions.md)

 - [InstitutionsSearchRequest](docs/InstitutionsSearchRequest.md)

 - [InstitutionsSearchRequestOptions](docs/InstitutionsSearchRequestOptions.md)

 - [InstitutionsSearchResponse](docs/InstitutionsSearchResponse.md)

 - [InvestmentAccountSubtype](docs/InvestmentAccountSubtype.md)

 - [InvestmentFilter](docs/InvestmentFilter.md)

 - [InvestmentHoldingsGetRequestOptions](docs/InvestmentHoldingsGetRequestOptions.md)

 - [InvestmentTransaction](docs/InvestmentTransaction.md)

 - [InvestmentsDefaultUpdateWebhook](docs/InvestmentsDefaultUpdateWebhook.md)

 - [InvestmentsHoldingsGetRequest](docs/InvestmentsHoldingsGetRequest.md)

 - [InvestmentsHoldingsGetResponse](docs/InvestmentsHoldingsGetResponse.md)

 - [InvestmentsTransactionsGetRequest](docs/InvestmentsTransactionsGetRequest.md)

 - [InvestmentsTransactionsGetRequestOptions](docs/InvestmentsTransactionsGetRequestOptions.md)

 - [InvestmentsTransactionsGetResponse](docs/InvestmentsTransactionsGetResponse.md)

 - [InvestmentsTransactionsOverride](docs/InvestmentsTransactionsOverride.md)

 - [Item](docs/Item.md)

 - [ItemAccessTokenInvalidateRequest](docs/ItemAccessTokenInvalidateRequest.md)

 - [ItemAccessTokenInvalidateResponse](docs/ItemAccessTokenInvalidateResponse.md)

 - [ItemApplicationListRequest](docs/ItemApplicationListRequest.md)

 - [ItemApplicationListResponse](docs/ItemApplicationListResponse.md)

 - [ItemApplicationListUserAuth](docs/ItemApplicationListUserAuth.md)

 - [ItemApplicationScopesUpdateRequest](docs/ItemApplicationScopesUpdateRequest.md)

 - [ItemApplicationScopesUpdateResponse](docs/ItemApplicationScopesUpdateResponse.md)

 - [ItemErrorWebhook](docs/ItemErrorWebhook.md)

 - [ItemGetRequest](docs/ItemGetRequest.md)

 - [ItemGetResponse](docs/ItemGetResponse.md)

 - [ItemImportRequest](docs/ItemImportRequest.md)

 - [ItemImportRequestOptions](docs/ItemImportRequestOptions.md)

 - [ItemImportRequestUserAuth](docs/ItemImportRequestUserAuth.md)

 - [ItemImportResponse](docs/ItemImportResponse.md)

 - [ItemProductReadyWebhook](docs/ItemProductReadyWebhook.md)

 - [ItemPublicTokenCreateRequest](docs/ItemPublicTokenCreateRequest.md)

 - [ItemPublicTokenCreateResponse](docs/ItemPublicTokenCreateResponse.md)

 - [ItemPublicTokenExchangeRequest](docs/ItemPublicTokenExchangeRequest.md)

 - [ItemPublicTokenExchangeResponse](docs/ItemPublicTokenExchangeResponse.md)

 - [ItemRemoveRequest](docs/ItemRemoveRequest.md)

 - [ItemRemoveResponse](docs/ItemRemoveResponse.md)

 - [ItemStatus](docs/ItemStatus.md)

 - [ItemStatusInvestments](docs/ItemStatusInvestments.md)

 - [ItemStatusLastWebhook](docs/ItemStatusLastWebhook.md)

 - [ItemStatusNullable](docs/ItemStatusNullable.md)

 - [ItemStatusTransactions](docs/ItemStatusTransactions.md)

 - [ItemWebhookUpdateRequest](docs/ItemWebhookUpdateRequest.md)

 - [ItemWebhookUpdateResponse](docs/ItemWebhookUpdateResponse.md)

 - [JWKPublicKey](docs/JWKPublicKey.md)

 - [JWTHeader](docs/JWTHeader.md)

 - [LiabilitiesDefaultUpdateWebhook](docs/LiabilitiesDefaultUpdateWebhook.md)

 - [LiabilitiesGetRequest](docs/LiabilitiesGetRequest.md)

 - [LiabilitiesGetRequestOptions](docs/LiabilitiesGetRequestOptions.md)

 - [LiabilitiesGetResponse](docs/LiabilitiesGetResponse.md)

 - [LiabilitiesObject](docs/LiabilitiesObject.md)

 - [LiabilityOverride](docs/LiabilityOverride.md)

 - [LinkTokenAccountFilters](docs/LinkTokenAccountFilters.md)

 - [LinkTokenCreateCreditFilter](docs/LinkTokenCreateCreditFilter.md)

 - [LinkTokenCreateDepositoryFilter](docs/LinkTokenCreateDepositoryFilter.md)

 - [LinkTokenCreateInvestmentFilter](docs/LinkTokenCreateInvestmentFilter.md)

 - [LinkTokenCreateLoanFilter](docs/LinkTokenCreateLoanFilter.md)

 - [LinkTokenCreateRequest](docs/LinkTokenCreateRequest.md)

 - [LinkTokenCreateRequestAccountSubtypes](docs/LinkTokenCreateRequestAccountSubtypes.md)

 - [LinkTokenCreateRequestAuth](docs/LinkTokenCreateRequestAuth.md)

 - [LinkTokenCreateRequestDepositSwitch](docs/LinkTokenCreateRequestDepositSwitch.md)

 - [LinkTokenCreateRequestIncomeVerification](docs/LinkTokenCreateRequestIncomeVerification.md)

 - [LinkTokenCreateRequestPaymentInitiation](docs/LinkTokenCreateRequestPaymentInitiation.md)

 - [LinkTokenCreateRequestTransfer](docs/LinkTokenCreateRequestTransfer.md)

 - [LinkTokenCreateRequestUpdate](docs/LinkTokenCreateRequestUpdate.md)

 - [LinkTokenCreateRequestUser](docs/LinkTokenCreateRequestUser.md)

 - [LinkTokenCreateResponse](docs/LinkTokenCreateResponse.md)

 - [LinkTokenEUConfig](docs/LinkTokenEUConfig.md)

 - [LinkTokenGetMetadataResponse](docs/LinkTokenGetMetadataResponse.md)

 - [LinkTokenGetRequest](docs/LinkTokenGetRequest.md)

 - [LinkTokenGetResponse](docs/LinkTokenGetResponse.md)

 - [LoanAccountSubtype](docs/LoanAccountSubtype.md)

 - [LoanFilter](docs/LoanFilter.md)

 - [Location](docs/Location.md)

 - [MFA](docs/MFA.md)

 - [Meta](docs/Meta.md)

 - [MortgageInterestRate](docs/MortgageInterestRate.md)

 - [MortgageLiability](docs/MortgageLiability.md)

 - [MortgagePropertyAddress](docs/MortgagePropertyAddress.md)

 - [NetPay](docs/NetPay.md)

 - [NewAccountsAvailableWebhook](docs/NewAccountsAvailableWebhook.md)

 - [Numbers](docs/Numbers.md)

 - [NumbersACH](docs/NumbersACH.md)

 - [NumbersACHNullable](docs/NumbersACHNullable.md)

 - [NumbersBACS](docs/NumbersBACS.md)

 - [NumbersBACSNullable](docs/NumbersBACSNullable.md)

 - [NumbersEFT](docs/NumbersEFT.md)

 - [NumbersEFTNullable](docs/NumbersEFTNullable.md)

 - [NumbersInternational](docs/NumbersInternational.md)

 - [NumbersInternationalNullable](docs/NumbersInternationalNullable.md)

 - [OverrideAccountType](docs/OverrideAccountType.md)

 - [OverrideAccounts](docs/OverrideAccounts.md)

 - [Owner](docs/Owner.md)

 - [OwnerOverride](docs/OwnerOverride.md)

 - [PSLFStatus](docs/PSLFStatus.md)

 - [Pay](docs/Pay.md)

 - [PayFrequency](docs/PayFrequency.md)

 - [PayFrequencyValue](docs/PayFrequencyValue.md)

 - [PayPeriodDetails](docs/PayPeriodDetails.md)

 - [PaymentAmount](docs/PaymentAmount.md)

 - [PaymentInitiationAddress](docs/PaymentInitiationAddress.md)

 - [PaymentInitiationMetadata](docs/PaymentInitiationMetadata.md)

 - [PaymentInitiationOptionalRestrictionBacs](docs/PaymentInitiationOptionalRestrictionBacs.md)

 - [PaymentInitiationPayment](docs/PaymentInitiationPayment.md)

 - [PaymentInitiationPaymentCreateRequest](docs/PaymentInitiationPaymentCreateRequest.md)

 - [PaymentInitiationPaymentCreateResponse](docs/PaymentInitiationPaymentCreateResponse.md)

 - [PaymentInitiationPaymentGetRequest](docs/PaymentInitiationPaymentGetRequest.md)

 - [PaymentInitiationPaymentGetResponse](docs/PaymentInitiationPaymentGetResponse.md)

 - [PaymentInitiationPaymentListRequest](docs/PaymentInitiationPaymentListRequest.md)

 - [PaymentInitiationPaymentListResponse](docs/PaymentInitiationPaymentListResponse.md)

 - [PaymentInitiationPaymentReverseRequest](docs/PaymentInitiationPaymentReverseRequest.md)

 - [PaymentInitiationPaymentReverseResponse](docs/PaymentInitiationPaymentReverseResponse.md)

 - [PaymentInitiationPaymentStatus](docs/PaymentInitiationPaymentStatus.md)

 - [PaymentInitiationPaymentTokenCreateRequest](docs/PaymentInitiationPaymentTokenCreateRequest.md)

 - [PaymentInitiationPaymentTokenCreateResponse](docs/PaymentInitiationPaymentTokenCreateResponse.md)

 - [PaymentInitiationRecipient](docs/PaymentInitiationRecipient.md)

 - [PaymentInitiationRecipientCreateRequest](docs/PaymentInitiationRecipientCreateRequest.md)

 - [PaymentInitiationRecipientCreateResponse](docs/PaymentInitiationRecipientCreateResponse.md)

 - [PaymentInitiationRecipientGetRequest](docs/PaymentInitiationRecipientGetRequest.md)

 - [PaymentInitiationRecipientGetResponse](docs/PaymentInitiationRecipientGetResponse.md)

 - [PaymentInitiationRecipientGetResponseAllOf](docs/PaymentInitiationRecipientGetResponseAllOf.md)

 - [PaymentInitiationRecipientListRequest](docs/PaymentInitiationRecipientListRequest.md)

 - [PaymentInitiationRecipientListResponse](docs/PaymentInitiationRecipientListResponse.md)

 - [PaymentInitiationRefund](docs/PaymentInitiationRefund.md)

 - [PaymentInitiationStandingOrderMetadata](docs/PaymentInitiationStandingOrderMetadata.md)

 - [PaymentMeta](docs/PaymentMeta.md)

 - [PaymentScheduleInterval](docs/PaymentScheduleInterval.md)

 - [PaymentScheme](docs/PaymentScheme.md)

 - [PaymentStatusUpdateWebhook](docs/PaymentStatusUpdateWebhook.md)

 - [Paystub](docs/Paystub.md)

 - [PaystubAddress](docs/PaystubAddress.md)

 - [PaystubDeduction](docs/PaystubDeduction.md)

 - [PaystubDetails](docs/PaystubDetails.md)

 - [PaystubEmployer](docs/PaystubEmployer.md)

 - [PaystubOverride](docs/PaystubOverride.md)

 - [PaystubOverrideEmployee](docs/PaystubOverrideEmployee.md)

 - [PaystubOverrideEmployeeAddress](docs/PaystubOverrideEmployeeAddress.md)

 - [PaystubOverrideEmployer](docs/PaystubOverrideEmployer.md)

 - [PaystubPayFrequency](docs/PaystubPayFrequency.md)

 - [PaystubVerification](docs/PaystubVerification.md)

 - [PaystubVerificationStatus](docs/PaystubVerificationStatus.md)

 - [PaystubYTDDetails](docs/PaystubYTDDetails.md)

 - [PendingExpirationWebhook](docs/PendingExpirationWebhook.md)

 - [PersonalFinanceCategory](docs/PersonalFinanceCategory.md)

 - [PhoneNumber](docs/PhoneNumber.md)

 - [PlaidError](docs/PlaidError.md)

 - [PlatformIds](docs/PlatformIds.md)

 - [ProcessorApexProcessorTokenCreateRequest](docs/ProcessorApexProcessorTokenCreateRequest.md)

 - [ProcessorAuthGetRequest](docs/ProcessorAuthGetRequest.md)

 - [ProcessorAuthGetResponse](docs/ProcessorAuthGetResponse.md)

 - [ProcessorBalanceGetRequest](docs/ProcessorBalanceGetRequest.md)

 - [ProcessorBalanceGetRequestOptions](docs/ProcessorBalanceGetRequestOptions.md)

 - [ProcessorBalanceGetResponse](docs/ProcessorBalanceGetResponse.md)

 - [ProcessorBankTransferCreateRequest](docs/ProcessorBankTransferCreateRequest.md)

 - [ProcessorBankTransferCreateResponse](docs/ProcessorBankTransferCreateResponse.md)

 - [ProcessorIdentityGetRequest](docs/ProcessorIdentityGetRequest.md)

 - [ProcessorIdentityGetResponse](docs/ProcessorIdentityGetResponse.md)

 - [ProcessorNumber](docs/ProcessorNumber.md)

 - [ProcessorStripeBankAccountTokenCreateRequest](docs/ProcessorStripeBankAccountTokenCreateRequest.md)

 - [ProcessorStripeBankAccountTokenCreateResponse](docs/ProcessorStripeBankAccountTokenCreateResponse.md)

 - [ProcessorTokenCreateRequest](docs/ProcessorTokenCreateRequest.md)

 - [ProcessorTokenCreateResponse](docs/ProcessorTokenCreateResponse.md)

 - [ProductAccess](docs/ProductAccess.md)

 - [ProductStatus](docs/ProductStatus.md)

 - [ProductStatusBreakdown](docs/ProductStatusBreakdown.md)

 - [Products](docs/Products.md)

 - [ProjectedIncomeSummaryFieldNumber](docs/ProjectedIncomeSummaryFieldNumber.md)

 - [RecaptchaRequiredError](docs/RecaptchaRequiredError.md)

 - [RecipientBACS](docs/RecipientBACS.md)

 - [RecipientBACSNullable](docs/RecipientBACSNullable.md)

 - [RecurringTransactionFrequency](docs/RecurringTransactionFrequency.md)

 - [RemovedTransaction](docs/RemovedTransaction.md)

 - [RequestedScopes](docs/RequestedScopes.md)

 - [SandboxBankTransferFireWebhookRequest](docs/SandboxBankTransferFireWebhookRequest.md)

 - [SandboxBankTransferFireWebhookResponse](docs/SandboxBankTransferFireWebhookResponse.md)

 - [SandboxBankTransferSimulateRequest](docs/SandboxBankTransferSimulateRequest.md)

 - [SandboxBankTransferSimulateResponse](docs/SandboxBankTransferSimulateResponse.md)

 - [SandboxIncomeFireWebhookRequest](docs/SandboxIncomeFireWebhookRequest.md)

 - [SandboxIncomeFireWebhookResponse](docs/SandboxIncomeFireWebhookResponse.md)

 - [SandboxItemFireWebhookRequest](docs/SandboxItemFireWebhookRequest.md)

 - [SandboxItemFireWebhookResponse](docs/SandboxItemFireWebhookResponse.md)

 - [SandboxItemResetLoginRequest](docs/SandboxItemResetLoginRequest.md)

 - [SandboxItemResetLoginResponse](docs/SandboxItemResetLoginResponse.md)

 - [SandboxItemSetVerificationStatusRequest](docs/SandboxItemSetVerificationStatusRequest.md)

 - [SandboxItemSetVerificationStatusResponse](docs/SandboxItemSetVerificationStatusResponse.md)

 - [SandboxOauthSelectAccountsRequest](docs/SandboxOauthSelectAccountsRequest.md)

 - [SandboxProcessorTokenCreateRequest](docs/SandboxProcessorTokenCreateRequest.md)

 - [SandboxProcessorTokenCreateRequestOptions](docs/SandboxProcessorTokenCreateRequestOptions.md)

 - [SandboxProcessorTokenCreateResponse](docs/SandboxProcessorTokenCreateResponse.md)

 - [SandboxPublicTokenCreateRequest](docs/SandboxPublicTokenCreateRequest.md)

 - [SandboxPublicTokenCreateRequestOptions](docs/SandboxPublicTokenCreateRequestOptions.md)

 - [SandboxPublicTokenCreateRequestOptionsTransactions](docs/SandboxPublicTokenCreateRequestOptionsTransactions.md)

 - [SandboxPublicTokenCreateResponse](docs/SandboxPublicTokenCreateResponse.md)

 - [SandboxTransferRepaymentSimulateRequest](docs/SandboxTransferRepaymentSimulateRequest.md)

 - [SandboxTransferRepaymentSimulateResponse](docs/SandboxTransferRepaymentSimulateResponse.md)

 - [SandboxTransferSimulateRequest](docs/SandboxTransferSimulateRequest.md)

 - [SandboxTransferSimulateResponse](docs/SandboxTransferSimulateResponse.md)

 - [SandboxTransferSweepSimulateRequest](docs/SandboxTransferSweepSimulateRequest.md)

 - [SandboxTransferSweepSimulateResponse](docs/SandboxTransferSweepSimulateResponse.md)

 - [Scopes](docs/Scopes.md)

 - [ScopesContext](docs/ScopesContext.md)

 - [ScopesNullable](docs/ScopesNullable.md)

 - [Security](docs/Security.md)

 - [SecurityOverride](docs/SecurityOverride.md)

 - [SenderBACSNullable](docs/SenderBACSNullable.md)

 - [ServicerAddressData](docs/ServicerAddressData.md)

 - [SignalAddressData](docs/SignalAddressData.md)

 - [SignalDecisionReportRequest](docs/SignalDecisionReportRequest.md)

 - [SignalDecisionReportResponse](docs/SignalDecisionReportResponse.md)

 - [SignalDevice](docs/SignalDevice.md)

 - [SignalEvaluateCoreAttributes](docs/SignalEvaluateCoreAttributes.md)

 - [SignalEvaluateRequest](docs/SignalEvaluateRequest.md)

 - [SignalEvaluateResponse](docs/SignalEvaluateResponse.md)

 - [SignalPersonName](docs/SignalPersonName.md)

 - [SignalReturnReportRequest](docs/SignalReturnReportRequest.md)

 - [SignalReturnReportResponse](docs/SignalReturnReportResponse.md)

 - [SignalScores](docs/SignalScores.md)

 - [SignalUser](docs/SignalUser.md)

 - [SimulatedTransferSweep](docs/SimulatedTransferSweep.md)

 - [StandaloneAccountType](docs/StandaloneAccountType.md)

 - [StandaloneCurrencyCodeList](docs/StandaloneCurrencyCodeList.md)

 - [StandaloneInvestmentTransactionType](docs/StandaloneInvestmentTransactionType.md)

 - [StudentLoan](docs/StudentLoan.md)

 - [StudentLoanRepaymentModel](docs/StudentLoanRepaymentModel.md)

 - [StudentLoanStatus](docs/StudentLoanStatus.md)

 - [StudentRepaymentPlan](docs/StudentRepaymentPlan.md)

 - [Taxform](docs/Taxform.md)

 - [TaxpayerID](docs/TaxpayerID.md)

 - [Total](docs/Total.md)

 - [TotalCanonicalDescription](docs/TotalCanonicalDescription.md)

 - [Transaction](docs/Transaction.md)

 - [TransactionAllOf](docs/TransactionAllOf.md)

 - [TransactionBase](docs/TransactionBase.md)

 - [TransactionCode](docs/TransactionCode.md)

 - [TransactionData](docs/TransactionData.md)

 - [TransactionOverride](docs/TransactionOverride.md)

 - [TransactionStream](docs/TransactionStream.md)

 - [TransactionStreamAmount](docs/TransactionStreamAmount.md)

 - [TransactionsGetRequest](docs/TransactionsGetRequest.md)

 - [TransactionsGetRequestOptions](docs/TransactionsGetRequestOptions.md)

 - [TransactionsGetResponse](docs/TransactionsGetResponse.md)

 - [TransactionsRecurringGetRequest](docs/TransactionsRecurringGetRequest.md)

 - [TransactionsRecurringGetResponse](docs/TransactionsRecurringGetResponse.md)

 - [TransactionsRefreshRequest](docs/TransactionsRefreshRequest.md)

 - [TransactionsRefreshResponse](docs/TransactionsRefreshResponse.md)

 - [TransactionsRemovedWebhook](docs/TransactionsRemovedWebhook.md)

 - [TransactionsSyncRequest](docs/TransactionsSyncRequest.md)

 - [TransactionsSyncResponse](docs/TransactionsSyncResponse.md)

 - [Transfer](docs/Transfer.md)

 - [TransferAuthorization](docs/TransferAuthorization.md)

 - [TransferAuthorizationCreateRequest](docs/TransferAuthorizationCreateRequest.md)

 - [TransferAuthorizationCreateResponse](docs/TransferAuthorizationCreateResponse.md)

 - [TransferAuthorizationDecisionRationale](docs/TransferAuthorizationDecisionRationale.md)

 - [TransferAuthorizationDevice](docs/TransferAuthorizationDevice.md)

 - [TransferAuthorizationGuaranteeDecision](docs/TransferAuthorizationGuaranteeDecision.md)

 - [TransferAuthorizationGuaranteeDecisionRationale](docs/TransferAuthorizationGuaranteeDecisionRationale.md)

 - [TransferAuthorizationProposedTransfer](docs/TransferAuthorizationProposedTransfer.md)

 - [TransferCancelRequest](docs/TransferCancelRequest.md)

 - [TransferCancelResponse](docs/TransferCancelResponse.md)

 - [TransferCreateRequest](docs/TransferCreateRequest.md)

 - [TransferCreateResponse](docs/TransferCreateResponse.md)

 - [TransferEvent](docs/TransferEvent.md)

 - [TransferEventListRequest](docs/TransferEventListRequest.md)

 - [TransferEventListResponse](docs/TransferEventListResponse.md)

 - [TransferEventSyncRequest](docs/TransferEventSyncRequest.md)

 - [TransferEventSyncResponse](docs/TransferEventSyncResponse.md)

 - [TransferEventType](docs/TransferEventType.md)

 - [TransferFailure](docs/TransferFailure.md)

 - [TransferGetRequest](docs/TransferGetRequest.md)

 - [TransferGetResponse](docs/TransferGetResponse.md)

 - [TransferIntentCreate](docs/TransferIntentCreate.md)

 - [TransferIntentCreateMode](docs/TransferIntentCreateMode.md)

 - [TransferIntentCreateRequest](docs/TransferIntentCreateRequest.md)

 - [TransferIntentCreateResponse](docs/TransferIntentCreateResponse.md)

 - [TransferIntentGet](docs/TransferIntentGet.md)

 - [TransferIntentGetFailureReason](docs/TransferIntentGetFailureReason.md)

 - [TransferIntentGetRequest](docs/TransferIntentGetRequest.md)

 - [TransferIntentGetResponse](docs/TransferIntentGetResponse.md)

 - [TransferListRequest](docs/TransferListRequest.md)

 - [TransferListResponse](docs/TransferListResponse.md)

 - [TransferNetwork](docs/TransferNetwork.md)

 - [TransferRepayment](docs/TransferRepayment.md)

 - [TransferRepaymentListRequest](docs/TransferRepaymentListRequest.md)

 - [TransferRepaymentListResponse](docs/TransferRepaymentListResponse.md)

 - [TransferRepaymentReturn](docs/TransferRepaymentReturn.md)

 - [TransferRepaymentReturnListRequest](docs/TransferRepaymentReturnListRequest.md)

 - [TransferRepaymentReturnListResponse](docs/TransferRepaymentReturnListResponse.md)

 - [TransferStatus](docs/TransferStatus.md)

 - [TransferSweep](docs/TransferSweep.md)

 - [TransferSweepGetRequest](docs/TransferSweepGetRequest.md)

 - [TransferSweepGetResponse](docs/TransferSweepGetResponse.md)

 - [TransferSweepListRequest](docs/TransferSweepListRequest.md)

 - [TransferSweepListResponse](docs/TransferSweepListResponse.md)

 - [TransferSweepStatus](docs/TransferSweepStatus.md)

 - [TransferType](docs/TransferType.md)

 - [TransferUserAddressInRequest](docs/TransferUserAddressInRequest.md)

 - [TransferUserAddressInResponse](docs/TransferUserAddressInResponse.md)

 - [TransferUserInRequest](docs/TransferUserInRequest.md)

 - [TransferUserInResponse](docs/TransferUserInResponse.md)

 - [UserCustomPassword](docs/UserCustomPassword.md)

 - [UserPermissionRevokedWebhook](docs/UserPermissionRevokedWebhook.md)

 - [VerificationAttribute](docs/VerificationAttribute.md)

 - [VerificationExpiredWebhook](docs/VerificationExpiredWebhook.md)

 - [VerificationRefreshStatus](docs/VerificationRefreshStatus.md)

 - [VerificationStatus](docs/VerificationStatus.md)

 - [W2](docs/W2.md)

 - [W2Box12](docs/W2Box12.md)

 - [W2StateAndLocalWages](docs/W2StateAndLocalWages.md)

 - [WalletBalance](docs/WalletBalance.md)

 - [WalletGetRequest](docs/WalletGetRequest.md)

 - [WalletGetResponse](docs/WalletGetResponse.md)

 - [WalletTransaction](docs/WalletTransaction.md)

 - [WalletTransactionAmount](docs/WalletTransactionAmount.md)

 - [WalletTransactionCounterparty](docs/WalletTransactionCounterparty.md)

 - [WalletTransactionCounterpartyBACS](docs/WalletTransactionCounterpartyBACS.md)

 - [WalletTransactionCounterpartyNumbers](docs/WalletTransactionCounterpartyNumbers.md)

 - [WalletTransactionExecuteRequest](docs/WalletTransactionExecuteRequest.md)

 - [WalletTransactionExecuteResponse](docs/WalletTransactionExecuteResponse.md)

 - [WalletTransactionStatus](docs/WalletTransactionStatus.md)

 - [WalletTransactionsListRequest](docs/WalletTransactionsListRequest.md)

 - [WalletTransactionsListResponse](docs/WalletTransactionsListResponse.md)

 - [Warning](docs/Warning.md)

 - [WebhookUpdateAcknowledgedWebhook](docs/WebhookUpdateAcknowledgedWebhook.md)

 - [WebhookVerificationKeyGetRequest](docs/WebhookVerificationKeyGetRequest.md)

 - [WebhookVerificationKeyGetResponse](docs/WebhookVerificationKeyGetResponse.md)

 - [YTDGrossIncomeSummaryFieldNumber](docs/YTDGrossIncomeSummaryFieldNumber.md)

 - [YTDNetIncomeSummaryFieldNumber](docs/YTDNetIncomeSummaryFieldNumber.md)

## Documentation For Authorization

### clientId

- **Type**: API key

- **API key parameter name**: PLAID-CLIENT-ID

- **Location**: HTTP header

Note, each API key must be added to a map of `map[string]APIKey` where the key is: PLAID-CLIENT-ID and passed in as the auth context for each request.

### plaidVersion

- **Type**: API key

- **API key parameter name**: Plaid-Version

- **Location**: HTTP header

Note, each API key must be added to a map of `map[string]APIKey` where the key is: Plaid-Version and passed in as the auth context for each request.

### secret

- **Type**: API key

- **API key parameter name**: PLAID-SECRET

- **Location**: HTTP header

Note, each API key must be added to a map of `map[string]APIKey` where the key is: PLAID-SECRET and passed in as the auth context for each request.

## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains

a number of utility functions to easily obtain pointers to values of basic types.

Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`

* `PtrInt`

* `PtrInt32`

* `PtrInt64`

* `PtrFloat`

* `PtrFloat32`

* `PtrFloat64`

* `PtrString`

* `PtrTime`

## Author
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/libninjacom/openapi-generator-plaid-go

Awesome Lists containing this project

README
