​
Request Structure

To check the status of a transaction, provide the transaction ID in the request. This ID is typically returned in the response after a payment or deposit.

  • For deposits, use depositId.
  • For payouts, use payoutId.

​
Example Request

{
  "params": {
    "id": "Wxxxxxxxxxxxxb"
  }
}

​
Response Structure

The structure of the response expected from the api is as shown below.

{
  "success": true,
  "message": "Transaction data fetched successfully.",
  "data": {
    "amount": "Transaction amount",
    "fee": "Transaction fee if applicable",
    "currency": "Transaction currency",
    "status": "Transaction status",
    "payee": "Name of recipient for payouts",
    "invoice_no": "Invoice number of transaction",
    "mobile": "Recipient mobile",
    "account_number": "Account number in the case of payouts",
    "ref": "Transaction reference from provider",
    "balance": "Account balance",
    "transaction_detail": "Transaction details",
    "payment_channel": "Payment channel",
    "transaction_date": "2024-08-06 00:00:00",
    "created_at": "2024-06-06T11:58:12.000000Z",
    "updated_at": "2024-06-06T11:58:27.000000Z",
    "callback_url": "https://your-domain.com/niobi/result",
    "status_code": "Status code",
    "failureReason": {
            "failureCode": null,
            "failureMessage": null
        }
  }
}
The transaction failure reason for deposits are passed within the failureReason object.