Get Transaction By Reference

GET /GetTransactionByReference

Try it

Parameters

siteCode*querytransactionReference*queryisTestquery

Request sampleLanguage

curl -X GET 'https://api.ozow.com/GetTransactionByReference?siteCode=TST-MER-001&transactionReference=MyReference&isTest=false' \
  -H 'ApiKey: YOUR_API_KEY'

Response exampleStatus

[
  {
    "id": "33857766-f29a-4a3a-a37e-66db3c42e439",
    "createdDateUtc": "<createdDateUtc>",
    "siteCode": "<siteCode>",
    "siteName": "<siteName>",
    "bankFromName": "<bankFromName>",
    "bankToName": "<bankToName>",
    "amount": 100.55,
    "status": "Complete",
    "toAccount": "<toAccount>",
    "toReference": "<toReference>",
    "paymentDate": "2026-01-15",
    "paymentDateUtc": "2026-01-15",
    "transactionReference": "<transactionReference>",
    "customer": "<customer>",
    "optional1": "<optional1>",
    "optional2": "<optional2>",
    "optional3": "<optional3>",
    "optional4": "<optional4>",
    "optional5": "<optional5>",
    "lastEvent": "<lastEvent>",
    "lastEventStatus": "<lastEventStatus>"
  }
]

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

GEThttps://api.ozow.com/GetTransactionByReferenceProduction

Build with AI 2 packages

A build package is every page for one task, with the API operations they use. Copy the prompt into a coding assistant, or hand it the package itself: slim links to each page, full inlines all of them in one document.

Embed checkout in your own pageEverything needed to keep the customer on your site while they pay, as an iframe, a modal, or the Wallet SDK for Apple Pay and Google Pay, with the notification that actually confirms the payment.
View package
Migrate a payin from the Payments API to One APIEverything needed to move an existing redirect payin onto One API, with the legacy guide and its One API counterpart side by side.
View package

This operation is used when you want to query transactions using the merchant's transaction reference, specified when creating the payment request. This method is able to return multiple results. Ozow does not restrict the merchant from sending duplicate merchant references, though it is advised that a unique reference is sent per transaction. The number of results returned are limited to 10. Note that the site code must be the same as the one used when the associated payment request was created.

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

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
transactionReference string required
The merchant's reference for the transaction.
max length50
exampleMyReference
isTest boolean
Defaults to false. Use true only to get results for test requests.
examplefalse

Request body

This method is called when you want to query transactions using the merchant's reference. This method is able to return multiple results. Ozow does not restrict the merchant from sending duplicate merchant references, though it is advised that a unique reference is sent per transaction. The number of results returned are limited to 10.

Responses

200 Array of TransactionModel

application/json

array of TransactionModel

application/xml

array of TransactionModel

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

Guides

Request

curl -X GET 'https://api.ozow.com/GetTransactionByReference?siteCode=TST-MER-001&transactionReference=MyReference&isTest=false' \
  -H 'ApiKey: YOUR_API_KEY'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ozow.com/GetTransactionByReference?siteCode=TST-MER-001&transactionReference=MyReference&isTest=false");
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/GetTransactionByReference?siteCode=TST-MER-001&transactionReference=MyReference&isTest=false',
    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/GetTransactionByReference?siteCode=TST-MER-001&transactionReference=MyReference&isTest=false", {
  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/GetTransactionByReference?siteCode=TST-MER-001&transactionReference=MyReference&isTest=false",
    headers=headers,
)

Response

Array of TransactionModel

[
  {
    "id": "33857766-f29a-4a3a-a37e-66db3c42e439",
    "createdDateUtc": "<createdDateUtc>",
    "siteCode": "<siteCode>",
    "siteName": "<siteName>",
    "bankFromName": "<bankFromName>",
    "bankToName": "<bankToName>",
    "amount": 100.55,
    "status": "Complete",
    "toAccount": "<toAccount>",
    "toReference": "<toReference>",
    "paymentDate": "2026-01-15",
    "paymentDateUtc": "2026-01-15",
    "transactionReference": "<transactionReference>",
    "customer": "<customer>",
    "optional1": "<optional1>",
    "optional2": "<optional2>",
    "optional3": "<optional3>",
    "optional4": "<optional4>",
    "optional5": "<optional5>",
    "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.