# Spotflow Documentation ## Docs - [Authentication](https://docs.spotflow.one/api-reference/authentication.md): Secure authentication is crucial for protecting your account and ensuring authorized access. All API requests require authentication with your secret key, kindly include it in the `Authorization` header for secure access. - [Create Dynamic Account](https://docs.spotflow.one/api-reference/dynamic-accounts/create-dynamic-account.md): Dynamic accounts don't act as independent money storage - they simply channel incoming payments straight to your account. These accounts cannot process outgoing payments or be linked to payment terminals. Since virtual accounts do not serve as containers for funds, there's no need for BVN verificati… - [Get Dynamic Account by ID](https://docs.spotflow.one/api-reference/dynamic-accounts/dynamic-account-id.md): Get details of your created dynamic account by its ID. - [Get All Dynamic Accounts](https://docs.spotflow.one/api-reference/dynamic-accounts/list-dynamic-account.md): This retrieves and lists all the active dynamic accounts you created. - [Error Codes](https://docs.spotflow.one/api-reference/error-codes.md): Ran into an error? Don't worry—we've got you covered. This page lists all known error codes along with simple explanations and fixes to get you back on track. - [Introduction](https://docs.spotflow.one/api-reference/introduction.md): Spotflow is your global Merchant of Record (MoR) that simplifies payment processing for businesses worldwide. We handle everything from global payment acceptance to compliance and settlement — empowering merchants to go global effortlessly. Learn how to easily integrate our APIs to streamline your i… - [Authorize Payment](https://docs.spotflow.one/api-reference/payments/authorize-collection.md): This authorizes a payment by pre-approving the transaction before final validation. Authorization required could be PIN, OTP, 3DS, AVS, etc. - [Create Payment](https://docs.spotflow.one/api-reference/payments/create-collection.md): If you have PCI-DSS certification, use this endpoint to collect payments using different payment methods. Note that for card payments, you'll use the authorize endpoint to input either the OTP or PIN. - [Get Payment](https://docs.spotflow.one/api-reference/payments/fetch-collection.md): Get details of a specific payment by its ID - [Initialize Payment](https://docs.spotflow.one/api-reference/payments/initialize-collection.md): This is Spotflow's Redirect Checkout. Initiate a payment request to generate a unique payment reference, payment code and checkout URL for your customers - [List Payments](https://docs.spotflow.one/api-reference/payments/list-collection.md): Get details of all payments collection done via your keys. - [Verify Payment](https://docs.spotflow.one/api-reference/payments/verify-collection.md): Confirm the status of a payment - [Activate Plan](https://docs.spotflow.one/api-reference/subscription-plans/activate-plan.md): Activate a subscription with the plan Id. - [Cancel Plan](https://docs.spotflow.one/api-reference/subscription-plans/cancel-plan.md): Cancel a subscription with the plan Id. - [Create Bulk Plans](https://docs.spotflow.one/api-reference/subscription-plans/create-bulk-plan.md): Create multiple subscription plans under your integration. - [Create Single Plan](https://docs.spotflow.one/api-reference/subscription-plans/create-single-plan.md): Create a subscription plan under your integration. - [Get All Plans](https://docs.spotflow.one/api-reference/subscription-plans/fetch-plan.md): This retrieves and lists all subscription plans available on your integration. - [Get Single Plan](https://docs.spotflow.one/api-reference/subscription-plans/list-single-plan.md): Retrieve details of a single subscription plan available on your integration. - [Update Plan](https://docs.spotflow.one/api-reference/subscription-plans/update-plan.md): Update the details of an existing subscription plan - [Get All Subscriptions](https://docs.spotflow.one/api-reference/subscriptions/list-subscriptions.md): Retrieve details of all subscriptions. - [Activate Subscription](https://docs.spotflow.one/api-reference/subscriptions/subscription-activate.md): Activate a subscription with the plan Id. - [Subscriptions by plan](https://docs.spotflow.one/api-reference/subscriptions/subscription-by-plan.md): Retrieve details of all subscriptions associated with a customer's plan ID. - [Cancel Subscription](https://docs.spotflow.one/api-reference/subscriptions/subscription-cancel.md): Cancel a subscription with the plan Id. - [Get Subscriptions Details](https://docs.spotflow.one/api-reference/subscriptions/subscription-details.md): This is the unique ID of the subscription or customer you want to fetch. - [Get Bulk Disbursement By Its Categories](https://docs.spotflow.one/api-reference/transfer-api/bulk-transfer-categories.md): Get details of an uploaded bulk disbursement by the categories you created with. - [Get Bulk Disbursement By ID](https://docs.spotflow.one/api-reference/transfer-api/bulk-transfer-id.md): Get details of an uploaded bulk disbursement by its id. - [Get All Bulk Disbursements](https://docs.spotflow.one/api-reference/transfer-api/bulk-transfers.md): Get details of all bulk disbursements files you have uploaded. - [Get Bulk Disbursements By ID](https://docs.spotflow.one/api-reference/transfer-api/bulk-transfers-by-id.md): Fetch all transfer details present in a bulk disbursements file by its specific id to know the status of each transaction. - [Create Bulk Disbursement](https://docs.spotflow.one/api-reference/transfer-api/create-bulk-transfer.md): You can use this endpoint to perform bulk bank account transfer to multiple bank accounts. - [Create Single Bank Disbursement](https://docs.spotflow.one/api-reference/transfer-api/create-single-transfer.md): You can use this endpoint to perform bank account transfer from your main account gotten from the [Get Main Account endpoint](/api-reference/subaccounts/main-account-balance). - [Get All Banks](https://docs.spotflow.one/api-reference/transfer-api/list-banks.md): Get details of all banks, their names and codes. Currently, this is for NGN and GHS only. - [Get All Branches](https://docs.spotflow.one/api-reference/transfer-api/list-branches.md): Retrieves a list of supported branches for a for transfers in the specified mode and selected currency - [Get Transfer By Reference](https://docs.spotflow.one/api-reference/transfer-api/transfer-by-reference.md): Get details of a particular transfer by its reference id. - [Resolve Bank Account](https://docs.spotflow.one/api-reference/transfer-api/transfer-resolve-account.md): Get/Validate A Specific Account Number and Bank Code with its details i.e the account name - [Validate Bulk Disbursements File](https://docs.spotflow.one/api-reference/transfer-api/validate-bulk-transfer.md): Use this endpoint to confirm your bulk disbursements CSV file has all the necessary details needed and won't fail when uploaded for the bulk transfer transaction. - [Get Wallet Balance](https://docs.spotflow.one/api-reference/wallets/account-balance.md): Get account balance details for a specific wallet before and after top-up in both NGN and GHS currency. - [Get Wallet Balance By Account Number](https://docs.spotflow.one/api-reference/wallets/account-balance-spotflow-wallet.md): Retrieves account balance details for all direct wallets of the specified main account in both NGN and GHS. - [Create Wallets](https://docs.spotflow.one/api-reference/wallets/create-account.md): Wallets are created only through the API and serve a unique purpose to act as a pocket of money where funds can sit in. Importantly, wallets do not require BVNs upon creation. - [Get All Wallets](https://docs.spotflow.one/api-reference/wallets/list-spotflow-wallets.md): This retrieves and lists all the wallets you've created. This is both for your main account wallet and sub account wallets. - [Get Main Wallet Balance](https://docs.spotflow.one/api-reference/wallets/main-account-balance.md): Retrieves paginated balances for main accounts with optional currency, mode, and date filters. - [Get Wallet By ID](https://docs.spotflow.one/api-reference/wallets/spotflow-wallet-id.md): Get details of your created wallet by its ID. You can get this in either NGN or GHS. - [Introduction](https://docs.spotflow.one/changelog/introduction.md): Welcome to the Spotflow Changelog. Or, as we call it, "The Big List of Things We Just Made Better." We're constantly shipping updates to make your payment processing less of a headache. We're obsessed with building a platform that just works for global merchants. Consider this page our public commit… - [v1.52.4 (15 Oct 2025)](https://docs.spotflow.one/changelog/v1.52.4.md): This release was focused on getting you started faster and giving you the tools to grow. - [v1.52.5 (29 Oct 2025)](https://docs.spotflow.one/changelog/v1.52.5.md): This release is all about security, control, and giving you more data to work with. - [Community Contributions](https://docs.spotflow.one/contributions/overview.md): Discover community-built SDKs and libraries for Spotflow. - [Projects Catalog](https://docs.spotflow.one/contributions/projects.md): Community-maintained libraries and SDKs for Spotflow. - [Share Your Contributions](https://docs.spotflow.one/contributions/submit.md): How to add your open-source project to Spotflow's contributions directory - [Introduction](https://docs.spotflow.one/developer-resources/android-sdk.md): The Spotflow Android SDK empowers developers to seamlessly integrate payment functionalities into their Android applications. It provides UI components and methods that allows you accept payment in your Android app. - [Angular Library](https://docs.spotflow.one/developer-resources/angular-library.md): The `Spotflow Angular SDK` enables users to make payments seamlessly. It integrates smoothly into your Angular application, providing a streamlined checkout experience. - [Introduction](https://docs.spotflow.one/developer-resources/flutter-sdk.md): Our Flutter SDK provides a rich set of pre-built UI components and APIs to seamlessly integrate payment functionalities within your Flutter application.

The `Spotflow Flutter SDK` pallows you to integrate smooth and secure payment flows into your Flutter apps. It supports both Android and… - [Introduction](https://docs.spotflow.one/developer-resources/iOS-sdk.md): The Spotflow iOS SDK is a SwiftUI library that allows developers to integrate payment collection functionality into their iOS applications. It provides a simple interface to navigate to a payment screen, handle payment logic, and manage success or failure callbacks using the `SpotFlowPaymentUI` clas… - [Introduction](https://docs.spotflow.one/developer-resources/inline-js.md): InlineJS is Spotflow's JavaScript library designed to simplify the integration of payment functionalities into your web application. By embedding InlineJS into your checkout page, you can create a seamless payment experience without the need for redirects. It integrates smoothly into your applicatio… - [Create Spotflow Payment Links In Under 5 Minutes (No Code Required)](https://docs.spotflow.one/developer-resources/integration-guide.md): This guide will help you create a Spotflow Payment Link in under 5 minutes with no code required. - [Introduction](https://docs.spotflow.one/developer-resources/introduction.md): Welcome to the Spotflow Core - This section contains everything you need to successfully integrate, test, master and go live with the Spotflow platform. - [React Library](https://docs.spotflow.one/developer-resources/react-library.md): The `Spotflow React SDK` helps you or rather enables your users to make payments seamlessly. It integrates smoothly into your application, providing a streamlined checkout experience. - [Integrate Spotflow Initialize/Redirect API Into Your Application](https://docs.spotflow.one/developer-resources/redirectapi-in-your-app.md): This tutorial will help you integrate the Spotflow API into your application. - [Vue Library](https://docs.spotflow.one/developer-resources/vue-library.md): This `Spotflow Vue.js library` wraps around the [inline library](https://github.com/Spotflow-One/spotflow-checkout-inline), which enables your users to make payments seamlessly. It integrates smoothly into your Vue.js application, providing a streamlined checkout experience. - [Accounts](https://docs.spotflow.one/developer-resources/webhooks/accounts.md): This is the structure of the data payload sent to your webhook URL to notify your system about debits, credits, status updates related to Spotflow Wallets and Dynamic Accounts. - [Overview](https://docs.spotflow.one/developer-resources/webhooks/overview.md): Webhooks are your essential tool for real-time notifications. They provide instant, server-to-server notifications when critical events occur within the Spotflow platform, ensuring your application is always up-to-date, enabling seamless integration. - [Payment Collections](https://docs.spotflow.one/developer-resources/webhooks/payment-collections.md): This is the structure of the data payload sent to your webhook URL whenever a payment collection is successful within Spotflow. - [FAQs](https://docs.spotflow.one/expert-desk/faq.md): Comprehensive answers to common questions about Spotflow, covering everything from onboarding, payments, subscriptions, compliance to technical integration, designed to help you navigate and make the most of our platform. - [Help and Support](https://docs.spotflow.one/expert-desk/help-support.md): We understand that even the most seamless platforms require a lifeline now and then. At Spotflow, we keep our support channels tight and highly technical, ensuring you get the right expert, fast. - [Test Mode Vs Live Mode](https://docs.spotflow.one/expert-desk/test-mode-vs-live-mode.md): Learn the critical differences between Test and Live mode and how to switch between them. - [Testing Payments](https://docs.spotflow.one/expert-desk/testing-payments.md): You can use the following details to test your implementation for card and mobile money payments before going live. Note that this works only with your test keys. - [Verification Process](https://docs.spotflow.one/expert-desk/verification-process.md): Learn how to successfully complete our mandatory onboarding verification process, ensuring compliance and facilitating quick approval so you can start processing payments. - [Account Management](https://docs.spotflow.one/features/account-management.md): The Payout process is how your earned revenue moves from your Spotflow Balance to your preferred Bank Account via Bank Transfer. We offer flexible cycles to match your cash flow needs. - [Available Regions](https://docs.spotflow.one/features/available-regions.md): Explore Spotflow's geographic coverage and supported payment channels. - [Dynamic Accounts](https://docs.spotflow.one/features/dynamic-accounts.md): Dynamic accounts are intelligent payment routing tools that automatically channel incoming collections directly to your main Spotflow account. Think of them not as bank accounts that hold money, but as virtual smart conduits that simplify payment collection without fund segregation. - [MoR VS PG](https://docs.spotflow.one/features/mor-vs-pg.md): Digital businesses often face a choice: the hands-on approach of a Payment Gateway (PG) or the simplified path of a Merchant of Record (MoR). At Spotflow, we operate as your Merchant of Record (MoR) to simplify global payments, especially across Africa, by managing compliance, local taxes, and compl… - [Accepting Payment Collections](https://docs.spotflow.one/features/payment-collections.md): Payments are processed by creating a transaction using our APIs, libraries, or SDKs. - [Payment Methods](https://docs.spotflow.one/features/payment-methods.md): This is your complete guide to the payment methods currently supported by Spotflow. We activate and manage these regional options automatically to maximize your conversion across Africa. - [Payout Structure](https://docs.spotflow.one/features/payout-structure.md): The Payout process is how your earned revenue moves from your Spotflow Balance to your preferred Bank Account via Bank Transfer. We offer flexible cycles to match your cash flow needs. - [Security Reporting Policy](https://docs.spotflow.one/features/security-policy.md): At Spotflow, security is foundational and we take it seriously. If you discover a vulnerability, we appreciate your responsible disclosure to help us improve our platform and maintain its integrity. - [Settlement](https://docs.spotflow.one/features/settlement.md): Settlement is the process of transferring collected funds from your Spotflow platform account directly into your designated bank account. Think of it as Spotflow's job of making sure your hard work actually pays the bills. - [Single and Bulk Disbursements](https://docs.spotflow.one/features/single-and-bulk-disbursements.md): With our APIs, initiating funds disbursements is straightforward and seamless. We maintain strict security and compliance standards to ensure every transaction is processed safely and responsibly. This process covers payouts to vendors, contractors, or moving funds between accounts. - [Spotflow Checkout Demo](https://docs.spotflow.one/features/spotflow-demo-checkout.md): This is a fully realistic showcase of our redirect checkout solution that eliminates the need for direct payment gateway integration on your application. See exactly how hassle-free, professional, and smooth the user journey is for payment collections. - [Subscription Payment Collections](https://docs.spotflow.one/features/subscription-payment-collections.md): Offer recurring billing for memberships, SaaS, or services with flexible cycles, tiered pricing, and automated renewals. This is your engine for predictable revenue. - [Collections](https://docs.spotflow.one/features/transactions/collections.md): The Collections page provides a detailed, real-time overview of all customer transactions processed through Spotflow. Here, you as a merchant can track collection statuses, initiate refunds, resend webhooks, and access comprehensive payment details for every transaction. - [Spotflow Wallets](https://docs.spotflow.one/features/wallets.md): Spotflow Wallets (formerly called sub-accounts) are powerful, virtual, API-only financial containers designed to store and manage funds independently within your account ecosystem. Unlike Dynamic Accounts, which simply route payments, Wallets maintain their own balances and act as genuine repositori… - [Your Team Members](https://docs.spotflow.one/features/your-team-members.md): The Spotflow Invite/Add User feature enables you to onboard team members to your dashboard, granting them secure access based on customizable roles and permissions. Ensure secure and flexible collaboration by allowing full modification rights or restricting access to view-only mode. - [Introduction](https://docs.spotflow.one/introduction.md): Welcome to Spotflow, the Merchant of Record (MOR) that simplifies global payments. We handle the entire end-to-end lifecycle for your business—from managing transactions and compliance to ensuring timely payouts. ## OpenAPI Specs - [openapi](https://docs.spotflow.one/openapi.json)