The Flutterwave connector lets your AI agent act in each user's Flutterwave account. Each user connects their own Flutterwave access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 37 · 20 · 337 read20 write3 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Flutterwave connection
In AgentKit > Connections, create a Flutterwave connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'flutterwave'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Flutterwave:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'flutterwave_balances_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "flutterwave"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Flutterwave:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="flutterwave_balances_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Flutterwave credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolflutterwave_balance_getGet your available and ledger balance in one currency.Read-onlyGet Wallet Balance
Get your available and ledger balance in one currency.
Inputs
currencystringrequired- ISO 4217 currency code. Example: NGN.
flutterwave_balances_listGet your available and ledger balance in every currency wallet.Read-onlyList Wallet Balances
Get your available and ledger balance in every currency wallet.
Inputs
This tool takes no inputs.
flutterwave_bank_account_resolveLook up the account holder name of a bank account number before sending a transfer.Read-onlyResolve Bank Account Name
Look up the account holder name of a bank account number before sending a transfer. Returns account_number and account_name.
Inputs
account_bankstringrequired- The Customer's Bank code. See full list of bank codes here. Example: 044.
account_numberstringrequired- The Customer's Bank account number. Example: 0690000032.
flutterwave_bank_branches_listList the branches of a bank with their branch codes (needed for transfers in some countries).Read-onlyList Bank Branches
List the branches of a bank with their branch codes (needed for transfers in some countries).
Inputs
idintegerrequired- The Bank's unique ID returned in the fetch response. Example: 280.
flutterwave_banks_listList the banks supported in a country with their codes.Read-onlyList Banks
List the banks supported in a country with their codes. Use the code as account_bank in transfers and account lookups.
Inputs
countrystringrequired- ISO-2 country code e.g. NG. Example: NG.
include_provider_typestring- This introduces a field that helps differentiate between a bank and mobile money provider. Example: 1.
flutterwave_beneficiaries_listList saved transfer beneficiaries.Read-onlyList Beneficiaries
List saved transfer beneficiaries. Returns per beneficiary its id, account number, bank and name. Results are paged; pass page for the next page.
Inputs
pageinteger- This is the page number to retrieve e.g. setting 1 retrieves the first page. Example: 1.
flutterwave_beneficiary_getGet one transfer beneficiary by ID.Read-onlyGet Beneficiary
Get one transfer beneficiary by ID.
Inputs
idintegerrequired- This is the unique identifier for the beneficiary you intend to fetch. It is returned in the call to create a beneficiary as data.id. Example: 3644.
flutterwave_bill_categories_listList the bill categories (airtime, data, cable, power and others) you can pay in a country.Read-onlyList Bill Categories
List the bill categories (airtime, data, cable, power and others) you can pay in a country. Returns per category its code and name.
Inputs
countrystring- This is the country of the Biller. The expected value is NG. Example: NG.
flutterwave_bill_customer_validateValidate a customer identifier (meter number, smartcard number, phone and so on) for a bill item before paying.Read-onlyValidate Bill Customer
Validate a customer identifier (meter number, smartcard number, phone and so on) for a bill item before paying. Returns the customer name and status.
Inputs
customerstringrequired- This is the customer identifier For airtime, the value must be the customer's phone number. For DSTV, it must be the customer's smartcard number. Example: 08038291822.
item_codestringrequired- This is the item_code returned from bills categories endpoint as data[i].item_code. Example: AT099.
flutterwave_bill_items_listList the items (products and plans) a biller offers, with item_code, name, amount and fee.Read-onlyList Biller Items
List the items (products and plans) a biller offers, with item_code, name, amount and fee.
Inputs
biller_codestringrequired- The unique identifier for the biller. This is returned as data[i].biller_code in the get billers response. Example: BIL119.
flutterwave_bill_payment_status_getGet the status of a bill payment by reference, including the token for prepaid electricity.Read-onlyGet Bill Payment Status
Get the status of a bill payment by reference, including the token for prepaid electricity.
Inputs
referencestringrequired- This is the tx_ref of the bill transaction. Example: 9300049404444.
verboseinteger- This flag allows us to return the status of the bill payment from the provider. Example: 1.
flutterwave_bill_payments_history_listList past bill payments, filtered by status, dates, reference, batch, category or country, with commission earned.Read-onlyList Bill Payment History
List past bill payments, filtered by status, dates, reference, batch, category or country, with commission earned. Results are paged; pass page for the next page.
Inputs
batch_referencestring- This unique identifier for a bulk payment. Example: batch-ref-abc123.
categorystring- The bill category code. Example: CABLEBILLS.
countrystring- This is the country of the Biller. Allowed values: NG, GH, KE, ZM. Example: NG.
fromstring- This is the start date it can be in any of this formats: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD. Example: 2018-08-01.
limitstring- The number of entries returned per page. Example: 10.
pagestring- The page index to start the search from. Example: 1.
referencestring- This unique identifier for a single payment. Example: ref-abc123.
statusstring- The transaction status Allowed values: Successful, Failed, Reversed. Example: Successful.
tostring- This is the end date, it can be in any of this formats: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD. Example: 2018-08-27.
flutterwave_bill_payments_summary_getGet totals of bill payments in a date range, including commission earned.Read-onlyGet Bill Payments Summary
Get totals of bill payments in a date range, including commission earned.
Inputs
fromstring- This is the start date it can be in any of this formats: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD. Example: 2018-08-01.
tostring- This is the end date, it can be in any of this formats: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD. Example: 2018-08-27.
flutterwave_billers_listList the billers in a bill category for a country.Read-onlyList Billers in Category
List the billers in a bill category for a country. Returns per biller its biller_code and name.
Inputs
categorystringrequired- The bill category code. Example: CABLEBILLS.
countrystringrequired- This is the country of the Biller. The expected value is NG. Example: NG.
flutterwave_card_bin_resolveGet the issuer, card type and country of a card from its first six digits (BIN).Read-onlyResolve Card BIN
Get the issuer, card type and country of a card from its first six digits (BIN).
Inputs
binintegerrequired- The first 6 six digits on the customer's debit/credit card. Example: 123456.
flutterwave_chargebacks_listList chargebacks raised against your transactions, optionally by status, dates, currency, flw_ref or id.Read-onlyList Chargebacks
List chargebacks raised against your transactions, optionally by status, dates, currency, flw_ref or id. Results are paged; pass page for the next page.
Inputs
currencystring- ISO 4217 currency code. Example: NGN.
flw_refstring- A unique Flutterwave reference for the transaction returned as flw_ref. Example: YemiDesola/FLW275389391.
fromstring- The start date of the data query in YYYY-MM-DD. Example: 2020-08-01.
idstring- The unique identifier for the transaction. Example: 288192886.
pageinteger- The page of the data to retrieve e.g. setting 1 retrieves the first page. Example: 1.
statusstring- The status of the chargeback i.e. lost, won, initiated, accepted, or declined . Example: lost.
tostring- The finish date of the data query in YYYY-MM-DD. Example: 2020-08-14.
flutterwave_payment_plan_getGet one payment plan by ID.Read-onlyGet Payment Plan
Get one payment plan by ID.
Inputs
idintegerrequired- This is the unique id of the payment plan you want to fetch. It is returned in the call to create a payment plan as data.id. Example: 3807.
flutterwave_payment_plans_listList recurring payment plans, optionally by date range, amount, currency, interval or status.Read-onlyList Payment Plans
List recurring payment plans, optionally by date range, amount, currency, interval or status. Returns per plan its id, name, amount, interval, duration, status and plan token. Results are paged; pass page for the next page.
Inputs
amountinteger- This is the exact amount set when creating the payment plan. Example: 5000.
currencystring- This is the currency the payment plan amount is charged in. Example: NGN.
fromstring- This is the specified date to start the list from. YYYY-MM-DD. Example: 2020-01-01.
intervalstring- This is how often the payment plan is set to execute. Example: weekly.
pageinteger- This is the page number to retrieve e.g. setting 1 retrieves the first page. Example: 1.
statusstring- This is the status of the payment plan. Example: active.
tostring- The is the specified end period for the search. YYYY-MM-DD. Example: 2020-05-05.
flutterwave_refund_getGet one refund by ID with its amount, status and transaction.Read-onlyGet Refund
Get one refund by ID with its amount, status and transaction.
Inputs
idintegerrequired- This is a unique transaction identifier generated by our systems. It is returned in the initiate charge and verify transaction responses as data.id. Example: 469462.
flutterwave_refunds_listList refunds, optionally by date range, status, currency or flw_ref.Read-onlyList Refunds
List refunds, optionally by date range, status, currency or flw_ref. Returns per refund its id, amount, status, flw_ref, transaction and dates.
Inputs
currencystring- This is the specified currency to charge in. All currencies supported by Flutterwave can be passed here. You can check our Currency listing for more details. Example: NGN.
flw_refstring- This is the unique reference for the refund transaction. It can be retrieved from the initial refund response as flw_ref. Example: 4687213286.
fromstring- This is the specified date to start the list from. YYYY-MM-DD. Example: 2020-01-01.
idstring- This is a unique transaction identifier generated by our systems. It is returned in the initiate charge and verify transaction responses as data.id. Example: 99025.
statusstring- This is the status for the queried refunds, Expected values include: successful, failed and completed. Example: completed-mpgs.
tostring- The is the specified end period for the search . YYYY-MM-DD. Example: 2020-10-30.
flutterwave_settlement_getGet one settlement with the transactions it includes.Read-onlyGet Settlement
Get one settlement with the transactions it includes.
Inputs
idintegerrequired- This is a unique identifier for the particular settlement you want to fetch. It is returned in the call to list all settlements as data.id. Example: 41497.
pagestring- This is the page number to retrieve e.g. setting 1 retrieves the first page. Example: 1.
flutterwave_settlements_listList settlements (payouts of collected funds to your bank account), optionally by date range or subaccount.Read-onlyList Settlements
List settlements (payouts of collected funds to your bank account), optionally by date range or subaccount. Results are paged; pass page for the next page.
Inputs
disburse_refstring- The disbursement reference ID to filter settlement logs by. This unique identifier is returned when a disbursement is initiated and can be used to track specific settlement transactions. Example: DISBURSE-123456.
fromstring- This is the specified date to start the data query from. It should take a YYYY-MM-DD format. Example: 2024-01-01.
pageinteger- The page of the data to retrieve e.g. setting 1 retrieves the first page. Example: 1.
subaccount_idstring- The subaccount ID to query settlement logs for. This is returned as subaccount_id when creating a subaccount. Example: PSA5D901175CB7307974.
tostring- This is the specified end date for the data query. It should take a YYYY-MM-DD format. Example: 2024-12-31.
flutterwave_subaccount_getGet one collection subaccount by ID with its bank account and split settings.Read-onlyGet Subaccount
Get one collection subaccount by ID with its bank account and split settings.
Inputs
idintegerrequired- This is the unique id of the sub account you want to fetch. It is returned in the call to create a sub account as data.id. Example: 2181.
flutterwave_subaccounts_listList collection subaccounts (split payment recipients), optionally by bank or account number.Read-onlyList Subaccounts
List collection subaccounts (split payment recipients), optionally by bank or account number. Returns per subaccount its id, subaccount_id, business name, bank account and split settings. Results are paged; pass page for the next page.
Inputs
account_bankstring- This is the sub-accounts bank ISO code. Example: 044.
account_numberstring- This is the account number associated with the subaccount you want to fetch. Example: 0690000031.
bank_namestring- This is the name of the bank associated with the ISO code provided in account_bankfield. Example: Access Bank Nigeria.
pageinteger- This is the page number to retrieve e.g. setting 1 retrieves the first page. Example: 1.
flutterwave_subscriptions_listList customer subscriptions to payment plans, filtered by email, transaction, plan, dates or status.Read-onlyList Subscriptions
List customer subscriptions to payment plans, filtered by email, transaction, plan, dates or status. Returns per subscription its id, customer, plan, amount, status and next due date. Results are paged; pass page for the next page.
Inputs
emailstring- This is the email of the subscriber. You can use this to query the transactions for a single customer. Example: user@gmail.com.
next_due_fromstring- This is the parameter to filter from the start date of the next due subscriptions. Example: 2020-01-01.
next_due_tostring- This is the parameter to filter to the end date of the next due subscriptions. Example: 2020-05-05.
pageinteger- This is the page number to retrieve e.g. setting 1 retrieves the first page. Example: 1.
planinteger- This is the ID of the payment plan. It is returned in the call to create a payment plan as data.id. Example: 3874.
statusstring- This is the status for the queried transactions. Expected values are active and cancelled. Example: active.
subscribed_fromstring- This is the start date of the subscriptions(when they are first active). You can use this as a starting point for your query. The expected date format for this parameter is YYYY-MM-DD. Example: 2020-01-01.
subscribed_tostring- This is the end date for a subscription. Like subscribed_from, It also has an expected date format of YYYY-MM-DD. Example: 2020-05-05.
transaction_idinteger- This is a unique transaction identifier generated by our systems. It is returned in the initiate charge response as data.id. Example: 1190701.
flutterwave_transaction_events_listGet the timeline of events of a transaction (checkout opened, payment method chosen, OTP sent and so on).Read-onlyView Transaction Timeline
Get the timeline of events of a transaction (checkout opened, payment method chosen, OTP sent and so on). Use this to see where a customer dropped off.
Inputs
idintegerrequired- This is a unique transaction identifier generated by our systems. It is returned in the initiate charge and verify transaction responses as data.id. Example: 957764.
flutterwave_transaction_fee_getGet the fee Flutterwave charges to collect an amount in a currency, optionally for a payment type or card BIN.Read-onlyGet Transaction Fee
Get the fee Flutterwave charges to collect an amount in a currency, optionally for a payment type or card BIN. Returns the fee, merchant fee and charge amount.
Inputs
amountintegerrequired- This is the amount of the product or service to be charged from the customer. Example: 1000.
currencystringrequired- This is the specified currency to charge in. Example: NGN.
card_first6digitsinteger- This can be used only when the user has entered first 6digits of their card number, it also helps determine international fees on the transaction if the card being used is an international card. Example: 536613.
payment_typestring- This is an optional parameter to be used when getting the transaction fees for different payment types. Expected values are card, debit_ng_account, mobilemoney, bank_transfer, and ach_payment.Kindly note that different fees are applied to the different methods, You can check our fee document for more details. Example: card.
flutterwave_transaction_verifyVerify a transaction by its Flutterwave ID and get its final status.Read-onlyVerify Transaction
Verify a transaction by its Flutterwave ID and get its final status. Returns status, amount, charged amount, currency, tx_ref, flw_ref, payment type, card or account details and customer. Always verify before giving value.
Inputs
idintegerrequired- This is the transaction unique identifier. It is returned in the initiate transaction call as data.id. Example: 288200108.
flutterwave_transaction_verify_by_referenceVerify a transaction by your tx_ref and get its final status, amount, currency and customer.Read-onlyVerify Transaction by Reference
Verify a transaction by your tx_ref and get its final status, amount, currency and customer. Use this when you only have your own reference.
Inputs
tx_refstringrequired- The unique reference you set when you created the transaction. Example: DevRef002156.
flutterwave_transactions_listList collection transactions in a date range, optionally by status, reference, customer or currency.Read-onlyList Transactions
List collection transactions in a date range, optionally by status, reference, customer or currency. Returns per transaction its id, tx_ref, flw_ref, amount, charged amount, fee, currency, status, payment type, customer and date. Results are paged; pass page for the next page. Use flutterwave_transaction_verify for one transaction.
Inputs
fromstringrequired- This is the specified date to start the list from. YYYY-MM-DD. Example: 2020-01-01.
tostringrequired- The is the specified end period for the search . YYYY-MM-DD. Example: 2020-01-14.
currencystring- This is the specified currency to charge in. All currencies supported by Flutterwave can be passed here. You can check our Currency listing for more details. Example: NGN.
customer_emailstring- This is the email of the customer who carried out a transaction. You can use this to query the transactions for a single customer. Example: user@example.com.
customer_fullnamestring- The Customer's full name. Example: Yemi Desola.
pageinteger- This is the page number to retrieve e.g. setting 1 retrieves the first page. Example: 1.
statusstring- This is the status for the queried transactions. Expected values for status include successful and failed. Example: successful.
tx_refstring- This is the unique merchant reference tied to a transaction. This should be specified when querying a specific transaction. Example: new-transaction-ref.
flutterwave_transfer_fee_getGet the fee for a transfer of an amount in a currency, optionally by type (account or mobilemoney).Read-onlyGet Transfer Fee
Get the fee for a transfer of an amount in a currency, optionally by type (account or mobilemoney). Returns the fee and fee type.
Inputs
amountintegerrequired- This is the amount to be transferred. Example: 10000.
currencystringrequired- This is the specified currency for the transfer. Expected values include: NGN, USD, GHS, KES, UGX, RWF. Example: NGN.
typestring- This is the type of transfer you want to get the fee for. Expected values are mobilemoney and account. Example: account.
flutterwave_transfer_getGet one transfer by ID with its status, amount, fee, recipient and completion message.Read-onlyGet Transfer
Get one transfer by ID with its status, amount, fee, recipient and completion message.
Inputs
idintegerrequired- This is the numeric ID of the transfer you want to fetch. It is returned in the call to create a transfer as data.id. Example: 26251.
flutterwave_transfer_rates_getGet the exchange rate to send an amount in a destination currency from a source currency balance.Read-onlyGet Transfer Rate
Get the exchange rate to send an amount in a destination currency from a source currency balance. Returns the rate and the source amount.
Inputs
amountintegerrequired- This is the amount to transfer to the recipient. Example: 1000.
destination_currencystringrequired- This is the currency of the wallet you are making a transfer to. Example: USD.
source_currencystringrequired- This is the currency of the wallet being debited for the transfer. Example: NGN.
flutterwave_transfer_retries_getList the retry attempts of a transfer with their status.Read-onlyGet Transfer Retries
List the retry attempts of a transfer with their status.
Inputs
idintegerrequired- This is the numeric ID of the transfer you want to fetch. It is returned in the call to create a transfer as data.id. Example: 26251.
flutterwave_transfers_listList transfers, optionally by reference, status or date range.Read-onlyList Transfers
List transfers, optionally by reference, status or date range. Returns per transfer its id, account, bank, amount, fee, currency, status, reference, narration and date. Results are paged; pass page for the next page.
Inputs
fromstring- This is the start date for the query. Example: 2026-01-01.
pagestring- This allows you fetch from a specific page e.g. setting 1 retrieves the first page. Example: 1.
page_sizestring- The number of query results to return per page. If unspecified, this would default to 10 items per page. Example: 20.
referencestring- The merchant's unique reference for the transfer. Example: ref-abc123.
statusstring- This allows you fetch only transfers with a specific status e.g. fetch all successful transactions. Expected values include failed, successful. Example: successful.
tostring- This is the end date for the query. Example: 2026-01-31.
flutterwave_virtual_account_getGet a virtual account number by its order_ref.Read-onlyGet Virtual Account Number
Get a virtual account number by its order_ref.
Inputs
order_refstringrequired- The order reference generated for the virtual account. Example: URF_1579513580629_5981535.
flutterwave_wallet_statement_getGet the balance history (credits and debits) of a currency wallet in a date range.Read-onlyGet Wallet Statement
Get the balance history (credits and debits) of a currency wallet in a date range. Results are paged; pass page for the next page.
Inputs
currencystringrequired- ISO 4217 currency code. Example: USD.
fromstringrequired- The start date for the filter query in YYYY-MM-DD. Example: 2021-01-01.
tostringrequired- The end date for the filter query in YYYY-MM-DD. Example: 2021-01-05.
pageinteger- The page of the data to retrieve. Example: 1.
typestring- This indicate the transaction type, i.e. credit(C) or debit(D). Example: C.
flutterwave_beneficiary_createSave a bank account as a transfer beneficiary.WriteCreate Beneficiary
Save a bank account as a transfer beneficiary. Returns the beneficiary with its id.
Inputs
account_bankstringrequired- This is the Bank numeric code. It can be gotten from the get banks endpoint. Example: 044.
account_numberstringrequired- This is the account number of the customer. Example: 0690000032.
beneficiary_namestringrequired- This is the name of the beneficiary for the transfer. Example: Flutterwave Developers.
bank_namestring- This is the name of the beneficiary bank. Example: ACCESS BANK NIGERIA.
currencystring- This is the based of the country of the beneficiary bank. If country is KE, supply KES, if NG, supply NGN. Example: NGN.
flutterwave_bill_payment_createPay a bill (airtime, data, cable, electricity and others) for a customer from your Flutterwave balance.WriteCreate Bill Payment
Pay a bill (airtime, data, cable, electricity and others) for a customer from your Flutterwave balance. Returns the payment with its reference and status. This spends real money.
Inputs
amountnumberrequired- This is the amount for the service you would like to buy. Example: 500.
biller_codestringrequired- The unique identifier for the biller. This is returned as data[i].biller_code in the get billers response. Example: BIL099.
countrystringrequired- This is the country attached to the service being bought e.g. if service is Airtime and country is NG it means you are buying airtime in Nigeria. Example: NG.
customer_idstringrequired- This is the customer identifier. For airtime, the value must be the customer's phone number. For DSTV, it must be the customer's smartcard number. Example: +23490803840303.
item_codestringrequired- This is the item_code returned from bills categories endpoint as data[i].item_code. Example: AT099.
callback_urlstring- Merchant-specific URL for bill payment callbacks. Example: https://webhook.site/5f9a659a-11a2-4925-89cf-8a59ea6a019a.
referencestring- This is a unique reference passed by the developer to identify transactions on their end. Example: 9300049404444.
flutterwave_bulk_transfer_createSend many transfers in one batch.WriteCreate Bulk Transfer
Send many transfers in one batch. Each bulk_data entry takes the same fields as a single transfer. Returns the batch with its id. This moves real money.
Inputs
bulk_dataarrayrequired- Transfers to make, each with bank_code, account_number, amount, currency, narration and reference. Example: [{"bank_code": "044", "account_number": "0690000032", "amount": 500, "currency": "NGN", "narration": "Salary", "reference": "sal-0001"}]
currencystringrequired- The currency of the Transfer. Example: NGN.
titlestring- This is the title of the bulk transfer attempt. Example: March staff salary payment.
flutterwave_charge_captureCapture a preauthorized card charge, for the full or a smaller amount.WriteCapture Preauthorized Charge
Capture a preauthorized card charge, for the full or a smaller amount. Returns the captured charge.
Inputs
amountstringrequired- This is the amount to be captured. This allows you to capture an amount less than the original amount authorised on the card. Example: 1000.
flw_refstringrequired- This is the data.flw_ref returned in the charge response. Example: FLW001296992.
flutterwave_charge_preauth_refundRefund a captured preauthorized charge.WriteRefund Preauthorized Charge
Refund a captured preauthorized charge. Returns the refund.
Inputs
amountstringrequired- This is the amount to be refunded. Example: 1000.
flw_refstringrequired- This is a unique reference internally generated by Flutterwave. It is returned as data.flw_ref in the charge response. Example: FLW001296992.
flutterwave_chargeback_respondAccept or decline a chargeback with a comment.WriteAccept or Decline Chargeback
Accept or decline a chargeback with a comment. Returns the chargeback.
- Idempotent
Inputs
actionstringrequired- The action you want to perform on the chargeback i.e. accept or decline. Example: accept.
commentstringrequired- Give a reason why you're accepting or rejecting the chargeback. Example: I accept the chargeback.
idstringrequired- Unique identifier for the chargeback. Example: 143.
flutterwave_payment_link_createCreate a Flutterwave hosted checkout link for a customer to pay an amount by card, bank transfer, USSD, mobile money and other enabled methods.WriteCreate Payment Link (Checkout)
Create a Flutterwave hosted checkout link for a customer to pay an amount by card, bank transfer, USSD, mobile money and other enabled methods. Returns data.link, the URL to send the customer to. Use flutterwave_transaction_verify after payment to confirm it.
Inputs
amountintegerrequired- Amount to charge, in the currency's main unit. Example: 1000.
customer_emailstringrequired- Customer email address. Example: customer@example.com.
tx_refstringrequired- Your unique reference for this payment. Example: order-1042-a1.
currencystring- The currency to charge in. Defaults to "NGN" if not specified. Example: NGN.
customer_namestring- Customer full name. Example: Yemi Desola.
customer_phonestring- Customer phone number. Example: 08012345678.
descriptionstring- Description shown on the checkout page. Example: Payment for order #1042.
link_expirationstring- Sets how long the hosted payment link remains valid. Example: 2024-02-14T12:20:00.
logostring- URL of a logo to show on the checkout page. Example: https://example.com/logo.png.
metaobject- Extra data to store with the transaction, as an object. Example: {"order_id": "1042"}
payment_optionsstring- Comma-separated list of payment methods to display. Example: card, ussd, mobilemoneyghana.
payment_planinteger- ID of the payment plan (used for recurring payments). Example: 3807.
redirect_urlstring- URL to redirect the customer to after payment is completed. Example: https://www.flutterwave.com/ng.
subaccountsarray- Subaccounts to split the payment with, each with an id. Example: [{"id": "RS_A8EB7D4D9C66C0B1C75014EE67D4D663"}]
titlestring- Title shown on the checkout page. Example: Acme Store.
flutterwave_payment_plan_cancelCancel a payment plan so no new subscriptions are charged on it.WriteCancel Payment Plan
Cancel a payment plan so no new subscriptions are charged on it. Returns the plan.
- Idempotent
Inputs
idintegerrequired- This is the unique ìd of the payment plan you want to cancel. Example: 3807.
flutterwave_payment_plan_createCreate a recurring payment plan with an amount and interval (daily, weekly, monthly, quarterly, bi-annually or yearly).WriteCreate Payment Plan
Create a recurring payment plan with an amount and interval (daily, weekly, monthly, quarterly, bi-annually or yearly). Returns the plan with its id to pass as payment_plan in a checkout link.
Inputs
amountintegerrequired- This is the amount to charge all customers subscribed to this plan. Example: 5000.
intervalstringrequired- This will determine the frequency of the charges for this plan. Could be yearly, quarterly, monthly, weekly, daily, etc. Example: Monthly.
namestringrequired- This is the name of the payment plan, it will appear on the subscription reminder emails. Example: Monthly Nepa Bill Collection.
durationinteger- This is the frequency, it is numeric, e.g. if set to 5 and intervals is set to monthly you would be charged 5 months, and then the subscription stops. Example: 24.
flutterwave_payment_plan_updateRename a payment plan or change its status.WriteUpdate Payment Plan
Rename a payment plan or change its status. Returns the plan.
- Idempotent
Inputs
idintegerrequired- This is the unique id of the payment plan you want to fetch. It is returned in the call to create a payment plan as data.id. Example: 3807.
namestringrequired- The new name of the payment plan. Example: January neighbourhood contribution.
statusstringrequired- The new status of the payment plan. Example: active.
flutterwave_subaccount_createCreate a collection subaccount that receives a split of payments into its bank account.WriteCreate Subaccount
Create a collection subaccount that receives a split of payments into its bank account. Returns the subaccount with its subaccount_id to pass in checkout subaccounts.
Inputs
account_bankstringrequired- This is the sub-accounts bank ISO code, use the List of Banks for Transfer endpoint to retrieve a list of bank codes. Example: 044.
account_numberstringrequired- This is the customer's account number. When testing on staging, you can find a list of all available test bank accounts here. Example: 0690000037.
business_mobilestringrequired- Primary business contact number. Example: 090890382.
business_namestringrequired- This is the sub-account business name. Example: Eternal Blue.
countrystringrequired- This is the ISO country code of the merchant e.g. NG, GH, KE etc. Example: NG.
split_valuenumberrequired- This can be a percentage value or flat value depending on what was set on split_type.Note that the % value is in decimal. So 50% is 0.5 and so on. Example: 0.5.
business_contactstring- This is the contact person for the sub-account e.g. Richard Hendrix. Example: Richard Hendrix.
business_contact_mobilestring- Business contact number number. Example: 090890382.
business_emailstring- This is the sub-account business email. Example: petya@stux.net.
split_typestring- This can be set as percentage or flat. Example: percentage.
flutterwave_subaccount_updateUpdate a subaccount's business name, email, split type and value or account number.WriteUpdate Subaccount
Update a subaccount's business name, email, split type and value or account number. Returns the subaccount.
- Idempotent
Inputs
idintegerrequired- This is the unique id of the subaccount you want to update. It is returned in the call to create a subaccount as data.id. Example: 3256.
split_valuenumberrequired- This can be a percentage value or flat value depending on what was set on split_type. Example: 1000.
account_numberstring- This is the customer's account number. Example: 0690000040.
business_emailstring- This is the sub-account business email". Example: richard@piedpiper.com.
business_namestring- This is the sub-account business name. Example: Pied Piper.
split_typestring- This can be set as percentage or flat. Example: flat.
flutterwave_subscription_activateReactivate a cancelled subscription.WriteActivate Subscription
Reactivate a cancelled subscription. Returns the subscription.
- Idempotent
Inputs
idintegerrequired- This is the ID of the subscription you want to activate. It is returned in the call to query all subscription as data.id. Example: 4147.
flutterwave_subscription_cancelCancel (deactivate) a customer's subscription so it is no longer charged.WriteCancel Subscription
Cancel (deactivate) a customer's subscription so it is no longer charged. Returns the subscription.
- Idempotent
Inputs
idintegerrequired- This is the ID of the subscription to be cancelled. It is returned in the call to query all subscription as data.id. Example: 4147.
flutterwave_transaction_refundRefund a successful transaction in full or in part.WriteRefund Transaction
Refund a successful transaction in full or in part. Returns the refund with its id and status. This returns money to the customer.
Inputs
idintegerrequired- This is a unique transaction identifier generated by our systems. It is returned in the initiate charge and verify transaction responses as data.id. Example: 5708.
amountinteger- The amount to refund, Set this to issue a partial refund. Example: 5000.
callbackurlstring- The URL for refund response callbacks. Example: https://webhook.site/5f9a659a-11a2-4925-89cf-8a59ea6a019a.
commentsstring- Custom description for the refund. Example: Refund for order #1042.
flutterwave_transaction_webhook_resendResend the webhook for a transaction to your webhook URL.WriteResend Transaction Webhook
Resend the webhook for a transaction to your webhook URL. Returns a confirmation.
Inputs
idstringrequired- This is a unique transaction identifier generated by our systems. It is returned in the initiate charge response as data.id. Example: 5708.
waitinteger- This parameter would hold for the hook response and return what you respond with as the response. The expected value is 1. Example: 1.
flutterwave_transfer_createSend money from your Flutterwave balance to a bank account or mobile money wallet.WriteCreate Transfer
Send money from your Flutterwave balance to a bank account or mobile money wallet. Returns the transfer with its id and status (usually NEW, then SUCCESSFUL or FAILED). This moves real money. Use flutterwave_transfer_fee_get first to see the fee.
Inputs
account_bankstringrequired- The recipient's bank code. You can query all available banks and their corresponding codes from the get banks endpoint. Example: 044.
account_numberstringrequired- This is the recipient account number. Example: 0690000040.
amountintegerrequired- This is the amount to transfer to the recipient. Example: 5500.
currencystringrequired- The currency of the transfer. Example: NGN.
beneficiaryinteger- The beneficiary's id. This allows you to make a transfer to an existing beneficiary. Example: 3768.
beneficiary_namestring- The full name of a transfer beneficiary. Example: Yemi Desola.
callback_urlstring- The URL for transfer response callbacks. Example: https://webhook.site/5f9a659a-11a2-4925-89cf-8a59ea6a019a.
debit_currencystring- Pass this to set a different currency balance as the source of transfer funds. if unspecified, your default balance is debited for the transfer. Example: USD.
destination_branch_codestring- A code used to identify different bank branches. This is required for banks that have branches — varies by bank, not country. Check has_branches on the bank object from GET /v3/banks/{country}, or call GET /v3/banks/{id}/branches. Bank has branches -> required (omitting causes disbursement to fail after queueing). Bank has no branches -> omit. Requirements are provider-determined and can change; don't hardcode. Example: 001.
narrationstring- This is the narration for the transfer e.g. payments for x services provided. Example: Payment for goods purchased.
referencestring- This is a merchant's unique reference for the transfer, it can be used to query for the status of the transfer. Example: newFLWXTransfer123.
skip_beneficiary_creationstring- if you don't want the automatic beneficiary creation step you can skip that by setting this as 1. Example: 0.
flutterwave_transfer_retryRetry a failed transfer.WriteRetry Failed Transfer
Retry a failed transfer. Returns the new transfer attempt. This moves real money.
Inputs
idintegerrequired- This is the unique identifier for the transfer you want to retry. It is returned in the call to create a transfer as data.id. Example: 166948.
flutterwave_virtual_account_createCreate a virtual bank account number (NGN or GHS) that a customer pays into by bank transfer: dynamic for one amount, or permanent (static, needs BVN or NIN).WriteCreate Virtual Account Number
Create a virtual bank account number (NGN or GHS) that a customer pays into by bank transfer: dynamic for one amount, or permanent (static, needs BVN or NIN). Returns the account number, bank and expiry.
Inputs
amountintegerrequired- The desired amount to be collected. Required when creating a dynamic virtual account. Example: 2000.
emailstringrequired- The email address of the customer. Example: user@example.com.
bank_codestring- The bank code for the generated virtual account. Example: 090567.
bvnstring- This is the customer's Bank Verification Number. This is only required when creating a static NGN virtual accounts. Example: 12345678901.
currencystring- The currency of the Virtual Account. Defaults to NGN if not passed. Allowed values: NGN, GHS. Example: NGN.
expiresstring- This specifies how long a dynamic virtual account remains active, in seconds. Minimum is 60 seconds (1 minute); Maximum is 5,270,401 seconds (2 months) for NGN and 172,800 seconds (48 hours) for GHS. Example: 60.
firstnamestring- This is the first name associated with the customer's account. Example: John.
is_permanentboolean- This allows you create a static account number i.e. it doesn't expire. Example: true.
lastnamestring- This is the last name associated with the customer's account. Example: Doe.
narrationstring- This allows you specify the name shown when the account is resolved. for GHS Account. this should be 35 characters long. Example: Please make a bank transfer to John.
ninstring- This is the customer’s National identification Number. It is required when creating a static virtual account. It can be used in place of the customer's bank verification number. Example: 12345678901.
phonenumberstring- This is the customer's phone number. Example: 08012345678.
tx_refstring- This is a transaction reference that would be returned each time a transfer is done to the account. Example: jhn-mdkn-10192029920.
flutterwave_virtual_account_status_updateDeactivate or reactivate a virtual account number.WriteDeactivate or Reactivate Virtual Account
Deactivate or reactivate a virtual account number. Returns the account.
- Idempotent
Inputs
order_refstringrequired- This is a special reference returned when the virtual account is created. It is returned in the create response as data.order_ref. Example: URF_1787125640627_1836135.
statusstringrequired- The status to set for the virtual account. Use inactive to deactivate a static virtual account, and active to reactivate a deactivated static virtual account. Example: inactive.
flutterwave_beneficiary_deleteDelete a saved transfer beneficiary.DestructiveDelete Beneficiary
Delete a saved transfer beneficiary.
- Idempotent
Inputs
idintegerrequired- This is the unique identifier for the beneficiary you intend to fetch. It is returned in the call to create a beneficiary as data.id. Example: 3103.
flutterwave_charge_voidVoid (release) a preauthorized charge that has not been captured.DestructiveVoid Preauthorized Charge
Void (release) a preauthorized charge that has not been captured. Returns the voided charge.
Inputs
flw_refstringrequired- This is a unique reference internally generated by Flutterwave. It is returned as data.flw_ref in the charge response. Example: FLW-TYR67844.
flutterwave_subaccount_deleteDelete a collection subaccount.DestructiveDelete Subaccount
Delete a collection subaccount.
- Idempotent
Inputs
idintegerrequired- This is the unique id of the sub account you want to fetch. It is returned in the call to create a sub account as data.id. Example: 2165.
No tools match.