Jump to Content

Documentation Recipes API References Support Blog

Documentation Recipes API References

Documentation Recipes API References Support Blog

API References

Getting Started

Introduction

Charge

Cardpost
Standard APIpost
Bank Transferspost
ACHpost
Pay with Bank (UK/EU)post
Pay with Bank (NG)post
Mpesapost
Ghana Mobile Moneypost
Rwanda Mobile Moneypost
Uganda Mobile Moneypost
Francophone Mobile Moneypost
Tanzania mobile moneypost
Zambia Mobile Moneypost
1Voucherpost
Apple Paypost
Google Paypost
E-Nairapost
USSDpost
NQRpost
OPaypost
Capitecpost
Fawry Paypost

Validate charge

Validate a card or account chargepost

Tokenized Charges

Create a Tokenized Chargepost
Tokenize a customer's bank accountpost
Retrieve a Bank Account Tokenpost
Update a debit or credit card tokenput
Update the status of a bank account tokenput
Create bulk Tokenized chargespost
Get a bulk tokenized charge statusget
Get bulk Tokenized Chargesget

Preauthorization

Capture a preauthorized chargepost
Void a preauthorized chargepost
Refund a preauthorized chargepost

Transactions

Verify transaction statusget
Verify transaction status with referenceget
Get multiple transactionsget
View transaction timelineget
Refund a transactionpost
Fetch a refunded transactionget
Fetch multiple refunded transactionsget
Query transaction feesget
Resend failed Webhookspost

Transfers

Create a transferpost
Retry a failed transferpost
Create bulk transferpost
Query transfer feeget
Get all transfersget
Get a transferget
Get a transfer retryget
Get a bulk transferget
Query transfer ratesget
Query bulk transfer ratespost
Verify bulk transfer ratesget

Transfer Beneficiaries

Create a beneficiarypost
List all beneficiariesget
Fetch a beneficiaryget
Delete a beneficiarydelete

Virtual Account Numbers

Create a virtual account numberpost
Create bulk virtual account numberspost
Get bulk virtual account detailsget
Get a virtual account numberget
Update BVNput
Delete a Virtual accountpost

Payment Plans

Create payment planpost
Get payment plansget
Get a payment planget
Update a payment planput
Cancel a payment planput

Subscriptions

Get all subscriptionsget
Deactivate a Subscriptionput
Activate a subscriptionput

Collection Subaccounts

Create a subaccountpost
Fetch all subaccountsget
Fetch a subaccountget
Update a subaccountput
Delete a subaccountdelete

Payout Subaccounts

Create a subaccountpost
Fetch All Subaccountsget
Fetch a subaccountget
Update A Subaccountput
Fetch Transactionsget
Fetch Available Balanceget
Fetch Static Virtual Accountsget
Delete A Subaccountdelete

Bills

Get supported bill categoriesget
Get biller informationget
Get bill informationget
Validate customer detailsget
Create a bill paymentpost
Create bulk bill paymentpost
Get status of a bill paymentget
Get bill payments summaryget
Get bill payments historyget
Biller types for data bundles

Remita Payments

Get bill payment agenciesget
Get products under an agencyget
Get amount to be paid for a productget
Create order using billing code and product codepost
Update bills orderput

Banks

Get all banksget
Get bank branchesget

Misc

Initiate consent request for BVN verificationpost
Retrieve BVN informationget
Retrieve Bank Account Namepost
Resolve card binsget
Retrieve Wallet balancesget
Retrieve Wallet balance by currencyget
Query Wallet balance historyget

Settlements

Retrieve Settlements informationget
Retrieve a single Settlement logget

Otps

Generate an OTP Stringpost
Validate an OTP Stringpost

Chargebacks

Upload proofpost
Accept or decline a chargebackput
Retrieve Chargeback Informationget
Retrieve a single chargebackget

Getting Started

Introduction

Charge

Cardpost
Standard APIpost
Bank Transferspost
ACHpost
Pay with Bank (UK/EU)post
Pay with Bank (NG)post
Mpesapost
Ghana Mobile Moneypost
Rwanda Mobile Moneypost
Uganda Mobile Moneypost
Francophone Mobile Moneypost
Tanzania mobile moneypost
Zambia Mobile Moneypost
1Voucherpost
Apple Paypost
Google Paypost
E-Nairapost
USSDpost
NQRpost
OPaypost
Capitecpost
Fawry Paypost

Validate charge

Validate a card or account chargepost

Tokenized Charges

Create a Tokenized Chargepost
Tokenize a customer's bank accountpost
Retrieve a Bank Account Tokenpost
Update a debit or credit card tokenput
Update the status of a bank account tokenput
Create bulk Tokenized chargespost
Get a bulk tokenized charge statusget
Get bulk Tokenized Chargesget

Preauthorization

Capture a preauthorized chargepost
Void a preauthorized chargepost
Refund a preauthorized chargepost

Transactions

Verify transaction statusget
Verify transaction status with referenceget
Get multiple transactionsget
View transaction timelineget
Refund a transactionpost
Fetch a refunded transactionget
Fetch multiple refunded transactionsget
Query transaction feesget
Resend failed Webhookspost

Transfers

Create a transferpost
Retry a failed transferpost
Create bulk transferpost
Query transfer feeget
Get all transfersget
Get a transferget
Get a transfer retryget
Get a bulk transferget
Query transfer ratesget
Query bulk transfer ratespost
Verify bulk transfer ratesget

Transfer Beneficiaries

Create a beneficiarypost
List all beneficiariesget
Fetch a beneficiaryget
Delete a beneficiarydelete

Virtual Account Numbers

Create a virtual account numberpost
Create bulk virtual account numberspost
Get bulk virtual account detailsget
Get a virtual account numberget
Update BVNput
Delete a Virtual accountpost

Payment Plans

Create payment planpost
Get payment plansget
Get a payment planget
Update a payment planput
Cancel a payment planput

Subscriptions

Get all subscriptionsget
Deactivate a Subscriptionput
Activate a subscriptionput

Collection Subaccounts

Create a subaccountpost
Fetch all subaccountsget
Fetch a subaccountget
Update a subaccountput
Delete a subaccountdelete

Payout Subaccounts

Create a subaccountpost
Fetch All Subaccountsget
Fetch a subaccountget
Update A Subaccountput
Fetch Transactionsget
Fetch Available Balanceget
Fetch Static Virtual Accountsget
Delete A Subaccountdelete

Bills

Get supported bill categoriesget
Get biller informationget
Get bill informationget
Validate customer detailsget
Create a bill paymentpost
Create bulk bill paymentpost
Get status of a bill paymentget
Get bill payments summaryget
Get bill payments historyget
Biller types for data bundles

Remita Payments

Get bill payment agenciesget
Get products under an agencyget
Get amount to be paid for a productget
Create order using billing code and product codepost
Update bills orderput

Banks

Get all banksget
Get bank branchesget

Misc

Initiate consent request for BVN verificationpost
Retrieve BVN informationget
Retrieve Bank Account Namepost
Resolve card binsget
Retrieve Wallet balancesget
Retrieve Wallet balance by currencyget
Query Wallet balance historyget

Settlements

Retrieve Settlements informationget
Retrieve a single Settlement logget

Otps

Generate an OTP Stringpost
Validate an OTP Stringpost

Chargebacks

Upload proofpost
Accept or decline a chargebackput
Retrieve Chargeback Informationget
Retrieve a single chargebackget

Delete a beneficiary

delete https://api.flutterwave.com/v3/beneficiaries/{id}

Delete a transfer beneficiary

Language

Click Try It! to start a request and see the response here!