Skip to main content
GET

Get Transaction Status

This endpoint allows you to check the current status of a payment transaction using its reference identifier. Endpoint: GET /v1/payment/{reference}/status

Path Parameter

  • reference (string, required): The reference identifier of the payment transaction to check.
    • Example: 20416369453214532143

Responses

200 OK - Transaction Status Retrieved Successfully

404 Not Found - Transaction Not Found

401 Unauthorized - Invalid Credentials

Response Fields

  • statusCode (string): Status code indicating the result of the request
    • "0000": Successful
    • "0404": Transaction not found
    • "0401": Unauthorized
  • statusMessage (string): Human-readable status message
  • transactionId (string): Unique transaction identifier for tracking
  • data (object): Transaction details when successful
    • reference (string): Reference identifier for the payment
    • status (string): Current transaction status - PENDING, COMPLETED, FAILED, CANCELLED
    • amount (number): Base payment amount
    • charge (number): Processing charge amount
    • totalAmount (number): Total amount including charges
    • payee (string): Name of the payee receiving the payment
    • payer (string): Name or identifier of the payer
    • narration (string): Payment description or narration
    • msisdn (string): Mobile subscriber identifier
    • completedAt (string): ISO 8601 timestamp when transaction was completed (null if not completed)
  • links (array): HATEOAS links for related actions

Transaction Status Values

  • PENDING: Transaction is being processed
  • COMPLETED: Transaction has been successfully completed
  • FAILED: Transaction failed to process
  • CANCELLED: Transaction was cancelled

Usage Example

Use this endpoint to check the current status of a payment transaction. This is particularly useful for:
  • Polling transaction status after initiating a payment
  • Verifying payment completion before fulfilling orders
  • Troubleshooting failed transactions

Authorizations

Authorization
string
header
required

Basic authentication using base64 encoded username:password

Path Parameters

reference
string
required

The reference identifier of the payment transaction

Response

Transaction status retrieved successfully

statusCode
string

Status code indicating the result of the request

Example:

"0000"

statusMessage
string

Human-readable status message

Example:

"Successful"

transactionId
string

Unique transaction identifier for tracking

Example:

"20416369453214532143"

data
object | null

Transaction details when successful

HATEOAS links for related actions