Skip to main content
GET
/
bbps
/
cou
/
v1
/
billers
/
categories
Fetch Biller Categories
curl --request GET \
  --url https://sandbox.cashfree.com/bbps/cou/v1/billers/categories \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
import requests

url = "https://sandbox.cashfree.com/bbps/cou/v1/billers/categories"

headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};

fetch('https://sandbox.cashfree.com/bbps/cou/v1/billers/categories', 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://sandbox.cashfree.com/bbps/cou/v1/billers/categories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://sandbox.cashfree.com/bbps/cou/v1/billers/categories"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sandbox.cashfree.com/bbps/cou/v1/billers/categories")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/bbps/cou/v1/billers/categories")

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

request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "status": "OK",
  "message": "Biller categories fetched successfully",
  "data": [
    "Broadband Postpaid",
    "Cable TV",
    "Clubs and Associations",
    "Credit Card",
    "DTH",
    "Donation",
    "Education",
    "Electricity",
    "Fastag",
    "Gas",
    "Hospital",
    "Hospital and Pathology",
    "Insurance",
    "LPG Gas",
    "Landline Postpaid",
    "Loan Repayment",
    "Mobile Postpaid",
    "Municipal Services",
    "Municipal Taxes",
    "Recurring Deposit",
    "Rental",
    "Subscription",
    "Water"
  ]
}
{
"message": "authentication Failed",
"code": "request_failed",
"type": "authentication_error"
}
{
"message": "Too many requests from IP. Check headers",
"code": "request_failed",
"type": "rate_limit_error"
}
{
"message": "internal Server Error",
"code": "internal_error",
"type": "api_error"
}

Authorizations

x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret
string
header
required

Your unique client secret issued by Cashfree. Keep this confidential and never expose it in client-side code. You can find this in your Merchant Dashboard.

Response

Success response for fetching all active biller categories available on the BBPS network.

status
string

Always "OK" on success.

Example:

"OK"

message
string

Human-readable confirmation of the operation result.

Example:

"Biller categories fetched successfully"

data
string[]

Alphabetically sorted list of active biller categories available on the BBPS network.

Example:
[
"Broadband Postpaid",
"Cable TV",
"Clubs and Associations",
"Credit Card",
"DTH",
"Donation",
"Education",
"Electricity",
"Fastag",
"Gas",
"Hospital",
"Hospital and Pathology",
"Insurance",
"LPG Gas",
"Landline Postpaid",
"Loan Repayment",
"Mobile Postpaid",
"Municipal Services",
"Municipal Taxes",
"Recurring Deposit",
"Rental",
"Subscription",
"Water"
]