com.plaid.client.request.PlaidApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plaid-java Show documentation
Show all versions of plaid-java Show documentation
Bindings for the Plaid (plaid.com) API.
package com.plaid.client.request;
import com.plaid.client.CollectionFormats.*;
import retrofit2.Call;
import retrofit2.http.*;
import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import okhttp3.MultipartBody;
import com.plaid.client.model.AccountsBalanceGetRequest;
import com.plaid.client.model.AccountsGetRequest;
import com.plaid.client.model.AccountsGetResponse;
import com.plaid.client.model.ApplicationGetRequest;
import com.plaid.client.model.ApplicationGetResponse;
import com.plaid.client.model.AssetReportAuditCopyCreateRequest;
import com.plaid.client.model.AssetReportAuditCopyCreateResponse;
import com.plaid.client.model.AssetReportAuditCopyGetRequest;
import com.plaid.client.model.AssetReportAuditCopyRemoveRequest;
import com.plaid.client.model.AssetReportAuditCopyRemoveResponse;
import com.plaid.client.model.AssetReportCreateRequest;
import com.plaid.client.model.AssetReportCreateResponse;
import com.plaid.client.model.AssetReportFilterRequest;
import com.plaid.client.model.AssetReportFilterResponse;
import com.plaid.client.model.AssetReportFreddieGetRequest;
import com.plaid.client.model.AssetReportFreddieGetResponse;
import com.plaid.client.model.AssetReportGetRequest;
import com.plaid.client.model.AssetReportGetResponse;
import com.plaid.client.model.AssetReportPDFGetRequest;
import com.plaid.client.model.AssetReportRefreshRequest;
import com.plaid.client.model.AssetReportRefreshResponse;
import com.plaid.client.model.AssetReportRemoveRequest;
import com.plaid.client.model.AssetReportRemoveResponse;
import com.plaid.client.model.AuthGetRequest;
import com.plaid.client.model.AuthGetResponse;
import com.plaid.client.model.BankTransferBalanceGetRequest;
import com.plaid.client.model.BankTransferBalanceGetResponse;
import com.plaid.client.model.BankTransferCancelRequest;
import com.plaid.client.model.BankTransferCancelResponse;
import com.plaid.client.model.BankTransferCreateRequest;
import com.plaid.client.model.BankTransferCreateResponse;
import com.plaid.client.model.BankTransferEventListRequest;
import com.plaid.client.model.BankTransferEventListResponse;
import com.plaid.client.model.BankTransferEventSyncRequest;
import com.plaid.client.model.BankTransferEventSyncResponse;
import com.plaid.client.model.BankTransferGetRequest;
import com.plaid.client.model.BankTransferGetResponse;
import com.plaid.client.model.BankTransferListRequest;
import com.plaid.client.model.BankTransferListResponse;
import com.plaid.client.model.BankTransferMigrateAccountRequest;
import com.plaid.client.model.BankTransferMigrateAccountResponse;
import com.plaid.client.model.BankTransferSweepGetRequest;
import com.plaid.client.model.BankTransferSweepGetResponse;
import com.plaid.client.model.BankTransferSweepListRequest;
import com.plaid.client.model.BankTransferSweepListResponse;
import com.plaid.client.model.BaseReportCreateRequest;
import com.plaid.client.model.BaseReportCreateResponse;
import com.plaid.client.model.BaseReportGetRequest;
import com.plaid.client.model.BaseReportGetResponse;
import com.plaid.client.model.BeaconAccountRiskEvaluateRequest;
import com.plaid.client.model.BeaconAccountRiskEvaluateResponse;
import com.plaid.client.model.BeaconDuplicateGetRequest;
import com.plaid.client.model.BeaconDuplicateGetResponse;
import com.plaid.client.model.BeaconReportCreateRequest;
import com.plaid.client.model.BeaconReportCreateResponse;
import com.plaid.client.model.BeaconReportGetRequest;
import com.plaid.client.model.BeaconReportGetResponse;
import com.plaid.client.model.BeaconReportListRequest;
import com.plaid.client.model.BeaconReportListResponse;
import com.plaid.client.model.BeaconReportSyndicationGetRequest;
import com.plaid.client.model.BeaconReportSyndicationGetResponse;
import com.plaid.client.model.BeaconReportSyndicationListRequest;
import com.plaid.client.model.BeaconReportSyndicationListResponse;
import com.plaid.client.model.BeaconUserCreateRequest;
import com.plaid.client.model.BeaconUserCreateResponse;
import com.plaid.client.model.BeaconUserGetRequest;
import com.plaid.client.model.BeaconUserGetResponse;
import com.plaid.client.model.BeaconUserHistoryListRequest;
import com.plaid.client.model.BeaconUserHistoryListResponse;
import com.plaid.client.model.BeaconUserReviewRequest;
import com.plaid.client.model.BeaconUserUpdateRequest;
import com.plaid.client.model.BeaconUserUpdateResponse;
import com.plaid.client.model.CategoriesGetResponse;
import com.plaid.client.model.CraBankIncomeCreateRequest;
import com.plaid.client.model.CraBankIncomeCreateResponse;
import com.plaid.client.model.CraBankIncomeGetRequest;
import com.plaid.client.model.CraBankIncomeGetResponse;
import com.plaid.client.model.CraPartnerInsightsGetRequest;
import com.plaid.client.model.CraPartnerInsightsGetResponse;
import com.plaid.client.model.CreditAuditCopyTokenCreateRequest;
import com.plaid.client.model.CreditAuditCopyTokenCreateResponse;
import com.plaid.client.model.CreditAuditCopyTokenRemoveRequest;
import com.plaid.client.model.CreditAuditCopyTokenRemoveResponse;
import com.plaid.client.model.CreditAuditCopyTokenUpdateRequest;
import com.plaid.client.model.CreditAuditCopyTokenUpdateResponse;
import com.plaid.client.model.CreditBankEmploymentGetRequest;
import com.plaid.client.model.CreditBankEmploymentGetResponse;
import com.plaid.client.model.CreditBankIncomeGetRequest;
import com.plaid.client.model.CreditBankIncomeGetResponse;
import com.plaid.client.model.CreditBankIncomePDFGetRequest;
import com.plaid.client.model.CreditBankIncomeRefreshRequest;
import com.plaid.client.model.CreditBankIncomeRefreshResponse;
import com.plaid.client.model.CreditBankIncomeWebhookUpdateRequest;
import com.plaid.client.model.CreditBankIncomeWebhookUpdateResponse;
import com.plaid.client.model.CreditBankStatementsUploadsGetRequest;
import com.plaid.client.model.CreditBankStatementsUploadsGetResponse;
import com.plaid.client.model.CreditEmploymentGetRequest;
import com.plaid.client.model.CreditEmploymentGetResponse;
import com.plaid.client.model.CreditFreddieMacReportsGetRequest;
import com.plaid.client.model.CreditFreddieMacReportsGetResponse;
import com.plaid.client.model.CreditPayrollIncomeGetRequest;
import com.plaid.client.model.CreditPayrollIncomeGetResponse;
import com.plaid.client.model.CreditPayrollIncomeParsingConfigUpdateRequest;
import com.plaid.client.model.CreditPayrollIncomeParsingConfigUpdateResponse;
import com.plaid.client.model.CreditPayrollIncomePrecheckRequest;
import com.plaid.client.model.CreditPayrollIncomePrecheckResponse;
import com.plaid.client.model.CreditPayrollIncomeRefreshRequest;
import com.plaid.client.model.CreditPayrollIncomeRefreshResponse;
import com.plaid.client.model.CreditPayrollIncomeRiskSignalsGetRequest;
import com.plaid.client.model.CreditPayrollIncomeRiskSignalsGetResponse;
import com.plaid.client.model.CreditRelayCreateRequest;
import com.plaid.client.model.CreditRelayCreateResponse;
import com.plaid.client.model.CreditRelayGetRequest;
import com.plaid.client.model.CreditRelayPDFGetRequest;
import com.plaid.client.model.CreditRelayRefreshRequest;
import com.plaid.client.model.CreditRelayRefreshResponse;
import com.plaid.client.model.CreditRelayRemoveRequest;
import com.plaid.client.model.CreditRelayRemoveResponse;
import com.plaid.client.model.CreditSessionsGetRequest;
import com.plaid.client.model.CreditSessionsGetResponse;
import com.plaid.client.model.DashboardUserGetRequest;
import com.plaid.client.model.DashboardUserGetResponse;
import com.plaid.client.model.DashboardUserListRequest;
import com.plaid.client.model.DashboardUserListResponse;
import com.plaid.client.model.DepositSwitchAltCreateRequest;
import com.plaid.client.model.DepositSwitchAltCreateResponse;
import com.plaid.client.model.DepositSwitchCreateRequest;
import com.plaid.client.model.DepositSwitchCreateResponse;
import com.plaid.client.model.DepositSwitchGetRequest;
import com.plaid.client.model.DepositSwitchGetResponse;
import com.plaid.client.model.DepositSwitchTokenCreateRequest;
import com.plaid.client.model.DepositSwitchTokenCreateResponse;
import com.plaid.client.model.EmployersSearchRequest;
import com.plaid.client.model.EmployersSearchResponse;
import com.plaid.client.model.EmploymentVerificationGetRequest;
import com.plaid.client.model.EmploymentVerificationGetResponse;
import com.plaid.client.model.FDXNotification;
import java.io.File;
import com.plaid.client.model.IdentityGetRequest;
import com.plaid.client.model.IdentityGetResponse;
import com.plaid.client.model.IdentityMatchRequest;
import com.plaid.client.model.IdentityMatchResponse;
import com.plaid.client.model.IdentityRefreshRequest;
import com.plaid.client.model.IdentityRefreshResponse;
import com.plaid.client.model.IdentityVerificationAutofillCreateRequest;
import com.plaid.client.model.IdentityVerificationAutofillCreateResponse;
import com.plaid.client.model.IdentityVerificationCreateRequest;
import com.plaid.client.model.IdentityVerificationCreateResponse;
import com.plaid.client.model.IdentityVerificationGetRequest;
import com.plaid.client.model.IdentityVerificationGetResponse;
import com.plaid.client.model.IdentityVerificationListRequest;
import com.plaid.client.model.IdentityVerificationListResponse;
import com.plaid.client.model.IdentityVerificationRetryRequest;
import com.plaid.client.model.IdentityVerificationRetryResponse;
import com.plaid.client.model.IncomeVerificationCreateRequest;
import com.plaid.client.model.IncomeVerificationCreateResponse;
import com.plaid.client.model.IncomeVerificationDocumentsDownloadRequest;
import com.plaid.client.model.IncomeVerificationPaystubsGetRequest;
import com.plaid.client.model.IncomeVerificationPaystubsGetResponse;
import com.plaid.client.model.IncomeVerificationPrecheckRequest;
import com.plaid.client.model.IncomeVerificationPrecheckResponse;
import com.plaid.client.model.IncomeVerificationTaxformsGetRequest;
import com.plaid.client.model.IncomeVerificationTaxformsGetResponse;
import com.plaid.client.model.InstitutionsGetByIdRequest;
import com.plaid.client.model.InstitutionsGetByIdResponse;
import com.plaid.client.model.InstitutionsGetRequest;
import com.plaid.client.model.InstitutionsGetResponse;
import com.plaid.client.model.InstitutionsSearchRequest;
import com.plaid.client.model.InstitutionsSearchResponse;
import com.plaid.client.model.InvestmentsAuthGetRequest;
import com.plaid.client.model.InvestmentsAuthGetResponse;
import com.plaid.client.model.InvestmentsHoldingsGetRequest;
import com.plaid.client.model.InvestmentsHoldingsGetResponse;
import com.plaid.client.model.InvestmentsRefreshRequest;
import com.plaid.client.model.InvestmentsRefreshResponse;
import com.plaid.client.model.InvestmentsTransactionsGetRequest;
import com.plaid.client.model.InvestmentsTransactionsGetResponse;
import com.plaid.client.model.ItemAccessTokenInvalidateRequest;
import com.plaid.client.model.ItemAccessTokenInvalidateResponse;
import com.plaid.client.model.ItemActivityListRequest;
import com.plaid.client.model.ItemActivityListResponse;
import com.plaid.client.model.ItemApplicationListRequest;
import com.plaid.client.model.ItemApplicationListResponse;
import com.plaid.client.model.ItemApplicationScopesUpdateRequest;
import com.plaid.client.model.ItemApplicationScopesUpdateResponse;
import com.plaid.client.model.ItemApplicationUnlinkRequest;
import com.plaid.client.model.ItemApplicationUnlinkResponse;
import com.plaid.client.model.ItemGetRequest;
import com.plaid.client.model.ItemGetResponse;
import com.plaid.client.model.ItemImportRequest;
import com.plaid.client.model.ItemImportResponse;
import com.plaid.client.model.ItemPublicTokenCreateRequest;
import com.plaid.client.model.ItemPublicTokenCreateResponse;
import com.plaid.client.model.ItemPublicTokenExchangeRequest;
import com.plaid.client.model.ItemPublicTokenExchangeResponse;
import com.plaid.client.model.ItemRemoveRequest;
import com.plaid.client.model.ItemRemoveResponse;
import com.plaid.client.model.ItemWebhookUpdateRequest;
import com.plaid.client.model.ItemWebhookUpdateResponse;
import com.plaid.client.model.LiabilitiesGetRequest;
import com.plaid.client.model.LiabilitiesGetResponse;
import com.plaid.client.model.LinkDeliveryCreateRequest;
import com.plaid.client.model.LinkDeliveryCreateResponse;
import com.plaid.client.model.LinkDeliveryGetRequest;
import com.plaid.client.model.LinkDeliveryGetResponse;
import com.plaid.client.model.LinkOAuthCorrelationIdExchangeRequest;
import com.plaid.client.model.LinkOAuthCorrelationIdExchangeResponse;
import com.plaid.client.model.LinkTokenCreateRequest;
import com.plaid.client.model.LinkTokenCreateResponse;
import com.plaid.client.model.LinkTokenGetRequest;
import com.plaid.client.model.LinkTokenGetResponse;
import com.plaid.client.model.PartnerCustomerCreateRequest;
import com.plaid.client.model.PartnerCustomerCreateResponse;
import com.plaid.client.model.PartnerCustomerEnableRequest;
import com.plaid.client.model.PartnerCustomerEnableResponse;
import com.plaid.client.model.PartnerCustomerGetRequest;
import com.plaid.client.model.PartnerCustomerGetResponse;
import com.plaid.client.model.PartnerCustomerOAuthInstitutionsGetRequest;
import com.plaid.client.model.PartnerCustomerOAuthInstitutionsGetResponse;
import com.plaid.client.model.PartnerCustomerRemoveRequest;
import com.plaid.client.model.PartnerCustomerRemoveResponse;
import com.plaid.client.model.PaymentInitiationConsentCreateRequest;
import com.plaid.client.model.PaymentInitiationConsentCreateResponse;
import com.plaid.client.model.PaymentInitiationConsentGetRequest;
import com.plaid.client.model.PaymentInitiationConsentGetResponse;
import com.plaid.client.model.PaymentInitiationConsentPaymentExecuteRequest;
import com.plaid.client.model.PaymentInitiationConsentPaymentExecuteResponse;
import com.plaid.client.model.PaymentInitiationConsentRevokeRequest;
import com.plaid.client.model.PaymentInitiationConsentRevokeResponse;
import com.plaid.client.model.PaymentInitiationPaymentCreateRequest;
import com.plaid.client.model.PaymentInitiationPaymentCreateResponse;
import com.plaid.client.model.PaymentInitiationPaymentGetRequest;
import com.plaid.client.model.PaymentInitiationPaymentGetResponse;
import com.plaid.client.model.PaymentInitiationPaymentListRequest;
import com.plaid.client.model.PaymentInitiationPaymentListResponse;
import com.plaid.client.model.PaymentInitiationPaymentReverseRequest;
import com.plaid.client.model.PaymentInitiationPaymentReverseResponse;
import com.plaid.client.model.PaymentInitiationPaymentTokenCreateRequest;
import com.plaid.client.model.PaymentInitiationPaymentTokenCreateResponse;
import com.plaid.client.model.PaymentInitiationRecipientCreateRequest;
import com.plaid.client.model.PaymentInitiationRecipientCreateResponse;
import com.plaid.client.model.PaymentInitiationRecipientGetRequest;
import com.plaid.client.model.PaymentInitiationRecipientGetResponse;
import com.plaid.client.model.PaymentInitiationRecipientListRequest;
import com.plaid.client.model.PaymentInitiationRecipientListResponse;
import com.plaid.client.model.PaymentProfileCreateRequest;
import com.plaid.client.model.PaymentProfileCreateResponse;
import com.plaid.client.model.PaymentProfileGetRequest;
import com.plaid.client.model.PaymentProfileGetResponse;
import com.plaid.client.model.PaymentProfileRemoveRequest;
import com.plaid.client.model.PaymentProfileRemoveResponse;
import com.plaid.client.model.PlaidError;
import com.plaid.client.model.ProcessorAccountGetRequest;
import com.plaid.client.model.ProcessorAccountGetResponse;
import com.plaid.client.model.ProcessorApexProcessorTokenCreateRequest;
import com.plaid.client.model.ProcessorAuthGetRequest;
import com.plaid.client.model.ProcessorAuthGetResponse;
import com.plaid.client.model.ProcessorBalanceGetRequest;
import com.plaid.client.model.ProcessorBalanceGetResponse;
import com.plaid.client.model.ProcessorBankTransferCreateRequest;
import com.plaid.client.model.ProcessorBankTransferCreateResponse;
import com.plaid.client.model.ProcessorIdentityGetRequest;
import com.plaid.client.model.ProcessorIdentityGetResponse;
import com.plaid.client.model.ProcessorIdentityMatchRequest;
import com.plaid.client.model.ProcessorIdentityMatchResponse;
import com.plaid.client.model.ProcessorLiabilitiesGetRequest;
import com.plaid.client.model.ProcessorLiabilitiesGetResponse;
import com.plaid.client.model.ProcessorSignalDecisionReportRequest;
import com.plaid.client.model.ProcessorSignalDecisionReportResponse;
import com.plaid.client.model.ProcessorSignalEvaluateRequest;
import com.plaid.client.model.ProcessorSignalEvaluateResponse;
import com.plaid.client.model.ProcessorSignalPrepareRequest;
import com.plaid.client.model.ProcessorSignalPrepareResponse;
import com.plaid.client.model.ProcessorSignalReturnReportRequest;
import com.plaid.client.model.ProcessorSignalReturnReportResponse;
import com.plaid.client.model.ProcessorStripeBankAccountTokenCreateRequest;
import com.plaid.client.model.ProcessorStripeBankAccountTokenCreateResponse;
import com.plaid.client.model.ProcessorTokenCreateRequest;
import com.plaid.client.model.ProcessorTokenCreateResponse;
import com.plaid.client.model.ProcessorTokenPermissionsGetRequest;
import com.plaid.client.model.ProcessorTokenPermissionsGetResponse;
import com.plaid.client.model.ProcessorTokenPermissionsSetRequest;
import com.plaid.client.model.ProcessorTokenPermissionsSetResponse;
import com.plaid.client.model.ProcessorTokenWebhookUpdateRequest;
import com.plaid.client.model.ProcessorTokenWebhookUpdateResponse;
import com.plaid.client.model.ProcessorTransactionsGetRequest;
import com.plaid.client.model.ProcessorTransactionsGetResponse;
import com.plaid.client.model.ProcessorTransactionsRecurringGetRequest;
import com.plaid.client.model.ProcessorTransactionsRecurringGetResponse;
import com.plaid.client.model.ProcessorTransactionsRefreshRequest;
import com.plaid.client.model.ProcessorTransactionsRefreshResponse;
import com.plaid.client.model.ProcessorTransactionsSyncRequest;
import com.plaid.client.model.ProcessorTransactionsSyncResponse;
import com.plaid.client.model.ProfileGetRequest;
import com.plaid.client.model.ProfileGetResponse;
import com.plaid.client.model.SandboxBankIncomeFireWebhookRequest;
import com.plaid.client.model.SandboxBankIncomeFireWebhookResponse;
import com.plaid.client.model.SandboxBankTransferFireWebhookRequest;
import com.plaid.client.model.SandboxBankTransferFireWebhookResponse;
import com.plaid.client.model.SandboxBankTransferSimulateRequest;
import com.plaid.client.model.SandboxBankTransferSimulateResponse;
import com.plaid.client.model.SandboxIncomeFireWebhookRequest;
import com.plaid.client.model.SandboxIncomeFireWebhookResponse;
import com.plaid.client.model.SandboxItemFireWebhookRequest;
import com.plaid.client.model.SandboxItemFireWebhookResponse;
import com.plaid.client.model.SandboxItemResetLoginRequest;
import com.plaid.client.model.SandboxItemResetLoginResponse;
import com.plaid.client.model.SandboxItemSetVerificationStatusRequest;
import com.plaid.client.model.SandboxItemSetVerificationStatusResponse;
import com.plaid.client.model.SandboxOauthSelectAccountsRequest;
import com.plaid.client.model.SandboxPaymentProfileResetLoginRequest;
import com.plaid.client.model.SandboxPaymentProfileResetLoginResponse;
import com.plaid.client.model.SandboxProcessorTokenCreateRequest;
import com.plaid.client.model.SandboxProcessorTokenCreateResponse;
import com.plaid.client.model.SandboxPublicTokenCreateRequest;
import com.plaid.client.model.SandboxPublicTokenCreateResponse;
import com.plaid.client.model.SandboxTransferFireWebhookRequest;
import com.plaid.client.model.SandboxTransferFireWebhookResponse;
import com.plaid.client.model.SandboxTransferLedgerDepositSimulateRequest;
import com.plaid.client.model.SandboxTransferLedgerDepositSimulateResponse;
import com.plaid.client.model.SandboxTransferLedgerSimulateAvailableRequest;
import com.plaid.client.model.SandboxTransferLedgerSimulateAvailableResponse;
import com.plaid.client.model.SandboxTransferLedgerWithdrawSimulateRequest;
import com.plaid.client.model.SandboxTransferLedgerWithdrawSimulateResponse;
import com.plaid.client.model.SandboxTransferRefundSimulateRequest;
import com.plaid.client.model.SandboxTransferRefundSimulateResponse;
import com.plaid.client.model.SandboxTransferRepaymentSimulateRequest;
import com.plaid.client.model.SandboxTransferRepaymentSimulateResponse;
import com.plaid.client.model.SandboxTransferSimulateRequest;
import com.plaid.client.model.SandboxTransferSimulateResponse;
import com.plaid.client.model.SandboxTransferSweepSimulateRequest;
import com.plaid.client.model.SandboxTransferSweepSimulateResponse;
import com.plaid.client.model.SandboxTransferTestClockAdvanceRequest;
import com.plaid.client.model.SandboxTransferTestClockAdvanceResponse;
import com.plaid.client.model.SandboxTransferTestClockCreateRequest;
import com.plaid.client.model.SandboxTransferTestClockCreateResponse;
import com.plaid.client.model.SandboxTransferTestClockGetRequest;
import com.plaid.client.model.SandboxTransferTestClockGetResponse;
import com.plaid.client.model.SandboxTransferTestClockListRequest;
import com.plaid.client.model.SandboxTransferTestClockListResponse;
import com.plaid.client.model.SignalDecisionReportRequest;
import com.plaid.client.model.SignalDecisionReportResponse;
import com.plaid.client.model.SignalEvaluateRequest;
import com.plaid.client.model.SignalEvaluateResponse;
import com.plaid.client.model.SignalPrepareRequest;
import com.plaid.client.model.SignalPrepareResponse;
import com.plaid.client.model.SignalReturnReportRequest;
import com.plaid.client.model.SignalReturnReportResponse;
import com.plaid.client.model.StatementsDownloadRequest;
import com.plaid.client.model.StatementsListRequest;
import com.plaid.client.model.StatementsListResponse;
import com.plaid.client.model.StatementsRefreshRequest;
import com.plaid.client.model.StatementsRefreshResponse;
import com.plaid.client.model.TransactionsEnhanceGetRequest;
import com.plaid.client.model.TransactionsEnhanceGetResponse;
import com.plaid.client.model.TransactionsEnrichRequest;
import com.plaid.client.model.TransactionsEnrichResponse;
import com.plaid.client.model.TransactionsGetRequest;
import com.plaid.client.model.TransactionsGetResponse;
import com.plaid.client.model.TransactionsRecurringGetRequest;
import com.plaid.client.model.TransactionsRecurringGetResponse;
import com.plaid.client.model.TransactionsRefreshRequest;
import com.plaid.client.model.TransactionsRefreshResponse;
import com.plaid.client.model.TransactionsRulesCreateRequest;
import com.plaid.client.model.TransactionsRulesCreateResponse;
import com.plaid.client.model.TransactionsRulesListRequest;
import com.plaid.client.model.TransactionsRulesListResponse;
import com.plaid.client.model.TransactionsRulesRemoveRequest;
import com.plaid.client.model.TransactionsRulesRemoveResponse;
import com.plaid.client.model.TransactionsSyncRequest;
import com.plaid.client.model.TransactionsSyncResponse;
import com.plaid.client.model.TransactionsUserInsightsGetRequest;
import com.plaid.client.model.TransactionsUserInsightsGetResponse;
import com.plaid.client.model.TransferAuthorizationCreateRequest;
import com.plaid.client.model.TransferAuthorizationCreateResponse;
import com.plaid.client.model.TransferBalanceGetRequest;
import com.plaid.client.model.TransferBalanceGetResponse;
import com.plaid.client.model.TransferCancelRequest;
import com.plaid.client.model.TransferCancelResponse;
import com.plaid.client.model.TransferCapabilitiesGetRequest;
import com.plaid.client.model.TransferCapabilitiesGetResponse;
import com.plaid.client.model.TransferConfigurationGetRequest;
import com.plaid.client.model.TransferConfigurationGetResponse;
import com.plaid.client.model.TransferCreateRequest;
import com.plaid.client.model.TransferCreateResponse;
import com.plaid.client.model.TransferDiligenceDocumentUploadRequest;
import com.plaid.client.model.TransferDiligenceDocumentUploadResponse;
import com.plaid.client.model.TransferDiligenceSubmitRequest;
import com.plaid.client.model.TransferDiligenceSubmitResponse;
import com.plaid.client.model.TransferEventListRequest;
import com.plaid.client.model.TransferEventListResponse;
import com.plaid.client.model.TransferEventSyncRequest;
import com.plaid.client.model.TransferEventSyncResponse;
import com.plaid.client.model.TransferGetRequest;
import com.plaid.client.model.TransferGetResponse;
import com.plaid.client.model.TransferIntentCreateRequest;
import com.plaid.client.model.TransferIntentCreateResponse;
import com.plaid.client.model.TransferIntentGetRequest;
import com.plaid.client.model.TransferIntentGetResponse;
import com.plaid.client.model.TransferLedgerDepositRequest;
import com.plaid.client.model.TransferLedgerDepositResponse;
import com.plaid.client.model.TransferLedgerDistributeRequest;
import com.plaid.client.model.TransferLedgerDistributeResponse;
import com.plaid.client.model.TransferLedgerGetRequest;
import com.plaid.client.model.TransferLedgerGetResponse;
import com.plaid.client.model.TransferLedgerWithdrawRequest;
import com.plaid.client.model.TransferLedgerWithdrawResponse;
import com.plaid.client.model.TransferListRequest;
import com.plaid.client.model.TransferListResponse;
import com.plaid.client.model.TransferMetricsGetRequest;
import com.plaid.client.model.TransferMetricsGetResponse;
import com.plaid.client.model.TransferMigrateAccountRequest;
import com.plaid.client.model.TransferMigrateAccountResponse;
import com.plaid.client.model.TransferOriginatorCreateRequest;
import com.plaid.client.model.TransferOriginatorCreateResponse;
import com.plaid.client.model.TransferOriginatorFundingAccountUpdateRequest;
import com.plaid.client.model.TransferOriginatorFundingAccountUpdateResponse;
import com.plaid.client.model.TransferOriginatorGetRequest;
import com.plaid.client.model.TransferOriginatorGetResponse;
import com.plaid.client.model.TransferOriginatorListRequest;
import com.plaid.client.model.TransferOriginatorListResponse;
import com.plaid.client.model.TransferQuestionnaireCreateRequest;
import com.plaid.client.model.TransferQuestionnaireCreateResponse;
import com.plaid.client.model.TransferRecurringCancelRequest;
import com.plaid.client.model.TransferRecurringCancelResponse;
import com.plaid.client.model.TransferRecurringCreateRequest;
import com.plaid.client.model.TransferRecurringCreateResponse;
import com.plaid.client.model.TransferRecurringGetRequest;
import com.plaid.client.model.TransferRecurringGetResponse;
import com.plaid.client.model.TransferRecurringListRequest;
import com.plaid.client.model.TransferRecurringListResponse;
import com.plaid.client.model.TransferRefundCancelRequest;
import com.plaid.client.model.TransferRefundCancelResponse;
import com.plaid.client.model.TransferRefundCreateRequest;
import com.plaid.client.model.TransferRefundCreateResponse;
import com.plaid.client.model.TransferRefundGetRequest;
import com.plaid.client.model.TransferRefundGetResponse;
import com.plaid.client.model.TransferRepaymentListRequest;
import com.plaid.client.model.TransferRepaymentListResponse;
import com.plaid.client.model.TransferRepaymentReturnListRequest;
import com.plaid.client.model.TransferRepaymentReturnListResponse;
import com.plaid.client.model.TransferSweepGetRequest;
import com.plaid.client.model.TransferSweepGetResponse;
import com.plaid.client.model.TransferSweepListRequest;
import com.plaid.client.model.TransferSweepListResponse;
import com.plaid.client.model.UserCreateRequest;
import com.plaid.client.model.UserCreateResponse;
import com.plaid.client.model.UserUpdateRequest;
import com.plaid.client.model.UserUpdateResponse;
import com.plaid.client.model.WalletCreateRequest;
import com.plaid.client.model.WalletCreateResponse;
import com.plaid.client.model.WalletGetRequest;
import com.plaid.client.model.WalletGetResponse;
import com.plaid.client.model.WalletListRequest;
import com.plaid.client.model.WalletListResponse;
import com.plaid.client.model.WalletTransactionExecuteRequest;
import com.plaid.client.model.WalletTransactionExecuteResponse;
import com.plaid.client.model.WalletTransactionGetRequest;
import com.plaid.client.model.WalletTransactionGetResponse;
import com.plaid.client.model.WalletTransactionListRequest;
import com.plaid.client.model.WalletTransactionListResponse;
import com.plaid.client.model.WatchlistScreeningEntityCreateRequest;
import com.plaid.client.model.WatchlistScreeningEntityCreateResponse;
import com.plaid.client.model.WatchlistScreeningEntityGetRequest;
import com.plaid.client.model.WatchlistScreeningEntityGetResponse;
import com.plaid.client.model.WatchlistScreeningEntityHistoryListRequest;
import com.plaid.client.model.WatchlistScreeningEntityHistoryListResponse;
import com.plaid.client.model.WatchlistScreeningEntityHitListRequest;
import com.plaid.client.model.WatchlistScreeningEntityHitListResponse;
import com.plaid.client.model.WatchlistScreeningEntityListRequest;
import com.plaid.client.model.WatchlistScreeningEntityListResponse;
import com.plaid.client.model.WatchlistScreeningEntityProgramGetRequest;
import com.plaid.client.model.WatchlistScreeningEntityProgramGetResponse;
import com.plaid.client.model.WatchlistScreeningEntityProgramListRequest;
import com.plaid.client.model.WatchlistScreeningEntityProgramListResponse;
import com.plaid.client.model.WatchlistScreeningEntityReviewCreateRequest;
import com.plaid.client.model.WatchlistScreeningEntityReviewCreateResponse;
import com.plaid.client.model.WatchlistScreeningEntityReviewListRequest;
import com.plaid.client.model.WatchlistScreeningEntityReviewListResponse;
import com.plaid.client.model.WatchlistScreeningEntityUpdateRequest;
import com.plaid.client.model.WatchlistScreeningEntityUpdateResponse;
import com.plaid.client.model.WatchlistScreeningIndividualCreateRequest;
import com.plaid.client.model.WatchlistScreeningIndividualCreateResponse;
import com.plaid.client.model.WatchlistScreeningIndividualGetRequest;
import com.plaid.client.model.WatchlistScreeningIndividualGetResponse;
import com.plaid.client.model.WatchlistScreeningIndividualHistoryListRequest;
import com.plaid.client.model.WatchlistScreeningIndividualHistoryListResponse;
import com.plaid.client.model.WatchlistScreeningIndividualHitListRequest;
import com.plaid.client.model.WatchlistScreeningIndividualHitListResponse;
import com.plaid.client.model.WatchlistScreeningIndividualListRequest;
import com.plaid.client.model.WatchlistScreeningIndividualListResponse;
import com.plaid.client.model.WatchlistScreeningIndividualProgramGetRequest;
import com.plaid.client.model.WatchlistScreeningIndividualProgramGetResponse;
import com.plaid.client.model.WatchlistScreeningIndividualProgramListRequest;
import com.plaid.client.model.WatchlistScreeningIndividualProgramListResponse;
import com.plaid.client.model.WatchlistScreeningIndividualReviewCreateRequest;
import com.plaid.client.model.WatchlistScreeningIndividualReviewCreateResponse;
import com.plaid.client.model.WatchlistScreeningIndividualReviewListRequest;
import com.plaid.client.model.WatchlistScreeningIndividualReviewListResponse;
import com.plaid.client.model.WatchlistScreeningIndividualUpdateRequest;
import com.plaid.client.model.WatchlistScreeningIndividualUpdateResponse;
import com.plaid.client.model.WebhookVerificationKeyGetRequest;
import com.plaid.client.model.WebhookVerificationKeyGetResponse;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public interface PlaidApi {
/**
* 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, such as `/accounts/get`, 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. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
* @param accountsBalanceGetRequest (required)
* @return Call<AccountsGetResponse>
*
* @see Retrieve real-time balance data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("accounts/balance/get")
Call accountsBalanceGet(
@retrofit2.http.Body AccountsBalanceGetRequest accountsBalanceGetRequest
);
/**
* Retrieve accounts
* The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead.
* @param accountsGetRequest (required)
* @return Call<AccountsGetResponse>
*
* @see Retrieve accounts Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("accounts/get")
Call accountsGet(
@retrofit2.http.Body AccountsGetRequest accountsGetRequest
);
/**
* Retrieve information about a Plaid application
* Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
* @param applicationGetRequest (required)
* @return Call<ApplicationGetResponse>
*/
@Headers({
"Content-Type:application/json"
})
@POST("application/get")
Call applicationGet(
@retrofit2.http.Body ApplicationGetRequest applicationGetRequest
);
/**
* 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.
* @param assetReportAuditCopyCreateRequest (required)
* @return Call<AssetReportAuditCopyCreateResponse>
*
* @see Create Asset Report Audit Copy Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/audit_copy/create")
Call assetReportAuditCopyCreate(
@retrofit2.http.Body AssetReportAuditCopyCreateRequest assetReportAuditCopyCreateRequest
);
/**
* 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`.
* @param assetReportAuditCopyGetRequest (required)
* @return Call<AssetReportGetResponse>
*
* @see Retrieve an Asset Report Audit Copy Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/audit_copy/get")
Call assetReportAuditCopyGet(
@retrofit2.http.Body AssetReportAuditCopyGetRequest assetReportAuditCopyGetRequest
);
/**
* 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.
* @param assetReportAuditCopyRemoveRequest (required)
* @return Call<AssetReportAuditCopyRemoveResponse>
*
* @see Remove Asset Report Audit Copy Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/audit_copy/remove")
Call assetReportAuditCopyRemove(
@retrofit2.http.Body AssetReportAuditCopyRemoveRequest assetReportAuditCopyRemoveRequest
);
/**
* 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`. The exact amount of time to create the report will vary depending on how many days of history are requested and will typically range from a few seconds to about one minute. 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/products/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.
* @param assetReportCreateRequest (required)
* @return Call<AssetReportCreateResponse>
*
* @see Create an Asset Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/create")
Call assetReportCreate(
@retrofit2.http.Body AssetReportCreateRequest assetReportCreateRequest
);
/**
* 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/products/assets/#product_ready) webhook once generation of the filtered Asset Report has completed.
* @param assetReportFilterRequest (required)
* @return Call<AssetReportFilterResponse>
*
* @see Filter Asset Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/filter")
Call assetReportFilter(
@retrofit2.http.Body AssetReportFilterRequest assetReportFilterRequest
);
/**
* 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/products/assets/#product_ready) 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 `/asset_report/get` endpoint with `include_insights` set to `true`. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
* @param assetReportGetRequest (required)
* @return Call<AssetReportGetResponse>
*
* @see Retrieve an Asset Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/get")
Call assetReportGet(
@retrofit2.http.Body AssetReportGetRequest assetReportGetRequest
);
/**
* 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/products/assets/#product_ready) 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).
* @param assetReportPDFGetRequest (required)
* @return Call<ResponseBody>
*
* @see Retrieve a PDF Asset Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/pdf/get")
Call assetReportPdfGet(
@retrofit2.http.Body AssetReportPDFGetRequest assetReportPDFGetRequest
);
/**
* 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.
* @param assetReportRefreshRequest (required)
* @return Call<AssetReportRefreshResponse>
*
* @see Refresh an Asset Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/refresh")
Call assetReportRefresh(
@retrofit2.http.Body AssetReportRefreshRequest assetReportRefreshRequest
);
/**
* 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 access to 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.
* @param assetReportRemoveRequest (required)
* @return Call<AssetReportRemoveResponse>
*
* @see Delete an Asset Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("asset_report/remove")
Call assetReportRemove(
@retrofit2.http.Body AssetReportRemoveRequest assetReportRemoveRequest
);
/**
* 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. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
* @param authGetRequest (required)
* @return Call<AuthGetResponse>
*
* @see Retrieve auth data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("auth/get")
Call authGet(
@retrofit2.http.Body AuthGetRequest authGetRequest
);
/**
* 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.
* @param bankTransferBalanceGetRequest (required)
* @return Call<BankTransferBalanceGetResponse>
*
* @see Get balance of your Bank Transfer account Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/balance/get")
Call bankTransferBalanceGet(
@retrofit2.http.Body BankTransferBalanceGetRequest bankTransferBalanceGetRequest
);
/**
* 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`.
* @param bankTransferCancelRequest (required)
* @return Call<BankTransferCancelResponse>
*
* @see Cancel a bank transfer Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/cancel")
Call bankTransferCancel(
@retrofit2.http.Body BankTransferCancelRequest bankTransferCancelRequest
);
/**
* Create a bank transfer
* Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
* @param bankTransferCreateRequest (required)
* @return Call<BankTransferCreateResponse>
*
* @see Create a bank transfer Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/create")
Call bankTransferCreate(
@retrofit2.http.Body BankTransferCreateRequest bankTransferCreateRequest
);
/**
* List bank transfer events
* Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://plaid.com/docs/auth/coverage/microdeposit-events/).
* @param bankTransferEventListRequest (required)
* @return Call<BankTransferEventListResponse>
*
* @see List bank transfer events Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/event/list")
Call bankTransferEventList(
@retrofit2.http.Body BankTransferEventListRequest bankTransferEventListRequest
);
/**
* Sync bank transfer events
* `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
* @param bankTransferEventSyncRequest (required)
* @return Call<BankTransferEventSyncResponse>
*
* @see Sync bank transfer events Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/event/sync")
Call bankTransferEventSync(
@retrofit2.http.Body BankTransferEventSyncRequest bankTransferEventSyncRequest
);
/**
* Retrieve a bank transfer
* The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
* @param bankTransferGetRequest (required)
* @return Call<BankTransferGetResponse>
*
* @see Retrieve a bank transfer Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/get")
Call bankTransferGet(
@retrofit2.http.Body BankTransferGetRequest bankTransferGetRequest
);
/**
* 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.
* @param bankTransferListRequest (required)
* @return Call<BankTransferListResponse>
*
* @see List bank transfers Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/list")
Call bankTransferList(
@retrofit2.http.Body BankTransferListRequest bankTransferListRequest
);
/**
* 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.
* @param bankTransferMigrateAccountRequest (required)
* @return Call<BankTransferMigrateAccountResponse>
*
* @see Migrate account into Bank Transfers Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/migrate_account")
Call bankTransferMigrateAccount(
@retrofit2.http.Body BankTransferMigrateAccountRequest bankTransferMigrateAccountRequest
);
/**
* Retrieve a sweep
* The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
* @param bankTransferSweepGetRequest (required)
* @return Call<BankTransferSweepGetResponse>
*
* @see Retrieve a sweep Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/sweep/get")
Call bankTransferSweepGet(
@retrofit2.http.Body BankTransferSweepGetRequest bankTransferSweepGetRequest
);
/**
* List sweeps
* The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
* @param bankTransferSweepListRequest (required)
* @return Call<BankTransferSweepListResponse>
*
* @see List sweeps Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("bank_transfer/sweep/list")
Call bankTransferSweepList(
@retrofit2.http.Body BankTransferSweepListRequest bankTransferSweepListRequest
);
/**
* Create a Base Report
* This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
* @param baseReportCreateRequest (required)
* @return Call<BaseReportCreateResponse>
*
* @see Create a Base Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("cra/base_report/create")
Call baseReportCreate(
@retrofit2.http.Body BaseReportCreateRequest baseReportCreateRequest
);
/**
* Retrieve a Base Report
* This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/link/token/create`.
* @param baseReportGetRequest (required)
* @return Call<BaseReportGetResponse>
*
* @see Retrieve a Base Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("cra/base_report/get")
Call baseReportGet(
@retrofit2.http.Body BaseReportGetRequest baseReportGetRequest
);
/**
* Evaluate risk of a bank account
* Use `/beacon/account_risk/v1/evaluate` to get risk insights for a linked account.
* @param beaconAccountRiskEvaluateRequest (required)
* @return Call<BeaconAccountRiskEvaluateResponse>
*
* @see Evaluate risk of a bank account Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/account_risk/v1/evaluate")
Call beaconAccountRiskEvaluate(
@retrofit2.http.Body BeaconAccountRiskEvaluateRequest beaconAccountRiskEvaluateRequest
);
/**
* Get a Beacon Duplicate
* Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are returned for each Duplicate record in either the `beacon_user1` or `beacon_user2` response fields. The `analysis` field in the response indicates which fields matched between `beacon_user1` and `beacon_user2`.
* @param beaconDuplicateGetRequest (required)
* @return Call<BeaconDuplicateGetResponse>
*
* @see Get a Beacon Duplicate Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/duplicate/get")
Call beaconDuplicateGet(
@retrofit2.http.Body BeaconDuplicateGetRequest beaconDuplicateGetRequest
);
/**
* Create a Beacon Report
* Create a fraud report for a given Beacon User.
* @param beaconReportCreateRequest (required)
* @return Call<BeaconReportCreateResponse>
*
* @see Create a Beacon Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/report/create")
Call beaconReportCreate(
@retrofit2.http.Body BeaconReportCreateRequest beaconReportCreateRequest
);
/**
* Get a Beacon Report
* Returns a Beacon report for a given Beacon report id.
* @param beaconReportGetRequest (required)
* @return Call<BeaconReportGetResponse>
*
* @see Get a Beacon Report Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/report/get")
Call beaconReportGet(
@retrofit2.http.Body BeaconReportGetRequest beaconReportGetRequest
);
/**
* List Beacon Reports for a Beacon User
* Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
* @param beaconReportListRequest (required)
* @return Call<BeaconReportListResponse>
*
* @see List Beacon Reports for a Beacon User Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/report/list")
Call beaconReportList(
@retrofit2.http.Body BeaconReportListRequest beaconReportListRequest
);
/**
* Get a Beacon Report Syndication
* Returns a Beacon Report Syndication for a given Beacon Report Syndication id.
* @param beaconReportSyndicationGetRequest (required)
* @return Call<BeaconReportSyndicationGetResponse>
*
* @see Get a Beacon Report Syndication Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/report_syndication/get")
Call beaconReportSyndicationGet(
@retrofit2.http.Body BeaconReportSyndicationGetRequest beaconReportSyndicationGetRequest
);
/**
* List Beacon Report Syndications for a Beacon User
* Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
* @param beaconReportSyndicationListRequest (required)
* @return Call<BeaconReportSyndicationListResponse>
*
* @see List Beacon Report Syndications for a Beacon User Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/report_syndication/list")
Call beaconReportSyndicationList(
@retrofit2.http.Body BeaconReportSyndicationListRequest beaconReportSyndicationListRequest
);
/**
* Create a Beacon User
* Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud.
* @param beaconUserCreateRequest (required)
* @return Call<BeaconUserCreateResponse>
*
* @see Create a Beacon User Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/user/create")
Call beaconUserCreate(
@retrofit2.http.Body BeaconUserCreateRequest beaconUserCreateRequest
);
/**
* Get a Beacon User
* Fetch a Beacon User. The Beacon User is returned with all of their associated information and a `status` based on the Beacon Network duplicate record and fraud checks.
* @param beaconUserGetRequest (required)
* @return Call<BeaconUserGetResponse>
*
* @see Get a Beacon User Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/user/get")
Call beaconUserGet(
@retrofit2.http.Body BeaconUserGetRequest beaconUserGetRequest
);
/**
* List a Beacon User's history
* List all changes to the Beacon User in reverse-chronological order.
* @param beaconUserHistoryListRequest (required)
* @return Call<BeaconUserHistoryListResponse>
*
* @see List a Beacon User's history Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/user/history/list")
Call beaconUserHistoryList(
@retrofit2.http.Body BeaconUserHistoryListRequest beaconUserHistoryListRequest
);
/**
* Review a Beacon User
* Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User's status to \"rejected\", we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to \"cleared\", we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to \"cleared\". There are no restrictions on updating a Beacon User's status to \"pending_review\". If these conditions are not met, the request will be rejected with an error explaining the issue.
* @param beaconUserReviewRequest (required)
* @return Call<BeaconUserGetResponse>
*
* @see Review a Beacon User Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/user/review")
Call beaconUserReview(
@retrofit2.http.Body BeaconUserReviewRequest beaconUserReviewRequest
);
/**
* Update the identity data of a Beacon User
* Update the identity data for a Beacon User in your Beacon Program. Similar to `/beacon/user/create`, several checks are performed immediately when you submit a change to `/beacon/user/update`: - The user's updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
* @param beaconUserUpdateRequest (required)
* @return Call<BeaconUserUpdateResponse>
*
* @see Update the identity data of a Beacon User Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beacon/user/update")
Call beaconUserUpdate(
@retrofit2.http.Body BeaconUserUpdateRequest beaconUserUpdateRequest
);
/**
* 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. All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
* @param body (required)
* @return Call<CategoriesGetResponse>
*
* @see Get categories Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("categories/get")
Call categoriesGet(
@retrofit2.http.Body Object body
);
/**
* Create a CRA report for income verification
* `/cra/bank_income/create` creates a CRA report for income verification
* @param craBankIncomeCreateRequest (required)
* @return Call<CraBankIncomeCreateResponse>
*
* @see Create a CRA report for income verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("cra/bank_income/create")
Call craBankIncomeCreate(
@retrofit2.http.Body CraBankIncomeCreateRequest craBankIncomeCreateRequest
);
/**
* Retrieve information from the bank accounts used for income verification
* `/cra/bank_income/get` returns the bank income report(s) for a specified user.
* @param craBankIncomeGetRequest (required)
* @return Call<CraBankIncomeGetResponse>
*
* @see Retrieve information from the bank accounts used for income verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("cra/bank_income/get")
Call craBankIncomeGet(
@retrofit2.http.Body CraBankIncomeGetRequest craBankIncomeGetRequest
);
/**
* Retrieve cash flow insights from the bank accounts used for income verification
* `/cra/partner_insights/get` returns cash flow insights for a specified user.
* @param craPartnerInsightsGetRequest (required)
* @return Call<CraPartnerInsightsGetResponse>
*
* @see Retrieve cash flow insights from the bank accounts used for income verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("cra/partner_insights/get")
Call craPartnerInsightsGet(
@retrofit2.http.Body CraPartnerInsightsGetRequest craPartnerInsightsGetRequest
);
/**
* 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.
* @param paymentInitiationPaymentTokenCreateRequest (required)
* @return Call<PaymentInitiationPaymentTokenCreateResponse>
* @deprecated
*
* @see Create payment token Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/payment/token/create")
Call createPaymentToken(
@retrofit2.http.Body PaymentInitiationPaymentTokenCreateRequest paymentInitiationPaymentTokenCreateRequest
);
/**
* Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
* The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
* @param assetReportFreddieGetRequest (required)
* @return Call<AssetReportFreddieGetResponse>
*
* @see Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/asset_report/freddie_mac/get")
Call creditAssetReportFreddieMacGet(
@retrofit2.http.Body AssetReportFreddieGetRequest assetReportFreddieGetRequest
);
/**
* Create Asset or Income Report Audit Copy Token
* Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.
* @param creditAuditCopyTokenCreateRequest (required)
* @return Call<CreditAuditCopyTokenCreateResponse>
*
* @see Create Asset or Income Report Audit Copy Token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/audit_copy_token/create")
Call creditAuditCopyTokenCreate(
@retrofit2.http.Body CreditAuditCopyTokenCreateRequest creditAuditCopyTokenCreateRequest
);
/**
* Update an Audit Copy Token
* The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.
* @param creditAuditCopyTokenUpdateRequest (required)
* @return Call<CreditAuditCopyTokenUpdateResponse>
*
* @see Update an Audit Copy Token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/audit_copy_token/update")
Call creditAuditCopyTokenUpdate(
@retrofit2.http.Body CreditAuditCopyTokenUpdateRequest creditAuditCopyTokenUpdateRequest
);
/**
* Retrieve information from the bank accounts used for employment verification
* `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
* @param creditBankEmploymentGetRequest (required)
* @return Call<CreditBankEmploymentGetResponse>
*
* @see Retrieve information from the bank accounts used for employment verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("beta/credit/v1/bank_employment/get")
Call creditBankEmploymentGet(
@retrofit2.http.Body CreditBankEmploymentGetRequest creditBankEmploymentGetRequest
);
/**
* Retrieve information from the bank accounts used for income verification
* `/credit/bank_income/get` returns the bank income report(s) for a specified user.
* @param creditBankIncomeGetRequest (required)
* @return Call<CreditBankIncomeGetResponse>
*
* @see Retrieve information from the bank accounts used for income verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/bank_income/get")
Call creditBankIncomeGet(
@retrofit2.http.Body CreditBankIncomeGetRequest creditBankIncomeGetRequest
);
/**
* Retrieve information from the bank accounts used for income verification in PDF format
* `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format.
* @param creditBankIncomePDFGetRequest (required)
* @return Call<ResponseBody>
*
* @see Retrieve information from the bank accounts used for income verification in PDF format Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/bank_income/pdf/get")
Call creditBankIncomePdfGet(
@retrofit2.http.Body CreditBankIncomePDFGetRequest creditBankIncomePDFGetRequest
);
/**
* Refresh a user's bank income information
* `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
* @param creditBankIncomeRefreshRequest (required)
* @return Call<CreditBankIncomeRefreshResponse>
*
* @see Refresh a user's bank income information Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/bank_income/refresh")
Call creditBankIncomeRefresh(
@retrofit2.http.Body CreditBankIncomeRefreshRequest creditBankIncomeRefreshRequest
);
/**
* Subscribe and unsubscribe to proactive notifications for a user's income profile
* `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user.
* @param creditBankIncomeWebhookUpdateRequest (required)
* @return Call<CreditBankIncomeWebhookUpdateResponse>
*
* @see Subscribe and unsubscribe to proactive notifications for a user's income profile Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/bank_income/webhook/update")
Call creditBankIncomeWebhookUpdate(
@retrofit2.http.Body CreditBankIncomeWebhookUpdateRequest creditBankIncomeWebhookUpdateRequest
);
/**
* Retrieve data for a user's uploaded bank statements
* `/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document Parsing, contact your account manager to request access.
* @param creditBankStatementsUploadsGetRequest (required)
* @return Call<CreditBankStatementsUploadsGetResponse>
*
* @see Retrieve data for a user's uploaded bank statements Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/bank_statements/uploads/get")
Call creditBankStatementsUploadsGet(
@retrofit2.http.Body CreditBankStatementsUploadsGetRequest creditBankStatementsUploadsGetRequest
);
/**
* Retrieve a summary of an individual's employment information
* `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user.
* @param creditEmploymentGetRequest (required)
* @return Call<CreditEmploymentGetResponse>
*
* @see Retrieve a summary of an individual's employment information Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/employment/get")
Call creditEmploymentGet(
@retrofit2.http.Body CreditEmploymentGetRequest creditEmploymentGetRequest
);
/**
* Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
* The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
* @param creditFreddieMacReportsGetRequest (required)
* @return Call<CreditFreddieMacReportsGetResponse>
*
* @see Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint. Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/freddie_mac/reports/get")
Call creditFreddieMacReportsGet(
@retrofit2.http.Body CreditFreddieMacReportsGetRequest creditFreddieMacReportsGetRequest
);
/**
* Retrieve a user's payroll information
* This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
* @param creditPayrollIncomeGetRequest (required)
* @return Call<CreditPayrollIncomeGetResponse>
*
* @see Retrieve a user's payroll information Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/payroll_income/get")
Call creditPayrollIncomeGet(
@retrofit2.http.Body CreditPayrollIncomeGetRequest creditPayrollIncomeGetRequest
);
/**
* Update the parsing configuration for a document income verification
* `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.
* @param creditPayrollIncomeParsingConfigUpdateRequest (required)
* @return Call<CreditPayrollIncomeParsingConfigUpdateResponse>
*
* @see Update the parsing configuration for a document income verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/payroll_income/parsing_config/update")
Call creditPayrollIncomeParsingConfigUpdate(
@retrofit2.http.Body CreditPayrollIncomeParsingConfigUpdateRequest creditPayrollIncomeParsingConfigUpdateRequest
);
/**
* Check income verification eligibility and optimize conversion
* `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.
* @param creditPayrollIncomePrecheckRequest (required)
* @return Call<CreditPayrollIncomePrecheckResponse>
* @deprecated
*
* @see Check income verification eligibility and optimize conversion Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("credit/payroll_income/precheck")
Call creditPayrollIncomePrecheck(
@retrofit2.http.Body CreditPayrollIncomePrecheckRequest creditPayrollIncomePrecheckRequest
);
/**
* Refresh a digital payroll income verification
* `/credit/payroll_income/refresh` refreshes a given digital payroll income verification.
* @param creditPayrollIncomeRefreshRequest (required)
* @return Call<CreditPayrollIncomeRefreshResponse>
*
* @see Refresh a digital payroll income verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/payroll_income/refresh")
Call creditPayrollIncomeRefresh(
@retrofit2.http.Body CreditPayrollIncomeRefreshRequest creditPayrollIncomeRefreshRequest
);
/**
* Retrieve fraud insights for a user's manually uploaded document(s).
* `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call `/link/token/create` with `parsing_config` set to include `risk_signals`, or call `/credit/payroll_income/parsing_config/update`. Once risk signal generation has been triggered, `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION_RISK_SIGNALS` webhook has been fired. `/credit/payroll_income/risk_signals/get` is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
* @param creditPayrollIncomeRiskSignalsGetRequest (required)
* @return Call<CreditPayrollIncomeRiskSignalsGetResponse>
*
* @see Retrieve fraud insights for a user's manually uploaded document(s). Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/payroll_income/risk_signals/get")
Call creditPayrollIncomeRiskSignalsGet(
@retrofit2.http.Body CreditPayrollIncomeRiskSignalsGetRequest creditPayrollIncomeRiskSignalsGetRequest
);
/**
* Create a relay token to share an Asset Report with a partner client (beta)
* Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf.
* @param creditRelayCreateRequest (required)
* @return Call<CreditRelayCreateResponse>
*
* @see Create a relay token to share an Asset Report with a partner client (beta) Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/relay/create")
Call creditRelayCreate(
@retrofit2.http.Body CreditRelayCreateRequest creditRelayCreateRequest
);
/**
* Retrieve the reports associated with a relay token that was shared with you (beta)
* `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner.
* @param creditRelayGetRequest (required)
* @return Call<AssetReportGetResponse>
*
* @see Retrieve the reports associated with a relay token that was shared with you (beta) Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/relay/get")
Call creditRelayGet(
@retrofit2.http.Body CreditRelayGetRequest creditRelayGetRequest
);
/**
* Retrieve the pdf reports associated with a relay token that was shared with you (beta)
* `/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/credit/relay/pdf/get`, you must first create the Asset Report using `/credit/relay/create` and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/credit/relay/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).
* @param creditRelayPDFGetRequest (required)
* @return Call<ResponseBody>
*
* @see Retrieve the pdf reports associated with a relay token that was shared with you (beta) Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/relay/pdf/get")
Call creditRelayPdfGet(
@retrofit2.http.Body CreditRelayPDFGetRequest creditRelayPDFGetRequest
);
/**
* Refresh a report of a relay token (beta)
* The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the `days_requested` value of the original report.
* @param creditRelayRefreshRequest (required)
* @return Call<CreditRelayRefreshResponse>
*
* @see Refresh a report of a relay token (beta) Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/relay/refresh")
Call creditRelayRefresh(
@retrofit2.http.Body CreditRelayRefreshRequest creditRelayRefreshRequest
);
/**
* Remove relay token (beta)
* The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the `relay_token` gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token`.
* @param creditRelayRemoveRequest (required)
* @return Call<CreditRelayRemoveResponse>
*
* @see Remove relay token (beta) Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/relay/remove")
Call creditRelayRemove(
@retrofit2.http.Body CreditRelayRemoveRequest creditRelayRemoveRequest
);
/**
* Remove an Audit Copy token
* The `/credit/audit_copy_token/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 Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
* @param creditAuditCopyTokenRemoveRequest (required)
* @return Call<CreditAuditCopyTokenRemoveResponse>
*
* @see Remove an Audit Copy token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/audit_copy_token/remove")
Call creditReportAuditCopyRemove(
@retrofit2.http.Body CreditAuditCopyTokenRemoveRequest creditAuditCopyTokenRemoveRequest
);
/**
* Retrieve Link sessions for your user
* This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step).
* @param creditSessionsGetRequest (required)
* @return Call<CreditSessionsGetResponse>
*
* @see Retrieve Link sessions for your user Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("credit/sessions/get")
Call creditSessionsGet(
@retrofit2.http.Body CreditSessionsGetRequest creditSessionsGetRequest
);
/**
* Retrieve a dashboard user
* Retrieve information about a dashboard user.
* @param dashboardUserGetRequest (required)
* @return Call<DashboardUserGetResponse>
*
* @see Retrieve a dashboard user Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("dashboard_user/get")
Call dashboardUserGet(
@retrofit2.http.Body DashboardUserGetRequest dashboardUserGetRequest
);
/**
* List dashboard users
* List all dashboard users associated with your account.
* @param dashboardUserListRequest (required)
* @return Call<DashboardUserListResponse>
*
* @see List dashboard users Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("dashboard_user/list")
Call dashboardUserList(
@retrofit2.http.Body DashboardUserListRequest dashboardUserListRequest
);
/**
* 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.
* @param depositSwitchAltCreateRequest (required)
* @return Call<DepositSwitchAltCreateResponse>
*
* @see Create a deposit switch without using Plaid Exchange Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("deposit_switch/alt/create")
Call depositSwitchAltCreate(
@retrofit2.http.Body DepositSwitchAltCreateRequest depositSwitchAltCreateRequest
);
/**
* Create a deposit switch
* This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
* @param depositSwitchCreateRequest (required)
* @return Call<DepositSwitchCreateResponse>
*
* @see Create a deposit switch Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("deposit_switch/create")
Call depositSwitchCreate(
@retrofit2.http.Body DepositSwitchCreateRequest depositSwitchCreateRequest
);
/**
* 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.
* @param depositSwitchGetRequest (required)
* @return Call<DepositSwitchGetResponse>
*
* @see Retrieve a deposit switch Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("deposit_switch/get")
Call depositSwitchGet(
@retrofit2.http.Body DepositSwitchGetRequest depositSwitchGetRequest
);
/**
* 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.
* @param depositSwitchTokenCreateRequest (required)
* @return Call<DepositSwitchTokenCreateResponse>
*
* @see Create a deposit switch token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("deposit_switch/token/create")
Call depositSwitchTokenCreate(
@retrofit2.http.Body DepositSwitchTokenCreateRequest depositSwitchTokenCreateRequest
);
/**
* 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.
* @param employersSearchRequest (required)
* @return Call<EmployersSearchResponse>
*
* @see Search employer database Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("employers/search")
Call employersSearch(
@retrofit2.http.Body EmployersSearchRequest employersSearchRequest
);
/**
* (Deprecated) 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. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead.
* @param employmentVerificationGetRequest (required)
* @return Call<EmploymentVerificationGetResponse>
* @deprecated
*
* @see (Deprecated) Retrieve a summary of an individual's employment information Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("employment/verification/get")
Call employmentVerificationGet(
@retrofit2.http.Body EmploymentVerificationGetRequest employmentVerificationGetRequest
);
/**
* Webhook receiver for fdx notifications
* A generic webhook receiver endpoint for FDX Event Notifications
* @param fdXNotification (required)
* @return Call<Void>
*
* @see Webhook receiver for fdx notifications Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("fdx/notifications")
Call fdxNotifications(
@retrofit2.http.Body FDXNotification fdXNotification
);
/**
* 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. 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. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
* @param identityGetRequest (required)
* @return Call<IdentityGetResponse>
*
* @see Retrieve identity data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("identity/get")
Call identityGet(
@retrofit2.http.Body IdentityGetRequest identityGetRequest
);
/**
* Retrieve identity match score
* The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. 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.
* @param identityMatchRequest (required)
* @return Call<IdentityMatchResponse>
*
* @see Retrieve identity match score Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("identity/match")
Call identityMatch(
@retrofit2.http.Body IdentityMatchRequest identityMatchRequest
);
/**
* Refresh identity data
* `/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur for any Identity-enabled Item. If changes to Identity are discovered after calling `/identity/refresh`, Plaid will fire a webhook [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/identity/#default_update). As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/identity/refresh` is offered as an add-on to Identity and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
* @param identityRefreshRequest (required)
* @return Call<IdentityRefreshResponse>
*
* @see Refresh identity data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("identity/refresh")
Call identityRefresh(
@retrofit2.http.Body IdentityRefreshRequest identityRefreshRequest
);
/**
* Create autofill for an Identity Verification
* Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence.
* @param identityVerificationAutofillCreateRequest (required)
* @return Call<IdentityVerificationAutofillCreateResponse>
*
* @see Create autofill for an Identity Verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("identity_verification/autofill/create")
Call identityVerificationAutofillCreate(
@retrofit2.http.Body IdentityVerificationAutofillCreateRequest identityVerificationAutofillCreateRequest
);
/**
* Create a new Identity Verification
* Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
* @param identityVerificationCreateRequest (required)
* @return Call<IdentityVerificationCreateResponse>
*
* @see Create a new Identity Verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("identity_verification/create")
Call identityVerificationCreate(
@retrofit2.http.Body IdentityVerificationCreateRequest identityVerificationCreateRequest
);
/**
* Retrieve Identity Verification
* Retrieve a previously created Identity Verification.
* @param identityVerificationGetRequest (required)
* @return Call<IdentityVerificationGetResponse>
*
* @see Retrieve Identity Verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("identity_verification/get")
Call identityVerificationGet(
@retrofit2.http.Body IdentityVerificationGetRequest identityVerificationGetRequest
);
/**
* List Identity Verifications
* Filter and list Identity Verifications created by your account
* @param identityVerificationListRequest (required)
* @return Call<IdentityVerificationListResponse>
*
* @see List Identity Verifications Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("identity_verification/list")
Call identityVerificationList(
@retrofit2.http.Body IdentityVerificationListRequest identityVerificationListRequest
);
/**
* Retry an Identity Verification
* Allow a customer to retry their Identity Verification
* @param identityVerificationRetryRequest (required)
* @return Call<IdentityVerificationRetryResponse>
*
* @see Retry an Identity Verification Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("identity_verification/retry")
Call identityVerificationRetry(
@retrofit2.http.Body IdentityVerificationRetryRequest identityVerificationRetryRequest
);
/**
* (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.
* @param incomeVerificationCreateRequest (required)
* @return Call<IncomeVerificationCreateResponse>
* @deprecated
*
* @see (Deprecated) Create an income verification instance Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("income/verification/create")
Call incomeVerificationCreate(
@retrofit2.http.Body IncomeVerificationCreateRequest incomeVerificationCreateRequest
);
/**
* (Deprecated) 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 a 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.
* @param incomeVerificationDocumentsDownloadRequest (required)
* @return Call<ResponseBody>
* @deprecated
*
* @see (Deprecated) Download the original documents used for income verification Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("income/verification/documents/download")
Call incomeVerificationDocumentsDownload(
@retrofit2.http.Body IncomeVerificationDocumentsDownloadRequest incomeVerificationDocumentsDownloadRequest
);
/**
* (Deprecated) 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. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
* @param incomeVerificationPaystubsGetRequest (required)
* @return Call<IncomeVerificationPaystubsGetResponse>
* @deprecated
*
* @see (Deprecated) Retrieve information from the paystubs used for income verification Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("income/verification/paystubs/get")
Call incomeVerificationPaystubsGet(
@retrofit2.http.Body IncomeVerificationPaystubsGetRequest incomeVerificationPaystubsGetRequest
);
/**
* (Deprecated) Check digital income verification eligibility and optimize conversion
* `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead.
* @param incomeVerificationPrecheckRequest (required)
* @return Call<IncomeVerificationPrecheckResponse>
* @deprecated
*
* @see (Deprecated) Check digital income verification eligibility and optimize conversion Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("income/verification/precheck")
Call incomeVerificationPrecheck(
@retrofit2.http.Body IncomeVerificationPrecheckRequest incomeVerificationPrecheckRequest
);
/**
* (Deprecated) Retrieve information from the tax documents used for income verification
* `/income/verification/taxforms/get` returns the information collected from forms 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. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
* @param incomeVerificationTaxformsGetRequest (required)
* @return Call<IncomeVerificationTaxformsGetResponse>
* @deprecated
*
* @see (Deprecated) Retrieve information from the tax documents used for income verification Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("income/verification/taxforms/get")
Call incomeVerificationTaxformsGet(
@retrofit2.http.Body IncomeVerificationTaxformsGetRequest incomeVerificationTaxformsGetRequest
);
/**
* 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.
* @param institutionsGetRequest (required)
* @return Call<InstitutionsGetResponse>
*
* @see Get details of all supported institutions Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("institutions/get")
Call institutionsGet(
@retrofit2.http.Body InstitutionsGetRequest institutionsGetRequest
);
/**
* Get details of an institution
* Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
* @param institutionsGetByIdRequest (required)
* @return Call<InstitutionsGetByIdResponse>
*
* @see Get details of an institution Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("institutions/get_by_id")
Call institutionsGetById(
@retrofit2.http.Body InstitutionsGetByIdRequest institutionsGetByIdRequest
);
/**
* Search institutions
* Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
* @param institutionsSearchRequest (required)
* @return Call<InstitutionsSearchResponse>
*
* @see Search institutions Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("institutions/search")
Call institutionsSearch(
@retrofit2.http.Body InstitutionsSearchRequest institutionsSearchRequest
);
/**
* Get data needed to authorize an investments transfer
* The `/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings
* @param investmentsAuthGetRequest (required)
* @return Call<InvestmentsAuthGetResponse>
*
* @see Get data needed to authorize an investments transfer Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("investments/auth/get")
Call investmentsAuthGet(
@retrofit2.http.Body InvestmentsAuthGetRequest investmentsAuthGetRequest
);
/**
* Get Investment holdings
* The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
* @param investmentsHoldingsGetRequest (required)
* @return Call<InvestmentsHoldingsGetResponse>
*
* @see Get Investment holdings Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("investments/holdings/get")
Call investmentsHoldingsGet(
@retrofit2.http.Body InvestmentsHoldingsGetRequest investmentsHoldingsGetRequest
);
/**
* Refresh investment data
* `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. \"Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
* @param investmentsRefreshRequest (required)
* @return Call<InvestmentsRefreshResponse>
*
* @see Refresh investment data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("investments/refresh")
Call investmentsRefresh(
@retrofit2.http.Body InvestmentsRefreshRequest investmentsRefreshRequest
);
/**
* Get investment transactions
* The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of 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. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the `async_update` option). Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when `async_update` is set to true) may not be immediately available to `/investments/transactions/get`. To be alerted when the data is ready to be fetched, listen for the `HISTORICAL_UPDATE` webhook. If no investments history is ready when `/investments/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
* @param investmentsTransactionsGetRequest (required)
* @return Call<InvestmentsTransactionsGetResponse>
*
* @see Get investment transactions Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("investments/transactions/get")
Call investmentsTransactionsGet(
@retrofit2.http.Body InvestmentsTransactionsGetRequest investmentsTransactionsGetRequest
);
/**
* 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`.
* @param itemAccessTokenInvalidateRequest (required)
* @return Call<ItemAccessTokenInvalidateResponse>
*
* @see Invalidate access_token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/access_token/invalidate")
Call itemAccessTokenInvalidate(
@retrofit2.http.Body ItemAccessTokenInvalidateRequest itemAccessTokenInvalidateRequest
);
/**
* List a historical log of user consent events
* List a historical log of user consent events
* @param itemActivityListRequest (required)
* @return Call<ItemActivityListResponse>
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/activity/list")
Call itemActivityList(
@retrofit2.http.Body ItemActivityListRequest itemActivityListRequest
);
/**
* List a user’s connected applications
* List a user’s connected applications
* @param itemApplicationListRequest (required)
* @return Call<ItemApplicationListResponse>
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/application/list")
Call itemApplicationList(
@retrofit2.http.Body ItemApplicationListRequest itemApplicationListRequest
);
/**
* Update the scopes of access for a particular application
* Enable consumers to update product access on selected accounts for an application.
* @param itemApplicationScopesUpdateRequest (required)
* @return Call<ItemApplicationScopesUpdateResponse>
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/application/scopes/update")
Call itemApplicationScopesUpdate(
@retrofit2.http.Body ItemApplicationScopesUpdateRequest itemApplicationScopesUpdateRequest
);
/**
* Unlink a user’s connected application
* Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.
* @param itemApplicationUnlinkRequest (required)
* @return Call<ItemApplicationUnlinkResponse>
*
* @see Unlink a user’s connected application Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/application/unlink")
Call itemApplicationUnlink(
@retrofit2.http.Body ItemApplicationUnlinkRequest itemApplicationUnlinkRequest
);
/**
* 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.
* @param itemPublicTokenCreateRequest (required)
* @return Call<ItemPublicTokenCreateResponse>
*
* @see Create public token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/public_token/create")
Call itemCreatePublicToken(
@retrofit2.http.Body ItemPublicTokenCreateRequest itemPublicTokenCreateRequest
);
/**
* Retrieve an Item
* Returns information about the status of an Item.
* @param itemGetRequest (required)
* @return Call<ItemGetResponse>
*
* @see Retrieve an Item Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/get")
Call itemGet(
@retrofit2.http.Body ItemGetRequest itemGetRequest
);
/**
* 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.
* @param itemImportRequest (required)
* @return Call<ItemImportResponse>
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/import")
Call itemImport(
@retrofit2.http.Body ItemImportRequest itemImportRequest
);
/**
* 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. An `access_token` does not expire, but can be revoked by calling `/item/remove`. 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.
* @param itemPublicTokenExchangeRequest (required)
* @return Call<ItemPublicTokenExchangeResponse>
*
* @see Exchange public token for an access token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/public_token/exchange")
Call itemPublicTokenExchange(
@retrofit2.http.Body ItemPublicTokenExchangeRequest itemPublicTokenExchangeRequest
);
/**
* Remove an Item
* The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. 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. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
* @param itemRemoveRequest (required)
* @return Call<ItemRemoveResponse>
*
* @see Remove an Item Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/remove")
Call itemRemove(
@retrofit2.http.Body ItemRemoveRequest itemRemoveRequest
);
/**
* 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/items/#webhook_update_acknowledged) webhook to the newly specified webhook URL.
* @param itemWebhookUpdateRequest (required)
* @return Call<ItemWebhookUpdateResponse>
*
* @see Update Webhook URL Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("item/webhook/update")
Call itemWebhookUpdate(
@retrofit2.http.Body ItemWebhookUpdateRequest itemWebhookUpdateRequest
);
/**
* 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.
* @param liabilitiesGetRequest (required)
* @return Call<LiabilitiesGetResponse>
*
* @see Retrieve Liabilities data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("liabilities/get")
Call liabilitiesGet(
@retrofit2.http.Body LiabilitiesGetRequest liabilitiesGetRequest
);
/**
* Create Hosted Link session
* Use the `/link_delivery/create` endpoint to create a Hosted Link session.
* @param linkDeliveryCreateRequest (required)
* @return Call<LinkDeliveryCreateResponse>
*
* @see Create Hosted Link session Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("link_delivery/create")
Call linkDeliveryCreate(
@retrofit2.http.Body LinkDeliveryCreateRequest linkDeliveryCreateRequest
);
/**
* Get Hosted Link session
* Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session.
* @param linkDeliveryGetRequest (required)
* @return Call<LinkDeliveryGetResponse>
*
* @see Get Hosted Link session Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("link_delivery/get")
Call linkDeliveryGet(
@retrofit2.http.Body LinkDeliveryGetRequest linkDeliveryGetRequest
);
/**
* Exchange the Link Correlation Id for a Link Token
* Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for 'payment_initiation' products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the 'link_token'.
* @param linkOAuthCorrelationIdExchangeRequest (required)
* @return Call<LinkOAuthCorrelationIdExchangeResponse>
*
* @see Exchange the Link Correlation Id for a Link Token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("link/oauth/correlation_id/exchange")
Call linkOauthCorrelationIdExchange(
@retrofit2.http.Body LinkOAuthCorrelationIdExchangeRequest linkOAuthCorrelationIdExchangeRequest
);
/**
* 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.
* @param linkTokenCreateRequest (required)
* @return Call<LinkTokenCreateResponse>
*
* @see Create Link Token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("link/token/create")
Call linkTokenCreate(
@retrofit2.http.Body LinkTokenCreateRequest linkTokenCreateRequest
);
/**
* 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.
* @param linkTokenGetRequest (required)
* @return Call<LinkTokenGetResponse>
*
* @see Get Link Token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("link/token/get")
Call linkTokenGet(
@retrofit2.http.Body LinkTokenGetRequest linkTokenGetRequest
);
/**
* Creates a new end customer for a Plaid reseller.
* The `/partner/customer/create` endpoint is used by reseller partners to create end customers.
* @param partnerCustomerCreateRequest (required)
* @return Call<PartnerCustomerCreateResponse>
*
* @see Creates a new end customer for a Plaid reseller. Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("partner/customer/create")
Call partnerCustomerCreate(
@retrofit2.http.Body PartnerCustomerCreateRequest partnerCustomerCreateRequest
);
/**
* Enables a Plaid reseller's end customer in the Production environment.
* The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment.
* @param partnerCustomerEnableRequest (required)
* @return Call<PartnerCustomerEnableResponse>
*
* @see Enables a Plaid reseller's end customer in the Production environment. Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("partner/customer/enable")
Call partnerCustomerEnable(
@retrofit2.http.Body PartnerCustomerEnableRequest partnerCustomerEnableRequest
);
/**
* Returns a Plaid reseller's end customer.
* The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer.
* @param partnerCustomerGetRequest (required)
* @return Call<PartnerCustomerGetResponse>
*
* @see Returns a Plaid reseller's end customer. Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("partner/customer/get")
Call partnerCustomerGet(
@retrofit2.http.Body PartnerCustomerGetRequest partnerCustomerGetRequest
);
/**
* Returns OAuth-institution registration information for a given end customer.
* The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn how to set up a webhook to listen to status update events, visit the [reseller documentation](https://plaid.com/docs/account/resellers/#enabling-end-customers).
* @param partnerCustomerOAuthInstitutionsGetRequest (required)
* @return Call<PartnerCustomerOAuthInstitutionsGetResponse>
*
* @see Returns OAuth-institution registration information for a given end customer. Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("partner/customer/oauth_institutions/get")
Call partnerCustomerOauthInstitutionsGet(
@retrofit2.http.Body PartnerCustomerOAuthInstitutionsGetRequest partnerCustomerOAuthInstitutionsGetRequest
);
/**
* Removes a Plaid reseller's end customer.
* The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production.
* @param partnerCustomerRemoveRequest (required)
* @return Call<PartnerCustomerRemoveResponse>
*
* @see Removes a Plaid reseller's end customer. Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("partner/customer/remove")
Call partnerCustomerRemove(
@retrofit2.http.Body PartnerCustomerRemoveRequest partnerCustomerRemoveRequest
);
/**
* Create payment consent
* The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with `UNAUTHORISED` status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments.
* @param paymentInitiationConsentCreateRequest (required)
* @return Call<PaymentInitiationConsentCreateResponse>
*
* @see Create payment consent Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/consent/create")
Call paymentInitiationConsentCreate(
@retrofit2.http.Body PaymentInitiationConsentCreateRequest paymentInitiationConsentCreateRequest
);
/**
* Get payment consent
* The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.
* @param paymentInitiationConsentGetRequest (required)
* @return Call<PaymentInitiationConsentGetResponse>
*
* @see Get payment consent Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/consent/get")
Call paymentInitiationConsentGet(
@retrofit2.http.Body PaymentInitiationConsentGetRequest paymentInitiationConsentGetRequest
);
/**
* Execute a single payment using consent
* The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent.
* @param paymentInitiationConsentPaymentExecuteRequest (required)
* @return Call<PaymentInitiationConsentPaymentExecuteResponse>
*
* @see Execute a single payment using consent Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/consent/payment/execute")
Call paymentInitiationConsentPaymentExecute(
@retrofit2.http.Body PaymentInitiationConsentPaymentExecuteRequest paymentInitiationConsentPaymentExecuteRequest
);
/**
* Revoke payment consent
* The `/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it.
* @param paymentInitiationConsentRevokeRequest (required)
* @return Call<PaymentInitiationConsentRevokeResponse>
*
* @see Revoke payment consent Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/consent/revoke")
Call paymentInitiationConsentRevoke(
@retrofit2.http.Body PaymentInitiationConsentRevokeRequest paymentInitiationConsentRevokeRequest
);
/**
* 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, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). 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, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, 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 or other local payment schemes 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 or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
* @param paymentInitiationPaymentCreateRequest (required)
* @return Call<PaymentInitiationPaymentCreateResponse>
*
* @see Create a payment Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/payment/create")
Call paymentInitiationPaymentCreate(
@retrofit2.http.Body PaymentInitiationPaymentCreateRequest paymentInitiationPaymentCreateRequest
);
/**
* 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.
* @param paymentInitiationPaymentGetRequest (required)
* @return Call<PaymentInitiationPaymentGetResponse>
*
* @see Get payment details Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/payment/get")
Call paymentInitiationPaymentGet(
@retrofit2.http.Body PaymentInitiationPaymentGetRequest paymentInitiationPaymentGetRequest
);
/**
* 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.
* @param paymentInitiationPaymentListRequest (required)
* @return Call<PaymentInitiationPaymentListResponse>
*
* @see List payments Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/payment/list")
Call paymentInitiationPaymentList(
@retrofit2.http.Body PaymentInitiationPaymentListRequest paymentInitiationPaymentListRequest
);
/**
* Reverse an existing payment
* Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
* @param paymentInitiationPaymentReverseRequest (required)
* @return Call<PaymentInitiationPaymentReverseResponse>
*
* @see Reverse an existing payment Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/payment/reverse")
Call paymentInitiationPaymentReverse(
@retrofit2.http.Body PaymentInitiationPaymentReverseRequest paymentInitiationPaymentReverseRequest
);
/**
* 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) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
* @param paymentInitiationRecipientCreateRequest (required)
* @return Call<PaymentInitiationRecipientCreateResponse>
*
* @see Create payment recipient Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/recipient/create")
Call paymentInitiationRecipientCreate(
@retrofit2.http.Body PaymentInitiationRecipientCreateRequest paymentInitiationRecipientCreateRequest
);
/**
* Get payment recipient
* Get details about a payment recipient you have previously created.
* @param paymentInitiationRecipientGetRequest (required)
* @return Call<PaymentInitiationRecipientGetResponse>
*
* @see Get payment recipient Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/recipient/get")
Call paymentInitiationRecipientGet(
@retrofit2.http.Body PaymentInitiationRecipientGetRequest paymentInitiationRecipientGetRequest
);
/**
* List payment recipients
* The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
* @param paymentInitiationRecipientListRequest (required)
* @return Call<PaymentInitiationRecipientListResponse>
*
* @see List payment recipients Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("payment_initiation/recipient/list")
Call paymentInitiationRecipientList(
@retrofit2.http.Body PaymentInitiationRecipientListRequest paymentInitiationRecipientListRequest
);
/**
* Create payment profile
* Use `/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_token` in the `transfer.payment_profile_token` field. You can then use the `payment_profile_token` when creating transfers using `/transfer/authorization/create` and `/transfer/create`.
* @param paymentProfileCreateRequest (required)
* @return Call<PaymentProfileCreateResponse>
* @deprecated
*
* @see Create payment profile Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("payment_profile/create")
Call paymentProfileCreate(
@retrofit2.http.Body PaymentProfileCreateRequest paymentProfileCreateRequest
);
/**
* Get payment profile
* Use `/payment_profile/get` endpoint to get the status of a given Payment Profile.
* @param paymentProfileGetRequest (required)
* @return Call<PaymentProfileGetResponse>
* @deprecated
*
* @see Get payment profile Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("payment_profile/get")
Call paymentProfileGet(
@retrofit2.http.Body PaymentProfileGetRequest paymentProfileGetRequest
);
/**
* Remove payment profile
* Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.
* @param paymentProfileRemoveRequest (required)
* @return Call<PaymentProfileRemoveResponse>
* @deprecated
*
* @see Remove payment profile Documentation
*/
@Deprecated
@Headers({
"Content-Type:application/json"
})
@POST("payment_profile/remove")
Call paymentProfileRemove(
@retrofit2.http.Body PaymentProfileRemoveRequest paymentProfileRemoveRequest
);
/**
* Retrieve the account associated with a processor token
* This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use `/processor/balance/get` instead. Note that some information is nullable.
* @param processorAccountGetRequest (required)
* @return Call<ProcessorAccountGetResponse>
*
* @see Retrieve the account associated with a processor token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/account/get")
Call processorAccountGet(
@retrofit2.http.Body ProcessorAccountGetRequest processorAccountGetRequest
);
/**
* Create Apex bank account token
* Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
* @param processorApexProcessorTokenCreateRequest (required)
* @return Call<ProcessorTokenCreateResponse>
*
* @see Create Apex bank account token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/apex/processor_token/create")
Call processorApexProcessorTokenCreate(
@retrofit2.http.Body ProcessorApexProcessorTokenCreateRequest processorApexProcessorTokenCreateRequest
);
/**
* 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. Versioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).
* @param processorAuthGetRequest (required)
* @return Call<ProcessorAuthGetResponse>
*
* @see Retrieve Auth data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/auth/get")
Call processorAuthGet(
@retrofit2.http.Body ProcessorAuthGetRequest processorAuthGetRequest
);
/**
* 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.
* @param 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)
* @return Call<ProcessorBalanceGetResponse>
*
* @see Retrieve Balance data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/balance/get")
Call processorBalanceGet(
@retrofit2.http.Body ProcessorBalanceGetRequest processorBalanceGetRequest
);
/**
* Create a bank transfer as a processor
* Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
* @param processorBankTransferCreateRequest (required)
* @return Call<ProcessorBankTransferCreateResponse>
*
* @see Create a bank transfer as a processor Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/bank_transfer/create")
Call processorBankTransferCreate(
@retrofit2.http.Body ProcessorBankTransferCreateRequest processorBankTransferCreateRequest
);
/**
* 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.
* @param processorIdentityGetRequest (required)
* @return Call<ProcessorIdentityGetResponse>
*
* @see Retrieve Identity data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/identity/get")
Call processorIdentityGet(
@retrofit2.http.Body ProcessorIdentityGetRequest processorIdentityGetRequest
);
/**
* Retrieve identity match score
* The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. 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.
* @param processorIdentityMatchRequest (required)
* @return Call<ProcessorIdentityMatchResponse>
*
* @see Retrieve identity match score Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/identity/match")
Call processorIdentityMatch(
@retrofit2.http.Body ProcessorIdentityMatchRequest processorIdentityMatchRequest
);
/**
* Retrieve Liabilities data
* The `/processor/liabilities/get` endpoint returns various details about a loan or credit account. 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`. 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 `/processor/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the processor token. This is because Plaid must communicate directly with the institution to retrieve the additional data.
* @param processorLiabilitiesGetRequest (required)
* @return Call<ProcessorLiabilitiesGetResponse>
*
* @see Retrieve Liabilities data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/liabilities/get")
Call processorLiabilitiesGet(
@retrofit2.http.Body ProcessorLiabilitiesGetRequest processorLiabilitiesGetRequest
);
/**
* Report whether you initiated an ACH transaction
* After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.
* @param processorSignalDecisionReportRequest (required)
* @return Call<ProcessorSignalDecisionReportResponse>
*
* @see Report whether you initiated an ACH transaction Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/signal/decision/report")
Call processorSignalDecisionReport(
@retrofit2.http.Body ProcessorSignalDecisionReportRequest processorSignalDecisionReportRequest
);
/**
* Evaluate a planned ACH transaction
* Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor 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. If `/processor/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. To reduce this latency, you can call `/signal/prepare` on the Item before you need to request Signal data.
* @param processorSignalEvaluateRequest (required)
* @return Call<ProcessorSignalEvaluateResponse>
*
* @see Evaluate a planned ACH transaction Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/signal/evaluate")
Call processorSignalEvaluate(
@retrofit2.http.Body ProcessorSignalEvaluateRequest processorSignalEvaluateRequest
);
/**
* Opt-in a processor token to Signal
* When a processor token is not initialized with Signal, call `/processor/signal/prepare` to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score. If this endpoint is called with a processor token that is already initialized with Signal, it will return a 200 response and will not modify the processor token.
* @param processorSignalPrepareRequest (required)
* @return Call<ProcessorSignalPrepareResponse>
*
* @see Opt-in a processor token to Signal Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/signal/prepare")
Call processorSignalPrepare(
@retrofit2.http.Body ProcessorSignalPrepareRequest processorSignalPrepareRequest
);
/**
* Report a return for an ACH transaction
* Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.
* @param processorSignalReturnReportRequest (required)
* @return Call<ProcessorSignalReturnReportResponse>
*
* @see Report a return for an ACH transaction Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/signal/return/report")
Call processorSignalReturnReport(
@retrofit2.http.Body ProcessorSignalReturnReportRequest processorSignalReturnReportRequest
);
/**
* 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/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.
* @param processorStripeBankAccountTokenCreateRequest (required)
* @return Call<ProcessorStripeBankAccountTokenCreateResponse>
*
* @see Create Stripe bank account token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/stripe/bank_account_token/create")
Call processorStripeBankAccountTokenCreate(
@retrofit2.http.Body ProcessorStripeBankAccountTokenCreateRequest processorStripeBankAccountTokenCreateRequest
);
/**
* 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. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`.
* @param processorTokenCreateRequest (required)
* @return Call<ProcessorTokenCreateResponse>
*
* @see Create processor token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/token/create")
Call processorTokenCreate(
@retrofit2.http.Body ProcessorTokenCreateRequest processorTokenCreateRequest
);
/**
* Get a processor token's product permissions
* Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products.
* @param processorTokenPermissionsGetRequest (required)
* @return Call<ProcessorTokenPermissionsGetResponse>
*
* @see Get a processor token's product permissions Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/token/permissions/get")
Call processorTokenPermissionsGet(
@retrofit2.http.Body ProcessorTokenPermissionsGetRequest processorTokenPermissionsGetRequest
);
/**
* Control a processor's access to products
* Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change.
* @param processorTokenPermissionsSetRequest (required)
* @return Call<ProcessorTokenPermissionsSetResponse>
*
* @see Control a processor's access to products Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/token/permissions/set")
Call processorTokenPermissionsSet(
@retrofit2.http.Body ProcessorTokenPermissionsSetRequest processorTokenPermissionsSetRequest
);
/**
* Update a processor token's webhook URL
* This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL.
* @param processorTokenWebhookUpdateRequest (required)
* @return Call<ProcessorTokenWebhookUpdateResponse>
*
* @see Update a processor token's webhook URL Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/token/webhook/update")
Call processorTokenWebhookUpdate(
@retrofit2.http.Body ProcessorTokenWebhookUpdateRequest processorTokenWebhookUpdateRequest
);
/**
* Get transaction data
* The `/processor/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). 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 `/processor/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 a processor token, 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 `/processor/transactions/get` will be the data available for the processor token 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. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
* @param processorTransactionsGetRequest (required)
* @return Call<ProcessorTransactionsGetResponse>
*
* @see Get transaction data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/transactions/get")
Call processorTransactionsGet(
@retrofit2.http.Body ProcessorTransactionsGetRequest processorTransactionsGetRequest
);
/**
* Fetch recurring transaction streams
* The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
* @param processorTransactionsRecurringGetRequest (required)
* @return Call<ProcessorTransactionsRecurringGetResponse>
*
* @see Fetch recurring transaction streams Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/transactions/recurring/get")
Call processorTransactionsRecurringGet(
@retrofit2.http.Body ProcessorTransactionsRecurringGetRequest processorTransactionsRecurringGetRequest
);
/**
* Refresh transaction data
* `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on a processor token from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
* @param processorTransactionsRefreshRequest (required)
* @return Call<ProcessorTransactionsRefreshResponse>
*
* @see Refresh transaction data Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/transactions/refresh")
Call processorTransactionsRefresh(
@retrofit2.http.Body ProcessorTransactionsRefreshRequest processorTransactionsRefreshRequest
);
/**
* Get incremental transaction updates on a processor token
* This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases. The `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides 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 `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/processor/transactions/sync` for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that processor token. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with a processor token, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/processor/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update, which can occur as a result of the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/processor/transactions/sync` will provide these updates. 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. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. Note that for newly created processor tokens, data may not be immediately available to `/processor/transactions/sync`. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
* @param processorTransactionsSyncRequest (required)
* @return Call<ProcessorTransactionsSyncResponse>
*
* @see Get incremental transaction updates on a processor token Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("processor/transactions/sync")
Call processorTransactionsSync(
@retrofit2.http.Body ProcessorTransactionsSyncRequest processorTransactionsSyncRequest
);
/**
* Retrieve a Profile
* Returns user permissioned profile data including identity and item access tokens.
* @param profileGetRequest (required)
* @return Call<ProfileGetResponse>
*
* @see Retrieve a Profile Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("profile/get")
Call profileGet(
@retrofit2.http.Body ProfileGetRequest profileGetRequest
);
/**
* Manually fire a bank income webhook in sandbox
* Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
* @param sandboxBankIncomeFireWebhookRequest (required)
* @return Call<SandboxBankIncomeFireWebhookResponse>
*
* @see Manually fire a bank income webhook in sandbox Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("sandbox/bank_income/fire_webhook")
Call sandboxBankIncomeFireWebhook(
@retrofit2.http.Body SandboxBankIncomeFireWebhookRequest sandboxBankIncomeFireWebhookRequest
);
/**
* 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.
* @param sandboxBankTransferFireWebhookRequest (required)
* @return Call<SandboxBankTransferFireWebhookResponse>
*
* @see Manually fire a Bank Transfer webhook Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("sandbox/bank_transfer/fire_webhook")
Call sandboxBankTransferFireWebhook(
@retrofit2.http.Body SandboxBankTransferFireWebhookRequest sandboxBankTransferFireWebhookRequest
);
/**
* 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.
* @param sandboxBankTransferSimulateRequest (required)
* @return Call<SandboxBankTransferSimulateResponse>
*
* @see Simulate a bank transfer event in Sandbox Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("sandbox/bank_transfer/simulate")
Call sandboxBankTransferSimulate(
@retrofit2.http.Body SandboxBankTransferSimulateRequest sandboxBankTransferSimulateRequest
);
/**
* Manually fire an Income webhook
* Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
* @param sandboxIncomeFireWebhookRequest (required)
* @return Call<SandboxIncomeFireWebhookResponse>
*
* @see Manually fire an Income webhook Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("sandbox/income/fire_webhook")
Call sandboxIncomeFireWebhook(
@retrofit2.http.Body SandboxIncomeFireWebhookRequest sandboxIncomeFireWebhookRequest
);
/**
* Fire a test webhook
* The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions 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. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development (except for webhooks of type `TRANSFER`).
* @param sandboxItemFireWebhookRequest (required)
* @return Call<SandboxItemFireWebhookResponse>
*
* @see Fire a test webhook Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("sandbox/item/fire_webhook")
Call sandboxItemFireWebhook(
@retrofit2.http.Body SandboxItemFireWebhookRequest sandboxItemFireWebhookRequest
);
/**
* 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.
* @param sandboxItemResetLoginRequest (required)
* @return Call<SandboxItemResetLoginResponse>
*
* @see Force a Sandbox Item into an error state Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("sandbox/item/reset_login")
Call sandboxItemResetLogin(
@retrofit2.http.Body SandboxItemResetLoginRequest sandboxItemResetLoginRequest
);
/**
* 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. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
* @param sandboxItemSetVerificationStatusRequest (required)
* @return Call<SandboxItemSetVerificationStatusResponse>
*
* @see Set verification status for Sandbox account Documentation
*/
@Headers({
"Content-Type:application/json"
})
@POST("sandbox/item/set_verification_status")
Call sandboxItemSetVerificationStatus(
@retrofit2.http.Body SandboxItemSetVerificationStatusRequest sandboxItemSetVerificationStatusRequest
);
/**
* Save the selected accounts when connecting to the Platypus Oauth institution
* Save the selected accounts when connecting to the Platypus Oauth institution
* @param sandboxOauthSelectAccountsRequest (required)
* @return Call<Object>
*/
@Headers({
"Content-Type:application/json"
})
@POST("sandbox/oauth/select_accounts")
Call