Rust API client for plaid

A collection of Plaid API endpoints for the sandbox environment. Each endpoint request comes with an example request & response. It also contains 'use cases' for each product.

Before you begin, please set your client_id and secret_key variables in the Sandbox environment. You can find them in your Plaid dashboard. Set the variables by clicking on the 'eye' icon in the top-right corner of the screen.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 1.0
• Package version: 1.3.1
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder and add the following to Cargo.toml under [dependencies]:

    openapi = { path = "./generated" }

Documentation for API Endpoints

All URIs are relative to https://sandbox.plaid.com

Class	Method	HTTP request	Description
AssetsApi	create_asset_report	post /asset_report/create	Create Asset Report
AssetsApi	create_audit_copy	post /asset_report/audit_copy/create	Create Audit Copy
AssetsApi	refresh_asset_report	post /asset_report/refresh	Refresh Asset Report
AssetsApi	remove_asset_report	post /asset_report/remove	Remove Asset Report
AssetsApi	remove_audit_copy	post /asset_report/audit_copy/remove	Remove Audit Copy
AssetsApi	retrievean_asset_report_json	post /asset_report/get	Retrieve an Asset Report (JSON)
AssetsApi	retrievean_asset_report_pdf	post /asset_report/pdf/get	Retrieve an Asset Report (PDF)
AuthApi	retrieve_auth	post /auth/get	Retrieve Auth
BalanceApi	retrieve_balance	post /accounts/balance/get	Retrieve Balance
CategoriesApi	retrieve_categories	post /categories/get	Retrieve Categories
IdentityApi	retrieve_identity	post /identity/get	Retrieve Identity
IncomeApi	retrieve_income	post /income/get	Retrieve Income
InstitutionsApi	retrieve_insitution_list	post /institutions/get	Retrieve Insitution List
InstitutionsApi	search_institutionby_id	post /institutions/get_by_id	Search Institution by ID
InstitutionsApi	search_institutionby_name	post /institutions/search	Search Institution by Name
InvestmentsApi	retrieve_investments_holdings	post /investments/holdings/get	Retrieve Investments Holdings
InvestmentsApi	retrieve_investments_transactions	post /investments/transactions/get	Retrieve Investments Transactions
ItemCreationApi	create_item_sandbox_only	post /sandbox/public_token/create	Create Item [Sandbox Only]
ItemCreationApi	exchange_token	post /item/public_token/exchange	Exchange Token
ItemManagementApi	automated_deposit_webhook	post /sandbox/item/set_verification_status	Automated Deposit Webhook
ItemManagementApi	create_public_tokenfor_update	post /item/public_token/create	Create Public Token for Update
ItemManagementApi	remove_item	post /item/remove	Remove Item
ItemManagementApi	retrieve_an_items_accounts	post /accounts/get	Retrieve an Item's Accounts
ItemManagementApi	retrieve_item	post /item/get	Retrieve Item
ItemManagementApi	rotate_access_token	post /item/access_token/invalidate	Rotate Access Token
ItemManagementApi	simulate_itemloginrequired_sandbox_only	post /sandbox/item/reset_login	Simulate ITEM_LOGIN_REQUIRED [Sandbox Only]
ItemManagementApi	update_an_items_webhook	post /item/webhook/update	Update an Item's Webhook
LiabilitiesApi	retrieve_liabilities	post /liabilities/get	Retrieve Liabilities
LiabilitiesReportApi	create_liabilities_report	post /liabilities_report/create	Create Liabilities Report
LiabilitiesReportApi	remove_liabilities_report	post /liabilities_report/remove	Remove Liabilities Report
LiabilitiesReportApi	retrieve_liabilities_report	post /liabilities_report/get	Retrieve Liabilities Report
LinkTokensApi	create_link_token	post /link/token/create	Create Link Token
PaymentInitiationUKOnlyApi	create_payment	post /payment_initiation/payment/create	Create Payment
PaymentInitiationUKOnlyApi	create_payment_recipient	post /payment_initiation/recipient/create	Create Payment Recipient
PaymentInitiationUKOnlyApi	create_payment_token	post /payment_initiation/payment/token/create	Create Payment Token
PaymentInitiationUKOnlyApi	get_payment	post /payment_initiation/payment/get	Get Payment
PaymentInitiationUKOnlyApi	get_payment_recipient	post /payment_initiation/recipient/get	Get Payment Recipient
PaymentInitiationUKOnlyApi	list_payment_recipients	post /payment_initiation/recipient/list	List Payment Recipients
PaymentInitiationUKOnlyApi	list_payments	post /payment_initiation/payment/list	List Payments
TransactionsApi	retrieve_transactions	post /transactions/get	Retrieve Transactions
WebhooksApi	fire_webhook_sandbox_only	post /sandbox/item/fire_webhook	Fire Webhook [Sandbox Only]
WebhooksApi	get_webhook_verification_key	post /webhook_verification_key/get	Get Webhook Verification Key

Documentation For Models

• Account
• Account5
• Account6
• Address
• Address1
• Address2
• Address3
• Amount
• Apr
• AutomatedDepositWebhookRequest
• AutomatedDepositWebhookResponse
• Balances
• Balances5
• Balances6
• Category
• CreateAssetReportRequest
• CreateAssetReportResponse
• CreateAuditCopyRequest
• CreateAuditCopyResponse
• CreateItemCustomSandboxOnlyRequest
• CreateItemSandboxOnlyRequest
• CreateItemSandboxOnlyResponse
• CreateLiabilitiesReportRequest
• CreateLiabilitiesReportResponse
• CreateLinkTokenOAuthRequest
• CreateLinkTokenPaymentInitiationRequest
• CreateLinkTokenRequest
• CreateLinkTokenResponse
• CreateLinkTokenUpdateModeRequest
• CreatePaymentRecipientRequest
• CreatePaymentRecipientResponse
• CreatePaymentRequest
• CreatePaymentResponse
• CreatePaymentTokenRequest
• CreatePublicTokenforUpdateRequest
• CreatePublicTokenforUpdateResponse
• Credential
• Credit
• Data
• Data2
• Eft
• Email
• ExchangeTokenRequest
• ExchangeTokenResponse
• FireWebhookSandboxOnlyRequest
• FireWebhookSandboxOnlyResponse
• GetPaymentRecipientRequest
• GetPaymentRecipientResponse
• GetPaymentRequest
• GetPaymentResponse
• GetWebhookVerificationKeyRequest
• GetWebhookVerificationKeyResponse
• GetWebhookVerificationKeyResponseKey
• HistoricalBalance
• Identity
• Income
• IncomeStream
• Institution
• InterestRate
• Item
• Item7
• Item8
• Liability
• ListPaymentRecipientsRequest
• ListPaymentRecipientsResponse
• ListPaymentsRequest
• ListPaymentsResponse
• LoanStatus
• Location
• Mortgage
• Numbers
• Options
• Options1
• Options2
• Owner
• Owner1
• Payment
• PaymentAmount
• PaymentInitiation
• PaymentMeta
• PaymentRecipient
• PaymentStatus
• PhoneNumber
• PropertyAddress
• PslfStatus
• RefreshAssetReportRequest
• RefreshAssetReportResponse
• RemoveAssetReportRequest
• RemoveAssetReportResponse
• RemoveAuditCopyRequest
• RemoveAuditCopyResponse
• RemoveItemRequest
• RemoveItemResponse
• RemoveLiabilitiesReportRequest
• RemoveLiabilitiesReportResponse
• RepaymentPlan
• Report
• Report1
• RetrieveAnItemsAccountsRequest
• RetrieveAnItemsAccountsResponse
• RetrieveAuthEftResponse
• RetrieveAuthRequest
• RetrieveBalanceRequest
• RetrieveBalanceResponse
• RetrieveCategoriesResponse
• RetrieveIdentityRequest
• RetrieveIdentityResponse
• RetrieveIncomeRequest
• RetrieveIncomeResponse
• RetrieveInsitutionListRequest
• RetrieveInsitutionListResponse
• RetrieveInvestmentsHoldingsRequest
• RetrieveInvestmentsHoldingsResponse
• RetrieveInvestmentsTransactionsRequest
• RetrieveItemRequest
• RetrieveItemResponse
• RetrieveLiabilitiesReportRequest
• RetrieveLiabilitiesReportResponse
• RetrieveLiabilitiesRequest
• RetrieveLiabilitiesResponse
• RetrieveTransactionsRequest
• RetrieveTransactionsResponse
• RetrieveanAssetReportJsoNwithInsights
• RetrieveanAssetReportJsonRequest
• RetrieveanAssetReportPdfRequest
• RotateAccessTokenRequest
• RotateAccessTokenResponse
• SearchInstitutionbyIdRequest
• SearchInstitutionbyIdResponse
• SearchInstitutionbyNameRequest
• SearchInstitutionbyNameResponse
• ServicerAddress
• SimulateItemLoginRequiredSandboxOnlyRequest
• SimulateItemLoginRequiredSandboxOnlyResponse
• Student
• Transaction
• Transaction1
• Transaction2
• UpdateAnItemsWebhookRequest
• UpdateAnItemsWebhookResponse
• User
• User4
• User5

To get access to the crate's generated documentation, use:

cargo doc --open

Author