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: benificiaryName benificiaryType payType benificiaryAccount benificiarySubAccount benificiaryBankCode amount remark payeeMobileForNotification	TRUE
benificiaryName	string	Name of the beneficiary	TRUE
benificiaryType	string	0 - Individual 1 - Business	TRUE
payType	string	0 - Paybill 1 - Till/BuyGoods Optional unless Mpesa B2B	FALSE
benificiaryAccount	string	Beneficiary account number / shortcode	TRUE
benificiarySubAccount	string	SubAccount of the beneficiary if the counterparty is a paybill	FALSE
benificiaryBankCode	string	Beneficiary bank code (See Get Enumerations)	TRUE
amount	decimal	Transfer amount	TRUE
paymentPurpose	string	Purpose of bank transfer (Use Pesalink Codes)	FALSE
remark	string	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

{
  "bulkPaymentOrderId": "" //Bulk payment order id
}

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": "", //total number of records of the query
  "resultArray": [
    {
      "txId": "",
      "payerAccount": "",
      "payerAccountName": "",
      "benificiaryAccount": "",
      "benificiaryName": "",
      "benificiarySubAccount": "",
      "benificiaryBankCode": "",
      "paymentChannel": "",
      "currency": "",
      "amount": "",
      "feeAmount": "",
      "externalTxId": "",
      "errorCode": "",
      "errorMsg": ""
    }
  ]
}