GET
/api/v1/transaction-status
Status Query
Transaction Status
Query the real-time status of any collection, card checkout, or payout using either your client reference or the HivePay gateway reference.
Query Parameters (URL)
| Parameter | Type | Required | Description |
|---|---|---|---|
| reference | string | Required | Either the merchant reference passed during creation (e.g. ORDER-98765) or the HivePay gateway reference (e.g. COL-AB12CD34EF). |
Code Example
curl "https://hivepay.site/api/v1/transaction-status?reference=ORDER-98765" \ -H "X-API-Key: YOUR_API_KEY" \ -H "X-API-Secret: YOUR_API_SECRET" \ -H "X-Account-Number: YOUR_ACCOUNT_NUMBER"
<?php
$ref = urlencode('ORDER-98765');
$ch = curl_init("https://hivepay.site/api/v1/transaction-status?reference={$ref}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-Key: ' . getenv('HIVEPAY_API_KEY'),
'X-API-Secret: ' . getenv('HIVEPAY_API_SECRET'),
'X-Account-Number: ' . getenv('HIVEPAY_ACCOUNT_NO')
]
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
echo "Transaction Status: " . $data['status']; // 'success', 'pending', or 'failed'
const ref = encodeURIComponent('ORDER-98765');
const response = await fetch(`https://hivepay.site/api/v1/transaction-status?reference=${ref}`, {
headers: {
'X-API-Key': process.env.HIVEPAY_API_KEY,
'X-API-Secret': process.env.HIVEPAY_API_SECRET,
'X-Account-Number': process.env.HIVEPAY_ACCOUNT_NO
}
});
const data = await response.json();
console.log('Status:', data.status);
import os, requests
res = requests.get(
'https://hivepay.site/api/v1/transaction-status',
params={'reference': 'ORDER-98765'},
headers={
'X-API-Key': os.getenv('HIVEPAY_API_KEY'),
'X-API-Secret': os.getenv('HIVEPAY_API_SECRET'),
'X-Account-Number': os.getenv('HIVEPAY_ACCOUNT_NO')
}
)
data = res.json()
print("Transaction Status:", data.get('status'))
Response (200 OK)
Response JSON
{
"success": true,
"type": "collection",
"reference": "ORDER-98765",
"gateway_reference": "HP-COL-AB12CD34EF",
"status": "success",
"amount": 50000,
"currency": "UGX",
"phone_number": "0777123456",
"customer_name": "JOHN DOE",
"network": "MTN",
"created_at": "2026-09-13T16:30:00.000000Z"
}