Payments

Get Series

Time-series invoiced vs collected — feeds line charts and grouped bar charts.

Each point in series has:

date — x-axis label (ISO date or YYYY-MM for monthly)
invoiced — KES recognised (accrual basis)
collected — KES received (cash basis)
gap — invoiced minus collected (positive = clients paying late)
invoice_count / payment_count — event counts for tooltips

Recommended chart: grouped bar (invoiced vs collected per bucket) or dual-line with area fill between lines to show the accrual-cash gap. Zero-value buckets are included so the x-axis is always continuous.

GET

api

payments

stats

series

Get Series

curl --request GET \
  --url https://api.capedigital.co.ke/payment/api/v1/payments/stats/series \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.capedigital.co.ke/payment/api/v1/payments/stats/series"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.capedigital.co.ke/payment/api/v1/payments/stats/series', 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.capedigital.co.ke/payment/api/v1/payments/stats/series",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.capedigital.co.ke/payment/api/v1/payments/stats/series"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.capedigital.co.ke/payment/api/v1/payments/stats/series")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.capedigital.co.ke/payment/api/v1/payments/stats/series")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

period

string

default:mtd

Reporting window. One of the preset windows below, or custom (requires date_from and date_to):

today — current day only
week — Monday of the current week to today
mtd — Month To Date: 1st of this month to today
qtd — Quarter To Date: 1st of this quarter to today (e.g. Apr 1 in Q2)
ytd — Year To Date: Jan 1 to today
rolling_30 — last 30 calendar days, regardless of month boundaries
rolling_60 — last 60 calendar days
rolling_90 — last 90 calendar days (standard treasury lookback)
custom — supply date_from=YYYY-MM-DD&date_to=YYYY-MM-DD

granularity

string

default:daily

Time bucket size for the x-axis:

daily — one point per day (best for: today, week, mtd, rolling_30)
weekly — one point per Mon–Sun week (best for: rolling_60, rolling_90, qtd)
monthly — one point per month (best for: ytd, custom long ranges)

date_from

string<date> | null

Start date for period='custom' (YYYY-MM-DD).

date_to

string<date> | null

End date for period='custom' (YYYY-MM-DD).

Response

Successful Response

Get Payment StatsCash flow stats — actual money received, by channel and period. Pair with `GET /invoice-requests/stats` for the full AR picture: that endpoint shows what was invoiced (accrual); this one shows what was actually collected (cash basis).

Get Series

curl --request GET \
  --url https://api.capedigital.co.ke/payment/api/v1/payments/stats/series \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.capedigital.co.ke/payment/api/v1/payments/stats/series"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.capedigital.co.ke/payment/api/v1/payments/stats/series', 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.capedigital.co.ke/payment/api/v1/payments/stats/series",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.capedigital.co.ke/payment/api/v1/payments/stats/series"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.capedigital.co.ke/payment/api/v1/payments/stats/series")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.capedigital.co.ke/payment/api/v1/payments/stats/series")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Invoices

Payments

Commissions

Health

Get Series

Authorizations

Query Parameters

Response