View Single Transaction

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

Use this call to get details of a transaction for a merchant.

Request

Parameters

Field	Type	Requirement	Description
TID	String	Required*	TID (Transaction ID) of the transaction.
OldReference	String	Required*	The reference number of the original transaction.
StoreID	String	Required	A unique store identifier code for the merchant.
Metadata	String	Optional	Any other detail that the merchant wishes to store on this transaction.

*Either the TID or OldReference must be supplied. If both are supplied, only OldReference will be used.

Example Body

{
  "TID": "14973608673",
  "OldReference": "101",
  "StoreID": "Store1",
  "Metadata": "{\"ActorUserIDs\": \"547828938941114\"}"
}

Response

Parameters

Field	Type	Description
TID	String	TID (Transaction ID) of the executed payment response.
Reference	String	The reference number given to the original transaction.
Date	String	Transaction execution date (YYYY/MM/DD).
Time	String	Transaction execution time (HH:MM).
Type	String	The type of transaction.
Amount	String	Transaction amount in cents.
Comms	String	Transaction commission amount in cents.
Recipient	String	Transaction recipient’s username.
ReverseID	String	TID for the reverse executed on this transaction.
ConfirmID	String	Transaction confirmation status (1 for confirmed).
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": "14973608673",
    "Reference": "101",
    "Date": "2024/05/11",
    "Time": "12:00",
    "Type": "Buy",
    "Amount": "2000",
    "Comms": "60",
    "Recipient": "27821231000",
    "ReverseID": "8515615069",
    "ConfirmID": "1",
    "State": "Success",
    "Status": "1",
    "Error": ""
}

cURL

curl -X POST '{api-url}/payment?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"TID":"14973608673","OldReference":"101","StoreID":"Store1","Metadata":"{\"ActorUserIDs\": \"547828938941114\"}"}'

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

        var jsonPayload = @"{
  ""TID"": ""14973608673"",
  ""OldReference"": ""101"",
  ""StoreID"": ""Store1"",
  ""Metadata"": ""{\""ActorUserIDs\"": \""547828938941114\""}""
}";
        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}/payment?ns={community}"
  payload := strings.NewReader(`{"TID":"14973608673","OldReference":"101","StoreID":"Store1","Metadata":"{\"ActorUserIDs\": \"547828938941114\"}"}`)

  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 = """
                {
  "TID": "14973608673",
  "OldReference": "101",
  "StoreID": "Store1",
  "Metadata": "{\"ActorUserIDs\": \"547828938941114\"}"
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/payment?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}/payment?ns={community}';
    const payload = {
    "TID": "14973608673",
    "OldReference": "101",
    "StoreID": "Store1",
    "Metadata": {
        "ActorUserIDs": "547828938941114"
    }
};

    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}/payment?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 => '{
  "TID": "14973608673",
  "OldReference": "101",
  "StoreID": "Store1",
  "Metadata": "{\"ActorUserIDs\": \"547828938941114\"}"
}',
  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}/payment?ns={community}"
payload = {
  "TID": "14973608673",
  "OldReference": "101",
  "StoreID": "Store1",
  "Metadata": {
    "ActorUserIDs": "547828938941114"
  }
}

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}/payment?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({
  "TID": "14973608673",
  "OldReference": "101",
  "StoreID": "Store1",
  "Metadata": {
    "ActorUserIDs": "547828938941114"
  }
})

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