Verifying Transaction Status

This section outlines the transaction status API, which allows you to query details of a specific transaction, including both payouts and deposits. Access the API endpoint here.

v3 Request Structure

The v3 transaction status request requires the usual integration fields plus params.id (the transaction reference) and params.type (payin or payout).

Example

curl --location 'https://sandbox.users.niobi.co/api/v3/get-unified-transaction-status' \
--header 'Content-Type: application/json' \
--data '{
  "client_id": "<REDACTED_CLIENT_ID>",
  "params": { "id": "<REDACTED_REF>", "type": "payin" },
  "salt": "<REDACTED>",
  "sender": "Sandbox",
  "timestamp": "<REDACTED_TIMESTAMP>",
  "signature": "<REDACTED_SIGNATURE>"
}'

v3 Response Structure

The v3 response returns unified transaction metadata. Example (masked):

{
  "success": true,
  "message": "Transaction data fetched successfully.",
  "data": {
    "amount": "Transaction Amount",
    "fee": "Transaction fees",
    "currency": "Currency",
    "status": "Transaction Status",
    "payee": "Payee if available - for payouts",
    "invoice_no": "Invoice number - for payouts",
    "mobile": "2547xxxxxxx",
    "account_number": "Account number where applicable",
    "ref": "NIO-SXXXXX",
    "balance": "Balance where applicable",
    "transaction_detail": "N/A",
    "payment_channel": "Payment channel",
    "transaction_date": "Transaction Date",
    "created_at": "Created Date",
    "updated_at": "Updated date",
    "callback_url": "https://webhook.site/<REDACTED>",
    "status_code": "Status Code",
    "failureReason": { "failureCode": null, "failureMessage": null }
  }
}

Variables

Variable	Description
client_id	Your integration client_id
params.id	Transaction reference (ref)
params.type	Transaction type: payin or payout
salt	Salt used to build the signature
timestamp	Unix timestamp
signature	HMAC signature for request validation

See the API reference for full details: Get Transaction Status (v3).