Account Alerts

This will enable you to setup alerts which are sent when there is an activity on your account. An activity on the account can be debit, credit or both depending on the setup.

To receive Account Alerts:

Go to JengaHQ (opens in a new tab)
Sign-in and select Alerts on the Settings menu on the sidebar
Specify the account to receive alerts, account type (debit, credit or both), username, password and callback URL you would like to receive alerts on.

Request Fields

Field Name	Description	Type	Required
callbackType	The type of callback. In this case ALT	String	Yes
customer.name	The customer name	String	Yes
customer.mobileNumber	Customer mobile number	String	No
customer.reference	Customer reference	String	Yes
transaction.date	The transaction date	String	Yes
transaction.reference	Transaction reference	String	Yes
transaction.paymentMode	Transaction payment mode	String	Yes
transaction.amount	Transaction amount	Number	Yes
transaction.billNumber	Transaction bill number. This is the account number.	String	Yes
transaction.servedBy	The entity that served the transaction	String	No
transaction.additionalInfo	Any additional information for the transaction	String	No
transaction.orderAmount	Transaction order amount	Number	Yes
transaction.serviceCharge	Transaction service charge	Number	No
transaction.status	Transaction status	String	Yes
transaction.remarks	Transaction remarks	String	No
bank.reference	The bank system reference ID	String	Yes
bank.transactionType	Bank transaction type (Credit or Debit)	String	Yes
bank.account	Bank account	String	Yes

Sample Request

{
  "callbackType": "ALT",
  "customer": {
    "name": "Customer Name",
    "mobileNumber": null,
    "reference": "2547xxxxx QJ50A5ZZMI 076332"
  },
  "transaction": {
    "date": "2022-10-05 14:22:48",
    "reference": " S8550312",
    "paymentMode": "MISYS",
    "amount": 5,
    "billNumber": " S8550312",
    "servedBy": "EQ",
    "additionalInfo": "254711xxxxxx QJ50A5ZZMI 076332",
    "orderAmount": 5,
    "serviceCharge": 0,
    "status": "SUCCESS",
    "remarks": "MPS 25471xxxxx4 QJ50A5ZZMI xxxxxx DONK/974361"
  },
  "bank": {
    "reference": " S8550312",
    "transactionType": "Credit",
    "account": "01xxxxxxxxxxx"
  }
}

Field Name	Description	Type
callbackType	The type of callback. In this case ALT	String
customer.name	The customer name	String
customer.mobileNumber	Customer mobile number	String
customer.reference	Customer reference	String
transaction.date	The transaction date	String
transaction.reference	Transaction reference	String
transaction.paymentMode	Transaction payment mode	String
transaction.amount	Transaction amount	Number
transaction.billNumber	Transaction bill number. This is the account number.	String
transaction.servedBy		String
transaction.additionalInfo	Any additional info for the transaction	String
transaction.orderAmount	Transaction order amount	Number
transaction.serviceCharge	Transaction service charge	Number
transaction.status	Transaction status	String
transaction.remarks	Transaction remarks	String
bank.reference	The bank system reference id	String
bank.transactionType	Bank transaction type	String
bank.account	Bank account	String

Error Responses

400 Bad Request

Missing or invalid parameters in the request body.

{
  "status": false,
  "code": 400,
  "message": "Invalid request parameters",
  "error_code": "INVALID_REQUEST"
}

401 Unauthorized

Invalid or expired access token.

{
  "status": false,
  "code": 401,
  "message": "Invalid or expired access token",
  "error_code": "UNAUTHORIZED"
}

404 Not Found

Account not found or invalid account number.

{
  "status": false,
  "code": 404,
  "message": "Source or destination account not found",
  "error_code": "ACCOUNT_NOT_FOUND"
}

Transaction Status Errors

Response Status	Response Code	Response Message
false	111102	Transaction with the passed reference cannot be found

Support

For questions or issues with this API:

Email: support@finserve.africa

Account Inquiry - All Accounts Within Equity Bank