API Reference

Request for Bulk Transfer

POST /trans/v2/generalBulkTransfer

<Use this endpoint to request for bulk transfers>

Parameters

Parameters	Type	Description	Is Required
payerAccountId	string	The ID of the account that is to make the transfer	TRUE
txDetails	array	Bulk payment details	TRUE
>>benificiaryName	string	The name of the beneficiary	TRUE
>>benificiaryType	string	0 - Individual 1 - Business	TRUE
>>payType	string	If it's an MPESA B2B transfer, the payType needs to be specified. 0 - Paybill 1 - Till/BuyGoods	FALSE
>>benificiaryAccount	string	Beneficiary account number / shortcode	TRUE
>>benificiarySubAccount	string	The beneficiary reference accout number, this is for cases when the receiving counterparty is a Paybill.	FALSE
>>benificiaryBankCode	string	The bank code of the counterparty, please refer to Get Enumerations	TRUE
>>amount	decimal	Transfer amount	TRUE
>>remark	string	The message to beneficiary	FALSE
>>payeeMobileForNotification	string	Specify beneficiary's mobile number here and the bank will send SMS notification to inform him/her about the inbound.	FALSE

Response

00000

{
  "applicationId": ""
}

Query Bank Transfer Details

POST /trans/queryBatchTransactionResult

<Use this endpoint to query bulk transfer details>

Parameters

Parameters	Type	Description	Is Required
orderId	string	The bulk transfer order ID	TRUE
pageNo	int	Page number	TRUE
pageSize	int	Page size	TRUE

Response

00000

{
  "orderId": "",
  "total": "",
  "resultArray": [
    {
      "txId": "",
      "txType": "",
      "payerAccount": "",
      "payerAccountName": "",
      "benificiaryAccount": "",
      "benificiaryName": "",
      "benificiarySubAccount": "",
      "benificiaryBankCode": "",
      "paymentChannel": "",
      "currency": "",
      "amount": "",
      "feeAmount": "",
      "externalTxId": "",
      "txStatus": "",
      "errorCode": "",
      "errorMsg": "",
      "completedTime": ""
    }
  ]
}