View Card PAN

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

Retrieve the full details and current balances of a specific Card PAN. You may look up the card using either its PAN or its Reference.

Request

Parameters

Field	Type	Requirement	Description
CardPAN	String	Conditional	The PAN of the card. Required if Reference is not provided.
Reference	String	Conditional	The Reference of the card. Required if CardPAN is not provided.
Metadata	String	Optional	Any other detail to store with this request.

Example Body

{
  "CardPAN": "5003456789012",
  "Reference": "",
  "Metadata": ""
}

Response

Parameters

Field	Type	Description
TID	String	TID of the executed operation.
CardPAN	String	The PAN of the queried card.
Owner	String	The username of the card owner.
VoucherTypeID	String	The internal identifier of the linked Voucher Type.
VoucherType	String	The title of the Voucher Type.
DisplayName	String	The user-facing display name of the Voucher Type.
Date	String	The date the card was created (YYYY/MM/DD).
Time	String	The time the card was created (HH:MM).
CardStatus	String	The current operational status of the card.
Community	String	The community the card was created in.
AutoCreateVoucher	String	Whether the card supports auto top-up (true or false).
CardBalances	String	A formatted string of balances associated with this card (e.g., ZAR:10000).
UserBalance	String	The available funding balance in the user’s root wallet.
Reference	String	The reference identifier assigned to the card.
State	String	Transaction state (Success or Failed).
Status	String	Transaction status code (1 or negative error code).
Error	String	Failure reason, if applicable.

Example Body

{
    "TID": "15000000000",
    "CardPAN": "5003456789012",
    "Owner": "27820000000",
    "VoucherTypeID": "14",
    "VoucherType": "168Cash",
    "DisplayName": "Celbux Cash",
    "Date": "2026/03/19",
    "Time": "12:00",
    "CardStatus": "Open",
    "Community": "celbux",
    "AutoCreateVoucher": "true",
    "CardBalances": "ZAR:10000",
    "UserBalance": "50000",
    "Reference": "3K9XJ1L2M",
    "State": "Success",
    "Status": "1",
    "Error": ""
}

cURL

curl -X POST '{api-url}/viewCardPAN?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"CardPAN":"5003456789012","Reference":"","Metadata":""}'

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}/viewCardPAN?ns={community}");
        request.Headers.Add("Authorization", "bearer YOUR_TOKEN");

        var jsonPayload = @"{
  ""CardPAN"": ""5003456789012"",
  ""Reference"": """",
  ""Metadata"": """"
}";
        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}/viewCardPAN?ns={community}"
  payload := strings.NewReader(`{"CardPAN":"5003456789012","Reference":"","Metadata":""}`)

  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 = """
                {
  "CardPAN": "5003456789012",
  "Reference": "",
  "Metadata": ""
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/viewCardPAN?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}/viewCardPAN?ns={community}';
    const payload = {
    "CardPAN": "5003456789012",
    "Reference": "",
    "Metadata": ""
};

    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}/viewCardPAN?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 => '{
  "CardPAN": "5003456789012",
  "Reference": "",
  "Metadata": ""
}',
  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}/viewCardPAN?ns={community}"
payload = {
  "CardPAN": "5003456789012",
  "Reference": "",
  "Metadata": ""
}

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}/viewCardPAN?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({
  "CardPAN": "5003456789012",
  "Reference": "",
  "Metadata": ""
})

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