List Partners

List Partners

curl --request GET \
  --url https://billapi.oneclickdz.com/v3/partners \
  --header 'X-Access-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};

fetch('https://billapi.oneclickdz.com/v3/partners', 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://billapi.oneclickdz.com/v3/partners",
  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-Access-Token: <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://billapi.oneclickdz.com/v3/partners"

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

	req.Header.Add("X-Access-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billapi.oneclickdz.com/v3/partners")

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

request = Net::HTTP::Get.new(url)
request["X-Access-Token"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "ADE": {},
    "SONELGAZ": {},
    "SEAAL": {},
    "AADL": {},
    "Algérie Télécom": {}
  },
  "status": "<string>",
  "meta": {
    "timestamp": "<string>"
  },
  "requestId": "<string>"
}

GET

partners

List Partners

curl --request GET \
  --url https://billapi.oneclickdz.com/v3/partners \
  --header 'X-Access-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};

fetch('https://billapi.oneclickdz.com/v3/partners', 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://billapi.oneclickdz.com/v3/partners",
  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-Access-Token: <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://billapi.oneclickdz.com/v3/partners"

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

	req.Header.Add("X-Access-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billapi.oneclickdz.com/v3/partners")

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

request = Net::HTTP::Get.new(url)
request["X-Access-Token"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "ADE": {},
    "SONELGAZ": {},
    "SEAAL": {},
    "AADL": {},
    "Algérie Télécom": {}
  },
  "status": "<string>",
  "meta": {
    "timestamp": "<string>"
  },
  "requestId": "<string>"
}

Overview

Returns the availability of every supported biller. Call it before a discovery so you can hide an unavailable partner from your customers instead of letting them hit a 503 at the end of a form. The response is a map keyed by the exact partner value you send to Discover Bills — including the accents in Algérie Télécom.

A PRODUCTION key sees live availability. A SANDBOX key sees a fixed map, because a sandbox request never reaches a partner and live availability would be misleading there.

Response

boolean

required

true when the map was returned.

object

required

One entry per partner. The key set is fixed.

Show properties

object

Algérienne Des Eaux — water.

object

Electricity and gas.

object

Water for Algiers and Tipaza.

object

Housing instalments.

object

Landline and internet.

Each entry has a single field:

string

required

ACTIVE — discovery and payment are accepted.UNAVAILABLE — discovery and payment for this partner answer 503 PARTNER_UNAVAILABLE.

object

required

Show properties

string

required

Response time, ISO 8601 UTC.

string

required

Correlation identifier, also sent as the X-Request-Id response header.

Examples

curl https://billapi.oneclickdz.com/v3/partners \
  -H "X-Access-Token: YOUR_API_KEY"

const response = await fetch("https://billapi.oneclickdz.com/v3/partners", {
  headers: { "X-Access-Token": process.env.ONECLICKDZ_API_KEY },
});

const body = await response.json();

if (!body.success) {
  throw new Error(`${body.error.code}: ${body.error.message}`);
}

const available = Object.entries(body.data)
  .filter(([, partner]) => partner.status === "ACTIVE")
  .map(([name]) => name);

console.log(available);

import os
import requests

response = requests.get(
    'https://billapi.oneclickdz.com/v3/partners',
    headers={'X-Access-Token': os.getenv('ONECLICKDZ_API_KEY')}
)

body = response.json()

if not body['success']:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")

available = [
    name for name, partner in body['data'].items()
    if partner['status'] == 'ACTIVE'
]

print(available)

<?php
$ch = curl_init('https://billapi.oneclickdz.com/v3/partners');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-Access-Token: ' . getenv('ONECLICKDZ_API_KEY')
]);

$body = json_decode(curl_exec($ch), true);
curl_close($ch);

if (!$body['success']) {
    throw new Exception($body['error']['code'] . ': ' . $body['error']['message']);
}

$available = array_keys(array_filter(
    $body['data'],
    fn($partner) => $partner['status'] === 'ACTIVE'
));

print_r($available);
?>

Success Response

{
  "success": true,
  "data": {
    "ADE": { "status": "ACTIVE" },
    "SONELGAZ": { "status": "ACTIVE" },
    "SEAAL": { "status": "UNAVAILABLE" },
    "AADL": { "status": "UNAVAILABLE" },
    "Algérie Télécom": { "status": "ACTIVE" }
  },
  "meta": {
    "timestamp": "2026-08-31T10:15:32.194Z"
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

Error Responses

401 — Missing access token

The X-Access-Token header was not sent.

{
  "success": false,
  "error": {
    "code": "MISSING_ACCESS_TOKEN",
    "message": "X-Access-Token header is required."
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

What to do: add the header and retry.

401 — Invalid access token

The key was rejected.

{
  "success": false,
  "error": {
    "code": "INVALID_ACCESS_TOKEN",
    "message": "The provided access token is invalid."
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

What to do: verify the key with Validate API Key.

503 — Authentication unavailable

We could not verify your key in time.

{
  "success": false,
  "error": {
    "code": "AUTH_UNAVAILABLE",
    "message": "Authentication is temporarily unavailable. Please retry shortly."
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

What to do: retry after the Retry-After header. Serve the last cached map in the meantime.

503 — Service unavailable

The Bill Payment API is in planned maintenance.

{
  "success": false,
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "The service is temporarily unavailable. Please retry shortly."
  },
  "requestId": "req_9f3a1c72e0b84d51aB3xZq07"
}

What to do: honour Retry-After and retry.

Current availability

SEAAL and AADL are currently UNAVAILABLE in both sandbox and production, and discovery or payment for them answers 503 PARTNER_UNAVAILABLE. This is the operator’s current setting, not a permanent limitation — keep both partners in your code and let this endpoint decide what to show.

Do not hard-code the availability of any partner. Read this map, and treat 503 PARTNER_UNAVAILABLE on a discovery as a partner that went unavailable between your last refresh and the request.

Caching the map

Availability changes rarely. Refresh it on a timer rather than before every discovery, and keep serving the last good copy when a refresh fails.

let cache = { map: null, fetchedAt: 0 };
const TTL_MS = 5 * 60 * 1000;

async function getPartners() {
  if (cache.map && Date.now() - cache.fetchedAt < TTL_MS) {
    return cache.map;
  }

  try {
    const response = await fetch("https://billapi.oneclickdz.com/v3/partners", {
      headers: { "X-Access-Token": process.env.ONECLICKDZ_API_KEY },
    });

    const body = await response.json();

    if (body.success) {
      cache = { map: body.data, fetchedAt: Date.now() };
    }
  } catch (error) {
    // Keep serving the previous map rather than blocking the customer.
  }

  return cache.map ?? {};
}

async function isAvailable(partner) {
  const map = await getPartners();
  return map[partner]?.status === "ACTIVE";
}

Best Practices

Cache for a few minutes

A 5-minute cache is enough. Calling this before every discovery adds a round trip and buys nothing.

Fail soft on refresh

If the refresh fails, keep the previous map. An empty partner list is worse than a slightly stale one.

Use the exact partner value

Send Algérie Télécom with its accents. The value is the key of this map, character for character.

Handle the race

A partner can become unavailable after you cached it. Handle 503 PARTNER_UNAVAILABLE on discovery too.

Validate API Key

Confirm your key and environment

Discover Bills

Look up what an account owes

Partners and Accounts

Identifiers for each partner

Bill Payment Overview

How the whole flow fits together

API Reference

Core

Account

Mobile Top-Ups

Internet Top-Ups

Gift Cards

Navio

Bill Payment

Overview

Response

Examples

Success Response

Error Responses

Current availability

Caching the map

Best Practices

Cache for a few minutes

Fail soft on refresh

Use the exact partner value

Handle the race

Validate API Key

Discover Bills

Partners and Accounts

Bill Payment Overview

​Overview

​Response

​Examples

​Success Response

​Error Responses

​Current availability

​Caching the map

​Best Practices

Cache for a few minutes

Fail soft on refresh

Use the exact partner value

Handle the race

​Related Endpoints

Validate API Key

Discover Bills

Partners and Accounts

Bill Payment Overview

Overview

Response

Examples

Success Response

Error Responses

Current availability

Caching the map

Best Practices

Related Endpoints