Other Functions

Apply for 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

POST /trans/queryTxReversal

<This endpoint allows end users query and fetch the reversal request details>

Parameters

Parameters	Type	Description	Is 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": ""
}

Fetch Transaction Fee

POST /trans/txReversal

<This endpoint allows end users to know the transaction fee before they make the transfer>

Parameters

Parameters	Type	Description	Is Required
payType	string	0-Paybill 1-Till/BuyGoods	FALSE
payerAccountId	string	Debit account number	TRUE
benificiaryName	string	Beneficiary name	TRUE
benificiaryType	string	0-Individual 1-Business	TRUE
benificiaryAccount	string	Beneficiary account number/shortcode	TRUE
benificiarySubAccount	string	Beneficiary paybill's sub-account number	FALSE
benificiaryBankCode	string	The bank code of the receiving bank Use /staticData/getBankCodes endpoint to get the list of bank codes	TRUE
amount	string	Transfer amount	TRUE

Response

00000

{
  "feeAmount": ""
}

Validate Account

POST /account/validateAccount

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

Parameters

Parameters	Type	Description	Is Required
accountId	string	The number/shortcode of the account that the end user is about to make transfer to.	TRUE
accountType	int	The type of the counterparty account 0-Choice Account 1-M-PESA Paybill 2-M-PESA Till/BuyGoods	TRUE

Response

00000

{
  "accountId": "",
  "accountName": "",
  "accountType": "",
  "freezeStatus": "", //The freezeStatus of Choice account will be returned
  "restrictStatus": "", //The restrictStatus of Choice account will be returned
}

Query BaaS Channel Closing Balance

POST /report/queryClosingBalance

<This endpoint allows BaaS partner to fetch all of account balances of the end users in its channel, on a certain date>

Parameters

Parameters	Type	Description	Is Required
queryDate	string	The UTC date that BaaS partner wants to query the closing balance on.	TRUE

Response

00000

{
  "jobId": "",
}

Result

Please refer to 0015-File Job Notification