Create a Bill Payment

curl --request POST \
  --url https://api.flutterwave.com/v3/billers/{biller_code}/items/{item_code}/payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "NG",
  "customer_id": "0025401100",
  "reference": "d7a004b1-a581-4cd9-89ae-a1f0934019",
  "amount": 1800,
  "callback_url": "https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8"
}
'

import requests

url = "https://api.flutterwave.com/v3/billers/{biller_code}/items/{item_code}/payment"

payload = {
    "country": "NG",
    "customer_id": "0025401100",
    "reference": "d7a004b1-a581-4cd9-89ae-a1f0934019",
    "amount": 1800,
    "callback_url": "https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8"
}
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({
    country: 'NG',
    customer_id: '0025401100',
    reference: 'd7a004b1-a581-4cd9-89ae-a1f0934019',
    amount: 1800,
    callback_url: 'https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8'
  })
};

fetch('https://api.flutterwave.com/v3/billers/{biller_code}/items/{item_code}/payment', 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/billers/{biller_code}/items/{item_code}/payment",
  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([
    'country' => 'NG',
    'customer_id' => '0025401100',
    'reference' => 'd7a004b1-a581-4cd9-89ae-a1f0934019',
    'amount' => 1800,
    'callback_url' => 'https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8'
  ]),
  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/billers/{biller_code}/items/{item_code}/payment"

	payload := strings.NewReader("{\n  \"country\": \"NG\",\n  \"customer_id\": \"0025401100\",\n  \"reference\": \"d7a004b1-a581-4cd9-89ae-a1f0934019\",\n  \"amount\": 1800,\n  \"callback_url\": \"https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8\"\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/billers/{biller_code}/items/{item_code}/payment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"NG\",\n  \"customer_id\": \"0025401100\",\n  \"reference\": \"d7a004b1-a581-4cd9-89ae-a1f0934019\",\n  \"amount\": 1800,\n  \"callback_url\": \"https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flutterwave.com/v3/billers/{biller_code}/items/{item_code}/payment")

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  \"country\": \"NG\",\n  \"customer_id\": \"0025401100\",\n  \"reference\": \"d7a004b1-a581-4cd9-89ae-a1f0934019\",\n  \"amount\": 1800,\n  \"callback_url\": \"https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8\"\n}"

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

{
  "status": "success",
  "message": "Bill payment successful",
  "data": {
    "phone_number": "0025401100",
    "amount": 1800,
    "network": "DSTV Payment",
    "code": "200",
    "tx_ref": "CF-FLYAPI-20240324091413750321",
    "reference": "247837898415",
    "batch_reference": null,
    "recharge_token": null,
    "fee": 100
  }
}

{
  "status": "error",
  "message": "No record found for customer",
  "data": null
}

POST

billers

{biller_code}

items

{item_code}

payment

Create a Bill Payment

curl --request POST \
  --url https://api.flutterwave.com/v3/billers/{biller_code}/items/{item_code}/payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "NG",
  "customer_id": "0025401100",
  "reference": "d7a004b1-a581-4cd9-89ae-a1f0934019",
  "amount": 1800,
  "callback_url": "https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8"
}
'

import requests

url = "https://api.flutterwave.com/v3/billers/{biller_code}/items/{item_code}/payment"

payload = {
    "country": "NG",
    "customer_id": "0025401100",
    "reference": "d7a004b1-a581-4cd9-89ae-a1f0934019",
    "amount": 1800,
    "callback_url": "https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8"
}
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({
    country: 'NG',
    customer_id: '0025401100',
    reference: 'd7a004b1-a581-4cd9-89ae-a1f0934019',
    amount: 1800,
    callback_url: 'https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8'
  })
};

fetch('https://api.flutterwave.com/v3/billers/{biller_code}/items/{item_code}/payment', 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/billers/{biller_code}/items/{item_code}/payment",
  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([
    'country' => 'NG',
    'customer_id' => '0025401100',
    'reference' => 'd7a004b1-a581-4cd9-89ae-a1f0934019',
    'amount' => 1800,
    'callback_url' => 'https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8'
  ]),
  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/billers/{biller_code}/items/{item_code}/payment"

	payload := strings.NewReader("{\n  \"country\": \"NG\",\n  \"customer_id\": \"0025401100\",\n  \"reference\": \"d7a004b1-a581-4cd9-89ae-a1f0934019\",\n  \"amount\": 1800,\n  \"callback_url\": \"https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8\"\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/billers/{biller_code}/items/{item_code}/payment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"NG\",\n  \"customer_id\": \"0025401100\",\n  \"reference\": \"d7a004b1-a581-4cd9-89ae-a1f0934019\",\n  \"amount\": 1800,\n  \"callback_url\": \"https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flutterwave.com/v3/billers/{biller_code}/items/{item_code}/payment")

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  \"country\": \"NG\",\n  \"customer_id\": \"0025401100\",\n  \"reference\": \"d7a004b1-a581-4cd9-89ae-a1f0934019\",\n  \"amount\": 1800,\n  \"callback_url\": \"https://webhook.site/#!/view/df95cc29-1556-4e39-85ff-180fae09f3e8\"\n}"

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

{
  "status": "success",
  "message": "Bill payment successful",
  "data": {
    "phone_number": "0025401100",
    "amount": 1800,
    "network": "DSTV Payment",
    "code": "200",
    "tx_ref": "CF-FLYAPI-20240324091413750321",
    "reference": "247837898415",
    "batch_reference": null,
    "recharge_token": null,
    "fee": 100
  }
}

{
  "status": "error",
  "message": "No record found for customer",
  "data": null
}

Authorizations

Authorization

string

header

required

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

Path Parameters

biller_code

string

required

Example:

"BIL119"

item_code

string

required

Example:

"CB140"

Body

application/json

country

string

required

customer_id

string

required

reference

string

required

amount

integer<int32>

required

callback_url

string

required

Response

status

string

required

message

string

required

data

Data74 · object

required

Show child attributes

Example:

{
  "phone_number": "0025401100",
  "amount": 1800,
  "network": "DSTV Payment",
  "code": "200",
  "tx_ref": "CF-FLYAPI-20240324091413750321",
  "reference": "247837898415",
  "batch_reference": null,
  "recharge_token": null,
  "fee": 100
}

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 a Bill Payment

Authorizations

Path Parameters

Body

Response