Welcome to Flowbrite’s Developer Docs

Explore our guides and API reference to integrate Flowbrite’s services into your product.

Fundamentals

At it’s core Flowbrite’s platform is built on wallets. These wallets allow clients to hold funds in multiple currencies, convert between these currencies, and to send and receive payments internationally.

Each wallet has one or more collection accounts attached to it to with details that can be shared with customers. Using these collection accounts clients can accept payments or fund their wallets using both local and global payment networks.

FX (forex, foreign exchange) conversions can be booked to move funds between wallets as either spot or forward contracts. Spot contracts exchange within 2 working days, while forward contracts allow clients to lock in a rate for a future date but may require a deposit to be held.

Payments are made from wallets to beneficiaries and can be sent in various currencies also using both local and global payment networks.

The API

The Flowbrite API is based on REST principles, providing a simple and secure way to process payments and convert funds. For asynchronous operations, webhooks can be used to receive real-time updates about status changes and other events.

API keys are used to authenticate requests, and can be scoped to specific permissions for enhanced security.

Dip into the resource references below to find out about our core objects and endpoints.

Wallets

Learn about the wallet model and the various transaction types that affect your balance.

FX Conversions

Learn about the conversion model and how to book trades.

Beneficiaries

Learn about how to create, retrieve, update, and delete beneficiaries.

Payments

Learn about the payment model and how to send payments to beneficiaries.