Artisan commands

Every command is prefixed flutterwave:. Commands that move money (fx-trade, accept-chargeback, decline-chargeback) ask for confirmation unless you pass --force.

Artisan command builder

Pick a command, fill in what you need and copy the line. Arguments and options are read from the package source when the docs are built.

Commandflutterwave:accept-chargebackflutterwave:balanceflutterwave:binflutterwave:decline-chargebackflutterwave:doctorflutterwave:rateflutterwave:fx-quoteflutterwave:fx-statusflutterwave:fx-tradeflutterwave:installflutterwave:banksflutterwave:billsflutterwave:branchesflutterwave:chargebacksflutterwave:payflutterwave:ping-webhookflutterwave:resend-webhookflutterwave:resolveflutterwave:verifyCheck your Flutterwave setup: keys, webhooks, cache, queue and API access.

Flags

--offline

Terminal

php artisan flutterwave:doctor

All commands

flutterwave:accept-chargeback

Accept a chargeback and refund the customer.

php artisan flutterwave:accept-chargeback <id> [options]

Argument / option	Description
id *	Chargeback id, from flutterwave:chargebacks
--comment=	Why you are accepting it
--force	Skip the confirmation prompt

flutterwave:balance

Show your Flutterwave wallet balances.

php artisan flutterwave:balance [options]

Argument / option	Description
--currency=	Only show this currency (NGN, GHS, USD, EUR...)

flutterwave:bin

Look up the issuer, type and country of a card.

php artisan flutterwave:bin <bin>

Argument / option	Description
bin *	First six digits of the card

flutterwave:decline-chargeback

Dispute a chargeback with proof that the customer received value.

php artisan flutterwave:decline-chargeback <id> [options]

Argument / option	Description
id *	Chargeback id, from flutterwave:chargebacks
--proof=	Your evidence as one JPEG, PNG or PDF file under 8MB
--proof-link=	A proof link you already uploaded, instead of --proof
--comment=	What the evidence shows
--force	Skip the confirmation prompt

flutterwave:doctor

Check your Flutterwave setup: keys, webhooks, cache, queue and API access.

php artisan flutterwave:doctor [options]

Argument / option	Description
--offline	Skip the check that calls the Flutterwave API

flutterwave:rate

Show the exchange rate Flutterwave uses for transfers.

php artisan flutterwave:rate [options]

Argument / option	Description
--amount=	Amount to convert, in the destination currency Default 1.
--from=	Currency you pay from Default USD.
--to=	Currency the recipient gets Default NGN.

flutterwave:fx-quote

Get an FX rate you can trade within 5 minutes.

php artisan flutterwave:fx-quote <base> <target> <quantity> [options]

Argument / option	Description
base *	Currency you sell, e.g. NGN
target *	Currency you buy, e.g. USD
quantity *	Amount of the base currency to sell
--reference=	Your own reference for the quote
--no-wait	Return straight away instead of waiting for the rate
--timeout=	Seconds to wait for the rate Default 60.
--poll=	Seconds between checks while waiting Default 2.

flutterwave:fx-status

Check an FX quote or trade.

php artisan flutterwave:fx-status <id> [options]

Argument / option	Description
id *	Quote id, or trade id when the trade option is set
--trade	Look up a trade instead of a quote

flutterwave:fx-trade

Trade a ready FX quote at its quoted rate.

php artisan flutterwave:fx-trade <quote> [options]

Argument / option	Description
quote *	Quote id from flutterwave:fx-quote
--narration=	A note for your records, e.g. Supplier payment
--force	Skip the confirmation prompt

flutterwave:install

Publish the Flutterwave config and add the required keys to your .env file.

php artisan flutterwave:install [options]

Argument / option	Description
--force	Overwrite files that were already published
--react	Also publish the React components for Inertia apps
--vue	Also publish the Vue 3 components for Inertia apps
--svelte	Also publish the Svelte 5 components for Inertia apps
--billable	Also publish the migration for saving customers' cards

flutterwave:banks

List bank codes for transfers and account resolution.

php artisan flutterwave:banks [country] [options]

Argument / option	Description
country	Two-letter country code (NG, GH, KE, UG, ZA, TZ...) Default NG.
--search=	Only show banks whose name contains this text

flutterwave:bills

Find the category, biller and item codes for paying bills.

php artisan flutterwave:bills [category] [options]

Argument / option	Description
category	Category code to list its billers, e.g. AIRTIME or UTILITYBILLS
--biller=	Biller code to list what it sells, e.g. BIL119
--country=	Two-letter country code Default NG.

flutterwave:branches

List branch codes for a bank.

php artisan flutterwave:branches <bank> [options]

Argument / option	Description
bank *	Bank id (the id column from flutterwave:banks, not the code)
--search=	Only show branches whose name contains this text

flutterwave:chargebacks

List chargebacks raised against your account.

php artisan flutterwave:chargebacks [options]

Argument / option	Description
--status=	initiated, accepted, declined, won or lost
--from=	Raised on or after this date, YYYY-MM-DD
--to=	Raised on or before this date, YYYY-MM-DD
--currency=	Three-letter currency code, e.g. NGN
--ref=	Show one chargeback and its history, by the transaction's flw_ref
--page=	Page of results

flutterwave:pay

Create a hosted checkout link for a quick test payment.

php artisan flutterwave:pay <email> <amount> [options]

Argument / option	Description
email *	Customer email
amount *	Amount to charge
--currency=	Defaults to the currency in config/flutterwave.php
--open	Open the payment link in your browser

flutterwave:ping-webhook

Send a signed webhook for a real transaction to a local URL, without exposing it to the internet.

php artisan flutterwave:ping-webhook <id> [url] [options]

Argument / option	Description
id *	Transaction id, or transfer id when the event option is transfer
url	Webhook URL, defaults to this app's webhook route
--event=	charge or transfer Default charge.
--hash=	Secret hash to sign with, defaults to FLW_SECRET_HASH

flutterwave:resend-webhook

Ask Flutterwave to resend a failed webhook to your dashboard webhook URL.

php artisan flutterwave:resend-webhook <transaction>

Argument / option	Description
transaction *	Transaction id (data.id)

flutterwave:resolve

Look up the name on a bank account, mobile money number or Flutterwave merchant ID.

php artisan flutterwave:resolve <account> [bank] [options]

Argument / option	Description
account *	Account number, mobile money number, or merchant ID when the merchant option is set
bank	Bank or mobile money provider code, see flutterwave:banks
--country=	Two-letter country code, e.g. GH for Ghanaian banks and mobile money
--merchant	Treat the account as a Flutterwave merchant ID

flutterwave:verify

Look up the status of a Flutterwave transaction.

php artisan flutterwave:verify <reference> [options]

Argument / option	Description
reference *	Transaction id, or tx_ref when the ref option is set
--ref	Treat the argument as a tx_ref