Skip to main content
POST https://starpayqa.starpayethiopia.com/v1/starpay-api/trdp/verify Use this endpoint to check the current status of an order at any time. Call it after receiving a webhook callback, or poll it to confirm payment before fulfilling an order.

Request

Headers

x-api-secret
string
required
Your App Secret provided by CBE.

Body

orderId
string
required
The order ID returned in the data.order_id field of the create transaction response. Example: "5428255034"

Response

201 Success

status
string
Response status. Value: "success"
timestamp
string
ISO 8601 timestamp of when the response was generated.
message
string
Human-readable result message. Value: "Payment verified successfully"
data
object

Error responses

StatusMeaning
400Bad request — missing or invalid orderId
401Unauthorized — invalid or missing x-api-secret
404Not found — no order exists with the provided orderId
500Server error — an unexpected error occurred on the Star-Pay side

Code examples

curl -X POST https://starpayqa.starpayethiopia.com/v1/starpay-api/trdp/verify \
  -H "Content-Type: application/json" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -d '{"orderId": "5428255034"}'

Example response

{
  "status": "success",
  "timestamp": "2025-07-01T10:05:00.000Z",
  "message": "Payment verified successfully",
  "data": {
    "order_id": "656445e6-20fa-440d-b8c9-0a588d1ca05b",
    "status": "PAID",
    "amount": 100,
    "currency": "ETB",
    "updated_at": "2025-07-01T10:04:45.000Z"
  }
}
A 201 response code indicates the API call itself succeeded. Always check data.status to determine whether the payment was actually completed.

Build docs developers (and LLMs) love