Skip to main content
GET
/
api
/
v1
/
payments
/
{transactionRef}
/
status
Check payment status
curl --request GET \
  --url https://dev-api-partner.onecluster.co/api/v1/payments/{transactionRef}/status \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "responseCode": "00",
  "message": "Status retrieved",
  "data": {
    "transactionRef": "TXN-20260325-001",
    "status": "SUCCESSFUL",
    "amount": 50000,
    "currency": "NGN",
    "completedAt": "2026-03-25T10:00:28+01:00"
  }
}

Authorizations

​
Authorization
string
header
required

Your API key, formatted as: ApiKey ubn_sb_your_key_here

  • Sandbox keys start with ubn_sb_
  • Production keys start with ubn_pk_
  • Never use production keys during testing — they will charge real money

Headers

​
X-Correlation-ID
string<uuid>

A UUID v4 you generate to trace this request through our systems. If you don't provide one, we generate it for you. Always include it in support requests — it helps us find your request in logs.

Example:

"7f3a9c21-4e8b-4a12-b6d1-3c8a7f2e1b09"

Path Parameters

​
transactionRef
string
required

The transaction reference returned when you initiated the transfer

Example:

"TXN-20260325-001"

Response

Payment status

Standard response wrapper for all successful API calls

​
success
boolean
required

Always true for successful responses

Example:

true

​
responseCode
string
required

00 means success

Example:

"00"

​
message
string
required

Human-readable description of the result

Example:

"Request processed successfully"

​
data
object
required

The actual response data (varies by endpoint)