FlowIQ
A comprehensive suite of APIs for financial technology, covering payments, stablecoin management, banking integrations, and compliance. Please use the `X-RapidAPI-Key` header for authentication.",
FlowIQ endpoints
| Method | Endpoint | Description |
|---|---|---|
| flow | ||
| POST |
/flow/aml /flow/aml |
Performs an Anti-Money Laundering (AML) screening on a transaction. |
| GET |
Analytics Endpoints / |
@router.get("/analytics/transactions") async def analytics_transactions(): """ Summarizes all transactions and transfers handled by FlowIQ. """ try: total_tx = len(flow_store)… |
| GET |
Tokenization Endpoints / |
@router.post("/token/mint") async def mint_token(user_id: str, amount: float): """ Mints FlowIQ tokens for user based on activity or yield participation. """ try: user_store =… |
| GET |
/flow/stablecoin/balance/{provider}/{wallet_id} /flow/stablecoin/balance/{provider}/{wallet_id} |
Retrieves the balance for a specific wallet from a supported provider (Circle, Paxos, Coinbase). |
| GET |
Wallet Management Endpoints / |
@router.post("/wallet/create") async def create_wallet(user_id: str): """ Creates a new custodial or non-custodial wallet for a user. """ try: wallet_id = str(uuid.uuid4())… |
| POST |
/flow/task/run-yield /flow/task/run-yield |
Triggers the calculation and distribution of yield for a specific deposit/flow. |
| POST |
/flow/stablecoin/transfer /flow/stablecoin/transfer |
Transfers stablecoins between two users' accounts (or connected wallets). |
| POST |
/flow/admid /flow/admid |
Performs an administrative action within the system. |
| POST |
/flow/flowpay /flow/flowpay |
Initiates a payment transaction, including KYC and AML checks. |
| POST |
/flow/flowvault /flow/flowvault |
Manages a secure vault associated with a financial flow. |
| POST |
/flow/task/deposit-settlement /flow/task/deposit-settlement |
Manually or automatically triggers the final settlement of a deposit. |
| POST |
/flow/full-compliance /flow/full-compliance |
Combines a KYC check and an optional AML screen into a single endpoint. |
| POST |
/flow/flowyield /flow/flowyield |
Calculates the potential yield for a specific financial flow. |
| POST |
/flow/initiate /flow/initiate |
Initiates a new financial flow by performing a KYC check and generating a unique flow ID. |
| POST |
/flow/flowid /flow/flowid |
Generates a unique ID for a new financial flow after a successful KYC check. |
| POST |
/flow/stablecoin/withdraw /flow/stablecoin/withdraw |
Withdraws stablecoins from a user's account to a specified address. |
| POST |
/flow/kyc /flow/kyc |
Performs a Know Your Customer (KYC) check on a user. |
| POST |
/flow/stablecoin/deposit /flow/stablecoin/deposit |
Deposits stablecoins (e.g., USDC) to a user's account. |
| banking | ||
| POST |
/banking/deposit /banking/deposit |
Initiates a fiat deposit from a linked bank account into a user's FlowIQ balance. |
| POST |
/banking/{partner_id}/compliance /banking/{partner_id}/compliance |
Sends compliance or audit notifications to FlowIQ or the partner institution. |
| GET |
/banking/account/{user_id} /banking/account/{user_id} |
Retrieves the details of a user's primary linked bank account. |
| POST |
/banking/{partner_id}/settlement /banking/{partner_id}/settlement |
Initiates fiat or stablecoin settlement between FlowIQ and partner banks. |
| POST |
/banking/register /banking/register |
Registers a bank to connect with the FlowIQ network. |
| POST |
/banking/link /banking/link |
Links a user's bank account to FlowIQ using a secure token. |
| POST |
/banking/transfer /banking/transfer |
Transfers funds between accounts (either internally within FlowIQ or externally to a recipient account). |
| POST |
/banking/settlement /banking/settlement |
Endpoint for external systems or callbacks to confirm the status of a settlement transaction. |
| POST |
/banking/withdraw /banking/withdraw |
Initiates a fiat withdrawal from a user's FlowIQ balance to their linked bank account. |
| POST |
/banking/{partner_id}/authenticate /banking/{partner_id}/authenticate |
Authenticates a registered bank partner before accessing FlowIQ settlement or custody rails. |
| api | ||
| GET |
Revenue Endpoints / |
@router.post("/revenue/record") async def record_revenue(payload: RevenueRecordRequest): """ Record a new revenue entry. """ try: entry = revenue_service.record(… |
| GET |
STAKING ENDPOINTS / |
@router.post("/staking/stake") def stake_tokens(payload: Dict[str, Any], db: Session = Depends(get_db)): """ Stake FLQ tokens for a fixed duration and earn yield. payload = {… |
| GET |
GOVERNANCE ENDPOINTS / |
@router.post("/governance/propose") def create_proposal(payload: Dict[str, Any], db: Session = Depends(get_db)): """ Submit a governance proposal. payload = { "proposer_id": str,… |
| POST |
/api/payments/provision-api-key /api/payments/provision-api-key |
Provisions a new API key for a business. |
| POST |
/api/payments/connect-bank /api/payments/connect-bank |
Connects the merchant's bank account for payouts using a secure token. |
| POST |
/api/payments/payment-intents /api/payments/payment-intents |
Creates a payment intent, which is a record of a future payment, and returns its ID. |
| POST |
/api/payments/flow/initiate /api/payments/flow/initiate |
Starts a new payment-related flow, storing initial payload data. |
| GET |
/api/payments/admid/{admin_id} /api/payments/admid/{admin_id} |
Provides a high-level overview of system metrics for an administrator. |
| GET |
/api/payments/flowid/{flow_id} /api/payments/flowid/{flow_id} |
Retrieves the data associated with a specific Flow ID. |
| POST |
/api/payments/process-payment /api/payments/process-payment |
Handles a complete checkout payment process, including item details. |
| GET |
/api/payments/merchant/stats /api/payments/merchant/stats |
Retrieves high-level performance metrics for the merchant. |
| POST |
/api/payments/flowpay/{flow_id} /api/payments/flowpay/{flow_id} |
Registers a payment event within a specific flow. |
| POST |
/api/payments /api/payments |
Creates a payment using various methods and idempotency keys. |
| POST |
/api/payments/execute-payment /api/payments/execute-payment |
Executes a previously created payment intent or a new ad-hoc payment. |
| GET |
/api/payments/merchant/payouts /api/payments/merchant/payouts |
Retrieves current balance and payout schedule information. |
| GET |
/api/payments/merchant/transactions /api/payments/merchant/transactions |
Retrieves a list of recent merchant transactions. |
| GET |
/api/payments/flowyield/{flow_id} /api/payments/flowyield/{flow_id} |
Retrieves the simulated or calculated yield for a financial flow. |
| POST |
/api/payments/merchant/payouts/request /api/payments/merchant/payouts/request |
Requests an immediate or manual payout of the current merchant balance. |
| POST |
/api/payments/flowvault/{flow_id} /api/payments/flowvault/{flow_id} |
Updates or stores data in the simulated vault for a given flow. |
| custody | ||
| POST |
/custody/wallet/create /custody/wallet/create |
Creates a new digital asset wallet with a registered custody provider. |
| POST |
/custody/provider/register /custody/provider/register |
Registers a new custody provider to work with FlowIQ. |
FlowIQ pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|