# Fluz API Docs Documentation

> Explore the Fluz API documentation to integrate rewards, payments, wallets and business tools into your app or platform. Get started quickly with guides, endpoints, and real-world examples.

## Guides
- [Fluz API Overview ](https://docs.fluz.app/docs/overview.md)
- [Authentication & Authorization Guide](https://docs.fluz.app/docs/authentication-accessing-the-api-1.md): Accessing and interacting with the Fluz API requires proper authentication to secure your application and user data. This guide will walk you through the necessary steps, from obtaining your API Key to generating User Access Tokens for specific operations.
- [ Prepare Your Accounts](https://docs.fluz.app/docs/prepare-your-accounts.md): Before writing any code, you need the right accounts and keys.
- [Obtain Your API Credentials](https://docs.fluz.app/docs/obtain-api-credentials.md)
- [Generate a User Access Token](https://docs.fluz.app/docs/generate-a-user-access-token.md)
- [Refresh an Expired User Access Token](https://docs.fluz.app/docs/refresh-an-expired-user-access-token.md)
- [Quickstart: Your First Gift Card Purchase](https://docs.fluz.app/docs/perform-basic-api-actions.md)
- [Deposit Funds to Fluz Balance](https://docs.fluz.app/docs/deposit-funds-to-fluz-balance.md)
- [[Deposit via API] Retrieve Payment Method Id](https://docs.fluz.app/docs/deposit-via-api-retrieve-payment-method-id.md)
- [Get Available Merchants](https://docs.fluz.app/docs/get-available-merchants.md)
- [Purchase a Gift Card](https://docs.fluz.app/docs/purchase-a-gift-card.md)
- [Reveal Gift Card Details](https://docs.fluz.app/docs/reveal-gift-card-details.md)
- [Idempotency Requests](https://docs.fluz.app/docs/idempotency-requests.md)
- [API General Error Codes](https://docs.fluz.app/docs/error-codes.md)
- [Address Formatting Requirements](https://docs.fluz.app/docs/address-formatting-requirements.md)
- [Staging vs. Live Environment](https://docs.fluz.app/docs/staging-vs-live-environment.md)
- [API Testing Credentials](https://docs.fluz.app/docs/testing-credentials.md)
- [Test Bank Cards](https://docs.fluz.app/docs/test-bank-cards.md)
- [Test Bank Accounts](https://docs.fluz.app/docs/test-bank-accounts.md)
- [Testing KYC Flows](https://docs.fluz.app/docs/testing-kyc-flows.md)
- [Test Merchants](https://docs.fluz.app/docs/test-merchants.md)
- [Test Addresses](https://docs.fluz.app/docs/test-addresses.md)
- [Managing Application](https://docs.fluz.app/docs/managing-application.md)
- [Application Scopes](https://docs.fluz.app/docs/application-scopes.md)
- [Webhooks](https://docs.fluz.app/docs/webhooks-v2.md)
- [Funding Sources Overview](https://docs.fluz.app/docs/funding-sources-overview-br.md)
- [View Funding Sources](https://docs.fluz.app/docs/view-a-funding-source.md): getWallet
- [Primary & Backup Payment Methods](https://docs.fluz.app/docs/primary-backup-payment-methods.md)
- [Link External Bank Cards](https://docs.fluz.app/docs/bank-cards.md)
- [Add Bank Card](https://docs.fluz.app/docs/adding-a-funding-source-1.md): addBankCard
- [Update Bank Card](https://docs.fluz.app/docs/update-bank-card.md): You can update specific details of an existing bank card using the following mutations. These mutations require the `MANAGE_PAYMENT` scope.
- [Delete Bank Card](https://docs.fluz.app/docs/delete-bank-card.md)
- [Link External Bank Accounts](https://docs.fluz.app/docs/bank-accounts.md)
- [Linking a Plaid Bank Account](https://docs.fluz.app/docs/linking-a-plaid-bank-account.md)
- [Managing Bank Account Spend Power](https://docs.fluz.app/docs/managing-bank-account-spend-power.md)
- [Relinking Disconnected Bank Accounts](https://docs.fluz.app/docs/relinking-disconnected-bank-accounts.md)
- [Getting Bank Account Transaction Data](https://docs.fluz.app/docs/getting-bank-account-transaction-data.md)
- [Add & Withdraw Funds via External Accounts](https://docs.fluz.app/docs/add-withdraw-funds-via-external-accounts.md)
- [Deposit Funds From External Accounts](https://docs.fluz.app/docs/deposit-funds.md): depositCashBalance
- [Redeem Fluz Gift Card to Gift Card Balance](https://docs.fluz.app/docs/redeem-fluz-gift-card.md)
- [Withdraw Funds To External Account](https://docs.fluz.app/docs/withdrawal.md)
- [Spend Accounts](https://docs.fluz.app/docs/spend-accounts.md)
- [Create Spend Accounts](https://docs.fluz.app/docs/create-spend-accounts.md)
- [Get Spend Accounts](https://docs.fluz.app/docs/get-spend-accounts.md): getUserCashBalances, getUserCashBalanceById
- [Edit Spend Accounts](https://docs.fluz.app/docs/edit-spend-accounts.md)
- [Close Spend Accounts](https://docs.fluz.app/docs/close-spend-accounts.md)
- [Transfer Funds Between Spend Accounts](https://docs.fluz.app/docs/transfer-funds-internally.md)
- [Check Account Balance](https://docs.fluz.app/docs/checking-account-balance.md)
- [Account to Account Transfers](https://docs.fluz.app/docs/account-to-account-transfers.md)
- [Wallet Transfer Recipient Lookup](https://docs.fluz.app/docs/lookup-recipient.md): Used to retrieve the `account_id` of the account for transfering funds.
- [Create Wallet Transfer to Another Fluz Account](https://docs.fluz.app/docs/application-transfer.md): Move funds between your application's balance and your users' balances, or between two users.
- [Get Merchant Catalog](https://docs.fluz.app/docs/get-merchant-catalog.md): getMerchants
- [Catalog Overview](https://docs.fluz.app/docs/get-full-catalog.md)
- [List Of Catalog Fields and Descriptions](https://docs.fluz.app/docs/field-list-and-description.md)
- [Get Gift Card Offers](https://docs.fluz.app/docs/gift-card-offers.md)
- [Get the Best Offer](https://docs.fluz.app/docs/get-best-offer.md): getOfferQuote
- [Get Inventory On Stocked Offers](https://docs.fluz.app/docs/determine-stock-availability.md)
- [Purchase Gift Cards](https://docs.fluz.app/docs/purchasing-gift-cards.md)
- [Buying more than one card at a time](https://docs.fluz.app/docs/buying-more-than-one-card-at-a-time.md)
- [View Gift Cards](https://docs.fluz.app/docs/viewing-gift-card-id.md): getGiftCards, revealGiftCardByGiftCardId
- [Gift Card Error Codes](https://docs.fluz.app/docs/gift-card-error-codes.md)
- [Virtual Card Overview](https://docs.fluz.app/docs/virtual-cards.md)
- [Get Virtual Card Offers](https://docs.fluz.app/docs/get-virtual-card-offers.md)
- [Create Virtual Card](https://docs.fluz.app/docs/create-virtual-cards.md): createVirtualCard
- [Edit Virtual Card](https://docs.fluz.app/docs/edit-virtual-card.md)
- [Lock Virtual Card](https://docs.fluz.app/docs/lock-virtual-card.md)
- [Unlock Virtual Card](https://docs.fluz.app/docs/unlock-virtual-card.md)
- [Add Virtual Card Address](https://docs.fluz.app/docs/add-virtual-card-address.md)
- [Billing Address Formatting & Validation](https://docs.fluz.app/docs/billing-address-formatting-validation.md)
- [Set Virtual Card PIN](https://docs.fluz.app/docs/set-virtual-card-pin.md)
- [Digital Wallet Push Provisioning](https://docs.fluz.app/docs/virtual-card-wallet-provisioning.md)
- [Reveal Virtual Card](https://docs.fluz.app/docs/viewing-virtual-card-details.md): revealVirtualCardByVirtualCardId
- [Get Virtual Card Balance](https://docs.fluz.app/docs/get-virtual-card-balance.md)
- [Virtual Card Error Codes](https://docs.fluz.app/docs/virtual-card-error-codes.md)
- [Bulk Operations](https://docs.fluz.app/docs/bulk-operations.md)
- [Create Virtual Card Bulk Order](https://docs.fluz.app/docs/bulk-virtual-card-creation.md)
- [Get Virtual Card Bulk Order Status](https://docs.fluz.app/docs/check-bulk-creation-order-status.md)
- [Send Hosted Links With Virtual Cards](https://docs.fluz.app/docs/share-virtual-cards.md): Create and manage shareable links to distribute virtual cards on your account.
- [Generate Share Links](https://docs.fluz.app/docs/generate-share-links.md)
- [Card Linked Offers](https://docs.fluz.app/docs/card-linked-offers.md)
- [Get all Transactions](https://docs.fluz.app/docs/get-all-transactions.md)
- [Get Declined Transactions](https://docs.fluz.app/docs/get-declined-transactions.md): getDeclinedTransactions
- [Get Virtual Card Transactions](https://docs.fluz.app/docs/get-virtual-card-transactions.md): Retrieve transactions for one or more virtual cards, with support for filtering and pagination.
- [Get Gift Card Purchases](https://docs.fluz.app/docs/getuserpurchases.md)
- [Decline Codes](https://docs.fluz.app/docs/decline-codes.md)
- [Add Expense Details To Transactions](https://docs.fluz.app/docs/annotate-a-transaction-memo-category-attachment.md)
- [Create Auth User](https://docs.fluz.app/docs/create-auth-user.md)
- [Remove Auth User](https://docs.fluz.app/docs/remove-auth-user.md)
- [Create Virtual Card for Auth User](https://docs.fluz.app/docs/create-virtual-card-for-auth-user.md)
- [Query Auth Users](https://docs.fluz.app/docs/query-auth-users.md)
- [Overview](https://docs.fluz.app/docs/overview-1.md)
- [Request Account Transfer Approval](https://docs.fluz.app/docs/request-account-transfer-approval.md)
- [Request Gift Card Purchase Approval](https://docs.fluz.app/docs/request-gift-card-purchase-approval.md)
- [Request Internal Transfer Approval](https://docs.fluz.app/docs/request-internal-transfer-approval.md)
- [Request Reimbursement Approval](https://docs.fluz.app/docs/request-reimbursement-approval.md)
- [Request Virtual Card Approval](https://docs.fluz.app/docs/request-virtual-card-approval.md)
- [Request Virtual Card Limit Change Approval](https://docs.fluz.app/docs/request-virtual-card-limit-change-approval.md)
- [Widget Overview](https://docs.fluz.app/docs/widget-overview.md)
- [Add A New App Widget](https://docs.fluz.app/docs/configuring-a-widget.md)
- [Configure App Widget](https://docs.fluz.app/docs/configure-widget-for-oauth.md)
- [Setting up your server to interact with the Fluz Javascript Widget](https://docs.fluz.app/docs/setting-up-your-server-to-interact-with-the-fluz-javascript-widget.md)
- [Adding the JavaScript widget to your page](https://docs.fluz.app/docs/adding-the-javascript-widget-to-your-page.md)
- [Disable or Delete Your App](https://docs.fluz.app/docs/disable-or-delete-your-app-widget.md)
- [Create an OAuth app](https://docs.fluz.app/docs/create-an-oauth-app.md)
- [Configure OAuth App](https://docs.fluz.app/docs/configure-oauth-app.md)
- [Client facing OAuth grant flow](https://docs.fluz.app/docs/grant-widget-user-permissions-todo.md)
- [Exchanging an OAuth authorization code](https://docs.fluz.app/docs/exchanging-an-oauth-authorization-code.md)
- [Refreshing an OAuth accessToken](https://docs.fluz.app/docs/refreshing-an-oauth-access-token.md)
- [Deploying to Production](https://docs.fluz.app/docs/deploying-to-production.md)
- [Managing External Reference IDs](https://docs.fluz.app/docs/managing-external-reference-ids.md)
- [User Registration](https://docs.fluz.app/docs/user-registration.md): Create a new user account programmatically via the API.
- [User KYC Verification](https://docs.fluz.app/docs/user-kyc-verification.md)
- [Business registration](https://docs.fluz.app/docs/business-registration.md)
- [Business categories](https://docs.fluz.app/docs/business-categories.md)
- [Formatting Referral Links](https://docs.fluz.app/docs/formatting-referral-links.md)
- [Gift Card API Connectors](https://docs.fluz.app/docs/gift-card-api-connectors.md)
- [Tango Card - API Connector](https://docs.fluz.app/docs/tango-card-api-connector.md)
- [Runa - API Connector](https://docs.fluz.app/docs/runa-api-connector.md)
- [Incomm - API Connector](https://docs.fluz.app/docs/incomm-api-connector.md)
- [Payment Processing API Connectors](https://docs.fluz.app/docs/payment-processors.md)
- [Stripe - API Connector](https://docs.fluz.app/docs/stripe.md)
- [Worldpay - API Connector](https://docs.fluz.app/docs/worldpay-api-connector.md)
- [TSYS - API Connector](https://docs.fluz.app/docs/tsys-api-connector.md)
- [Checkout - API Connector](https://docs.fluz.app/docs/checkout.md)
- [Braintree - API Connector](https://docs.fluz.app/docs/braintree-api-connector.md)
- [TabaPay - API Connector](https://docs.fluz.app/docs/tabapay-api-connector.md)
- [Finix - API Connector](https://docs.fluz.app/docs/finix-api-connector.md)
- [Authorize.net - API Connector](https://docs.fluz.app/docs/authorizenet-api-connector.md)
- [Sola / Cardknox - API Connector](https://docs.fluz.app/docs/sola-cardknox-api-connector.md)
- [Wallet Withdrawal API Connectors](https://docs.fluz.app/docs/wallet-withdrawal-api-connectors.md)
- [Venmo - API Connector](https://docs.fluz.app/docs/venmo-api-connector.md)
- [PayPal - API Connector](https://docs.fluz.app/docs/paypal-api-connector.md)

## Recipes
- [Create Virtual Card Bulk Order](https://docs.fluz.app/recipes/create-virtual-card-bulk-order.md)
- [Create Virtual Card](https://docs.fluz.app/recipes/create-virtual-card.md)
- [Deposit funds](https://docs.fluz.app/recipes/deposit-funds.md)
- [Edit Virtual Card](https://docs.fluz.app/recipes/edit-virtual-card.md)
- [Generate User Access Token](https://docs.fluz.app/recipes/generate-user-access-token.md)
- [Get Accounts](https://docs.fluz.app/recipes/get-accounts.md)
- [Get Merchants](https://docs.fluz.app/recipes/get-merchants.md)
- [Get Virtual Card Balance](https://docs.fluz.app/recipes/get-virtual-card-balance.md)
- [Get Virtual Card Bulk Order Status](https://docs.fluz.app/recipes/get-virtual-card-bulk-order-status.md)
- [Get Virtual Card Offers](https://docs.fluz.app/recipes/get-virtual-card-offers.md)
- [Get Virtual Card Transactions](https://docs.fluz.app/recipes/get-virtual-card-transactions.md)
- [Lock Virtual Card](https://docs.fluz.app/recipes/lock-virtual-card.md)
- [Purchase a Gift Card](https://docs.fluz.app/recipes/purchase-a-gift-card.md)
- [Request a user KYC verification](https://docs.fluz.app/recipes/request-a-user-kyc-verification.md)
- [Request document verification link](https://docs.fluz.app/recipes/request-document-verification-link.md)
- [Reveal Virtual Card](https://docs.fluz.app/recipes/reveal-virtual-card.md)
- [Set Virtual Card PIN](https://docs.fluz.app/recipes/set-virtual-card-pin.md)

## Changelog
- [v0.0.65](https://docs.fluz.app/changelog/v0065.md)
- [v0.062](https://docs.fluz.app/changelog/v0062.md)
- [v0.0.60](https://docs.fluz.app/changelog/v0060.md)
- [v0.0.59](https://docs.fluz.app/changelog/v0059.md)
- [v0.0.58](https://docs.fluz.app/changelog/v0058.md)