New Features

Transaction Reversal

POST /trans/txReversal

This endpoint allows end users to request for a reversal for a transaction.

Parameters

Parameters	Type	Description	Is Required
transactionId	string	The unique string generated by BaaS platform to identify a transaction. It has to be in the last 1 month. The transaction completed over 1 month ago cannot be reversed.	TRUE
reversalReceiptNo	string	If the transaction has been reversed already from third party institutions (i.e. M-PESA), end users should fill in the receipt number of the reversal transaction (The new transaction created to counter-effect the original one)	FALSE
reversedTime	string	If the transaction has been reversed already from third party institutions (i.e. M-PESA), end users should fill in the reversed time of the new reversal transaction	FALSE
reversalReason	string	Reversal reason	FALSE
voucherBase64	string	Voucher document	FALSE
voucherType	string	pdf image	FALSE

Response

00000

{
  "applicationId": "",
}

Query Reversal Request Details

POST /trans/queryTxReversal

Use this endpoint to fetch reversal request details.

Parameters

Parameters	Type	Description	Required?
applicationId	string	The unique string generated by BaaS platform to identify the application	TRUE

Response

00000

{
  "applicationId": "",
  "transactionId": "",
  "reversalReceiptNo": "",
  "reversedTime": "",
  "reversalReason": "",
  "voucher": "",
  "status": "",
  "reversalTxId": ""
}

Validate Account (Hakikisha)

POST /account/validateAccount

<This endpoint allows end users to validate account's name before making the transfer.>

Parameters	Type	Description	Required?
accountId	string	The account/shortcode which the user wants to validate. This endpoint does return "freezeStatus" and "restrictStatus" as well.	TRUE
accountType	int	The type of the counterparty account: 0 - Choice Merchant 1 - M-PESA Paybill 2 - M-PESA Till 3 - Mpesa Mobile 4 - Pesalink Account Number	TRUE
bankCode	string	See full list by calling /staticData/getBankCodes Mandatory when accountType is 4	Conditional

Response

00000

"data": {
    "accountType": "", //int, account type
    "accountId": "", //String, account Id
    "accountName": "", //String, return the account name if it's a valid accountId
    "freezeStatus":"", //freezeStatus: 0-normal; 1-frozen
    "restrictStatus":"",//restrict status 0-normal; 1-restrict in; 2-restrict out
}

Pull Transaction IDs

POST /query/pullTransactionIds

This API is for BaaS partners to get all transaction IDs within a certain period of time so that they do not miss any inbound transactions when balance change notifications / callback is not received.

Allowed query data timespan: past 30 days Allowed query interval: 1 hour Maximum endTime to startTime span: 4 hours

Fields	Type	Description	Required?
startTime	Long	Unix timestamp of the start time	Mandatory
endTime	Long	Unix timestamp of the end time	Mandatory

Response

00000

{
  "transactionID": "00000" //returns list of transaction IDs
}

Query Channel Closing Balance

POST /report/queryClosingBalance

Use this endpoint to fetch the consolidated balance across all accounts under your BaaS channel on a certain date.

Parameters

Parameters	Type	Description	Is Required
queryDate	string	UTC date as at which the closing balance is being sought.	TRUE

Response

00000

{
  "jobId": "",
}

Result

Please refer to 0015-File Job Notification