# Fluz - [API reference (422 pages)](https://docs.fluz.app/_llms/en/api-reference.txt): Documentation for API reference. ## Home ### Home - [Fluz API documentation](https://docs.fluz.app/overview.md): Embed money movement into your product — pay-ins, wallets, virtual cards, gift cards, and payouts — through one GraphQL API and a single unified ledger. - [Changelog](https://docs.fluz.app/changelog.md): Recent updates, additions, and breaking changes to the Fluz API. ### Additional resources - [Developer dashboard](https://docs.fluz.app/developer-dashboard.md) - [API explorer](https://docs.fluz.app/api-explorer.md) - [Go to Fluz app](https://docs.fluz.app/explore-fluz-app.md) ## Get started ### Get started - [Go from zero to your first API call](https://docs.fluz.app/get-started.md): One GraphQL endpoint. Create your account, generate credentials, exchange them for a scoped access token, and make your first purchase in staging. - [Introduction to the Fluz API](https://docs.fluz.app/get-started/introduction-to-the-fluz-api.md) - [Accounts, applications & environments](https://docs.fluz.app/get-started/accounts-and-applications.md): The model to understand before your first call: logins, personal and business accounts, application types and statuses, and which token each operation needs. - [Design a solution](https://docs.fluz.app/solution-designer.md): Describe what you want to build and get a tailored Fluz solution design. #### Authentication & authorization - [Prepare your accounts](https://docs.fluz.app/get-started/prepare-accounts.md): Create your sandbox login, the right type of application, and get it activated — for yourself and for each developer on your team. - [API credentials and access tokens](https://docs.fluz.app/get-started/api-credentials.md): Exchange your API key for a short-lived, scoped user access token. - [Make your first API call](https://docs.fluz.app/get-started/first-api-call.md): Run an authenticated GraphQL request against staging and confirm your token works. - [Refresh an expired access token](https://docs.fluz.app/get-started/refresh-expired-access-token.md): Exchange a refresh token for a fresh user access token without re-minting from scratch. #### Sandbox test data - [Test addresses](https://docs.fluz.app/test-addresses.md) - [Test adding bank cards](https://docs.fluz.app/test-adding-bank-cards.md) - [Test adding bank accounts](https://docs.fluz.app/test-adding-bank-accounts.md) - [Test KYC flows](https://docs.fluz.app/test-kyc-flows.md): Run identity verification against staging test identities, and learn which outcomes count as verified. - [KYB testing](https://docs.fluz.app/KYB-testing.md): Test data for simulating KYB verification outcomes in the staging environment - [Test gift card purchasing](https://docs.fluz.app/test-merchants.md) - [Test issuing virtual cards](https://docs.fluz.app/test-issuing-virtual-cards.md): Ready-to-use offer IDs for issuing virtual cards in the staging environment, plus how to discover offers dynamically. - [Simulate virtual card transactions](https://docs.fluz.app/Simulate-Virtual-Card-Transactions.md): Put a test spend on a staging virtual card — how to request an authorization, clearing, decline, or refund, and how to verify the result over the API. ### Fluz dashboard - [Managing your application](https://docs.fluz.app/fluz-dashboard/managing-your-application.md): Application fields, types and statuses, and where to find each environment's API keys. - [Application scopes](https://docs.fluz.app/fluz-dashboard/application-scopes.md) - [Webhooks](https://docs.fluz.app/fluz-dashboard/webhooks.md) ### Quickstarts - [Your first gift card purchase](https://docs.fluz.app/quickstart/first-gift-card.md): Run the full happy path end to end — deposit funds, browse merchants, buy a gift card, and reveal it — all in the sandbox. - [Your first virtual card purchase](https://docs.fluz.app/quickstart/create-and-spend-with-a-virtual-card.md): Run the full happy path end to end — pick a card program, issue a card with the right settings, reveal it, and track its spend — all in the sandbox. - [Issue 100 cards at once](https://docs.fluz.app/quickstart/bulk-issue-virtual-cards.md): Create a bulk virtual card order, poll it to completion, and handle partial failures — the programmatic issuance pattern at scale. - [Onboard & connect a customer](https://docs.fluz.app/quickstart/onboard-customers.md): Run the platform happy path end to end — register a customer, connect their account with OAuth, verify their identity, and operate on their behalf. - [Onboard & verify a business](https://docs.fluz.app/quickstart/onboard-businesses.md): Run the business happy path end to end — configure a business-only application, send an owner through OAuth, register the legal entity, and track KYB to an approved business account. - [Send a card to someone](https://docs.fluz.app/quickstart/send-a-card.md): Generate a hosted virtual card link, watch the recipient claim it, and manage the link lifecycle — end to end in the sandbox. - [Move money through a wallet](https://docs.fluz.app/quickstart/move-money-through-a-wallet.md): The full ledger lifecycle — create a spend account, deposit into it, transfer between accounts, withdraw back out, and verify every balance. ## Features ### Features - [API features](https://docs.fluz.app/features.md): Everything the Fluz API can do — every capability is account-agnostic. #### Funding sources - [Manage linked funding sources](https://docs.fluz.app/features/funding-sources.md) - [View funding sources](https://docs.fluz.app/features/view-funding-sources.md) - [Primary & backup funding](https://docs.fluz.app/features/primary-and-backup-funding.md) - [Funding source activity history](https://docs.fluz.app/features/funding-source-activity-history.md): Every event Fluz records on a bank card, bank account, or PayPal account — added, verified, edited, removed, and set as primary or backup — and how each one appears in objectChangeHistory. ##### Link external cards - [Manage linked bank cards](https://docs.fluz.app/features/link-external-cards.md) - [Add bank card](https://docs.fluz.app/features/add-bank-card.md) - [Delete bank card](https://docs.fluz.app/features/delete-bank-card.md) ##### Link external bank accounts - [Manage linked bank accounts](https://docs.fluz.app/features/link-external-bank-accounts.md) - [Linking bank account via Plaid](https://docs.fluz.app/features/link-via-plaid.md) - [Managing spend power](https://docs.fluz.app/features/manage-spend-power.md) - [Relinking bank accounts](https://docs.fluz.app/features/relink-accounts.md) - [Bring your own integration for Plaid (BYOI Plaid)](https://docs.fluz.app/features/byoi-plaid.md): Use your own Plaid client ID and secret for the bank links that your users make through your application. - [Getting bank account transaction data](https://docs.fluz.app/features/getting-bank-data.md) #### Gift cards - [Gift cards overview](https://docs.fluz.app/gift-card-overview.md): Read the merchant catalog, understand fixed versus variable offers, buy a card, and reveal it — the whole gift card arc and which page to read for each step. - [Inventory on stocked offers](https://docs.fluz.app/get-inventory.md) - [Purchase gift card](https://docs.fluz.app/purchase-gift-card.md): Purchase a gift card with the purchaseGiftCard mutation, including how to select the spend account funds are drawn from. - [View gift cards](https://docs.fluz.app/view-gift-card.md) - [Gift card activity history](https://docs.fluz.app/features/gift-card-activity-history.md): Every event Fluz records on a gift card — purchase, archive and used status, balance edits, expense details, sharing, and approvals — and how each one appears in objectChangeHistory. - [Gift card error codes](https://docs.fluz.app/gift-card-error-codes.md) ##### Merchant catalog - [Merchant catalog overview](https://docs.fluz.app/merchant-catalog.md) - [Get catalog](https://docs.fluz.app/get-catalog.md) - [Get gift card offers](https://docs.fluz.app/get-gift-card-offers.md) - [Get best offer](https://docs.fluz.app/get-best-offer.md) - [Catalog fields and descriptions](https://docs.fluz.app/catalog-fields.md) #### Wallets - [Wallets & transfers](https://docs.fluz.app/features/wallets-overview.md): How money is held and moved on Fluz — balance types, spend accounts, funding in from external sources or virtual account numbers, and reading the ledger. - [Check account balance](https://docs.fluz.app/check-account-balance.md) ##### Spend accounts - [Overview](https://docs.fluz.app/features/spend-accounts.md) - [Create spend accounts](https://docs.fluz.app/features/create-spend-accounts.md) - [Get spend accounts](https://docs.fluz.app/features/get-spend-accounts.md) - [Edit spend accounts](https://docs.fluz.app/features/edit-spend-accounts.md) - [Close spend accounts](https://docs.fluz.app/features/close-spend-accounts.md) - [Transfer between spend accounts](https://docs.fluz.app/features/transfer-between-spend-accounts.md) - [Spend account activity history](https://docs.fluz.app/features/spend-account-activity-history.md): Every event Fluz records on a spend account — creation, renames, default changes, images, closure, ownership, and access — and how each one appears in objectChangeHistory. ##### Deposits & withdrawals - [Overview](https://docs.fluz.app/features/move-funds-with-external-accounts.md) - [Deposit from external accounts](https://docs.fluz.app/features/deposit-from-external-accounts.md) - [Redeem Fluz gift card](https://docs.fluz.app/features/redeem-fluz-gift-card.md) - [Withdraw to external account](https://docs.fluz.app/features/withdraw-to-external-account.md) ##### Virtual account numbers - [Virtual account numbers](https://docs.fluz.app/features/virtual-account-numbers.md): Give each spend account a real routing and account number so external senders can push funds in over RTP, FedNow, Wire, or ACH. - [Virtual account documents](https://docs.fluz.app/features/virtual-account-documents.md): Generate payment instructions, paycheck direct-deposit forms, and account status letters as PDFs for a spend account's virtual account number. #### Send money ##### Account-to-account transfers - [Overview](https://docs.fluz.app/features/account-to-account-transfers.md) - [Wallet transfer recipient lookup](https://docs.fluz.app/features/recipient-lookup.md) - [Transfer to another Fluz account](https://docs.fluz.app/features/transfer-to-another-fluz-wallet.md) - [Fund account transfers with rewards](https://docs.fluz.app/features/fund-account-transfers-with-rewards.md): Pass useRewardsBalance on createTransfer and requestAccountTransfer to fund a send from rewards, or from rewards plus the sender's spend account. #### Virtual cards - [Overview](https://docs.fluz.app/features/virtual-cards.md): Network-branded virtual cards issued instantly over the API — card types, lifecycle, the scopes each operation needs, funding, spend controls, and how to reveal card details. - [Issue cards](https://docs.fluz.app/features/create-virtual-card.md) - [Virtual card activity history](https://docs.fluz.app/features/virtual-card-activity-history.md): Every event Fluz records on a virtual card — creation, settings, locks, PINs, wallet tokens, expense details, sharing, and approvals — and how each one appears in objectChangeHistory. - [Virtual card error codes](https://docs.fluz.app/features/virtual-card-error-codes.md) - [Card status, locks & limits](https://docs.fluz.app/virtual-cards/card-status-and-limits.md): What each VirtualCardStatus means, why a locked card still reads ACTIVE, how to read a card's current limit, and how cards are closed. ##### Get card offers - [Get card offers](https://docs.fluz.app/features/get-card-offers.md) - [Card linked offers](https://docs.fluz.app/features/card-linked-offers.md) ##### Set card billing address - [Billing address overview](https://docs.fluz.app/features/billing-address.md) - [Add virtual card address](https://docs.fluz.app/features/add-billing-address.md) ##### Edit card settings - [Edit card overview](https://docs.fluz.app/features/edit-virtual-card.md) - [Lock virtual card](https://docs.fluz.app/features/lock-virtual-card.md) - [Unlock virtual card](https://docs.fluz.app/features/unlock-virtual-card.md) - [Merchant-locked virtual cards](https://docs.fluz.app/merchant-locked-virtual-cards.md): Issue a virtual card that binds to a single merchant on first use, by selecting a brand-locked card program. - [Create a single-use virtual card](https://docs.fluz.app/Create-Single-Use-Virtual-Cards.md): Issue a virtual card that locks itself automatically after one transaction. - [Manage virtual card funding sources](https://docs.fluz.app/Manage-Virtual-Card-Funding-Sources.md): Choose what pays for a virtual card — a spend account, an external bank account, rewards, prepayment balance, or a combination. ##### Digital wallets & provisioning - [Digital wallet push provisioning](https://docs.fluz.app/digital-wallet-push-provisioning.md) - [Set virtual card PIN](https://docs.fluz.app/set-virtual-card-pin.md) #### Open loop cards - [Open loop cards overview](https://docs.fluz.app/features/open-loop-cards/send-open-loop-cards.md): Generate hosted virtual card links ("open-loop" Send Cards) from your platform. You call one API to mint one or more links, then deliver those links to recipients however you like — by email, by SMS, or by handing back the raw URLs to embed in your own flows. When a recipient opens the link, they la… - [Recipient experience](https://docs.fluz.app/features/open-loop-cards/open-loop-cards-recipient-experience.md): What a recipient sees when they open a hosted virtual card link — sign-in, two-factor verification, PIN, claim, and the program rules that govern how the card can be spent. - [Register & send](https://docs.fluz.app/features/open-loop-cards/register-and-send.md): Register a recipient's identity and billing address up front with registerUser, then generate a hosted virtual card link bound to that known user with generateVCShareLinks (shareMethod: EXISTING_USER). Unlike the standard flow, the card is created at link-generation time, not at claim. - [Delivery methods](https://docs.fluz.app/features/open-loop-cards/open-loop-card-delivery-methods.md): Four ways to get an open-loop card into a recipient's hands — and how much you need to know about them to do it. - [Open loop card funding sources](https://docs.fluz.app/Manage-Open-Loop-Virtual-Card-Funding-Sources.md): Set which spend account pays for each hosted open-loop card you generate. #### Authorized users - [Authorized user overview](https://docs.fluz.app/features/authorized-user-overview.md): Give other Fluz users scoped access to your account, control what they can do with roles, and issue virtual cards on their behalf. - [Create authorized user](https://docs.fluz.app/features/create-authorized-users.md) - [Remove authorized user](https://docs.fluz.app/features/remove-authorized-user.md) - [Query authorized user](https://docs.fluz.app/features/query-authorized-user.md) - [Create virtual card for authorized user](https://docs.fluz.app/features/create-virtual-card-for-authorized-user.md) - [Create spend account for authorized user](https://docs.fluz.app/create-wallet-for-authorized-user.md): Create a spend account on your account and assign an authorized user as its owner. #### Transaction activity - [Transactions overview](https://docs.fluz.app/features/transactions-details-overview.md): One ledger for every money movement on the account — which query to reach for, what a transaction record contains, and how to reconcile against your own system. - [Get all transactions](https://docs.fluz.app/features/get-all-transactions.md) - [Transaction lifecycle](https://docs.fluz.app/virtual-card-transaction-lifecycle.md): How a card purchase travels from the merchant terminal to your ledger — authorization, clearing, settlement, reversals, and refunds — and what Fluz records at each step. - [Get virtual card transactions](https://docs.fluz.app/features/get-virtual-card-transactions.md) - [Get gift card purchases](https://docs.fluz.app/features/get-gift-card-purchases.md) - [Get declined transactions](https://docs.fluz.app/features/get-decline-transactions.md) - [Decline codes](https://docs.fluz.app/features/decline-codes.md) - [Add expense details](https://docs.fluz.app/features/add-expense-details.md) #### Approvals & requests - [Approvals & requests overview](https://docs.fluz.app/features/approvals-and-requests.md) - [Request account transfer approval](https://docs.fluz.app/features/request-account-transfer-approval.md) - [Request gift card purchase approval](https://docs.fluz.app/features/request-gift-card-purchase-approval.md) - [Request internal transfer approval](https://docs.fluz.app/features/request-internal-transfer-approval.md) - [Request reimbursement approval](https://docs.fluz.app/features/request-reimbursement-approval.md) - [Request virtual card approval](https://docs.fluz.app/features/request-virtual-card-approval.md) - [Request virtual card limit change](https://docs.fluz.app/features/request-virtual-card-limit-change.md) #### Activity history - [Activity history overview](https://docs.fluz.app/features/activity-history.md): Read the audit trail of a virtual card, gift card, spend account, or funding source: who created it, who changed what, who it was shared with, and which approval authorized each change. ## Build a platform ### Build a platform - [Overview](https://docs.fluz.app/build-a-platform.md): Register or connect your customers, get a token scoped to each of them, and run the exact same APIs you already use on your own account. #### OAuth applications - [OAuth applications overview](https://docs.fluz.app/build-a-platform/oauth-applications-overview.md): How your application gets permission to act on a Fluz user's account — the credentials involved, the permission model, the token lifecycle, and which page to read next. - [Configure OAuth app](https://docs.fluz.app/create-an-o-auth-app.md): Set up your application's identity, scope ceiling, redirect URIs, and webhook endpoints — everything that has to be right before a user can grant you access. - [Managing external reference IDs](https://docs.fluz.app/managing-external-reference-ids.md): Use your own user identifiers to drive the Fluz API — how to assign one, where it appears across OAuth, widgets, transfers, and webhooks, and how to choose one you won't regret. - [Client-facing OAuth grant flow](https://docs.fluz.app/client-facing-o-auth-grant-flow.md): Send a user to Fluz to approve your scopes, and handle the authorization code that comes back — including the state validation that makes the flow safe. - [Business accounts in OAuth](https://docs.fluz.app/business-accounts-in-o-auth.md): Let a user authorize your app against a business account — or pre-approve permissions for a business they are about to register — and understand which account an authorization code actually resolves to. - [Exchange an OAuth code](https://docs.fluz.app/exchange-an-o-auth-authorization-code.md) - [Refresh OAuth access token](https://docs.fluz.app/refresh-o-auth-access-token.md) - [Deploying to production](https://docs.fluz.app/deploying-to-production.md): Move your integration from staging to live — the endpoint map, the credentials you have to reissue, the app configuration you have to redo, and what to verify before real money moves. #### Register & verify customers - [Register & verify customers overview](https://docs.fluz.app/register-and-verify-customers-overview.md): Bring individuals and businesses onto Fluz over the API — the two onboarding tracks, the order operations have to happen in, and what each verification outcome means. ##### Register customers - [Overview](https://docs.fluz.app/user-registration.md): Create a Fluz account for one of your users over the API, handle the already-exists case correctly, and hand off to authorization and verification. - [Formatting referral links](https://docs.fluz.app/formatting-referral-links.md) ##### Verify customers - [Overview](https://docs.fluz.app/user-kyc-verification.md): Verify your customers' identities through Fluz — either by embedding the Fluz widget or by submitting verifications directly through the API. - [Verify by widget](https://docs.fluz.app/verify-customers-by-widget.md): Let the Fluz widget handle identity verification as a built-in step, with no identity data passing through your systems. - [KYC autofill](https://docs.fluz.app/verify-customers-by-autofill.md): Request an identity decision using data Fluz already has on file for the customer — no identity fields to collect or submit. - [Verify by SSN](https://docs.fluz.app/verify-customers-by-ssn.md): Submit a customer's legal name, address, date of birth, and last four SSN digits for an immediate identity decision. - [Verify by documents](https://docs.fluz.app/verify-customers-by-documents.md): Request a hosted verification link, deliver it to your customer, and let them upload their government ID and a selfie. - [Verify by external provider](https://docs.fluz.app/verify-customers-by-external-provider.md): Submit a decisioned KYC result from your own identity verification provider instead of having Fluz run the verification. ##### Business registration - [Register & verify businesses](https://docs.fluz.app/kyb-overview.md): How business registration and KYB verification work end to end: what you need in place, the sequence of calls, and how to track an application to a decision. - [Business categories](https://docs.fluz.app/business-categories.md): Fetch the business category and sub-category IDs required by registerBusiness. - [Register a business](https://docs.fluz.app/business-registration.md): Submit the legal entity record and beneficial ownership roster with the registerBusiness mutation, and open a KYB case. - [Business KYB status](https://docs.fluz.app/get-business.md): Read a business account's KYB status and each owner's identity-verification progress with the getBusiness query. - [Owner verification link](https://docs.fluz.app/get-owner-verification-link.md): Generate a shareable identity-verification link for a business owner who must verify by document. - [Submit business documents](https://docs.fluz.app/submit-business-documents.md): Upload supporting documents for a business application, and respond to documentation requests raised during KYB review. #### Embedded widgets - [Embedded widgets overview](https://docs.fluz.app/developers/widgets.md): Drop a hosted Fluz flow into your own product to collect user permissions, capture sensitive data inside our PCI scope, and confirm money movement — then run everything else server-side over the API. - [Add a new app widget](https://docs.fluz.app/developers/add-a-widget.md) - [Configure app widget](https://docs.fluz.app/developers/configure-app-widget.md) - [Set up your server for the Fluz JS widget](https://docs.fluz.app/developers/setting-up-your-server.md): Generate the signed pre-approved transaction token (patToken) your page passes to the Fluz JS widget. - [Add the JS widget to your page](https://docs.fluz.app/developers/adding-the-js-widget-to-your-page.md): Load the Fluz embedded widget, initialize it with a patToken, open it, and handle the outcome. - [Enrollment widget](https://docs.fluz.app/developers/enrollment-widget.md): The ENROLLMENT widget type: send a user through account setup right after OAuth, choosing which steps they see — identity verification, funding sources, and PIN. - [Terminate a widget session](https://docs.fluz.app/developers/terminate-widget-session.md): Cancel a payment you have already handed off to the widget, so the user can no longer complete it. - [Disable or delete your app](https://docs.fluz.app/developers/disable-or-delete-your-app.md) #### Secure elements - [Overview](https://docs.fluz.app/build-a-platform/secure-elements-overview.md): Embed a Fluz-hosted frame directly in your page to show or collect card details, without the data ever reaching your servers or your page's JavaScript. - [Card reveal](https://docs.fluz.app/build-a-platform/card-reveal.md): Mount a Fluz-hosted viewer in your page to show a user their PAN, expiry, and CVV, without the data touching your servers or your page's JavaScript. - [Secure card input](https://docs.fluz.app/build-a-platform/secure-card-input.md): Collect a physical card and add it as a payment method on a user's Fluz account, without the PAN or CVV ever touching your servers or your page's JavaScript. - [VAN reveal](https://docs.fluz.app/build-a-platform/van-reveal.md): Mount a Fluz-hosted viewer in your page to show a user the account and routing number of their own virtual account number, without the data touching your servers or your page's JavaScript. #### Bulk API - [Bulk API](https://docs.fluz.app/bulk-api.md): Read and act across many connected Fluz users in a single call, instead of looping over one user token at a time. - [Discover connected users](https://docs.fluz.app/discover-connected-users.md): Return the users connected to your application through active OAuth grants, with their external reference id and granted scopes. - [Get bulk wallet balances](https://docs.fluz.app/get-bulk-balances.md): Return cash balances across up to 100 connected users in one call, one result per target. - [Bulk gift card purchasing](https://docs.fluz.app/bulk-gift-card-purchasing.md) - [Get bulk transactions](https://docs.fluz.app/get-bulk-transactions.md): Fetch transactions across your connected users as a single flat, keyset-paginated list. - [Track a bulk job](https://docs.fluz.app/track-a-bulk-job.md): Poll a submitted bulk operation for progress, read per-target results, and download the result file. - [Cancel a bulk operation](https://docs.fluz.app/cancel-a-bulk-operation.md) ##### Bulk virtual card operations - [Create bulk order](https://docs.fluz.app/features/create-bulk-order.md) - [Get bulk order status](https://docs.fluz.app/features/get-bulk-order-status.md) #### Custom experiences - [Specialized verticals](https://docs.fluz.app/specialized-verticals.md): Gaming, prediction markets, sweepstakes, and money services businesses run on the same Fluz APIs as everyone else. Here's the review path, the forms, and what to expect. - [Custom card art](https://docs.fluz.app/custom-card-art.md): Submit your own branded card design for the cards Fluz issues to your customers, and get it approved by the bank and the network. ## Developers ### Developers - [Tools that shorten the path to production](https://docs.fluz.app/developers.md): Embeddable widgets for low-code launches, drop-in connectors for APIs you already integrate with, and real-time event notifications. - [Security & compliance](https://docs.fluz.app/developers/security.md): How Fluz protects funds, customer data, and card credentials — and what that means for your integration. #### Good to know - [How the GraphQL API works](https://docs.fluz.app/concepts/graphql.md): One endpoint, queries and mutations, and the response format you can expect from every call. - [Authentication](https://docs.fluz.app/developers/good-to-know/authentication.md): How API keys, user access tokens, and scopes work — for your own account and for connected customer accounts. - [Staging vs. live environment](https://docs.fluz.app/concepts/environments.md): The two Fluz environments, what's separate between them, how to fund a staging wallet, and how to move to live. - [Idempotency requests](https://docs.fluz.app/concepts/idempotency.md) - [Address formatting requirements](https://docs.fluz.app/concepts/address-formatting-requirements.md) - [Rate limits](https://docs.fluz.app/concepts/rate-limits.md): Fluz applies protective, per-service rate limits and GraphQL query cost limits to keep the platform stable. What the limits are, how to tell a rate limit from a cost limit, and how to build clients that stay within them. - [General API error codes](https://docs.fluz.app/get-started/general-api-error-codes.md): Error codes that are consistent across the Fluz API, with the usual cause of the ones integrators hit most. #### API connectors - [API connectors](https://docs.fluz.app/API-connectors-overview.md): Point an integration you have already built at Fluz — without rewriting it. - [Connector behaviour](https://docs.fluz.app/connector-behaviour.md): Status values, error responses, timing, limits, and the request constraints that apply to every connector. ##### Gift card API connectors - [Tango Card](https://docs.fluz.app/tango.md) - [Runa](https://docs.fluz.app/runa.md) - [InComm](https://docs.fluz.app/in-comm.md) ##### Payment processing API connectors - [Stripe](https://docs.fluz.app/stripe.md) - [Worldpay](https://docs.fluz.app/world-pay.md) - [TSYS](https://docs.fluz.app/tsys.md) - [Checkout](https://docs.fluz.app/checkout.md) - [Braintree](https://docs.fluz.app/braintree.md) - [TabaPay](https://docs.fluz.app/tabapay.md) - [Finix](https://docs.fluz.app/finix.md) - [Authorize.net](https://docs.fluz.app/authorize-net.md) - [Sola / Cardknox](https://docs.fluz.app/sola.md) ### Recipes - [Money movement](https://docs.fluz.app/recipes/deposit-funds.md): Check balances and deposit funds into your Fluz cash balance. #### Getting started - [Generate a user access token](https://docs.fluz.app/recipes/generate-user-access-token.md): Exchange API credentials for a scoped user access token. - [Get accounts](https://docs.fluz.app/recipes/get-accounts.md): List all Fluz accounts associated with a user. #### Identity verification - [Request KYC autofill](https://docs.fluz.app/recipes/verify-user-autofill.md): Request an identity decision using data already on file for the customer — no fields to submit. - [Request a user KYC verification](https://docs.fluz.app/recipes/verify-user-kyc.md): Submit user identity information for immediate KYC verification. - [Request a document verification link](https://docs.fluz.app/recipes/request-document-verification-link.md): Generate a KYC document verification link to send to a user. #### Virtual cards - [Get virtual card offers](https://docs.fluz.app/recipes/get-virtual-card-offers.md): List active virtual card offers available on your account. - [Create a virtual card](https://docs.fluz.app/recipes/create-virtual-card.md): Issue a virtual card with a spend limit and funding source. - [Edit a virtual card](https://docs.fluz.app/recipes/edit-virtual-card.md): Update the spend limit, nickname, or lock date of an existing card. - [Lock a virtual card](https://docs.fluz.app/recipes/lock-virtual-card.md): Temporarily block a virtual card from further transactions. - [Reveal a virtual card](https://docs.fluz.app/recipes/reveal-virtual-card.md): Retrieve the PAN, CVV, and expiry for an issued virtual card. - [Set a virtual card PIN](https://docs.fluz.app/recipes/set-virtual-card-pin.md): Enqueue PIN updates on all eligible virtual cards. - [Get virtual card balance](https://docs.fluz.app/recipes/get-virtual-card-balance.md): Retrieve remaining balance, spend limit, status and lock state for one or more cards. - [Get virtual card transactions](https://docs.fluz.app/recipes/get-virtual-card-transactions.md): Query virtual card activity by card, transaction type, or date range. - [Create a virtual card bulk order](https://docs.fluz.app/recipes/create-virtual-card-bulk-order.md): Issue many virtual cards in a single asynchronous request. - [Get virtual card bulk order status](https://docs.fluz.app/recipes/get-virtual-card-bulk-order-status.md): Check the status of a bulk order and retrieve the issued cards. #### Gift cards - [Get merchants](https://docs.fluz.app/recipes/get-merchants.md): Fetch the merchant catalog with offers and stock information. - [Purchase a gift card](https://docs.fluz.app/recipes/purchase-gift-card.md): End-to-end example: generate a token, purchase a gift card, and reveal its details. ## Support ### Support - [Get help with Fluz](https://docs.fluz.app/support.md): Reach the support team, talk to sales, or check live system status — whatever you need when you're stuck. ## Optional - [Hire a partner](https://fluz.app/us/integration-partners?utm_source=docs&utm_medium=sidebar) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [English / API reference (422 pages)](https://docs.fluz.app/_llms/en/api-reference.txt): Documentation for English / API reference. - [Spanish (187 pages)](https://docs.fluz.app/_llms/es.txt): Documentation for Spanish. - [Chinese (189 pages)](https://docs.fluz.app/_llms/zh.txt): Documentation for Chinese. - [Traditional Chinese (189 pages)](https://docs.fluz.app/_llms/zh-hant.txt): Documentation for Traditional Chinese. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.