Flovide API Documentation

1 Quick Start Guide

Create Account

Generate Keys

Retrieve your Public Key and Secret Key from the developer dashboard.

Make Request

Pass your keys in request headers and test balances and beneficiaries.

cURL Request

curl -X GET "http://127.0.0.1:8000/api/v1/balances" ^
  -H "Accept: application/json" ^
  -H "X-Public-Key: pk_live_xxxxxxxxxxxxxxxxx" ^
  -H "X-Secret-Key: REDACTED_STRIPE_KEY"

Authentication

The Flovide API uses your Public Key and Secret Key to authenticate requests. Include both keys in the request headers. Your public key identifies your account, while your secret key authorizes access.

All API requests must be made over HTTPS. Never expose your secret key in frontend code or public repositories.

Security

Store your secret key only on the server side. Use your public key for identification and your secret key for authorization.

Balances API

Reference

GET /api/v1/balances

List all balances

Returns all balances that belong to the matched account.

Parameters

currency String

Optional

GET /api/v1/balances/{id}

Fetch single balance

Returns one balance record for the matched account.

Path Parameter

id Integer

Required

POST /api/v1/balances

Create a balance

Creates a new balance for the matched account.

Body Parameters

name

Required

currency

Required

amount

Optional

Beneficiaries API

Reference

POST /api/v1/beneficiaries/account-inquiry

Account Inquiry

Validate recipient details before creating a beneficiary.

Body Parameters

currency

Required

bank_code

Required

account_number

Required

POST /api/v1/beneficiaries

Create beneficiary

Creates a beneficiary for the matched account.

Body Parameters

type

Required

firstNames

Individual

lastName

Individual

name

Corporate

transfer_method

Required

bank.country

Required

bank.currency

Required

bank.accountHolder

Required

GET /api/v1/beneficiaries

List beneficiaries

Returns all beneficiaries for the matched account.

GET /api/v1/beneficiaries/{id}

Fetch single beneficiary

Returns one beneficiary record for the matched account.

Path Parameter

id Integer

Required

DELETE /api/v1/beneficiaries/{id}

Delete beneficiary

Deletes a beneficiary by ID for the matched account.

Path Parameter

id Integer

Required

Transactions API

Reference

GET /api/v1/transactions

List transactions

Returns all transactions for the matched account.

GET /api/v1/transactions/{id}

Fetch single transaction

Returns one transaction record for the matched account.

Path Parameter

id Integer

Required

POST /api/v1/transactions

Initiate transaction

Creates a new transaction for the matched account.

Rates API

Reference

GET /api/v1/rates

Get exchange rate

Returns exchange rate and transfer fee for a currency pair.

Query Params

from_currency

Required

to_currency

Required

amount

Optional

Webhooks

Flovide uses webhooks to notify your application when an event happens in your account.

payment.success

Sent when a charge is successfully captured.

payout.failed

Sent when a transfer to a bank account fails.

Error Handling

Code	Meaning
400 - Bad Request	The request was unacceptable, often due to missing parameters.
401 - Unauthorized	No valid API key provided.
404 - Not Found	The requested resource doesn't exist.
500 - Server Error	Something went wrong on our end.

Official SDKs

NodeJS

PHP

Python

Java