> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Flutterwave

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

![Flutterwave logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/flutterwave.ico?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=a822ff89f9e43f4cc431b80c8d204b89)

* **Category:** payment processing
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 53
* **Triggers:** 0
* **Slug:** `FLUTTERWAVE`
* **Version:** 20261101\_00

## Tools

> [accordion] Cancel Payment Plan
>
> **Slug:** `FLUTTERWAVE_CANCEL_PAYMENT_PLAN`
>
> Tool to cancel a payment plan. Use when you need to prevent all future subscriptions under this plan.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the payment plan to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Beneficiary
>
> **Slug:** `FLUTTERWAVE_CREATE_BENEFICIARY`
>
> Tool to create a new transfer beneficiary. Use when you need to add a beneficiary before making a transfer.
>
> #### Input Parameters
>
> **account\_bank** `string` *required*
>
> The beneficiary's bank code. Retrieve valid codes via the get\_banks endpoint.
>
> **account\_number** `string` *required*
>
> The beneficiary's account number. Example: '0690000041'
>
> **beneficiary\_name** `string`
>
> Optional: The full name of the beneficiary, if different from the account holder name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bulk Tokenized Charge
>
> **Slug:** `FLUTTERWAVE_CREATE_BULK_TOKENIZED_CHARGE`
>
> Tool to create a bulk tokenized charge batch for charging multiple previously tokenized cards. Use when you need to process multiple recurring or subscription charges in a single batch. Each charge must reference a valid card token obtained from prior tokenization.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Descriptive title identifying this bulk charge batch
>
> **bulk\_data** `array` *required*
>
> List of individual charge items to process. Each must have a unique tx\_ref
>
> **retry\_strategy** `object`
>
> Configuration for automatic charge retry behavior.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bulk Virtual Account Numbers
>
> **Slug:** `FLUTTERWAVE_CREATE_BULK_VIRTUAL_ACCOUNT_NUMBERS`
>
> Tool to create multiple virtual account numbers. Use when you need to generate multiple static virtual accounts for customers in a single request.
>
> #### Input Parameters
>
> **batch\_ref** `string` *required*
>
> Unique reference to identify this batch of virtual accounts.
>
> **bulk\_data** `array` *required*
>
> List of virtual account details for each customer in the batch.
>
> **narration** `string`
>
> Context or reason for this bulk creation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payment Link
>
> **Slug:** `FLUTTERWAVE_CREATE_PAYMENT_LINK`
>
> Tool to create a hosted payment link. Use when you need a shareable payment URL for one-time transactions.
>
> #### Input Parameters
>
> **amount** `string` *required*
>
> Amount to charge; must be greater than 0
>
> **tx\_ref** `string` *required*
>
> Unique transaction reference
>
> **currency** `string` *required*
>
> ISO 4217 currency code
>
> **customer** `object` *required*
>
> Customer contact information
>
> **redirect\_url** `string` *required*
>
> URL to redirect customer after payment
>
> **customizations** `object`
>
> Optional customization for the payment link.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payment Plan
>
> **Slug:** `FLUTTERWAVE_CREATE_PAYMENT_PLAN`
>
> Tool to create a new payment plan. Use after confirming plan and customer details.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the payment plan. Appears on subscription reminder emails.
>
> **amount** `string`
>
> The amount to charge each billing cycle. If omitted, uses the amount from subscription initiation.
>
> **currency** `string`
>
> Currency code (ISO 4217). Defaults to 'NGN'.
>
> **duration** `integer`
>
> The duration in billing cycles. For example, 5 for five months if interval='monthly'. If unset, the plan continues indefinitely.
>
> **interval** `string` *required*
>
> The billing interval; one of 'hourly', 'daily', 'weekly', 'monthly', 'yearly', 'quarterly', 'bi-annually', or custom like 'every five months'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Refund
>
> **Slug:** `FLUTTERWAVE_CREATE_REFUND`
>
> Tool to create a refund for a transaction. Use when you need to initiate a refund after confirming the transaction ID and refund amount.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the transaction to refund
>
> **amount** `string` *required*
>
> Amount to refund as a string. Must not exceed the original transaction amount.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Subaccount
>
> **Slug:** `FLUTTERWAVE_CREATE_SUBACCOUNT`
>
> Tool to create a new subaccount. Use when you need to configure split disbursement accounts.
>
> #### Input Parameters
>
> **meta** `array`
>
> Additional metadata as list of name/value pairs
>
> **country** `string`
>
> Country code for the subaccount
>
> **split\_type** `string ("percentage" | "flat")` *required*
>
> Split type: 'percentage' or 'flat'
>
> **split\_value** `number` *required*
>
> Split value for disbursement. For 'percentage' type, use decimal format (e.g., 0.10 for 10%, 0.25 for 25%). For 'flat' type, use the actual amount in the local currency.
>
> **account\_bank** `string` *required*
>
> Bank ISO code for the subaccount
>
> **business\_name** `string` *required*
>
> Business name for the subaccount
>
> **account\_number** `string` *required*
>
> Bank account number for the subaccount
>
> **business\_email** `string` *required*
>
> Business email address
>
> **business\_mobile** `string`
>
> Primary business contact mobile number
>
> **business\_contact** `string`
>
> Business contact person name
>
> **business\_contact\_mobile** `string`
>
> Business contact mobile number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Virtual Account
>
> **Slug:** `FLUTTERWAVE_CREATE_VIRTUAL_ACCOUNT`
>
> Tool to create a new virtual account number. Use after confirming customer details when assigning a unique account for bank transfers.
>
> #### Input Parameters
>
> **bvn** `string`
>
> Customer's Bank Verification Number; required if is\_permanent is true.
>
> **email** `string` *required*
>
> Customer's email address.
>
> **amount** `number` *required*
>
> Exact amount to be collected per transaction (minimum 1).
>
> **tx\_ref** `string`
>
> Merchant's transaction reference to echo with incoming payments.
>
> **duration** `integer`
>
> Number of days before a dynamic account expires.
>
> **lastname** `string`
>
> Customer's last name.
>
> **firstname** `string`
>
> Customer's first name.
>
> **frequency** `integer`
>
> Number of times a dynamic account can be used before expiring.
>
> **narration** `string`
>
> Description shown when retrieving account details.
>
> **phonenumber** `string`
>
> Customer's phone number with country code.
>
> **is\_permanent** `boolean`
>
> Set to true for a static (permanent) virtual account; defaults to false (dynamic account).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Beneficiary
>
> **Slug:** `FLUTTERWAVE_DELETE_BENEFICIARY`
>
> 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.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Unique identifier of the beneficiary to delete, obtained via the list-all-beneficiaries endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Subaccount
>
> **Slug:** `FLUTTERWAVE_DELETE_SUBACCOUNT`
>
> Tool to delete a subaccount by ID. Use when you need to remove a subaccount from your Flutterwave account.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The numeric ID of the subaccount to delete (e.g., from the 'id' field returned when creating a subaccount, not the 'subaccount\_id' field which starts with RS\_)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable Payment Link
>
> **Slug:** `FLUTTERWAVE_DISABLE_PAYMENT_LINK`
>
> Tool to disable a Flutterwave payment link. Use when you need to prevent further payments from an existing link after confirming the link is valid.
>
> #### Input Parameters
>
> **link** `string` *required*
>
> The full URL of the payment link to disable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Beneficiary
>
> **Slug:** `FLUTTERWAVE_FETCH_BENEFICIARY`
>
> Tool to retrieve details of a specific beneficiary by ID. Use after obtaining a beneficiary ID to fetch its full details from Flutterwave.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Unique identifier of the beneficiary to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Subaccount
>
> **Slug:** `FLUTTERWAVE_FETCH_SUBACCOUNT`
>
> Tool to retrieve details of a specific subaccount by ID. Use when you need full subaccount info after creating or updating splits.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The numeric ID of the subaccount to retrieve (e.g., from the 'id' field returned when creating a subaccount, not the 'subaccount\_id' field which starts with RS\_)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Transaction Reference
>
> **Slug:** `FLUTTERWAVE_GENERATE_TRANSACTION_REFERENCE`
>
> Tool to generate a unique transaction reference. Use when initiating a new Flutterwave transaction requires a unique reference to prevent duplication.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All Subscriptions
>
> **Slug:** `FLUTTERWAVE_GET_ALL_SUBSCRIPTIONS`
>
> Retrieve a page of subscriptions, including cancelled subscriptions, for auditing or reporting. Pagination parameters can be used to retrieve other pages.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>= 1)
>
> **per\_page** `integer`
>
> Number of records per page (>= 1)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve all transactions
>
> **Slug:** `FLUTTERWAVE_GET_ALL_TRANSACTIONS`
>
> 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.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to fetch (>= 1)
>
> **status** `string ("successful" | "failed")`
>
> Filter transactions by status ('successful' or 'failed')
>
> **tx\_ref** `string`
>
> Filter transactions by transaction reference
>
> **to\_date** `string`
>
> End date for fetching transactions (YYYY-MM-DD)
>
> **currency** `string`
>
> Filter transactions by currency (e.g., 'NGN', 'USD')
>
> **from\_date** `string`
>
> Start date for fetching transactions (YYYY-MM-DD)
>
> **customer\_email** `string`
>
> Filter transactions by customer email
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All Wallet Balances
>
> **Slug:** `FLUTTERWAVE_GET_ALL_WALLET_BALANCES`
>
> Tool to retrieve all wallet balances across currencies. Use when reconciling balances after authentication.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Balances per Currency
>
> **Slug:** `FLUTTERWAVE_GET_BALANCES_PER_CURRENCY`
>
> Tool to retrieve wallet balance for a specific currency. Use after transactions to confirm available and ledger balances in a given currency.
>
> #### Input Parameters
>
> **currency** `string` *required*
>
> Three-letter ISO currency code of the wallet, e.g., 'NGN', 'USD'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bank Branches
>
> **Slug:** `FLUTTERWAVE_GET_BANK_BRANCHES`
>
> Tool to retrieve branch codes for a specific bank. Use when you need branch information for transfers in countries like Ghana that require branch codes.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Unique identifier of the bank to retrieve branches for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Banks by Country
>
> **Slug:** `FLUTTERWAVE_GET_BANKS_BY_COUNTRY`
>
> Tool to retrieve all banks in a specified country. Use when you need to get available banks for transfers or payments in a specific country.
>
> #### Input Parameters
>
> **country** `string` *required*
>
> ISO 3166-1 alpha-2 country code (e.g., NG for Nigeria, GH for Ghana, KE for Kenya, UG for Uganda, ZA for South Africa, TZ for Tanzania).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bill Categories
>
> **Slug:** `FLUTTERWAVE_GET_BILL_CATEGORIES`
>
> Tool to retrieve available bill categories. Use after authenticating to Flutterwave to display bill payment options to users.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Tokenized Charge Status
>
> **Slug:** `FLUTTERWAVE_GET_BULK_TOKENIZED_CHARGE`
>
> Tool to retrieve the status of a bulk tokenized charge operation by ID. Use after initiating a bulk tokenized charge to check its processing status.
>
> #### Input Parameters
>
> **bulk\_id** `string` *required*
>
> Unique identifier of the bulk tokenized charge to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Virtual Account
>
> **Slug:** `FLUTTERWAVE_GET_BULK_VIRTUAL_ACCOUNT`
>
> Tool to fetch bulk virtual account details using batch ID. Use this after creating bulk virtual accounts to retrieve the generated account numbers and their details.
>
> #### Input Parameters
>
> **batch\_id** `string` *required*
>
> Unique identifier for the batch of virtual accounts to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Multiple Refund Transactions
>
> **Slug:** `FLUTTERWAVE_GET_MULTIPLE_REFUND_TRANSACTIONS`
>
> Tool to retrieve multiple refund transactions with optional filters. Use when you need to fetch paginated refund data after confirming valid API credentials.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>= 1)
>
> **status** `string ("completed" | "pending")`
>
> Filter refunds by status ('completed' or 'pending')
>
> **flw\_ref** `string`
>
> Filter refunds by Flutterwave reference
>
> **to\_date** `string`
>
> End date for filtering refunds (YYYY-MM-DD)
>
> **from\_date** `string`
>
> Start date for filtering refunds (YYYY-MM-DD)
>
> **page\_size** `integer`
>
> Number of records per page (>= 1)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment Plan
>
> **Slug:** `FLUTTERWAVE_GET_PAYMENT_PLAN`
>
> Tool to retrieve details of a specific payment plan by ID. Use after obtaining the payment plan ID to fetch its details from Flutterwave.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Unique identifier of the payment plan to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment Plans
>
> **Slug:** `FLUTTERWAVE_GET_PAYMENT_PLANS`
>
> Tool to retrieve a list of all payment plans. Use when you need to fetch and present your account’s configured billing plans.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Refund
>
> **Slug:** `FLUTTERWAVE_GET_REFUND`
>
> Tool to retrieve details of a specific refund by ID. Use after obtaining the refund ID to fetch its details from Flutterwave.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Unique identifier of the refund to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Transaction
>
> **Slug:** `FLUTTERWAVE_GET_TRANSACTION`
>
> Tool to retrieve details of a specific transaction by ID. Use after obtaining the transaction ID to fetch its details from Flutterwave.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Unique identifier of the transaction to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Transaction Fee
>
> **Slug:** `FLUTTERWAVE_GET_TRANSACTION_FEE`
>
> Retrieve collection transaction fees for an amount and currency to estimate the total charge before initiating a payment.
>
> #### Input Parameters
>
> **amount** `number` *required*
>
> The amount to be charged from the customer (must be non-negative)
>
> **currency** `string` *required*
>
> Currency code in ISO 4217 format, e.g., NGN or USD
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Transfer Fee
>
> **Slug:** `FLUTTERWAVE_GET_TRANSFER_FEE`
>
> 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."
>
> #### Input Parameters
>
> **type** `string ("account" | "mobilemoney" | "barter")`
>
> Type of transfer: 'account', 'mobilemoney', or 'barter'.
>
> **amount** `integer` *required*
>
> The amount to be transferred. Must be a positive integer.
>
> **currency** `string`
>
> ISO 4217 currency code for the transfer (e.g., 'NGN', 'USD').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Transfer Rates
>
> **Slug:** `FLUTTERWAVE_GET_TRANSFER_RATES`
>
> Tool to retrieve exchange rates for transfers between currencies. Use when you need to calculate conversion rates before initiating a cross-currency transfer.
>
> #### Input Parameters
>
> **amount** `number` *required*
>
> The destination amount for which to calculate transfer rates. Must be a positive number.
>
> **source\_currency** `string` *required*
>
> ISO 4217 currency code for the source currency (e.g., 'NGN', 'KES', 'GHS').
>
> **destination\_currency** `string` *required*
>
> ISO 4217 currency code for the destination currency (e.g., 'USD', 'EUR', 'GBP').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Virtual Account Number
>
> **Slug:** `FLUTTERWAVE_GET_VIRTUAL_ACCOUNT_NUMBER`
>
> Tool to fetch details of a virtual account number by order reference. Use when you need to retrieve account details after creation.
>
> #### Input Parameters
>
> **order\_ref** `string` *required*
>
> The order reference returned when the virtual account was created (e.g., URF\_1771052916369\_342835)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Wallet Statement
>
> **Slug:** `FLUTTERWAVE_GET_WALLET_STATEMENT`
>
> Tool to retrieve wallet balance history with optional filters. Use when you need to view transaction history and balance changes over a period.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination
>
> **to\_date** `string`
>
> End date for transaction history (format: YYYY-MM-DD)
>
> **currency** `string`
>
> Filter by currency (e.g., USD, NGN, GHS)
>
> **from\_date** `string`
>
> Start date for transaction history (format: YYYY-MM-DD)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Initiate BVN Verification
>
> **Slug:** `FLUTTERWAVE_INITIATE_BVN_VERIFICATION`
>
> Initiate consent for verification of a customer's Bank Verification Number (BVN). The response may include a consent page URL and a reference for the request.
>
> #### Input Parameters
>
> **bvn** `string` *required*
>
> The Bank Verification Number (11 digits)
>
> **lastname** `string` *required*
>
> The customer's last name
>
> **firstname** `string` *required*
>
> The customer's first name
>
> **redirect\_url** `string` *required*
>
> The URL where the customer will be redirected after consent is granted or declined
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Initiate Mobile Money Tanzania
>
> **Slug:** `FLUTTERWAVE_INITIATE_MOBILE_MONEY_TANZANIA`
>
> Tool to initiate a mobile money payment in Tanzania. Use after collecting customer details to charge via Tanzanian mobile money networks.
>
> #### Input Parameters
>
> **meta** `object`
>
> Additional custom metadata as key/value pairs
>
> **email** `string` *required*
>
> Customer's email address
>
> **amount** `number` *required*
>
> Amount to charge; must be greater than 0
>
> **tx\_ref** `string` *required*
>
> Unique transaction reference for this payment
>
> **network** `string`
>
> Mobile money network, e.g., 'Halopesa'
>
> **currency** `string` *required*
>
> Currency code in ISO 4217 format; must be 'TZS'
>
> **fullname** `string`
>
> Customer's full name
>
> **client\_ip** `string`
>
> Customer's IP address
>
> **phone\_number** `string` *required*
>
> Customer's mobile number in international format (e.g., +255712345678)
>
> **device\_fingerprint** `string`
>
> Device fingerprint for enhanced fraud detection
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Beneficiaries
>
> **Slug:** `FLUTTERWAVE_LIST_ALL_BENEFICIARIES`
>
> Tool to list all saved beneficiaries. Use when you need to retrieve all transfer beneficiaries associated with your account.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>= 1)
>
> **per\_page** `integer`
>
> Number of records per page (>= 1)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Biller Products
>
> **Slug:** `FLUTTERWAVE_LIST_BILLER_PRODUCTS`
>
> Tool to retrieve all products available under a specific biller. Use after getting bill categories to display available products for bill payment.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Biller code to retrieve products for (e.g., 'BIL136').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Billers
>
> **Slug:** `FLUTTERWAVE_LIST_BILLERS`
>
> Tool to retrieve available billers. Use after authenticating to Flutterwave to display bill payment biller options to users.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Chargebacks
>
> **Slug:** `FLUTTERWAVE_LIST_CHARGEBACKS`
>
> Tool to retrieve a list of chargebacks with optional filtering by Flutterwave reference. Use when you need to view all chargebacks or search for a specific chargeback by transaction reference.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>= 1)
>
> **flw\_ref** `string`
>
> Flutterwave reference to filter chargebacks by specific transaction
>
> **per\_page** `integer`
>
> Number of records per page (>= 1)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payout Subaccount Refunds
>
> **Slug:** `FLUTTERWAVE_LIST_PAYOUT_SUBACCOUNT_REFUNDS`
>
> Tool to list all payout subaccount refunds with pagination support. Use when you need to retrieve payout subaccount refund history with optional page filtering.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>= 1)
>
> **per\_page** `integer`
>
> Number of records per page (>= 1)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payout Subaccounts
>
> **Slug:** `FLUTTERWAVE_LIST_PAYOUT_SUBACCOUNTS`
>
> Tool to list all payout subaccounts. Use when you need to retrieve all payout subaccounts associated with your Flutterwave account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Recurring Bills
>
> **Slug:** `FLUTTERWAVE_LIST_RECURRING_BILLS`
>
> Tool to retrieve all recurring bill payments. Use when you need to view scheduled or active recurring billing arrangements.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all settlements
>
> **Slug:** `FLUTTERWAVE_LIST_SETTLEMENTS`
>
> Retrieve a page of settlements with optional date and subaccount filters, for viewing settlement records and tracking payment disbursements.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (>= 1)
>
> **to\_date** `string`
>
> End date for filtering settlements (YYYY-MM-DD format)
>
> **from\_date** `string`
>
> Start date for filtering settlements (YYYY-MM-DD format)
>
> **subaccount\_id** `string`
>
> Filter settlements by subaccount ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Subaccounts
>
> **Slug:** `FLUTTERWAVE_LIST_SUBACCOUNTS`
>
> Fetch a page of collection subaccounts used for split disbursements, with optional pagination controls.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>= 1)
>
> **per\_page** `integer`
>
> Number of records per page (>= 1)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Transfers
>
> **Slug:** `FLUTTERWAVE_LIST_TRANSFERS`
>
> Fetch a page of transfers from your Flutterwave account to review transfer history and statuses, with optional reference or status filters.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to fetch (>= 1). Used for pagination.
>
> **status** `string`
>
> Filter transfers by status (e.g., 'successful', 'failed', 'pending', 'new')
>
> **reference** `string`
>
> Filter transfers by reference. Use this to find a specific transfer by its reference.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve Bank Account
>
> **Slug:** `FLUTTERWAVE_RESOLVE_BANK_ACCOUNT`
>
> Tool to verify and resolve bank account details. Use when you need to retrieve the account holder name for a Nigerian bank account by providing the account number and bank code.
>
> #### Input Parameters
>
> **account\_bank** `string` *required*
>
> Bank code for the account. Retrieve valid codes via the get banks endpoint. Example: '044' for Access Bank.
>
> **account\_number** `string` *required*
>
> Bank account number to resolve. Example: '0690000034'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve Card BIN
>
> **Slug:** `FLUTTERWAVE_RESOLVE_CARD_BIN`
>
> Tool to resolve and retrieve card BIN information from Flutterwave. Use when you need to get issuer details, card type, and country information for a 6-digit BIN.
>
> #### Input Parameters
>
> **bin** `string` *required*
>
> 6-digit Bank Identification Number (BIN) to resolve. The BIN is the first 6 digits of a card number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Payment Plan
>
> **Slug:** `FLUTTERWAVE_UPDATE_PAYMENT_PLAN`
>
> Tool to update an existing payment plan. Use when you need to modify a payment plan's name or status.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the payment plan to update.
>
> **name** `string`
>
> The new name for the payment plan. If provided, updates the plan name.
>
> **status** `string`
>
> The new status for the payment plan. Common values include 'active' or 'cancelled'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Subaccount
>
> **Slug:** `FLUTTERWAVE_UPDATE_SUBACCOUNT`
>
> Tool to update an existing subaccount. Use when you need to modify split disbursement settings or business details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The numeric ID of the subaccount to update (e.g., from the 'id' field returned when creating a subaccount, not the 'subaccount\_id' field which starts with RS\_)
>
> **split\_type** `string ("percentage" | "flat")`
>
> Updated split type: 'percentage' or 'flat'
>
> **split\_value** `string`
>
> Updated split value for disbursement. For 'percentage' type, use the percentage value (e.g., '10' for 10%). For 'flat' type, use the actual amount in the local currency (e.g., '250'). Pass as string to match API expectations.
>
> **account\_bank** `string`
>
> Updated bank ISO code for the subaccount
>
> **business\_name** `string`
>
> Updated business name for the subaccount
>
> **account\_number** `string`
>
> Updated bank account number for the subaccount
>
> **business\_email** `string`
>
> Updated business email address
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Bill Item
>
> **Slug:** `FLUTTERWAVE_VALIDATE_BILL_ITEM`
>
> Tool to validate a bill service before payment. Use before initiating a bill payment to confirm the customer identifier (account number, meter number, etc.) is valid and retrieve customer details.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Biller code (e.g., BIL119 for DSTV in test mode)
>
> **customer** `string` *required*
>
> Customer identifier to validate (e.g., account number, meter number, or phone number)
>
> **item\_code** `string` *required*
>
> Product/item code to validate (e.g., CB141 for DSTV in test mode)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Transaction by Reference
>
> **Slug:** `FLUTTERWAVE_VERIFY_TRANSACTION_BY_REFERENCE`
>
> Tool to verify a transaction using its transaction reference. Use when you have a transaction reference (tx\_ref) and need to confirm the transaction status and retrieve its details.
>
> #### Input Parameters
>
> **tx\_ref** `string` *required*
>
> Transaction reference to verify. This is the unique reference provided during transaction initiation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View Transaction Timeline
>
> **Slug:** `FLUTTERWAVE_VIEW_TRANSACTION_TIMELINE`
>
> Tool to retrieve the event timeline for a transaction. Use after obtaining the transaction ID to audit or track the sequence of events.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Unique identifier of the transaction to retrieve its event timeline (>=1).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
