Skip to main content

​
Overview

Welcome to the Inflow API. Use it to create customers, collect cross-currency payments through hosted checkout, provision virtual accounts, and manage organization wallets. Start with Quickstart, then follow the workflow guides before diving into the endpoint reference.

​
What is Inflow?

Inflow provides APIs for financial operations across your customer lifecycle. You can:
  • Manage Customers: Onboard, track, and manage your users easily.
  • Process Payments & Cross-Currency Settlement: Generate payment requests, allow your customers to pay in their local currency, and settle the funds in your preferred currency.
  • Manage Wallets: Track balances, manage multi-currency wallets, and initiate withdrawals (e.g., NGN to local bank accounts).

​
API basics

​
Authentication

All API requests require an organization API key from the Inflow Dashboard. Send it as a Bearer token; keys begin with gtw_sk_. Include your API key in the Authorization header of your HTTP requests:

​
Base URL

Use the environment that matches your key:
Keep API keys on your server. Never ship a secret key in browser, mobile, or other client-side code.

​
Integration paths

Choose the guide that matches what you are building:

​
Typical payment flow

  1. Create a customer and store the customer ID.
  2. Optionally quote the exchange rate to show the payer the collection amount.
  3. Create a payment using a unique reference and the customer ID.
  4. Redirect the payer to the returned payment link.
  5. Retrieve the payment from your server and fulfil only after the required final status.

​
Next Steps

Explore the API reference in the sidebar for required fields, permissions, and full response schemas. Use sandbox until your end-to-end flow has been tested.