Skip to main content
POST
/
erp
/
check-txn
Check transaction status (polling)
curl --request POST \
  --url https://starpayqa.starpayethiopia.com/v1/starpay-api/erp/check-txn \
  --header 'Content-Type: application/json' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "billRefNo": "5WL30548HD"
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://erp-developer.starpayethiopia.com/llms.txt

Use this file to discover all available pages before exploring further.

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).
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).