Get Transaction Report · Payments API

GEThttps://api.ozow.com/GetTransactionReportProduction

This operation is used to get all transactions for a merchant site in a particular date range.

Authentication

API key in the ApiKey header
The unique API key for the merchant. See Prerequisites and onboarding for where to find it.

Query parameters

startDate string required
The filter start date. Use format YYYY-MM-DD.
min length10max length10
example2024-01-02
siteCode string required
A unique code for the each of the merchant's sites. A site code is generated when adding a site in the Ozow merchant admin section.
max length50
exampleTST-MER-001
endDate string required
The filter end date. Use format YYYY-MM-DD. If used with a startDate, endDate must be larger than startDate.
min length10max length10
example2024-02-03

Responses

200 Array of TransactionModel

application/json

array of TransactionModel

application/xml

array of TransactionModel

401 Unauthorized. The ApiKey header is missing or does not match the site, or for a Secure operation the bearer token is missing, expired or invalid.

string

example 1

API key is missing or invalid.

403 Forbidden. The credentials were readable but the site cannot be authorised, because no merchant matches the site code or the merchant is deactivated.

string

example 1

Merchant for site code TSTSTE0001 is deactivated

Request

curl -X GET 'https://api.ozow.com/GetTransactionReport?startDate=2024-01-02&siteCode=TST-MER-001&endDate=2024-02-03' \
  -H 'ApiKey: YOUR_API_KEY'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ozow.com/GetTransactionReport?startDate=2024-01-02&siteCode=TST-MER-001&endDate=2024-02-03");
request.Headers.Add("ApiKey", "YOUR_API_KEY");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ozow.com/GetTransactionReport?startDate=2024-01-02&siteCode=TST-MER-001&endDate=2024-02-03',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'ApiKey: YOUR_API_KEY',
    ],
]);

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

const response = await fetch("https://api.ozow.com/GetTransactionReport?startDate=2024-01-02&siteCode=TST-MER-001&endDate=2024-02-03", {
  method: "GET",
  headers: {
    "ApiKey": "YOUR_API_KEY",
  },
});

const data = await response.json();

import requests

headers = {
    "ApiKey": "YOUR_API_KEY",
}

response = requests.get(
    "https://api.ozow.com/GetTransactionReport?startDate=2024-01-02&siteCode=TST-MER-001&endDate=2024-02-03",
    headers=headers,
)

Response

Array of TransactionModel

[
  {
    "id": "33857766-f29a-4a3a-a37e-66db3c42e439",
    "createdDate": "2024-01-02T14:22:30.123456+00:00",
    "createdDateUtc": "2024-01-02T12:22:30.123456+00:00",
    "siteCode": "SITE-001",
    "siteName": "<siteName>",
    "bankFromName": "<bankFromName>",
    "bankToName": "<bankToName>",
    "amount": 100.55,
    "status": "Complete",
    "toAccount": "<toAccount>",
    "toReference": "<toReference>",
    "paymentDate": "2024-01-02T14:25:11.654321+00:00",
    "paymentDateUtc": "2024-01-02T12:25:11.654321+00:00",
    "transactionReference": "12345-abcde",
    "customer": "Firstname Lastname",
    "optional1": "Optional value 1",
    "optional2": "Optional value 2",
    "optional3": "Optional value 3",
    "optional4": "Optional value 4",
    "optional5": "Optional value 5",
    "lastEvent": "<lastEvent>",
    "lastEventStatus": "<lastEventStatus>"
  }
]

Built from the response schema. Values are placeholders, not real data.

Unauthorized. The `ApiKey` header is missing or does not match the site, or for a `Secure` operation the bearer token is missing, expired or invalid.

API key is missing or invalid.

Forbidden. The credentials were readable but the site cannot be authorised, because no merchant matches the site code or the merchant is deactivated.

Merchant for site code TSTSTE0001 is deactivated

Internal Server Error. Something failed on the Ozow side.

string

Built from the response schema. Values are placeholders, not real data.