Flutterwave

Learn how to use Flutterwave with Composio

Overview

Enum

FLUTTERWAVE

Description

Flutterwave is a payments technology company that provides payment infrastructure and APIs enabling businesses to accept and send payments in Africa and globally.

Authentication Details

secret_key
stringRequired

Actions

Tool to create a new transfer beneficiary. use when you need to add a beneficiary before making a transfer.

Action Parameters

account_bank
stringRequired
account_number
stringRequired
beneficiary_name
string

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to create multiple virtual account numbers. use when you need to generate multiple static virtual accounts for customers in a single request.

Action Parameters

batch_ref
stringRequired
bulk_data
arrayRequired
narration
string

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to create a new payment plan. use after confirming plan and customer details.

Action Parameters

amount
number
currency
string
duration
integer
interval
stringRequired
name
stringRequired

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to create a new subaccount. use when you need to configure split disbursement accounts.

Action Parameters

account_bank
stringRequired
account_number
stringRequired
business_contact
string
business_contact_mobile
string
business_email
string
business_mobile
string
business_name
stringRequired
country
string
meta
array
split_type
stringRequired
split_value
numberRequired

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to create a new virtual account number. use after confirming customer details when assigning a unique account for bank transfers.

Action Parameters

amount
number
bvn
string
duration
integer
email
stringRequired
firstname
string
frequency
integer
is_permanent
boolean
lastname
string
narration
string
phonenumber
string
tx_ref
string

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to delete a beneficiary by id. use when you need to remove a saved transfer beneficiary by its unique id after confirming the id.

Action Parameters

id
integerRequired

Action Response

data
string
error
string
message
string
status
string
successful
boolean
Tool to retrieve details of a specific beneficiary by id. use after obtaining a beneficiary id to fetch its full details from flutterwave.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to retrieve details of a specific subaccount by id. use when you need full subaccount info after creating or updating splits.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to generate a unique transaction reference. use when initiating a new flutterwave transaction requires a unique reference to prevent duplication.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to retrieve all subscriptions, including cancelled ones. use when you need a comprehensive list of subscription records for auditing or reporting.

Action Parameters

Action Response

data
array
error
string
message
string
status
string
successful
boolean
Tool to retrieve a list of all transactions with optional filters. use when you need to paginate or filter transaction history after confirming valid api credentials.

Action Parameters

currency
string
customer_email
from_date
page
integer
status
string
to_date
tx_ref
string

Action Response

data
array
error
string
message
string
meta
object
status
string
successful
boolean
Tool to retrieve all wallet balances across currencies. use when reconciling balances after authentication.

Action Parameters

Action Response

data
array
error
string
message
string
status
string
successful
boolean
Tool to retrieve wallet balance for a specific currency. use after transactions to confirm available and ledger balances in a given currency.

Action Parameters

currency
stringRequired

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to retrieve available bill categories. use after authenticating to flutterwave to display bill payment options to users.

Action Parameters

Action Response

data
array
error
string
message
string
status
string
successful
boolean
Tool to retrieve multiple refund transactions with optional filters. use when you need to fetch paginated refund data after confirming valid api credentials.

Action Parameters

flw_ref
string
from_date
page
integer
page_size
integer
status
string
to_date

Action Response

data
array
error
string
message
string
meta
object
status
string
successful
boolean
Tool to retrieve a list of all payment plans. use when you need to fetch and present your account’s configured billing plans.

Action Parameters

Action Response

data
array
error
string
message
string
status
string
successful
boolean
Tool to retrieve details of a specific transaction by id. use after obtaining the transaction id to fetch its details from flutterwave.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to retrieve the fee for a specific transaction. use when you need to calculate the total charge including fees before initiating the transaction.

Action Parameters

amount
integerRequired
currency
stringRequired

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to retrieve the fee for initiating a transfer. use when you need to estimate transfer costs before creating a transfer. example: "calculate the fee for transferring ngn 5000 to an account."

Action Parameters

amount
integerRequired
currency
string
type
string

Action Response

data
array
error
string
message
string
status
string
successful
boolean
Tool to initiate a mobile money payment in tanzania. use after collecting customer details to charge via tanzanian mobile money networks.

Action Parameters

amount
numberRequired
client_ip
string
currency
stringRequired
device_fingerprint
string
email
stringRequired
fullname
string
meta
object
network
string
phone_number
stringRequired
tx_ref
stringRequired

Action Response

data
object
error
string
message
string
status
string
successful
boolean
Tool to list all saved beneficiaries. use when you need to retrieve all transfer beneficiaries associated with your account.

Action Parameters

Action Response

data
array
error
string
message
string
meta
object
status
string
successful
boolean
Tool to retrieve the event timeline for a transaction. use after obtaining the transaction id to audit or track the sequence of events.

Action Parameters

id
integerRequired

Action Response

data
array
error
string
message
string
status
string
successful
boolean