View Transactions

POST {api-url}/viewDisbursementTransactions?ns={community}

Fetches a paginated list of all individual transactions within a specific disbursement, with support for filtering and sorting on the Audit object.

Request

Parameters

Field	Type	Requirement	Description
UIDx	Integer	Required	The unique internal identifier for this disbursement.
PageSize	Integer	Optional	The number of transactions to return per page. Max 1000, defaults to 1000.
Cursor	String	Optional	The cursor string from a previous response to fetch the next page.
SortField	String	Optional	Field to sort by. See Sort & Filter Rules.
SortOrder	String	Optional	Sort order (asc or desc). See Sort & Filter Rules.
Filters	Array	Optional	An array of filter objects. See Sort and Filter Rules.

Example Body

{
  "UIDx": 637,
  "PageSize": 1000,
  "Cursor": "a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...",
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "=",
      "Value": 5000
    }
  ]
}

Response

Parameters

Field	Type	Description
Total	Integer	The number of transactions returned in the current page.
Cursor	String	A cursor string to use in the next request to fetch the subsequent page.
Transactions	Array	An array of transaction objects containing Audit and Voucher details.

Example Body

{
    "Total": 1,
    "Cursor": "Z1tFV2B3b3UgIRdFR0ktFHV7bX9DWjgCR1RbZH5JYnBAXEZYKyFeWkdGcF12XVdlQ1koDn5JZmZVcgguaUxjax0SfnIQd29pX3thcVkAJwV/XXUqX2Vxe2V3",
    "Transactions": [
        {
            "Audit": {
                "Amount": 10,
                "Comms": 10,
                "Community": "fundingco",
                "DateTime": 1762437106680,
                "From": "FunderDemo",
                "FromBal": 17869074544,
                "FromKey": 4546326446997504,
                "FromMethod": "Cash",
                "FromType": "A",
                "FromUserID": "",
                "LastTransaction": 1762437106680,
                "METADATA": "{\"CheckIDCellMatch\":false,\"DisbursementID\":\"7bcddfd9-5b87-4d61-adb7-16f2c0cb32c1\",\"ExpectedFeesTotal\":99960,\"ExpectedTotal\":208006280,\"IsSingleUse\":true,\"Metadata\":\"\",\"Name\":\"Disbursement Test #1\",\"ShowVouchers\":false,\"VoucherNo\":\"\"}",
                "NewUser": 0,
                "TID": 12009351829,
                "TT": 1,
                "To": "celbuxuser3160",
                "ToBal": 10,
                "ToKey": 1000003159,
                "ToMethod": "Voucher: 168Cash",
                "ToType": "S",
                "ToUserID": "9128401442754",
                "TrxID": "1444-9640-5691",
                "Type": "New Merchant Voucher"
            },
            "Voucher": {
                "Amount": 10,
                "Community": "fundingco",
                "DateCreated": "2025-11-06T13:51:46.709798Z",
                "F3": 10,
                "F8": "ZAR1",
                "LastTransaction": 1762437106680,
                "Title": "Voucher 168Cash ZAR 0.10 Number : 414-44964-05691",
                "VTTitle": "168Cash"
            }
        }
    ]
}

cURL

curl -X POST '{api-url}/viewDisbursementTransactions?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"UIDx":637,"PageSize":1000,"Cursor":"a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...","SortField":"Amount","SortOrder":"asc","Filters":[{"Field":"Amount","Operator":"=","Value":5000}]}'

C#

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var request = new HttpRequestMessage(HttpMethod.Post, "{api-url}/viewDisbursementTransactions?ns={community}");
        request.Headers.Add("Authorization", "bearer YOUR_TOKEN");

        var jsonPayload = @"{
  ""UIDx"": 637,
  ""PageSize"": 1000,
  ""Cursor"": ""a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4..."",
  ""SortField"": ""Amount"",
  ""SortOrder"": ""asc"",
  ""Filters"": [
    {
      ""Field"": ""Amount"",
      ""Operator"": ""="",
      ""Value"": 5000
    }
  ]
}";
        request.Content = new StringContent(jsonPayload, Encoding.UTF8, "application/json");

        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Go

package main

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

func main() {
  url := "{api-url}/viewDisbursementTransactions?ns={community}"
  payload := strings.NewReader(`{"UIDx":637,"PageSize":1000,"Cursor":"a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...","SortField":"Amount","SortOrder":"asc","Filters":[{"Field":"Amount","Operator":"=","Value":5000}]}`)

  req, _ := http.NewRequest("POST", url, payload)
  req.Header.Add("Authorization", "bearer YOUR_TOKEN")
  req.Header.Add("Content-Type", "application/json")

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

  body, _ := ioutil.ReadAll(res.Body)
  fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ApiRequest {
    public static void main(String[] args) throws Exception {
        var payload = """
                {
  "UIDx": 637,
  "PageSize": 1000,
  "Cursor": "a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...",
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "=",
      "Value": 5000
    }
  ]
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/viewDisbursementTransactions?ns={community}"))
                .header("Authorization", "bearer YOUR_TOKEN")
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(payload))
                .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Node.js

// Requires Node.js v18+
(async () => {
    const url = '{api-url}/viewDisbursementTransactions?ns={community}';
    const payload = {
    "UIDx": 637,
    "PageSize": 1000,
    "Cursor": "a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...",
    "SortField": "Amount",
    "SortOrder": "asc",
    "Filters": [
        {
            "Field": "Amount",
            "Operator": "=",
            "Value": 5000
        }
    ]
};

    try {
        const response = await fetch(url, {
            method: 'POST',
            headers: {
                'Authorization': 'bearer YOUR_TOKEN',
                'Content-Type': 'application/json'
            },
            body: JSON.stringify(payload)
        });
        const data = await response.json();
        console.log(data);
    } catch (error) {
        console.error('Error:', error);
    }
})();

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{api-url}/viewDisbursementTransactions?ns={community}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "UIDx": 637,
  "PageSize": 1000,
  "Cursor": "a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...",
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "=",
      "Value": 5000
    }
  ]
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: bearer YOUR_TOKEN',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

Python

import requests
import json

url = "{api-url}/viewDisbursementTransactions?ns={community}"
payload = {
  "UIDx": 637,
  "PageSize": 1000,
  "Cursor": "a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...",
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "=",
      "Value": 5000
    }
  ]
}

headers = {
    "Authorization": "bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

Ruby

require 'uri'
require 'net/http'
require 'json'

url = URI("{api-url}/viewDisbursementTransactions?ns={community}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'bearer YOUR_TOKEN'
request["Content-Type"] = 'application/json'

request.body = JSON.dump({
  "UIDx": 637,
  "PageSize": 1000,
  "Cursor": "a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...",
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "=",
      "Value": 5000
    }
  ]
})

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