Record Payment
Finance confirms receipt of payment against an invoice.
curl --request POST \
--url https://api.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount_paid": 1,
"payment_reference": "<string>",
"payment_date": "2023-12-25",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
'import requests
url = "https://api.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments"
payload = {
"amount_paid": 1,
"payment_reference": "<string>",
"payment_date": "2023-12-25",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
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({
amount_paid: 1,
payment_reference: '<string>',
payment_date: '2023-12-25',
document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>'
})
};
fetch('https://api.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments', 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/invoices/{invoice_id}/payments",
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([
'amount_paid' => 1,
'payment_reference' => '<string>',
'payment_date' => '2023-12-25',
'document_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>'
]),
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.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments"
payload := strings.NewReader("{\n \"amount_paid\": 1,\n \"payment_reference\": \"<string>\",\n \"payment_date\": \"2023-12-25\",\n \"document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\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.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount_paid\": 1,\n \"payment_reference\": \"<string>\",\n \"payment_date\": \"2023-12-25\",\n \"document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments")
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 \"amount_paid\": 1,\n \"payment_reference\": \"<string>\",\n \"payment_date\": \"2023-12-25\",\n \"document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Records a payment receipt against an invoice.
Endpoint: POST /api/v1/invoices/{invoice_id}/payments
Required role: finance:confirm_payment
Multiple payments can be recorded against the same invoice to support installment/partial payment workflows.
Amount received in this payment. Must be greater than zero.
x > 0Channel used: RTGS, EFT, MPESA, CHEQUE, INTERNAL_LEDGER, or OTHER.
RTGS, EFT, MPESA, CHEQUE, INTERNAL_LEDGER, OTHER Bank reference, M-PESA transaction ID, or cheque number for audit trail.
Date funds were received, e.g. '2026-05-31'.
ID of the payment receipt uploaded to document-service (bank advice, M-PESA confirmation, cheque scan, etc.). Upload to document-service first, then pass the ID here.
Optional internal notes for the finance team.
Response
Successful Response
curl --request POST \
--url https://api.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount_paid": 1,
"payment_reference": "<string>",
"payment_date": "2023-12-25",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
'import requests
url = "https://api.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments"
payload = {
"amount_paid": 1,
"payment_reference": "<string>",
"payment_date": "2023-12-25",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
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({
amount_paid: 1,
payment_reference: '<string>',
payment_date: '2023-12-25',
document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>'
})
};
fetch('https://api.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments', 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/invoices/{invoice_id}/payments",
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([
'amount_paid' => 1,
'payment_reference' => '<string>',
'payment_date' => '2023-12-25',
'document_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>'
]),
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.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments"
payload := strings.NewReader("{\n \"amount_paid\": 1,\n \"payment_reference\": \"<string>\",\n \"payment_date\": \"2023-12-25\",\n \"document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\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.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount_paid\": 1,\n \"payment_reference\": \"<string>\",\n \"payment_date\": \"2023-12-25\",\n \"document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.capedigital.co.ke/payment/api/v1/invoices/{invoice_id}/payments")
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 \"amount_paid\": 1,\n \"payment_reference\": \"<string>\",\n \"payment_date\": \"2023-12-25\",\n \"document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}