Transaction status check

Check transaction status (polling)

curl --request POST \
  --url https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn \
  --header 'Content-Type: application/json' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "billRefNo": "5WL30548HD"
}
'

import requests

url = "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn"

payload = { "billRefNo": "5WL30548HD" }
headers = {
    "x-api-secret": "<x-api-secret>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-secret': '<x-api-secret>', 'Content-Type': 'application/json'},
  body: JSON.stringify({billRefNo: '5WL30548HD'})
};

fetch('https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billRefNo' => '5WL30548HD'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-secret: <x-api-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn"

	payload := strings.NewReader("{\n  \"billRefNo\": \"5WL30548HD\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-secret", "<x-api-secret>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn")
  .header("x-api-secret", "<x-api-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billRefNo\": \"5WL30548HD\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billRefNo\": \"5WL30548HD\"\n}"

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

{
  "status": "success",
  "timestamp": "2026-05-05T05:12:33.505Z",
  "message": "Transaction found successfully",
  "data": {
    "billRefNo": "5WL30548HD",
    "status": "PAID OR SETTLED",
    "timestamp": "2026-04-29T17:50:57.863Z",
    "message": "Payment successful",
    "merchantId": "42723792",
    "customerId": "",
    "externalReferenceId": "075SMPC2316706F7",
    "amount": 36500,
    "payment_type": "OTP_ACCOUNT",
    "receipt_url": "https://receipt.starpayethiopia.com/receiptqa/WST-5WL30548HD"
  }
}

POST

erp

check-txn

Check transaction status (polling)

curl --request POST \
  --url https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn \
  --header 'Content-Type: application/json' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "billRefNo": "5WL30548HD"
}
'

import requests

url = "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn"

payload = { "billRefNo": "5WL30548HD" }
headers = {
    "x-api-secret": "<x-api-secret>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-secret': '<x-api-secret>', 'Content-Type': 'application/json'},
  body: JSON.stringify({billRefNo: '5WL30548HD'})
};

fetch('https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billRefNo' => '5WL30548HD'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-secret: <x-api-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn"

	payload := strings.NewReader("{\n  \"billRefNo\": \"5WL30548HD\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-secret", "<x-api-secret>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn")
  .header("x-api-secret", "<x-api-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billRefNo\": \"5WL30548HD\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/check-txn")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billRefNo\": \"5WL30548HD\"\n}"

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

{
  "status": "success",
  "timestamp": "2026-05-05T05:12:33.505Z",
  "message": "Transaction found successfully",
  "data": {
    "billRefNo": "5WL30548HD",
    "status": "PAID OR SETTLED",
    "timestamp": "2026-04-29T17:50:57.863Z",
    "message": "Payment successful",
    "merchantId": "42723792",
    "customerId": "",
    "externalReferenceId": "075SMPC2316706F7",
    "amount": 36500,
    "payment_type": "OTP_ACCOUNT",
    "receipt_url": "https://receipt.starpayethiopia.com/receiptqa/WST-5WL30548HD"
  }
}

Use this endpoint for manual transaction status checks by billRefNo.

request

Send POST /erp/check-txn with:

Header: x-api-secret
Body: { "billRefNo": "..." }

response behavior

Returns current transaction state (for example PAID or FAILED).
If available, additional fields are returned (amount, receipt URL, merchant details, and more).

recommended usage

For real-time tracking, start with GET /erp/api/txn-sse.
If SSE does not return a definitive result within 15 seconds, use this endpoint as fallback.

Headers

x-api-secret

string

required

API secret key.

Example:

"X0Lkj979tyUv1IPGQkd+qsx0N6o1LQPSUpfBa6ZCKvXosp0HVnciXSIyWmgyBl0B"

Body

application/json

billRefNo

string

required

Example:

"5WL30548HD"

Response

Transaction found; data.status indicates outcome (for example PAID or FAILED).

status

string

required

Example:

"success"

timestamp

string<date-time>

required

message

string

required

Example:

"Transaction found successfully"

data

object

required

Transaction details when found. Fields present depend on status (for example PAID includes amount and receipt; FAILED may only include billRefNo, status, and message).

Show child attributes

Get started

Api Reference

Transaction status check

request

response behavior

recommended usage

Headers

Body

Response

​request

​response behavior

​recommended usage

Headers

Body

Response

request

response behavior

recommended usage