Skip to navigation

Query Transaction Status

View as Markdown

Returns the current state of a transaction you created, looked up by your request_ref. Use it to resolve any pending purchase.

Calling this endpoint also re-sends a transaction.requery webhook (if you have a webhook URL configured) carrying the same status.

transaction_type is one of AIRTIME, DATA, CABLE_TV, ELECTRICITY. previous_balance / new_balance are the wallet balance before and after the debit.

HTTPstatusstatus_codeMeaning
200successful200Transaction completed
202pending202Still processing — poll again or wait for your webhook
400error—Bad payload or missing request_ref
401——Missing, invalid or revoked API key
403error—Reference exists but belongs to another account (body identical to 404)
404error—No transaction with that reference
424failed424Transaction failed — wallet was refunded

Authentication

AuthorizationBearer

API key issued from the VTUAgent dashboard, sent as Authorization: Bearer {your_api_key}.

Request

This endpoint expects an object.
request_refstringRequired
The reference you sent when purchasing.

Response

Transaction completed
statusenum
Allowed values:
status_codeenum
Always equals the HTTP status.
Allowed values:
messagestring
referencestring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
424
Failed Dependency Error