Have you ever integrated our payment API into your product? Help us improve the developer experience for you and everyone by taking this short survey, get started here

Miscellaneous

Verify user information like bank verification numbers, card bins, account information, with Flutterwave APIs.

Request consent for BVN verification.

post https://api.flutterwave.com/v3/bvn/verifications

Body Params

bvn string

The bank verification number of the customer. It should be 11 digits.
firstname string

The customer's first name.
lastname string

The customer's last name.

Show optional parameters

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call. Unauthorized calls would return a 401 http code or raise unauthorized error in the different SDKs.

{
    "bvn": "123478322",
    "firstname": "Lyra",
    "lastname": "Balacqua",
    "redirect_url": "https://example-url.company.com"
}

{
    "status": "success",
    "message": "Bvn verification initiated",
    "data": {
        "url": "https://nibss-bvn-consent-management.myflutterwave.com/cms/BvnConsent?session=MWQzYWYxOWYtMWE1MS00MTdhLWFlMzEtNjEwNDgzZGQ0ZDFi",
        "reference": "FLW0B0BCB7D3F8A1148C87232"
    }
}

{
    "status": "error",
    "message": "bvn length must be 11 characters long",
    "data": null
}

Retrieve BVN Information.

get https://api.flutterwave.com/v3/bvn/verifications/:reference

Path Params

reference string

The reference from the consent request call.

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call.

curl --location 'https://api.flutterwave.com/v3/bvn/verifications/FLW441BD872AEBB28BD53B239' \
--header 'Authorization: Bearer YOUR_SECRET_KEY'

{
  "status": "success",
  "message": "Bvn details fetched",
  "data": {
      "first_name": "LYRA",
      "last_name": "Balacqua",
      "status": "COMPLETED",
      "reference": "FLW441BD872AEBB28BD53B239",
      "callback_url": null,
      "bvn_data": {
        "nin": "485xxxxxx33",
        "email": "test-user@example.com",
        "gender": "Male",
        "surname": "Balacqua",
        "serialNo": null,
        "faceImage": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAGQASwDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RF+vNcL27mkyTkZphY7gfEa/ZQGSPI6FeKt2vxIuldRNCki9z0IrzwLxnvT8kHrQFj2JPiBpRVd7EMRkgDOK0rbxdo9yo2XaKx/hY4rwwtgA5pwlK85+lILH0NDewz42ODkZ4NWQwNeEaZ4ivtOnSVJmfHBVj1FehaT45trt0SXMbsO/TNKwjteoo6gUyGRZEDqQQ3NSZoGLSHilo7UCAetIetLjijFAwpDSkelJz3oAPajOOKCBSUCF4pDx0pcGkIoGLkUnAoxg+1H4UCI6Wkpc0DClpuaWgApc0lFAC0UUlAWFozmk7UcUCDOBzVS81G3tI2aWRVwM81T1fxBZ6UhEr5f8AujHFeT+JPET6tdsV3LCvAGetFhmx4j8aPdO0Vm52Zxu9a4qWeSZizsSfeozJuJPemlqYIN2M0m4d6TPPSjYWGKAH76Qsp7UgiK9aXZQApIHIqNiWp+1jwBTxEcZoAh9yakDj/ChozjpUWCD3oAnVxng81NHIysCp5HNVfLJGQacrFTigD0Pw342a0Rba5BaPPDZ6V6NZ38V5GGjYYPvXz6rit/SPEk+mlQpLIOoJoCx7ePY5o5zWFoPiOy1S2ULLtmA+ZH4NbgOeQaQDqQ+9FHegQo6daOaMUUwEJOKO3FGPegECgAxz1oP50HHrSUAO7YxSYPrR+hq4bmdT4TW8ZSCS7toyOFbcR9K5Vj8xNbXiO483WpOeI1x+dYJPBPqamTvI46r1sPiOAxp0fKg1GuBExqWLlRimjAlA4p8Ms1rMJraZ4Zh0eM4P4+v40z8KKYJ2eh2Gl+Pbq3xHqVsLhf+esPysPqp4P4Gugj8Y6JKgf7aI8/wyqVI/CvMCeabyelNGyrS6o9gtdJsLJf9GtYoz6heT+PWppAAPeuXuPH1mmVtrO4mP8AefCL/U/pWHe+OdVmYiCO2gB/2S5/Xj9Kdze8V1O9Yjac1gan4i0vTyUkuVeUf8s4/mb9OlcFdatqV5n7Vf3EoP8ADu2r+S4FZzYA4AqXIXtEtjd1PxjeXOUs4xbR/wB8/M5/oK5iZ3mkaSV2kc9WY5NSNULDrUk8zZTkBLVEBh+PSp5cA1Dj5vekaosxcxMKz9uH/Gr8BxkVSYYc/Wktyobs3Ui3aS5H92ucToMV1Wlr52muh9K5Zl2Oy/3WIqnsaIUmm0oozxSKG8ilzRSEUABFGKSkoAXFFNzS7qBDsUoFMBpaAJBS7h2pgp3agYpOaQdaQdKXrQA4cmnqOaYBUi0gEbrXpXw7tmtfD91dvx50hIz6Dj+lecRQvcXKQRjLuwVfxr1m+C6N4chsozghAn6c1pDuZVHpY5HUZ/NnlkJ++xI+lVCPlANEzb5gKGOSKzXc4J6sG/1YX1NWIgQMVXfl0UDpzVlThaoXQdux1ppY/hTWIzSoAetUJIf2pc/Sm55IFJx9aZIqt7018ZpM4zTWbkUihj4qJj6U9utRMallojbpzUTVMelRMOaC0VZR14queGB96tSiqzjApG8SRDtf61HOm2QnsaeDwpp843xAjtS2Y4tpmp4clBd4j3rG1a3Ntqkydidw/GrOlTeRfLk4B4q74qtsNBdqMqw2k/yquhqtGc5RRmikWFFJS0ANNIRTjTTQAlKKSgUAKKcKSgUAPFL703tQaAFzSjrSCnDFADhT+gJpopwVpGWNAWdjhQO5oA6rwFpf27WTduuYrYZye7dq2fFGoedelAcqgx+Na1hZp4Y8LrG2BOy7m9Sxrh7yczzdcsx5qpOy5TkqyuNiPBkPelRgX9qHwkYUCmruVeFyT6Ckjl3JUG8l+Klzj6VGki/dzg04nimIOCRzUgOPpUajA7807OaBscD370m/HSmM4ApmSfWmybH/2Q==",
        "firstName": "LYRA ",
        "landmarks": null,
        "branchName": null,
        "middleName": "USER ",
        "nameOnCard": null,
        "dateOfBirth": "199x-05-xxT23:00:00Z",
        "lgaOfOrigin": "Test lga",
        "watchlisted": "0.0",
        "lgaOfCapture": null,
        "phoneNumber1": "234810xxxx188",
        "phoneNumber2": null,
        "maritalStatus": "Single",
        "stateOfOrigin": "Lagos State",
        "enrollBankCode": null,
        "enrollUserName": "user@example.com",
        "enrollmentDate": null,
        "lgaOfResidence": "Ikorodu",
        "stateOfCapture": "Lagos State",
        "additionalInfo1": null,
        "productReference": "FLW441BD872AEBB28BD53B239",
        "stateOfResidence": "Lagos State"
      },
      "created_at": "2023-04-13T23:02:23.000Z"
    }
}

{
    "status": "error",
    "message": "bvn length must be 11 characters long",
    "data": null
}

Verify bank account

Resolve your customer's bank account information. This supports only Nigerian Bank account, learn more about the feature here

post https://api.flutterwave.com/v3/accounts/resolve

Body Params

account_number string

The customer's account number.
account_bank string

The customer's bank code. Query the get bank endpoint to retrieve the correct code.

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call.

{
  "account_number": "0690000032",
  "account_bank": "044"
}

const Flutterwave = require('flutterwave-node-v3');
const flw = new Flutterwave("public key", "secret key");
const payload = {"account_number": "0690000032", "account_bank": "044"};
const response = await flw.Misc.verify_Account(payload);

require './flutterwave_sdk'
payment = Flutterwave.new("public key", "secret key", "encryption key")
misc = Misc.new(payment)
payload = {
  "account_number" => "0690000032",
  "account_bank" => "044"
}
response = misc.resolve_account(payload)
print response

{
  "status": "success",
  "message": "Account details fetched",
  "data": {
    "account_number": "0690000032",
    "account_name": "Pastor Bright"
  }
}

{}

Verify card BINs

Resolve your customer's bank identification number(BIN). Learn more about this feature here.

get https://api.flutterwave.com/v3/card-bins/:bin

Path Params

bin int32

The first six (6) digits on a debit/credit card

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call. Unauthorized calls would return a 401 http code or raise unauthorized error in the different SDKs.

require './flutterwave_sdk'
payment = Flutterwave.new("public key", "secret key", "encryption key")
misc = Misc.new(payment)
response = misc.resolve_card_bin(553188)
print response

{
  "status": "success",
  "message": "completed",
  "data": {
    "issuing_country": "UNITED KINGDOM GB",
    "bin": "123456",
    "card_type": "VISA",
    "issuer_info": "NATIONAL WESTMINSTER BANK PLC DEBITCLASSIC"
  }
}

{}

Fetch balance by currency

Fetch your wallet balance by currency.

get https://api.flutterwave.com/v3/balances/:currency

Path Params

currency string

This is the wallet whose currency you want to fetch the balance.

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call. Unauthorized calls would return a 401 http code or raise unauthorized error in the different SDKs.

const Flutterwave = require('flutterwave-node-v3');
const flw = new Flutterwave("public key", "secret key");
const response = await flw.Misc.bal_currency("NGN");

require './flutterwave_sdk'
payment = Flutterwave.new("public key", "secret key", "encryption key")
misc = Misc.new(payment)
response = misc.get_balance_per_currency("NGN")
print response

{
  "status": "success",
  "message": "Wallet balance fetched",
  "data": {
    "currency": "NGN",
    "available_balance": 2168880,
    "ledger_balance": 253125.82
  }
}

{}

Fetch all balances

Query your wallet balances in different currencies.

get https://api.flutterwave.com/v3/balances

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call. Unauthorized calls would return a 401 http code or raise unauthorized error in the different SDKs.

const Flutterwave = require('flutterwave-node-v3');
const flw = new Flutterwave("public key", "secret key");
const response = await flw.Misc.bal();

require './flutterwave_sdk'
payment = Flutterwave.new("public key", "secret key", "encryption key")
misc = Misc.new(payment)
response = misc.get_all_wallet_balance
print response

{
  "status": "success",
  "message": "Wallet balances fetched",
  "data": [
    {
      "currency": "NGN",
      "available_balance": 2367840,
      "ledger_balance": 253125.82
    },
    {
      "currency": "KES",
      "available_balance": 0,
      "ledger_balance": 1226.72
    },
    {
      "currency": "GHS",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "USD",
      "available_balance": 0,
      "ledger_balance": 472.08
    },
    {
      "currency": "EUR",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "ZAR",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "GBP",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "TZS",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "UGX",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "RWF",
      "available_balance": 0,
      "ledger_balance": 5000
    },
    {
      "currency": "ZMW",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "INR",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "XOF",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "MUR",
      "available_balance": 0,
      "ledger_balance": 0
    },
    {
      "currency": "ETB",
      "available_balance": 0,
      "ledger_balance": 0
    }
  ]
}

{}

Fetch wallet history

Fetch your wallet's transaction history.

get https://api.flutterwave.com/v3/wallet/statement

Query Params

currency string

The currency of the wallet being queried.

Show optional parameters

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call. Unauthorized calls would return a 401 http code or raise unauthorized error in the different SDKs.

{
  "status": "success",
  "message": "Wallet statement fetched",
  "data": {
    "page_info": {
      "total": 2,
      "current_page": 1,
      "total_pages": 1
    },
    "transactions": [
      {
        "type": "D",
        "amount": 5000,
        "currency": "NGN",
        "balance_before": 5306,
        "balance_after": 306,
        "reference": "CC-REFD-17124232941-000003201208145443000641923609",
        "date": "2021-01-04T09:57:14+00:00",
        "remarks": "",
        "sent_currency": "NGN",
        "rate_used": 1,
        "sent_amount": 5000,
        "statement_type": "available"
      },
      {
        "type": "C",
        "amount": 5300,
        "currency": "NGN",
        "balance_before": 6,
        "balance_after": 5306,
        "reference": "FLW414422434",
        "date": "2021-01-04T09:52:48+00:00",
        "remarks": "WALLET FUNDING WITH RAVE - FLW414422434",
        "sent_currency": "",
        "rate_used": 0,
        "sent_amount": 0,
        "statement_type": "available"
      }
    ]
  }
}

{}
Loading...