New Features

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

{
  "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

Validate Account (Hakikisha)

POST /account/validateAccount

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

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

(Mandatory if accountType is 4)

The bankCode should be obtained from the choice bankcode through calling /staticData/getBankCodes

Conditional

Response

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

Result

Please refer to 0015-File Job Notification

Last updated