Create Bulk Bills Payment

curl --request POST \
  --url https://api.flutterwave.com/v3/bulk-bills \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bulk_reference": "bulkRef0012",
  "callback_url": "https://www.google.com",
  "bulk_data": [
    {
      "country": "NG",
      "customer": "+2348029494025",
      "amount": 100,
      "recurrence": "WEEKLY",
      "type": "AIRTIME",
      "reference": "billRef05"
    },
    {
      "country": "NG",
      "customer": "+2347063932728",
      "amount": 100,
      "recurrence": "WEEKLY",
      "type": "AIRTIME",
      "reference": "billRef06"
    },
    {
      "country": "NG",
      "customer": "+2347013431382",
      "amount": 100,
      "recurrence": "WEEKLY",
      "type": "AIRTIME",
      "reference": "billRef07"
    },
    {
      "country": "NG",
      "customer": "+2348134088426",
      "amount": 100,
      "recurrence": "WEEKLY",
      "type": "AIRTIME",
      "reference": "billRef08"
    }
  ]
}
'

import requests

url = "https://api.flutterwave.com/v3/bulk-bills"

payload = {
    "bulk_reference": "bulkRef0012",
    "callback_url": "https://www.google.com",
    "bulk_data": [
        {
            "country": "NG",
            "customer": "+2348029494025",
            "amount": 100,
            "recurrence": "WEEKLY",
            "type": "AIRTIME",
            "reference": "billRef05"
        },
        {
            "country": "NG",
            "customer": "+2347063932728",
            "amount": 100,
            "recurrence": "WEEKLY",
            "type": "AIRTIME",
            "reference": "billRef06"
        },
        {
            "country": "NG",
            "customer": "+2347013431382",
            "amount": 100,
            "recurrence": "WEEKLY",
            "type": "AIRTIME",
            "reference": "billRef07"
        },
        {
            "country": "NG",
            "customer": "+2348134088426",
            "amount": 100,
            "recurrence": "WEEKLY",
            "type": "AIRTIME",
            "reference": "billRef08"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bulk_reference: 'bulkRef0012',
    callback_url: 'https://www.google.com',
    bulk_data: [
      {
        country: 'NG',
        customer: '+2348029494025',
        amount: 100,
        recurrence: 'WEEKLY',
        type: 'AIRTIME',
        reference: 'billRef05'
      },
      {
        country: 'NG',
        customer: '+2347063932728',
        amount: 100,
        recurrence: 'WEEKLY',
        type: 'AIRTIME',
        reference: 'billRef06'
      },
      {
        country: 'NG',
        customer: '+2347013431382',
        amount: 100,
        recurrence: 'WEEKLY',
        type: 'AIRTIME',
        reference: 'billRef07'
      },
      {
        country: 'NG',
        customer: '+2348134088426',
        amount: 100,
        recurrence: 'WEEKLY',
        type: 'AIRTIME',
        reference: 'billRef08'
      }
    ]
  })
};

fetch('https://api.flutterwave.com/v3/bulk-bills', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flutterwave.com/v3/bulk-bills",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bulk_reference' => 'bulkRef0012',
    'callback_url' => 'https://www.google.com',
    'bulk_data' => [
        [
                'country' => 'NG',
                'customer' => '+2348029494025',
                'amount' => 100,
                'recurrence' => 'WEEKLY',
                'type' => 'AIRTIME',
                'reference' => 'billRef05'
        ],
        [
                'country' => 'NG',
                'customer' => '+2347063932728',
                'amount' => 100,
                'recurrence' => 'WEEKLY',
                'type' => 'AIRTIME',
                'reference' => 'billRef06'
        ],
        [
                'country' => 'NG',
                'customer' => '+2347013431382',
                'amount' => 100,
                'recurrence' => 'WEEKLY',
                'type' => 'AIRTIME',
                'reference' => 'billRef07'
        ],
        [
                'country' => 'NG',
                'customer' => '+2348134088426',
                'amount' => 100,
                'recurrence' => 'WEEKLY',
                'type' => 'AIRTIME',
                'reference' => 'billRef08'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flutterwave.com/v3/bulk-bills"

	payload := strings.NewReader("{\n  \"bulk_reference\": \"bulkRef0012\",\n  \"callback_url\": \"https://www.google.com\",\n  \"bulk_data\": [\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348029494025\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef05\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347063932728\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef06\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347013431382\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef07\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348134088426\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef08\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flutterwave.com/v3/bulk-bills")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bulk_reference\": \"bulkRef0012\",\n  \"callback_url\": \"https://www.google.com\",\n  \"bulk_data\": [\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348029494025\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef05\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347063932728\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef06\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347013431382\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef07\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348134088426\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef08\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flutterwave.com/v3/bulk-bills")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bulk_reference\": \"bulkRef0012\",\n  \"callback_url\": \"https://www.google.com\",\n  \"bulk_data\": [\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348029494025\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef05\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347063932728\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef06\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347013431382\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef07\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348134088426\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef08\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Bulk bill Payment was queued for processing",
  "data": {
    "batch_reference": "CF-BATCH-FLY-API-20200310042210201008"
  }
}

{
  "status": "error",
  "message": "Please specify the following parameters in body: bulk_reference",
  "data": null
}

POST

bulk-bills

Create Bulk Bills Payment

curl --request POST \
  --url https://api.flutterwave.com/v3/bulk-bills \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bulk_reference": "bulkRef0012",
  "callback_url": "https://www.google.com",
  "bulk_data": [
    {
      "country": "NG",
      "customer": "+2348029494025",
      "amount": 100,
      "recurrence": "WEEKLY",
      "type": "AIRTIME",
      "reference": "billRef05"
    },
    {
      "country": "NG",
      "customer": "+2347063932728",
      "amount": 100,
      "recurrence": "WEEKLY",
      "type": "AIRTIME",
      "reference": "billRef06"
    },
    {
      "country": "NG",
      "customer": "+2347013431382",
      "amount": 100,
      "recurrence": "WEEKLY",
      "type": "AIRTIME",
      "reference": "billRef07"
    },
    {
      "country": "NG",
      "customer": "+2348134088426",
      "amount": 100,
      "recurrence": "WEEKLY",
      "type": "AIRTIME",
      "reference": "billRef08"
    }
  ]
}
'

import requests

url = "https://api.flutterwave.com/v3/bulk-bills"

payload = {
    "bulk_reference": "bulkRef0012",
    "callback_url": "https://www.google.com",
    "bulk_data": [
        {
            "country": "NG",
            "customer": "+2348029494025",
            "amount": 100,
            "recurrence": "WEEKLY",
            "type": "AIRTIME",
            "reference": "billRef05"
        },
        {
            "country": "NG",
            "customer": "+2347063932728",
            "amount": 100,
            "recurrence": "WEEKLY",
            "type": "AIRTIME",
            "reference": "billRef06"
        },
        {
            "country": "NG",
            "customer": "+2347013431382",
            "amount": 100,
            "recurrence": "WEEKLY",
            "type": "AIRTIME",
            "reference": "billRef07"
        },
        {
            "country": "NG",
            "customer": "+2348134088426",
            "amount": 100,
            "recurrence": "WEEKLY",
            "type": "AIRTIME",
            "reference": "billRef08"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bulk_reference: 'bulkRef0012',
    callback_url: 'https://www.google.com',
    bulk_data: [
      {
        country: 'NG',
        customer: '+2348029494025',
        amount: 100,
        recurrence: 'WEEKLY',
        type: 'AIRTIME',
        reference: 'billRef05'
      },
      {
        country: 'NG',
        customer: '+2347063932728',
        amount: 100,
        recurrence: 'WEEKLY',
        type: 'AIRTIME',
        reference: 'billRef06'
      },
      {
        country: 'NG',
        customer: '+2347013431382',
        amount: 100,
        recurrence: 'WEEKLY',
        type: 'AIRTIME',
        reference: 'billRef07'
      },
      {
        country: 'NG',
        customer: '+2348134088426',
        amount: 100,
        recurrence: 'WEEKLY',
        type: 'AIRTIME',
        reference: 'billRef08'
      }
    ]
  })
};

fetch('https://api.flutterwave.com/v3/bulk-bills', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flutterwave.com/v3/bulk-bills",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bulk_reference' => 'bulkRef0012',
    'callback_url' => 'https://www.google.com',
    'bulk_data' => [
        [
                'country' => 'NG',
                'customer' => '+2348029494025',
                'amount' => 100,
                'recurrence' => 'WEEKLY',
                'type' => 'AIRTIME',
                'reference' => 'billRef05'
        ],
        [
                'country' => 'NG',
                'customer' => '+2347063932728',
                'amount' => 100,
                'recurrence' => 'WEEKLY',
                'type' => 'AIRTIME',
                'reference' => 'billRef06'
        ],
        [
                'country' => 'NG',
                'customer' => '+2347013431382',
                'amount' => 100,
                'recurrence' => 'WEEKLY',
                'type' => 'AIRTIME',
                'reference' => 'billRef07'
        ],
        [
                'country' => 'NG',
                'customer' => '+2348134088426',
                'amount' => 100,
                'recurrence' => 'WEEKLY',
                'type' => 'AIRTIME',
                'reference' => 'billRef08'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flutterwave.com/v3/bulk-bills"

	payload := strings.NewReader("{\n  \"bulk_reference\": \"bulkRef0012\",\n  \"callback_url\": \"https://www.google.com\",\n  \"bulk_data\": [\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348029494025\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef05\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347063932728\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef06\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347013431382\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef07\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348134088426\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef08\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flutterwave.com/v3/bulk-bills")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bulk_reference\": \"bulkRef0012\",\n  \"callback_url\": \"https://www.google.com\",\n  \"bulk_data\": [\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348029494025\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef05\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347063932728\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef06\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347013431382\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef07\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348134088426\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef08\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flutterwave.com/v3/bulk-bills")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bulk_reference\": \"bulkRef0012\",\n  \"callback_url\": \"https://www.google.com\",\n  \"bulk_data\": [\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348029494025\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef05\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347063932728\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef06\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2347013431382\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef07\"\n    },\n    {\n      \"country\": \"NG\",\n      \"customer\": \"+2348134088426\",\n      \"amount\": 100,\n      \"recurrence\": \"WEEKLY\",\n      \"type\": \"AIRTIME\",\n      \"reference\": \"billRef08\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Bulk bill Payment was queued for processing",
  "data": {
    "batch_reference": "CF-BATCH-FLY-API-20200310042210201008"
  }
}

{
  "status": "error",
  "message": "Please specify the following parameters in body: bulk_reference",
  "data": null
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

bulk_reference

string

required

callback_url

string

required

bulk_data

BulkDatum2 · object[]

required

Show child attributes

Response

status

string

required

message

string

required

data

Data77 · object

required

Show child attributes

Example:

{
  "batch_reference": "CF-BATCH-FLY-API-20200310042210201008"
}

API Documentation

Charges

Tokenized Charges

Preauthorization

Transactions

Transfers

Beneficiaries

Virtual Cards

Virtual Account Numbers

Collection Subaccounts

Payout Subaccounts

Subscriptions

Payment Plans

Bill Payments

Banks

Misc

Settlements

Otps

Chargebacks

Create Bulk Bills Payment

Authorizations

Body

Response