View Multiple Transactions

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

Use this call to get a list of transactions for a merchant.

Request
Response

Parameters

Field	Type	Requirement	Description
`DateFrom`	String	Required	Specify the starting date and time for the search (`YYYY/MM/DD HH:MM`).
`DateTo`	String	Required	Specify the ending date and time for the search (`YYYY/MM/DD HH:MM`).
`StoreID`	String	Required	A unique store identifier code for the merchant.
`Type`	String	Required	A filter for the type of transaction you would like to list (e.g., `All`).
`Limit`	String	Optional	An Integer to limit the quantity of transaction responses.
`Offset`	String	Optional	An integer to indicate the start index for pagination.
`Metadata`	String	Optional	Any other detail that the merchant wishes to store on this transaction.

Example Body

{
  "DateFrom": "2024/05/11 16:00",
  "DateTo": "2024/05/11 23:00",
  "StoreID": "Store1",
  "Type": "All",
  "Limit": "100",
  "Offset": "0",
  "Metadata": "{\"ActorUserIDs\": \"547828938941114\"}"
}

The response will be returned as an array of transaction objects.

Parameters (per object)

Field	Type	Description
`TID`	String	TID (Transaction ID) of the executed payment response.
`Reference`	String	The reference number given to the original transaction.
`Created`	String	Transaction execution time.
`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 of 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": "8615615066",
        "Reference": "101",
        "Created": "2024/05/11 12:00",
        "Type": "Buy",
        "Amount": "2000",
        "Comms": "60",
        "Recipient": "27821231000",
        "ReverseID": "8515615069",
        "ConfirmID": "1",
        "State": "Success",
        "Status": "1",
        "Error": ""
    }
]

curl -X POST '{api-url}/payments?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"DateFrom":"2024/05/11 16:00","DateTo":"2024/05/11 23:00","StoreID":"Store1","Type":"All","Limit":"100","Offset":"0","Metadata":"{\"ActorUserIDs\": \"547828938941114\"}"}'

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

        var jsonPayload = @"{
  ""DateFrom"": ""2024/05/11 16:00"",
  ""DateTo"": ""2024/05/11 23:00"",
  ""StoreID"": ""Store1"",
  ""Type"": ""All"",
  ""Limit"": ""100"",
  ""Offset"": ""0"",
  ""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);
    }
}

package main

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

func main() {
  url := "{api-url}/payments?ns={community}"
  payload := strings.NewReader(`{"DateFrom":"2024/05/11 16:00","DateTo":"2024/05/11 23:00","StoreID":"Store1","Type":"All","Limit":"100","Offset":"0","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))
}

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 = """
                {
  "DateFrom": "2024/05/11 16:00",
  "DateTo": "2024/05/11 23:00",
  "StoreID": "Store1",
  "Type": "All",
  "Limit": "100",
  "Offset": "0",
  "Metadata": "{\"ActorUserIDs\": \"547828938941114\"}"
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/payments?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());
    }
}

// Requires Node.js v18+
(async () => {
    const url = '{api-url}/payments?ns={community}';
    const payload = {
    "DateFrom": "2024/05/11 16:00",
    "DateTo": "2024/05/11 23:00",
    "StoreID": "Store1",
    "Type": "All",
    "Limit": "100",
    "Offset": "0",
    "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
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{api-url}/payments?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 => '{
  "DateFrom": "2024/05/11 16:00",
  "DateTo": "2024/05/11 23:00",
  "StoreID": "Store1",
  "Type": "All",
  "Limit": "100",
  "Offset": "0",
  "Metadata": "{\"ActorUserIDs\": \"547828938941114\"}"
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: bearer YOUR_TOKEN',
    'Content-Type: application/json'
  ),
));

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

import requests
import json

url = "{api-url}/payments?ns={community}"
payload = {
  "DateFrom": "2024/05/11 16:00",
  "DateTo": "2024/05/11 23:00",
  "StoreID": "Store1",
  "Type": "All",
  "Limit": "100",
  "Offset": "0",
  "Metadata": {
    "ActorUserIDs": "547828938941114"
  }
}

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

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

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

url = URI("{api-url}/payments?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({
  "DateFrom": "2024/05/11 16:00",
  "DateTo": "2024/05/11 23:00",
  "StoreID": "Store1",
  "Type": "All",
  "Limit": "100",
  "Offset": "0",
  "Metadata": {
    "ActorUserIDs": "547828938941114"
  }
})

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