NetConnect API
Result Checker

Get Result Checker Order Status

Return the status of one result-checker transaction owned by the caller.

Endpoint

GET /api/v1/result-checker/orders/{orderId}/status

Path parameters

ParameterTypeRequiredNotes
orderIdrcTransactions idYesResult checker transaction id

Response

Returns the transaction status with credential if completed:

{
  "success": true,
  "data": {
    "_id": "rc9exampletxn",
    "shortReference": "421903",
    "state": "completed",
    "paymentGatewayStatus": null,
    "amount": 5.00,
    "currency": "GHS",
    "packageName": "Result Checker - Basic",
    "buyerPhone": "233201234567",
    "credential": {
      "username": "candidate-user",
      "password": "candidate-pass"
    },
    "createdAt": 1234567890123,
    "completedAt": 1234567950000
  }
}

Response fields

FieldTypeNotes
_idstringrcTransactions record ID
shortReferencestringShort alphanumeric reference
statestringpending, completed, or failed
paymentGatewayStatusstring | nullGateway status (if payment gateway was used)
amountnumberGHS amount charged
currencystringAlways GHS
packageNamestringPackage name
buyerPhonestringRecipient phone number
credentialobject | nullOnly present when state is completed
createdAtnumberCreation timestamp (unix ms)
completedAtnumber | nullCompletion timestamp (unix ms)

Credential object (when present)

FieldTypeNotes
usernamestringLogin username
passwordstringLogin password

Errors

  • 404 - Transaction not found or unauthorized
  • 403 - Insufficient permissions

Sample request

curl -X GET "https://api.netconnectgh.online/api/v1/result-checker/orders/rc9exampletxn/status" \
  -H "X-API-KEY: netconnect_live_your_secret_here" \
  -H "Content-Type: application/json"

On this page