# Fluz: English API reference ## API reference ### API reference - [API overview](https://docs.fluz.app/api-reference/overview.md): Endpoints, request format, and how to read responses from the Fluz GraphQL API. #### Queries - [approvalRequests](https://docs.fluz.app/api-reference/queries/approval-requests.md): Lists open approval requests for the caller's account. - [authorizedUsers](https://docs.fluz.app/api-reference/queries/authorized-users.md): List authorized users on the caller's account. - [erpChartOfAccounts](https://docs.fluz.app/api-reference/queries/erp-chart-of-accounts.md): The imported chart of accounts for the account's connected ERP provider. - [erpCustomers](https://docs.fluz.app/api-reference/queries/erp-customers.md): The imported customers for the account's connected ERP provider. - [erpTransactionMetadata](https://docs.fluz.app/api-reference/queries/erp-transaction-metadata.md): The ERP metadata for a single transaction. - [erpTransactionMetadataList](https://docs.fluz.app/api-reference/queries/erp-transaction-metadata-list.md): ERP metadata across transactions, filterable by sync status / last-updated time. - [erpVendors](https://docs.fluz.app/api-reference/queries/erp-vendors.md): The imported vendors for the account's connected ERP provider. - [getAccountsByUserId](https://docs.fluz.app/api-reference/queries/get-accounts-by-user-id.md): Get all the accounts information for the User using 'Basic '. - [getApplicationScopes](https://docs.fluz.app/api-reference/queries/get-application-scopes.md): Get the allowed scopes of the application using 'Basic '. - [getApplicationUsers](https://docs.fluz.app/api-reference/queries/get-application-users.md): Get the users who have granted scopes to the application using 'Basic '. - [getBulkBalances](https://docs.fluz.app/api-reference/queries/get-bulk-balances.md): Get cash balances across up to 100 connected users in one call, using 'Basic '. - [getBulkConnectedOAuthUsers](https://docs.fluz.app/api-reference/queries/get-bulk-connected-oauth-users.md): List the users connected to your application through active OAuth grants, using 'Basic '. - [getBulkOperationItems](https://docs.fluz.app/api-reference/queries/get-bulk-operation-items.md): Get the per-target results of one of your bulk jobs, using 'Basic '. - [getBulkOperationJob](https://docs.fluz.app/api-reference/queries/get-bulk-operation-job.md): Get the status and counters of one of your bulk jobs, using 'Basic '. - [getBulkTransactions](https://docs.fluz.app/api-reference/queries/get-bulk-transactions.md): Get transactions across up to 1,000 connected users in one call, using 'Basic '. - [getBusiness](https://docs.fluz.app/api-reference/queries/get-business.md): Returns KYB status and owner verification snapshots for the business linked to the token's accountId. - [getBusinessCategories](https://docs.fluz.app/api-reference/queries/get-business-categories.md): Query for listing all active business categories with their sub-categories. - [getCardProvisioningUrl](https://docs.fluz.app/api-reference/queries/get-card-provisioning-url.md): Returns a short URL that, when opened on the end-user's mobile device, launches the Fluz App Clip (iOS) or Fluz app (Android) and adds the specified virtual card to Apple Pay / Google Pay. - [getDeclinedTransactions](https://docs.fluz.app/api-reference/queries/get-declined-transactions.md): Retrieves paginated declined transaction history for the authenticated user's account. - [getDefaultFundingSource](https://docs.fluz.app/api-reference/queries/get-default-funding-source.md): getDefaultFundingSource returns the account's current primary (bank account) and backup (bank card) funding sources. - [getGiftCards](https://docs.fluz.app/api-reference/queries/get-gift-cards.md): Retrieves the user's gift cards. - [getMccList](https://docs.fluz.app/api-reference/queries/get-mcc-list.md): Query for listing merchant category codes. - [getMerchantCategories](https://docs.fluz.app/api-reference/queries/get-merchant-categories.md): Get the merchant categories. - [getMerchants](https://docs.fluz.app/api-reference/queries/get-merchants.md): Get the active merchant catalog. - [getOfferQuote](https://docs.fluz.app/api-reference/queries/get-offer-quote.md): Get the best offer for merchant based on matching arguments. - [getPlaidBankAccountBalance](https://docs.fluz.app/api-reference/queries/get-plaid-bank-account-balance.md): Gets the latest stored safe Plaid balance for one owned bank account. - [getPlaidBankAccountSpendPower](https://docs.fluz.app/api-reference/queries/get-plaid-bank-account-spend-power.md): Gets the latest safe spend power for one owned Plaid bank account. - [getPlaidBankAccounts](https://docs.fluz.app/api-reference/queries/get-plaid-bank-accounts.md): Lists safe Plaid bank accounts owned by the authenticated account. - [getPlaidBankBalances](https://docs.fluz.app/api-reference/queries/get-plaid-bank-balances.md): Lists latest stored safe Plaid balances owned by the authenticated account. - [getPlaidBankTransactions](https://docs.fluz.app/api-reference/queries/get-plaid-bank-transactions.md): Lists historical bank transactions populated by identity-service from Plaid. - [getPlaidIntegration](https://docs.fluz.app/api-reference/queries/get-plaid-integration.md): Returns the application's Plaid integration, or null when none was registered. - [getReferralUrl](https://docs.fluz.app/api-reference/queries/get-referral-url.md): Get the referral url for a merchant. - [getSpendAccountPaycheckDepositForm](https://docs.fluz.app/api-reference/queries/get-spend-account-paycheck-deposit-form.md): Retrieves a PDF paycheck direct-deposit form for a virtual account number belonging to a spend account (cash balance) of the authenticated user's account. - [getSpendAccountPaymentInstructions](https://docs.fluz.app/api-reference/queries/get-spend-account-payment-instructions.md): Retrieves a PDF payment instructions artifact (ACH routing + account details) for funding a virtual account number belonging to a spend account (cash balance) of the authenticated user's account. - [getSpendAccountStatusLetter](https://docs.fluz.app/api-reference/queries/get-spend-account-status-letter.md): Retrieves a PDF account status letter for a virtual account number belonging to a spend account (cash balance) of the authenticated user's account. - [getSpendAccountVirtualAccountNumbers](https://docs.fluz.app/api-reference/queries/get-spend-account-virtual-account-numbers.md): Retrieves the active virtual account number(s) for a spend account (cash balance) belonging to the authenticated user's account. - [getTransactions](https://docs.fluz.app/api-reference/queries/get-transactions.md): Retrieves paginated transaction history for the authenticated user's account. - [getUserAddresses](https://docs.fluz.app/api-reference/queries/get-user-addresses.md): getUserAddresses returns the user's addresses. - [getUserCashBalanceById](https://docs.fluz.app/api-reference/queries/get-user-cash-balance-by-id.md): Retrieves a single cash balance by ID for the authenticated user's account. - [getUserCashBalances](https://docs.fluz.app/api-reference/queries/get-user-cash-balances.md): Retrieves paginated list of cash balances for the authenticated user's account. - [getUserPurchases](https://docs.fluz.app/api-reference/queries/get-user-purchases.md): Retrieves the user's purchase history. - [getVCShareLinks](https://docs.fluz.app/api-reference/queries/get-vcshare-links.md): Get list of generated share links. - [getVirtualCardBalance](https://docs.fluz.app/api-reference/queries/get-virtual-card-balance.md): Get balance, status and lock state for multiple virtual cards. - [getVirtualCardBulkOrderStatus](https://docs.fluz.app/api-reference/queries/get-virtual-card-bulk-order-status.md): Checks bulk virtual card order status. - [getVirtualCardOffers](https://docs.fluz.app/api-reference/queries/get-virtual-card-offers.md): Get virtual card offers. - [getVirtualCardTransactions](https://docs.fluz.app/api-reference/queries/get-virtual-card-transactions.md): Get transactions for multiple virtual cards with filters. - [getWallet](https://docs.fluz.app/api-reference/queries/get-wallet.md): getWallet returns the user's wallet balance and payment methods. - [getWithdrawFeeEstimate](https://docs.fluz.app/api-reference/queries/get-withdraw-fee-estimate.md): Estimate the fees for a withdrawal before submitting. - [lookupBusiness](https://docs.fluz.app/api-reference/queries/lookup-business.md): Look up business recipients by company name. - [lookupUser](https://docs.fluz.app/api-reference/queries/lookup-user.md): Look up a user recipient by phone number or email. - [objectChangeHistory](https://docs.fluz.app/api-reference/queries/object-change-history.md): Change history for a virtual card, gift card, spend account, or funding source on the caller's account. #### Mutations - [addAuthorizedUser](https://docs.fluz.app/api-reference/mutations/add-authorized-user.md): Add an authorized user to the caller's account with specified UAC roles. - [addBankCard](https://docs.fluz.app/api-reference/mutations/add-bank-card.md): addBankCard adds a bank card to the user's wallet. - [addVirtualCardAddress](https://docs.fluz.app/api-reference/mutations/add-virtual-card-address.md): Saves a billing address for virtual card issuance. - [approveApprovalRequest](https://docs.fluz.app/api-reference/mutations/approve-approval-request.md): Approves an open approval request through the existing approval link pipeline. - [assignObjectOwner](https://docs.fluz.app/api-reference/mutations/assign-object-owner.md): Assign an owner to an object that does not have one yet. - [assignSupervisor](https://docs.fluz.app/api-reference/mutations/assign-supervisor.md) - [bulkUpdateErpTransactionMetadata](https://docs.fluz.app/api-reference/mutations/bulk-update-erp-transaction-metadata.md): Applies ERP-aware categorization to multiple transactions in one call (max 100 items). - [cancelBulkOperation](https://docs.fluz.app/api-reference/mutations/cancel-bulk-operation.md): Cancel one of your bulk jobs, using 'Basic '. - [closeUserCashBalance](https://docs.fluz.app/api-reference/mutations/close-user-cash-balance.md): Mutation for closing a user cash balance account. - [completePlaidLink](https://docs.fluz.app/api-reference/mutations/complete-plaid-link.md): Completes Plaid Link after the frontend receives publicToken from Plaid Link onSuccess. - [completePlaidRelink](https://docs.fluz.app/api-reference/mutations/complete-plaid-relink.md): Confirm and repopulate a repaired Item using its unchanged access token. - [createPlaidLinkAddress](https://docs.fluz.app/api-reference/mutations/create-plaid-link-address.md): Creates the billing/legal address required after Plaid Link when completePlaidLink returns requiresAddress. - [createPlaidLinkToken](https://docs.fluz.app/api-reference/mutations/create-plaid-link-token.md): Creates a Plaid Link token for new bank linking or relinking an existing Plaid connection. - [createPlaidRelinkToken](https://docs.fluz.app/api-reference/mutations/create-plaid-relink-token.md): Create an update-mode Link token using the existing Item and its original Plaid credentials. - [createTransfer](https://docs.fluz.app/api-reference/mutations/create-transfer.md): Create a transfer between accounts within an application. - [createUserCashBalance](https://docs.fluz.app/api-reference/mutations/create-user-cash-balance.md): Mutation for creating a new user cash balance account. - [createVirtualCard](https://docs.fluz.app/api-reference/mutations/create-virtual-card.md): Initiates virtual card creation. - [createVirtualCardBulkOrder](https://docs.fluz.app/api-reference/mutations/create-virtual-card-bulk-order.md): Initiates bulk virtual card creation. - [deactivateVCShareLinks](https://docs.fluz.app/api-reference/mutations/deactivate-vcshare-links.md): Deactivates share links. - [declineApprovalRequest](https://docs.fluz.app/api-reference/mutations/decline-approval-request.md): Declines an open approval request through the existing approval link pipeline. - [deleteBankCard](https://docs.fluz.app/api-reference/mutations/delete-bank-card.md): deleteBankCard set a bank card's status to INACTIVE. - [depositCashBalance](https://docs.fluz.app/api-reference/mutations/deposit-cash-balance.md): Mutation for depositing into a cash balance. - [disablePlaidIntegration](https://docs.fluz.app/api-reference/mutations/disable-plaid-integration.md): Disables the application's Plaid integration. - [editVirtualCard](https://docs.fluz.app/api-reference/mutations/edit-virtual-card.md): Mutation to edit virtual cards. - [generateUserAccessToken](https://docs.fluz.app/api-reference/mutations/generate-user-access-token.md): Generate a user token using 'Basic '. - [generateVCShareLinks](https://docs.fluz.app/api-reference/mutations/generate-vcshare-links.md): Generates share links. - [lockVirtualCard](https://docs.fluz.app/api-reference/mutations/lock-virtual-card.md): Mutation to lock virtual cards. - [postKycVerification](https://docs.fluz.app/api-reference/mutations/post-kyc-verification.md): Post a decisioned KYC verification result performed by an external identity provider. - [purchaseGiftCard](https://docs.fluz.app/api-reference/mutations/purchase-gift-card.md): Initiates a gift card purchase transaction. - [reassignSupervisor](https://docs.fluz.app/api-reference/mutations/reassign-supervisor.md) - [redeemFluzGiftCard](https://docs.fluz.app/api-reference/mutations/redeem-fluz-gift-card.md): Mutation for redeeming a Fluz Gift Card by code. - [refreshPlaidBankAccountBalance](https://docs.fluz.app/api-reference/mutations/refresh-plaid-bank-account-balance.md): Requests a rate-limited realtime balance refresh for one owned Plaid bank account. - [refreshPlaidBankConnections](https://docs.fluz.app/api-reference/mutations/refresh-plaid-bank-connections.md): Requests a cached data refresh for all connected Plaid institutions owned by the authenticated account. - [refreshUserAccessToken](https://docs.fluz.app/api-reference/mutations/refresh-user-access-token.md): Refresh a user token using 'Basic '. - [registerBusiness](https://docs.fluz.app/api-reference/mutations/register-business.md): Register a new business. - [registerPlaidIntegration](https://docs.fluz.app/api-reference/mutations/register-plaid-integration.md): Registers the application's own Plaid credentials. - [registerUser](https://docs.fluz.app/api-reference/mutations/register-user.md): Registration of a user. - [removeAuthorizedUser](https://docs.fluz.app/api-reference/mutations/remove-authorized-user.md): Remove an authorized user from the caller's account by setting their role assignment to INACTIVE. - [removePlaidBankInstitution](https://docs.fluz.app/api-reference/mutations/remove-plaid-bank-institution.md): Removes a Plaid bank institution and disables its local bank accounts. - [removeSupervisor](https://docs.fluz.app/api-reference/mutations/remove-supervisor.md) - [requestAccountTransfer](https://docs.fluz.app/api-reference/mutations/request-account-transfer.md): Requests manager approval for an account-to-account transfer. - [requestDocumentVerificationLink](https://docs.fluz.app/api-reference/mutations/request-document-verification-link.md): Request verification for a user with provided information - [requestGiftCardPurchase](https://docs.fluz.app/api-reference/mutations/request-gift-card-purchase.md): Requests manager approval to purchase a gift card. - [requestInternalTransfer](https://docs.fluz.app/api-reference/mutations/request-internal-transfer.md): Requests manager approval for an internal transfer. - [requestOwnerDocumentVerificationLink](https://docs.fluz.app/api-reference/mutations/request-owner-document-verification-link.md): Request a document verification link for a business owner on the document path. - [requestReimbursement](https://docs.fluz.app/api-reference/mutations/request-reimbursement.md): Requests manager approval for a reimbursement. - [requestVirtualCard](https://docs.fluz.app/api-reference/mutations/request-virtual-card.md): Requests manager approval to create a virtual card. - [requestVirtualCardLimitChange](https://docs.fluz.app/api-reference/mutations/request-virtual-card-limit-change.md): Requests manager approval to change a virtual card limit. - [revealGiftCardByGiftCardId](https://docs.fluz.app/api-reference/mutations/reveal-gift-card-by-gift-card-id.md): Reveals the Gift Card Code. - [revealVirtualCardByVirtualCardId](https://docs.fluz.app/api-reference/mutations/reveal-virtual-card-by-virtual-card-id.md): Reveals the full card number and CVV of a virtual card, along with its billing details. - [setBackupFundingSource](https://docs.fluz.app/api-reference/mutations/set-backup-funding-source.md): setBackupFundingSource sets a bank card as the account's backup funding source, replacing any previous backup. - [setPrimaryFundingSource](https://docs.fluz.app/api-reference/mutations/set-primary-funding-source.md): setPrimaryFundingSource sets a bank account as the account's primary funding source, replacing any previous primary. - [setVirtualCardPIN](https://docs.fluz.app/api-reference/mutations/set-virtual-card-pin.md): Mutation to set the PIN on eligible virtual cards that have not yet had a PIN set. - [submitBulkOperation](https://docs.fluz.app/api-reference/mutations/submit-bulk-operation.md): Submit an asynchronous bulk operation, using 'Basic '. - [transferInternalBalance](https://docs.fluz.app/api-reference/mutations/transfer-internal-balance.md): Mutation for transferring between user cash balances. - [transferObjectOwner](https://docs.fluz.app/api-reference/mutations/transfer-object-owner.md): Transfer ownership of an existing object to another user on the same account. - [unlockVirtualCard](https://docs.fluz.app/api-reference/mutations/unlock-virtual-card.md): Mutation to unlock a previously locked virtual card. - [updateBankCardNickname](https://docs.fluz.app/api-reference/mutations/update-bank-card-nickname.md): updateBankCardNickname updates the nickname of a bank card. - [updateBankCardPreferredMerchantCategoryCode](https://docs.fluz.app/api-reference/mutations/update-bank-card-preferred-merchant-category-code.md): updateBankCardPreferredMerchantCategoryCode updates the preferred merchant category code (MCC) for a bank card. - [updateTransactionMetadata](https://docs.fluz.app/api-reference/mutations/update-transaction-metadata.md): Updates the memo, category, and/or attachment on an existing transaction. - [updateUserCashBalance](https://docs.fluz.app/api-reference/mutations/update-user-cash-balance.md): Mutation for updating a user cash balance account. - [verifyUserInformation](https://docs.fluz.app/api-reference/mutations/verify-user-information.md): Verify and record a user's personal information. - [verifyUserPrefillInformation](https://docs.fluz.app/api-reference/mutations/verify-user-prefill-information.md): Verify and record a user's personal information using prefilled data already on file. - [withdrawCashBalance](https://docs.fluz.app/api-reference/mutations/withdraw-cash-balance.md): Mutation for withdrawing from a cash balance. #### Types ##### Objects - [Account](https://docs.fluz.app/api-reference/types/account.md): Represents the account operable by the application. - [AddAuthorizedUserResponse](https://docs.fluz.app/api-reference/types/add-authorized-user-response.md): Response returned from the addAuthorizedUser mutation. - [ApplicationUser](https://docs.fluz.app/api-reference/types/application-user.md): Represents the User who grants access to the application with scopes. - [ApprovalRequest](https://docs.fluz.app/api-reference/types/approval-request.md): An open approval request for the caller's account. - [ApprovalRequestActionError](https://docs.fluz.app/api-reference/types/approval-request-action-error.md): Error details returned when an approval action cannot be submitted. - [ApprovalRequestActionResponse](https://docs.fluz.app/api-reference/types/approval-request-action-response.md): Response returned from approve/decline approval request mutations. - [ApprovalRequestApprover](https://docs.fluz.app/api-reference/types/approval-request-approver.md): An approver assigned to an approval request. - [AssignObjectOwnerResponse](https://docs.fluz.app/api-reference/types/assign-object-owner-response.md) - [AuthorizedUser](https://docs.fluz.app/api-reference/types/authorized-user.md): Represents an authorized user on an account. - [AuthorizedUserError](https://docs.fluz.app/api-reference/types/authorized-user-error.md): Error details for authorized user mutation failures. - [BankAccount](https://docs.fluz.app/api-reference/types/bank-account.md): BankAccount is a record of a bank account added by a user. - [BankCard](https://docs.fluz.app/api-reference/types/bank-card.md): BankCard is a record of a bank card added by a user. - [BulkBalances](https://docs.fluz.app/api-reference/types/bulk-balances.md): Balances across your connected users, one result per target. - [BulkBalancesTargetResult](https://docs.fluz.app/api-reference/types/bulk-balances-target-result.md): The result of a bulk balances request for one target user. - [BulkConnectedOAuthUser](https://docs.fluz.app/api-reference/types/bulk-connected-oauth-user.md): A user connected to your application through an active OAuth grant. - [BulkConnectedOAuthUsers](https://docs.fluz.app/api-reference/types/bulk-connected-oauth-users.md): A page of users connected to your application. - [BulkJob](https://docs.fluz.app/api-reference/types/bulk-job.md): A submitted bulk job. - [BulkMetadataEditResult](https://docs.fluz.app/api-reference/types/bulk-metadata-edit-result.md): Per-edit outcome for a single UPDATE_TRANSACTION_METADATA edit within a bulk operation item. - [BulkOperationItem](https://docs.fluz.app/api-reference/types/bulk-operation-item.md): The result of one target within a bulk job. - [BulkOperationItems](https://docs.fluz.app/api-reference/types/bulk-operation-items.md): A page of per-target results for a bulk job. - [BulkTargetError](https://docs.fluz.app/api-reference/types/bulk-target-error.md): The per-target failure detail for a bulk operation. - [BulkTargetFailure](https://docs.fluz.app/api-reference/types/bulk-target-failure.md): A target user that could not be included in a bulk read result. - [BulkTransaction](https://docs.fluz.app/api-reference/types/bulk-transaction.md): One transaction in a bulk transactions result, attributed to the connected user it belongs to. - [BulkTransactions](https://docs.fluz.app/api-reference/types/bulk-transactions.md): Transactions across your connected users as a single flat, keyset-paginated list, newest first. - [BulkUpdateErpTransactionMetadataResult](https://docs.fluz.app/api-reference/types/bulk-update-erp-transaction-metadata-result.md) - [Business](https://docs.fluz.app/api-reference/types/business.md): Represents the Business who has access to the account. - [BusinessCategory](https://docs.fluz.app/api-reference/types/business-category.md): BusinessCategory represents a business category with its associated sub-categories. - [BusinessLookupResult](https://docs.fluz.app/api-reference/types/business-lookup-result.md): Represents a business recipient. - [BusinessOwnerStatus](https://docs.fluz.app/api-reference/types/business-owner-status.md): Snapshot of one business owner row for KYB UI (registered user, business user, or NRU). - [BusinessSubCategory](https://docs.fluz.app/api-reference/types/business-sub-category.md): BusinessSubCategory represents a sub-category within a business category. - [CardProvisioningUrl](https://docs.fluz.app/api-reference/types/card-provisioning-url.md) - [CashBalance](https://docs.fluz.app/api-reference/types/cash-balance.md): CashBalance represents the balance of a user's cash. - [CashBalanceDeposit](https://docs.fluz.app/api-reference/types/cash-balance-deposit.md): CashBalanceDeposit represents a cash balance deposit, including details like amount, fee, and status. - [CashBalanceSettlement](https://docs.fluz.app/api-reference/types/cash-balance-settlement.md): CashBalanceSettlement representing a settlement record of a cash balance. - [CloDetails](https://docs.fluz.app/api-reference/types/clo-details.md): [CLO Only] Contains specific details about rates and periods for a Card Linked Offer. - [CloPeriod](https://docs.fluz.app/api-reference/types/clo-period.md): [CLO Only] Represents a specific time period during which a Card Linked Offer rate applies. - [CloseUserCashBalanceResponse](https://docs.fluz.app/api-reference/types/close-user-cash-balance-response.md): Response type for the closeUserCashBalance mutation, returning a closed user cash balance and affected virtual card records - [CloseUserCashBalanceResponseVirtualCard](https://docs.fluz.app/api-reference/types/close-user-cash-balance-response-virtual-card.md): Response type for a virtual card affected by user cash balance closure. - [ClosedUserCashBalance](https://docs.fluz.app/api-reference/types/closed-user-cash-balance.md): Response type for closing a user cash balance account. - [CreatePlaidLinkAddressResponse](https://docs.fluz.app/api-reference/types/create-plaid-link-address-response.md) - [CreateTransferResponse](https://docs.fluz.app/api-reference/types/create-transfer-response.md): Represents the response returned from the createTransfer mutation. - [DeclinedTransaction](https://docs.fluz.app/api-reference/types/declined-transaction.md): DeclinedTransaction represents an attempted transaction that was declined or failed. - [DeclinedTransactionConnection](https://docs.fluz.app/api-reference/types/declined-transaction-connection.md): Paginated response for getDeclinedTransactions query. - [DefaultFundingSource](https://docs.fluz.app/api-reference/types/default-funding-source.md): DefaultFundingSource represents an account's default funding source: the primary payment method (a bank account, charged first) and the backup payment method (a bank card, charged if the primary can't be charged). - [DepositCashBalanceResponse](https://docs.fluz.app/api-reference/types/deposit-cash-balance-response.md): Response type for the depositCashBalance mutation, returning the resulting deposits and current user balances. - [ErpBulkFailure](https://docs.fluz.app/api-reference/types/erp-bulk-failure.md) - [ErpError](https://docs.fluz.app/api-reference/types/erp-error.md): A single per-item failure in bulkUpdateErpTransactionMetadata. - [ErpReferenceItem](https://docs.fluz.app/api-reference/types/erp-reference-item.md): A chart-of-accounts entry, vendor, or customer imported from the connected accounting provider (e.g. - [ErpReferenceItemConnection](https://docs.fluz.app/api-reference/types/erp-reference-item-connection.md) - [ErpReferenceItemRef](https://docs.fluz.app/api-reference/types/erp-reference-item-ref.md): A lightweight reference to a category, vendor, or customer attached to a transaction's ERP metadata. - [ErpTransactionMetadata](https://docs.fluz.app/api-reference/types/erp-transaction-metadata.md): The current ERP-side categorization state of a transaction. - [ErpTransactionMetadataConnection](https://docs.fluz.app/api-reference/types/erp-transaction-metadata-connection.md) - [ErrorInfo](https://docs.fluz.app/api-reference/types/error-info.md): Error information. - [GenerateUserAccessTokenResponse](https://docs.fluz.app/api-reference/types/generate-user-access-token-response.md): Represents the response returned from the generateUserAccessToken mutation. - [GeneratedShareLink](https://docs.fluz.app/api-reference/types/generated-share-link.md): GeneratedShareLink represents a single generated share link. - [GetBusinessResponse](https://docs.fluz.app/api-reference/types/get-business-response.md): KYB summary for the business tied to the bearer token's accountId. - [GetWalletResponse](https://docs.fluz.app/api-reference/types/get-wallet-response.md): GetWalletResponse represents the response to the get wallet request. - [GiftCard](https://docs.fluz.app/api-reference/types/gift-card.md): GiftCard represents a record of a gift card purchased by a user. - [GiftCardCode](https://docs.fluz.app/api-reference/types/gift-card-code.md): GiftCardCode contains the redemption credentials for a Merchant. - [LockVirtualCardResponse](https://docs.fluz.app/api-reference/types/lock-virtual-card-response.md) - [Merchant](https://docs.fluz.app/api-reference/types/merchant.md): Merchant is place that a Gift Card can be use, or can charge a user's VirtualCard. - [MerchantCategory](https://docs.fluz.app/api-reference/types/merchant-category.md): MerchantCategory is a curated shopping category (e.g. Dining, Travel) that groups merchants. - [MerchantCategoryCode](https://docs.fluz.app/api-reference/types/merchant-category-code.md): MerchantCategoryCode represents the classifier for a business by the types of goods or services it provides. - [ObjectChangeHistoryActor](https://docs.fluz.app/api-reference/types/object-change-history-actor.md): Who performed an object change. - [ObjectChangeHistoryApproval](https://docs.fluz.app/api-reference/types/object-change-history-approval.md): The approval that authorized, or is tracked by, an object change. - [ObjectChangeHistoryApprover](https://docs.fluz.app/api-reference/types/object-change-history-approver.md): One approver on the approval that authorized an object change. - [ObjectChangeHistoryEvent](https://docs.fluz.app/api-reference/types/object-change-history-event.md): One append-only history event for an object. - [ObjectOwner](https://docs.fluz.app/api-reference/types/object-owner.md): Object ownership metadata returned from assign/transfer mutations. - [ObjectOwnerError](https://docs.fluz.app/api-reference/types/object-owner-error.md) - [Offer](https://docs.fluz.app/api-reference/types/offer.md): Offer is a discounted offer for a merchant. - [OfferRate](https://docs.fluz.app/api-reference/types/offer-rate.md): OfferRate is the rate of a specific offer. - [Paypal](https://docs.fluz.app/api-reference/types/paypal.md): Paypal represents a PayPal account added by a user. - [PlaidBankAccount](https://docs.fluz.app/api-reference/types/plaid-bank-account.md): Safe persisted Plaid bank account metadata. - [PlaidBankAccountBalanceRefreshResponse](https://docs.fluz.app/api-reference/types/plaid-bank-account-balance-refresh-response.md): Result of a rate-limited realtime refresh for one Plaid bank account's owning institution. - [PlaidBankAccountSpendPower](https://docs.fluz.app/api-reference/types/plaid-bank-account-spend-power.md): Safe spend power calculated for one Plaid-linked bank account. - [PlaidBankBalance](https://docs.fluz.app/api-reference/types/plaid-bank-balance.md): Latest safe Plaid bank balance for a persisted bank account. - [PlaidBankConnectionRefreshResponse](https://docs.fluz.app/api-reference/types/plaid-bank-connection-refresh-response.md): Result of a cached refresh for all Plaid connections owned by the authenticated account. - [PlaidBankTransaction](https://docs.fluz.app/api-reference/types/plaid-bank-transaction.md): Safe persisted bank transaction populated by identity-service from Plaid. - [PlaidBankTransactionPage](https://docs.fluz.app/api-reference/types/plaid-bank-transaction-page.md) - [PlaidIntegration](https://docs.fluz.app/api-reference/types/plaid-integration.md): The application's own Plaid credentials. - [PlaidIntegrationResponse](https://docs.fluz.app/api-reference/types/plaid-integration-response.md) - [PlaidLinkCompletionResponse](https://docs.fluz.app/api-reference/types/plaid-link-completion-response.md): Safe public result of completing a Plaid Link flow. - [PlaidLinkTokenResponse](https://docs.fluz.app/api-reference/types/plaid-link-token-response.md): Response containing the token required to initialize Plaid Link. - [PlaidLinkedBankAccount](https://docs.fluz.app/api-reference/types/plaid-linked-bank-account.md): Linked bank account returned after identity-service completes Plaid ingestion. - [PlaidVerifyMember](https://docs.fluz.app/api-reference/types/plaid-verify-member.md): Plaid member that requires relinking after a refresh attempt. - [PostKycVerificationResponse](https://docs.fluz.app/api-reference/types/post-kyc-verification-response.md): Response type for the postKycVerification mutation. - [ProgramLimits](https://docs.fluz.app/api-reference/types/program-limits.md): Represents the bank program spent limits. - [RefreshUserAccessTokenResponse](https://docs.fluz.app/api-reference/types/refresh-user-access-token-response.md): Represents the response returned from the generateUserAccessToken mutation. - [RegisterBusinessResponse](https://docs.fluz.app/api-reference/types/register-business-response.md): Response from business registration. - [RegisterUserError](https://docs.fluz.app/api-reference/types/register-user-error.md): Error details for registerUser mutation failures. - [RegisterUserResponse](https://docs.fluz.app/api-reference/types/register-user-response.md): Represents the response returned from the registerUser mutation. - [RemoveAuthorizedUserResponse](https://docs.fluz.app/api-reference/types/remove-authorized-user-response.md): Response returned from the removeAuthorizedUser mutation. - [RemovePlaidBankInstitutionResponse](https://docs.fluz.app/api-reference/types/remove-plaid-bank-institution-response.md) - [RequestApprovalError](https://docs.fluz.app/api-reference/types/request-approval-error.md): Error details returned when an approval request cannot be submitted. - [RequestApprovalResponse](https://docs.fluz.app/api-reference/types/request-approval-response.md): Response returned from request approval mutations. - [RequestDocumentVerificationLinkResponse](https://docs.fluz.app/api-reference/types/request-document-verification-link-response.md): Response type for user verification request - [RequestOwnerDocumentVerificationLinkResponse](https://docs.fluz.app/api-reference/types/request-owner-document-verification-link-response.md): Response from requesting an owner document verification link. - [RewardsBalance](https://docs.fluz.app/api-reference/types/rewards-balance.md): RewardsBalance represents the balance of a user's rewards. - [Seat](https://docs.fluz.app/api-reference/types/seat.md): Represents the network position held by the entity. - [SetVirtualCardPINResponse](https://docs.fluz.app/api-reference/types/set-virtual-card-pinresponse.md): Shows whether setting the PIN on eligible virtual cards was successful. - [ShareLinkRecipientRegistrationResult](https://docs.fluz.app/api-reference/types/share-link-recipient-registration-result.md): Per-recipient outcome for REGISTER_USER share link generation. - [ShareRequest](https://docs.fluz.app/api-reference/types/share-request.md): ShareRequest represents a response from creating a share link. - [ShareRequestDetails](https://docs.fluz.app/api-reference/types/share-request-details.md): ShareRequestDetails represents the configuration settings of the share request. - [SpendAccountPdfDocument](https://docs.fluz.app/api-reference/types/spend-account-pdf-document.md): A PDF artifact containing ACH routing and account instructions for funding a spend account's virtual account number, returned as a base64-encoded string for the client to decode and render or download. - [SpendAccountVirtualAccountNumber](https://docs.fluz.app/api-reference/types/spend-account-virtual-account-number.md): A virtual account number (ACH routing + account number) tied to a spend account. - [StockInfoFixedType](https://docs.fluz.app/api-reference/types/stock-info-fixed-type.md): StockInfoFixedType describes the available denominations for fixed offers, and the amount in stock for each denomination. - [StockInfoVariableType](https://docs.fluz.app/api-reference/types/stock-info-variable-type.md): StockInfoVariableType describes the available denomination range for variable offers. - [SupervisionAssignment](https://docs.fluz.app/api-reference/types/supervision-assignment.md) - [SupervisionAssignmentError](https://docs.fluz.app/api-reference/types/supervision-assignment-error.md) - [SupervisionAssignmentResponse](https://docs.fluz.app/api-reference/types/supervision-assignment-response.md) - [Transaction](https://docs.fluz.app/api-reference/types/transaction.md): Transaction represents a comprehensive record of all account activity including purchases, deposits, withdrawals, transfers, and payouts. - [TransactionConnection](https://docs.fluz.app/api-reference/types/transaction-connection.md): Paginated response for transactions query. - [TransferInternalBalanceResponse](https://docs.fluz.app/api-reference/types/transfer-internal-balance-response.md): Response type for the transferInternalBalance mutation, returning the deposit, withdrawal records and updated balances. - [TransferObjectOwnerResponse](https://docs.fluz.app/api-reference/types/transfer-object-owner-response.md) - [UnlockVirtualCardResponse](https://docs.fluz.app/api-reference/types/unlock-virtual-card-response.md) - [UpdatedTransaction](https://docs.fluz.app/api-reference/types/updated-transaction.md): UpdatedTransaction is the transaction record returned by the updateTransactionMetadata mutation: the persisted transaction row plus the memo/category/attachment just written. - [UploadSoleProprietorshipDocumentResponse](https://docs.fluz.app/api-reference/types/upload-sole-proprietorship-document-response.md): Response from uploading sole proprietorship document. - [User](https://docs.fluz.app/api-reference/types/user.md): Represents the User who has access to the account. - [UserAddress](https://docs.fluz.app/api-reference/types/user-address.md): UserAddress represents a User Address record. - [UserBalances](https://docs.fluz.app/api-reference/types/user-balances.md): UserBalances represents the balances of a user's rewards, cash, and gift card cash. - [UserCashBalance](https://docs.fluz.app/api-reference/types/user-cash-balance.md): UserCashBalance represents a user's cash balance account. - [UserCashBalanceConnection](https://docs.fluz.app/api-reference/types/user-cash-balance-connection.md): Paginated response for cash balances query. - [UserCashBalanceDetail](https://docs.fluz.app/api-reference/types/user-cash-balance-detail.md): UserCashBalanceDetail represents a user's cash balance account with additional details. - [UserLookupResult](https://docs.fluz.app/api-reference/types/user-lookup-result.md): Represents a user recipient. - [UserPurchase](https://docs.fluz.app/api-reference/types/user-purchase.md): UserPurchase represents a record of a purchase made by a user, detailing the payment methods and other relevant information. - [VerifyUserInformationResponse](https://docs.fluz.app/api-reference/types/verify-user-information-response.md): Represents the response returned from the verifyUserInformation mutation. - [VirtualCard](https://docs.fluz.app/api-reference/types/virtual-card.md): VirtualCard represents a record of a virtual card generated by a user. - [VirtualCardAddressInfo](https://docs.fluz.app/api-reference/types/virtual-card-address-info.md): VirtualCardAddressInfo provides the address information associated with a virtual card. - [VirtualCardAuthorizationSetting](https://docs.fluz.app/api-reference/types/virtual-card-authorization-setting.md): VirtualCardAuthorizationSetting defines the authorization settings for a virtual card. - [VirtualCardBalance](https://docs.fluz.app/api-reference/types/virtual-card-balance.md): VirtualCardBalance provides the balance, status and lock state of a virtual card. - [VirtualCardBulkOrder](https://docs.fluz.app/api-reference/types/virtual-card-bulk-order.md): VirtualCardBulkOrder provides information about bulk creation order. - [VirtualCardDetails](https://docs.fluz.app/api-reference/types/virtual-card-details.md): The VirtualCardDetails type represents the details of a virtual card. - [VirtualCardOffer](https://docs.fluz.app/api-reference/types/virtual-card-offer.md): Represents the Bank identification numbers (BINs). - [VirtualCardTransaction](https://docs.fluz.app/api-reference/types/virtual-card-transaction.md): Virtual card transaction type. - [VirtualCardTransactions](https://docs.fluz.app/api-reference/types/virtual-card-transactions.md): Virtual card transactions, grouped by virtual card ID. - [Withdraw](https://docs.fluz.app/api-reference/types/withdraw.md): Withdraw represents a withdrawal transaction record. - [WithdrawCashBalanceResponse](https://docs.fluz.app/api-reference/types/withdraw-cash-balance-response.md): Response type for the withdrawCashBalance mutation, returning the withdrawal record and updated balances. - [WithdrawFeeEstimate](https://docs.fluz.app/api-reference/types/withdraw-fee-estimate.md): Estimated fees and net amount for a withdrawal. ##### Input objects - [AddBankCardInput](https://docs.fluz.app/api-reference/types/add-bank-card-input.md): Input type for adding a bank card to the user's wallet. - [AddVirtualCardAddressInput](https://docs.fluz.app/api-reference/types/add-virtual-card-address-input.md): Input type for saving a billing address before issuing virtual cards. - [BulkDepositItemInput](https://docs.fluz.app/api-reference/types/bulk-deposit-item-input.md): One deposit for a DEPOSIT_CASH_BALANCE bulk operation. - [BulkDepositOptionsInput](https://docs.fluz.app/api-reference/types/bulk-deposit-options-input.md): Options for the DEPOSIT_CASH_BALANCE operation. - [BulkExportOptionsInput](https://docs.fluz.app/api-reference/types/bulk-export-options-input.md): Options for the read-export operations (GET_TRANSACTIONS_EXPORT, GET_BALANCES_EXPORT). - [BulkMetadataEditInput](https://docs.fluz.app/api-reference/types/bulk-metadata-edit-input.md): One metadata change for a single transaction. - [BulkMetadataItemInput](https://docs.fluz.app/api-reference/types/bulk-metadata-item-input.md): All metadata edits for one target user in an UPDATE_TRANSACTION_METADATA bulk operation. - [BulkMetadataOptionsInput](https://docs.fluz.app/api-reference/types/bulk-metadata-options-input.md): Options for the UPDATE_TRANSACTION_METADATA operation. - [BulkPaginationInput](https://docs.fluz.app/api-reference/types/bulk-pagination-input.md): Pagination input for bulk API listings. - [BulkTargetSpecInput](https://docs.fluz.app/api-reference/types/bulk-target-spec-input.md): Selects the users a bulk operation applies to. - [BulkTransferEndpointInput](https://docs.fluz.app/api-reference/types/bulk-transfer-endpoint-input.md): One endpoint (the source or destination) of a bulk transfer. - [BulkTransferItemInput](https://docs.fluz.app/api-reference/types/bulk-transfer-item-input.md): One transfer for a CREATE_TRANSFER bulk operation: move the amount from the 'from' endpoint to the 'to' endpoint. - [BulkTransferOptionsInput](https://docs.fluz.app/api-reference/types/bulk-transfer-options-input.md): Options for the CREATE_TRANSFER operation. - [BulkUpdateErpTransactionMetadataItem](https://docs.fluz.app/api-reference/types/bulk-update-erp-transaction-metadata-item.md) - [BusinessLegalAddressInput](https://docs.fluz.app/api-reference/types/business-legal-address-input.md): Business legal address input. - [BusinessLookupInput](https://docs.fluz.app/api-reference/types/business-lookup-input.md): Input for looking up business recipients by company name. - [BusinessOwnerInput](https://docs.fluz.app/api-reference/types/business-owner-input.md): Business owner information for registration. - [CloseUserCashBalanceFundingSource](https://docs.fluz.app/api-reference/types/close-user-cash-balance-funding-source.md): CloseUserCashBalanceFundingSource represents new funding source for all user cash balance-associated virtual cards. - [CloseUserCashBalanceInput](https://docs.fluz.app/api-reference/types/close-user-cash-balance-input.md): Input type for closing a user cash balance account. - [CompletePlaidLinkInput](https://docs.fluz.app/api-reference/types/complete-plaid-link-input.md): Input submitted by the frontend after Plaid Link onSuccess returns a public token. - [CompletePlaidRelinkInput](https://docs.fluz.app/api-reference/types/complete-plaid-relink-input.md): Finish update mode after Link onSuccess. - [CreatePlaidLinkAddressInput](https://docs.fluz.app/api-reference/types/create-plaid-link-address-input.md): Input for creating the address required to complete a Plaid bank link. - [CreatePlaidLinkTokenInput](https://docs.fluz.app/api-reference/types/create-plaid-link-token-input.md): Input for creating a Plaid Link token. - [CreatePlaidRelinkTokenInput](https://docs.fluz.app/api-reference/types/create-plaid-relink-token-input.md): Start update mode for an existing Item, for an app with BYOI Plaid. - [CreateTransferInput](https://docs.fluz.app/api-reference/types/create-transfer-input.md): Represents the request payload for creating a transfer. - [CreateUserCashBalanceInput](https://docs.fluz.app/api-reference/types/create-user-cash-balance-input.md): Input type for creating a new user cash balance account. - [CreateVirtualCardBulkOrderInput](https://docs.fluz.app/api-reference/types/create-virtual-card-bulk-order-input.md) - [CreateVirtualCardInput](https://docs.fluz.app/api-reference/types/create-virtual-card-input.md): Input type for creating virtual cards. - [DeactivateVCShareLinksInput](https://docs.fluz.app/api-reference/types/deactivate-vcshare-links-input.md): Input type for deactivateVCShareLinks. - [DeclinedTransactionFilterInput](https://docs.fluz.app/api-reference/types/declined-transaction-filter-input.md): Input filter for querying transactions. - [DeleteBankCardInput](https://docs.fluz.app/api-reference/types/delete-bank-card-input.md): Input type for deleting a bank card. - [DepositCashBalanceInput](https://docs.fluz.app/api-reference/types/deposit-cash-balance-input.md): Input type for depositing cash balance, specifying the amount and deposit type. - [EditVirtualCardInput](https://docs.fluz.app/api-reference/types/edit-virtual-card-input.md): Input type for edit virtual card. - [ErpReferenceItemFilter](https://docs.fluz.app/api-reference/types/erp-reference-item-filter.md) - [ErpTransactionMetadataFilter](https://docs.fluz.app/api-reference/types/erp-transaction-metadata-filter.md) - [FilterByInput](https://docs.fluz.app/api-reference/types/filter-by-input.md): Input for applying fine-grained filters on offer attributes. - [GenerateVCShareLinksInput](https://docs.fluz.app/api-reference/types/generate-vcshare-links-input.md): Input type for generateVCShareLinks. - [GetCardProvisioningUrlInput](https://docs.fluz.app/api-reference/types/get-card-provisioning-url-input.md) - [GetOfferQuoteInput](https://docs.fluz.app/api-reference/types/get-offer-quote-input.md) - [GetVCShareLinksInput](https://docs.fluz.app/api-reference/types/get-vcshare-links-input.md): Input type for generateVCShareLinks. - [GetVirtualCardBalanceInput](https://docs.fluz.app/api-reference/types/get-virtual-card-balance-input.md): Input type for get virtual card balance. - [GetVirtualCardBulkOrderStatusInput](https://docs.fluz.app/api-reference/types/get-virtual-card-bulk-order-status-input.md): Input type for get bulk virtual card creation order. - [GetVirtualCardOffersInput](https://docs.fluz.app/api-reference/types/get-virtual-card-offers-input.md): Input type for get virtual card offers. - [GetVirtualCardTransactionsInput](https://docs.fluz.app/api-reference/types/get-virtual-card-transactions-input.md): Input type for fetching transactions for multiple virtual cards. - [GetWithdrawFeeEstimateInput](https://docs.fluz.app/api-reference/types/get-withdraw-fee-estimate-input.md): Input for estimating withdrawal fees before submitting a withdrawal. - [LockVirtualCardInput](https://docs.fluz.app/api-reference/types/lock-virtual-card-input.md): Input type for lock virtual card. - [MerchantInput](https://docs.fluz.app/api-reference/types/merchant-input.md): Input type for getReferralUrl. - [OfferTypesInput](https://docs.fluz.app/api-reference/types/offer-types-input.md): Input type for getMerchants. - [OffsetInput](https://docs.fluz.app/api-reference/types/offset-input.md): The page info. - [OwnerAddressInput](https://docs.fluz.app/api-reference/types/owner-address-input.md): Address for a business owner. - [PlaidBankAccountFilterInput](https://docs.fluz.app/api-reference/types/plaid-bank-account-filter-input.md): Optional filters for listing persisted Plaid bank accounts owned by the authenticated account. - [PlaidBankAccountInput](https://docs.fluz.app/api-reference/types/plaid-bank-account-input.md): Input for selecting one persisted Plaid bank account. - [PlaidBankBalanceFilterInput](https://docs.fluz.app/api-reference/types/plaid-bank-balance-filter-input.md): Optional filters for listing latest persisted Plaid bank balances. - [PlaidBankTransactionFilterInput](https://docs.fluz.app/api-reference/types/plaid-bank-transaction-filter-input.md): Input for listing persisted historical bank transactions populated by identity-service. - [PlaidLinkAddressInput](https://docs.fluz.app/api-reference/types/plaid-link-address-input.md): Address attached to Plaid-linked bank accounts when identity-service requires one after Link. - [PurchaseGiftCardInput](https://docs.fluz.app/api-reference/types/purchase-gift-card-input.md): Input type for purchase gift card. - [RedeemFluzGiftCardInput](https://docs.fluz.app/api-reference/types/redeem-fluz-gift-card-input.md): Input type for redeeming a Fluz Gift Card to the user's account. - [RegisterBusinessConfirmInput](https://docs.fluz.app/api-reference/types/register-business-confirm-input.md): Ownership roster certifications required at registration. - [RegisterBusinessInput](https://docs.fluz.app/api-reference/types/register-business-input.md): Input for registering a new business. - [RegisterPlaidIntegrationInput](https://docs.fluz.app/api-reference/types/register-plaid-integration-input.md): Input for registering the application's own Plaid credentials (BYOI Plaid). - [RemovePlaidBankInstitutionInput](https://docs.fluz.app/api-reference/types/remove-plaid-bank-institution-input.md): Input for removing a connected Plaid bank institution. - [RequestAccountTransferInput](https://docs.fluz.app/api-reference/types/request-account-transfer-input.md): Represents the request payload for account-transfer approval requests. - [RequestDocumentVerificationLinkInput](https://docs.fluz.app/api-reference/types/request-document-verification-link-input.md): Input type for requesting user verification - [RequestGiftCardPurchaseInput](https://docs.fluz.app/api-reference/types/request-gift-card-purchase-input.md) - [RequestInternalTransferInput](https://docs.fluz.app/api-reference/types/request-internal-transfer-input.md) - [RequestReimbursementInput](https://docs.fluz.app/api-reference/types/request-reimbursement-input.md) - [RequestVirtualCardInput](https://docs.fluz.app/api-reference/types/request-virtual-card-input.md) - [RequestVirtualCardLimitChangeInput](https://docs.fluz.app/api-reference/types/request-virtual-card-limit-change-input.md) - [SetBackupFundingSourceInput](https://docs.fluz.app/api-reference/types/set-backup-funding-source-input.md): Input type for setting an account's backup funding source. - [SetPrimaryFundingSourceInput](https://docs.fluz.app/api-reference/types/set-primary-funding-source-input.md): Input type for setting an account's primary funding source. - [SetVirtualCardPINInput](https://docs.fluz.app/api-reference/types/set-virtual-card-pininput.md): Input type for set Virtual Card PIN. - [ShareLinkRecipientRegistrationInput](https://docs.fluz.app/api-reference/types/share-link-recipient-registration-input.md): Input type for generateVCShareLinks. - [SubmitBulkOperationInput](https://docs.fluz.app/api-reference/types/submit-bulk-operation-input.md): Submit an asynchronous bulk operation across your connected users. - [TransactionFilterInput](https://docs.fluz.app/api-reference/types/transaction-filter-input.md): Input filter for querying transactions. - [TransferDestination](https://docs.fluz.app/api-reference/types/transfer-destination.md): Identifies the destination for a transfer. - [TransferInternalBalanceInput](https://docs.fluz.app/api-reference/types/transfer-internal-balance-input.md): Input type for a transfer between user cash balance accounts. - [UnlockVirtualCardInput](https://docs.fluz.app/api-reference/types/unlock-virtual-card-input.md): Input type for unlock virtual card. - [UpdateBankCardNicknameInput](https://docs.fluz.app/api-reference/types/update-bank-card-nickname-input.md): Input type for updating a bank card's nickname. - [UpdateBankCardPreferredMerchantCategoryCodeInput](https://docs.fluz.app/api-reference/types/update-bank-card-preferred-merchant-category-code-input.md): Input type for updating a bank card's preferred merchant category code. - [UpdateErpTransactionMetadataInput](https://docs.fluz.app/api-reference/types/update-erp-transaction-metadata-input.md): Optional ERP-aware categorization for this transaction (e.g. - [UpdateTransactionMetadataInput](https://docs.fluz.app/api-reference/types/update-transaction-metadata-input.md): Input for updating transaction metadata (memo, category, attachment). - [UpdateUserCashBalanceInput](https://docs.fluz.app/api-reference/types/update-user-cash-balance-input.md): Input type for updating a user cash balance account. - [UserAddressInput](https://docs.fluz.app/api-reference/types/user-address-input.md): Input type for adding an address to the user. - [UserCashBalanceFilterInput](https://docs.fluz.app/api-reference/types/user-cash-balance-filter-input.md): Input filter for querying cash balances. - [UserLookupInput](https://docs.fluz.app/api-reference/types/user-lookup-input.md): Input for looking up a user recipient by a specific identifier. - [UserPurchaseFilterInput](https://docs.fluz.app/api-reference/types/user-purchase-filter-input.md): Input filter type for getUserPurchases - Default [TOKEN_USER]. - [VirtualCardBillingAddressInput](https://docs.fluz.app/api-reference/types/virtual-card-billing-address-input.md): Input type for a new billing address when issuing a virtual card. - [VirtualCardOrderItemInput](https://docs.fluz.app/api-reference/types/virtual-card-order-item-input.md) - [VirtualCardTransactionFiltersInput](https://docs.fluz.app/api-reference/types/virtual-card-transaction-filters-input.md): Input type for filtering virtual card transactions. - [WithdrawCashBalanceInput](https://docs.fluz.app/api-reference/types/withdraw-cash-balance-input.md) ##### Enums - [AccountType](https://docs.fluz.app/api-reference/types/account-type.md): Enum describing the types of accounts. - [ApprovalRequestAction](https://docs.fluz.app/api-reference/types/approval-request-action.md): Approval action used by approve/decline mutations. - [ApprovalRequestApproverStatus](https://docs.fluz.app/api-reference/types/approval-request-approver-status.md): Approval approver status. - [ApprovalRequestStatus](https://docs.fluz.app/api-reference/types/approval-request-status.md): Approval request status. - [BankAccountStatus](https://docs.fluz.app/api-reference/types/bank-account-status.md): BankAccountStatus represents the current status of a bank account. - [BankAccountType](https://docs.fluz.app/api-reference/types/bank-account-type.md): BankAccountType represents the type of bank account. - [BankCardStatus](https://docs.fluz.app/api-reference/types/bank-card-status.md): BankCardStatus represents the status of bank card. - [BankCardType](https://docs.fluz.app/api-reference/types/bank-card-type.md): BankCardType represents the type of bank card. - [BarcodeTypeEnum](https://docs.fluz.app/api-reference/types/barcode-type-enum.md): BarcodeTypeEnum defines the barcode type of the offer. - [BulkItemStatus](https://docs.fluz.app/api-reference/types/bulk-item-status.md): The lifecycle status of a single item (one target) within a bulk job. - [BulkJobStatus](https://docs.fluz.app/api-reference/types/bulk-job-status.md): The lifecycle status of a bulk job. - [BulkOperationType](https://docs.fluz.app/api-reference/types/bulk-operation-type.md): The bulk operation to perform. - [BulkTargetErrorCode](https://docs.fluz.app/api-reference/types/bulk-target-error-code.md): Why a bulk operation could not be performed for one target. - [BulkTargetMode](https://docs.fluz.app/api-reference/types/bulk-target-mode.md): How a bulk operation selects its target users. - [BusinessAccountUsageType](https://docs.fluz.app/api-reference/types/business-account-usage-type.md): Business account usage types. - [BusinessOwnerVerificationType](https://docs.fluz.app/api-reference/types/business-owner-verification-type.md): Expected identity verification for an owner (returned by `getBusiness`). - [BusinessStructureType](https://docs.fluz.app/api-reference/types/business-structure-type.md): Business structure types supported for registration. - [CashBalanceAvailabilityType](https://docs.fluz.app/api-reference/types/cash-balance-availability-type.md): Enum defining the types of availability for a cash balance. - [CashBalanceDepositStatus](https://docs.fluz.app/api-reference/types/cash-balance-deposit-status.md): Enum representing the status of a cash balance deposit. - [CashBalanceDepositType](https://docs.fluz.app/api-reference/types/cash-balance-deposit-type.md): Enum representing different types of cash balance deposits. - [CloRateTypeEnum](https://docs.fluz.app/api-reference/types/clo-rate-type-enum.md): Indicates the type of rate active for a specific period of a Card Linked Offer. - [DeclinedTransactionStatus](https://docs.fluz.app/api-reference/types/declined-transaction-status.md): DeclinedTransactionStatus represents the current state of a transaction. - [DeliveryFormatType](https://docs.fluz.app/api-reference/types/delivery-format-type.md): DeliveryFormatType defines the delivery format of the offer. - [ErpReferenceItemSortKey](https://docs.fluz.app/api-reference/types/erp-reference-item-sort-key.md) - [ErpTransactionMetadataSortKey](https://docs.fluz.app/api-reference/types/erp-transaction-metadata-sort-key.md) - [ErpTransactionSyncStatus](https://docs.fluz.app/api-reference/types/erp-transaction-sync-status.md): Sync state of a transaction's ERP metadata against the connected accounting provider. - [ExternalBusinessOwnerStatus](https://docs.fluz.app/api-reference/types/external-business-owner-status.md): Per-owner verification progress for the business roster. - [ExternalKybStatus](https://docs.fluz.app/api-reference/types/external-kyb-status.md): KYB lifecycle status exposed to API clients (subset of internal KybStatus). - [GiftCardStatus](https://docs.fluz.app/api-reference/types/gift-card-status.md): GiftCardStatus represents the current state of a gift card. - [ObjectOwnerObjectType](https://docs.fluz.app/api-reference/types/object-owner-object-type.md): Supported object domains for metadata-only ownership. - [OfferDenominationType](https://docs.fluz.app/api-reference/types/offer-denomination-type.md): OfferDenominationType is the type of denomination of a specific offer. - [OfferType](https://docs.fluz.app/api-reference/types/offer-type.md): OfferType is the type of offer. - [PayPalAccountStatus](https://docs.fluz.app/api-reference/types/pay-pal-account-status.md): PayPalAccountStatus represents the current status of a PayPal account. - [PaycheckDepositType](https://docs.fluz.app/api-reference/types/paycheck-deposit-type.md): Distribution method for a paycheck direct-deposit form. - [PaymentMethodType](https://docs.fluz.app/api-reference/types/payment-method-type.md): PaymentMethodType represents the type of payment method. - [PlaidDeviceOs](https://docs.fluz.app/api-reference/types/plaid-device-os.md): PlaidDeviceOs enables Plaid OAuth redirects for native Link SDK integrations. - [PlaidIntegrationChange](https://docs.fluz.app/api-reference/types/plaid-integration-change.md): What a registration or disable call changed. - [PlaidIntegrationEnvironment](https://docs.fluz.app/api-reference/types/plaid-integration-environment.md) - [PlaidIntegrationStatus](https://docs.fluz.app/api-reference/types/plaid-integration-status.md) - [PlaidLinkMode](https://docs.fluz.app/api-reference/types/plaid-link-mode.md): PlaidLinkMode identifies whether the link token starts a new link or repairs an existing Plaid connection. - [ProvisioningPlatform](https://docs.fluz.app/api-reference/types/provisioning-platform.md): Target platform hint for the returned provisioning URL. - [PurchaseScopeFilter](https://docs.fluz.app/api-reference/types/purchase-scope-filter.md): PurchaseScopeFilter indicates the type of filter to use for getUserPurchases query - TOKEN_USER: use the userId from the token - TOKEN_ACCOUNT: use the accountId from the token Presence of both filters means both userId and accountId will be used. - [RegisterUserEnrollmentStep](https://docs.fluz.app/api-reference/types/register-user-enrollment-step.md): A step the person completes in the registration consent flow after approving the application. Fluz enables consent mode per application. - [RegisterUserStatus](https://docs.fluz.app/api-reference/types/register-user-status.md): Outcome of registerUser for applications in consent mode, which Fluz enables per application. - [ScopeType](https://docs.fluz.app/api-reference/types/scope-type.md): Enum describing the various types of access scopes available within the system. - [ShareCardType](https://docs.fluz.app/api-reference/types/share-card-type.md): ShareCardType represents the type of object you want to share. - [ShareLinkRecipientRegistrationStatus](https://docs.fluz.app/api-reference/types/share-link-recipient-registration-status.md): ShareLinkRecipientRegistrationStatus represents the outcome of registering one recipient during a generateVCShareLinks call with shareMethod REGISTER_USER. - [ShareMethodType](https://docs.fluz.app/api-reference/types/share-method-type.md): ShareMethodType represents the type of share method. - [ShareObjectStatus](https://docs.fluz.app/api-reference/types/share-object-status.md): ShareObjectStatus represents the status of the shared object. - [ShareObjectType](https://docs.fluz.app/api-reference/types/share-object-type.md): ShareObjectType represents the type of object you want to share. - [SortOrder](https://docs.fluz.app/api-reference/types/sort-order.md) - [SourcePlatformChannel](https://docs.fluz.app/api-reference/types/source-platform-channel.md): Source channel used in approval request payloads. - [TransactionStatus](https://docs.fluz.app/api-reference/types/transaction-status.md): TransactionStatus represents the current state of a transaction. - [UACRoleStatusType](https://docs.fluz.app/api-reference/types/uacrole-status-type.md): Enum describing the status of a UAC role assignment. - [UACRoleType](https://docs.fluz.app/api-reference/types/uacrole-type.md): Enum describing the UAC roles that can be assigned to authorized users. - [UserCashBalanceStatus](https://docs.fluz.app/api-reference/types/user-cash-balance-status.md): Enum representing the status of a user cash balance account. - [UserVerificationStatus](https://docs.fluz.app/api-reference/types/user-verification-status.md): Enum describing the user verification status. - [VirtualAccountNumberDebitControlMode](https://docs.fluz.app/api-reference/types/virtual-account-number-debit-control-mode.md): Controls which debits are permitted against a virtual account number. - [VirtualAccountNumberStatus](https://docs.fluz.app/api-reference/types/virtual-account-number-status.md): Status of a virtual account number. - [VirtualCardBulkOrderStatus](https://docs.fluz.app/api-reference/types/virtual-card-bulk-order-status.md): VirtualCardBulkOrderStatus represents the current state of a bulk virtual card order status. - [VirtualCardFundingSource](https://docs.fluz.app/api-reference/types/virtual-card-funding-source.md): VirtualCardFundingSource represents the funding sources available for Virtual Cards. - [VirtualCardNetwork](https://docs.fluz.app/api-reference/types/virtual-card-network.md): VirtualCardNetwork represents the card network of a virtual card (MASTERCARD or VISA). - [VirtualCardOfferType](https://docs.fluz.app/api-reference/types/virtual-card-offer-type.md): VirtualCardOfferType represents the card type of a virtual card (DEBIT or PREPAID). - [VirtualCardSpendLimitDuration](https://docs.fluz.app/api-reference/types/virtual-card-spend-limit-duration.md): VirtualCardSpendLimitDuration represents the card limit duration type. - [VirtualCardStatus](https://docs.fluz.app/api-reference/types/virtual-card-status.md): VirtualCardStatus represents the current state of a virtual card. - [VirtualCardTransactionListType](https://docs.fluz.app/api-reference/types/virtual-card-transaction-list-type.md) - [VirtualCardType](https://docs.fluz.app/api-reference/types/virtual-card-type.md): VirtualCardType indicates whether the card is multi-use or single-use, defining its usability. - [WithdrawMethods](https://docs.fluz.app/api-reference/types/withdraw-methods.md): Enum representing different withdrawal methods available to users. - [WithdrawSource](https://docs.fluz.app/api-reference/types/withdraw-source.md): Enum representing the source balance type for withdrawals. ##### Unions - [StockInfoType](https://docs.fluz.app/api-reference/types/stock-info-type.md): StockInfoType describes the stock for either fixed or variable offers. ##### Interfaces - [BasicUserCashBalance](https://docs.fluz.app/api-reference/types/basic-user-cash-balance.md): BasicUserCashBalance interface ##### Scalars - [DateTime](https://docs.fluz.app/api-reference/types/date-time.md): A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. - [UUID](https://docs.fluz.app/api-reference/types/uuid.md): A version 4 UUID is randomly generated. #### REST endpoints - [Upload sole proprietorship document](https://docs.fluz.app/api-reference/rest/upload-sole-proprietorship-document.md): REST endpoint for uploading the supporting document required when registering a SOLE_PROPRIETORSHIP business. ### Conventions - [Authentication reference](https://docs.fluz.app/api-reference/authentication.md): The exact request/response shapes for minting user access tokens with your API key. - [Errors](https://docs.fluz.app/api-reference/errors.md): Error codes, HTTP status codes, and how to troubleshoot with request IDs. - [Rate limits](https://docs.fluz.app/api-reference/rate-limits.md): Request rate limits, query cost limits, and best practices for staying within them. - [Pagination](https://docs.fluz.app/api-reference/pagination.md): Offset pagination, page-size caps, and the connection response shape.