Merchant

Request for Merchant Bulk Transfer

POST /trans/batchTransitionalFundsDisbursement

<Use this endpoint to request for bulk transfer>

Parameters

Parameters
Type
Description
Is Required

payerAccountId

string

The ID of the account that is to make the transfer

TRUE

orgBatchId

string

The unique request ID generated by BaaS partner for this bulk transfer.

TRUE

beneficiaryArray

array

Bulk payment details

TRUE

>>payeeAccountName

string

The name of the beneficiary

TRUE

>>payeeAccountId

string

Beneficiary account number / shortcode

TRUE

>>payeeType

string

0 - Individual

1 - Business

TRUE

>>currency

string

Transfer currency

TRUE

>>amount

decimal

Transfer amount

TRUE

>>remark

string

The message to beneficiary

FALSE

>>payType

string

If it's an MPESA B2B transfer, the payType needs to be specified.

0 - Paybill

1 - Till/BuyGoods

FALSE

>>payeeSubAccount

string

The beneficiary reference accout number, this is for cases when the receiving counterparty is a Paybill.

FALSE

>>payeeMobileForNotification

string

Specify beneficiary's mobile number here and the bank will send SMS notification to inform him/her about the inbound.

FALSE

>>payeeBankCode

string

The bank code of the counterparty, please refer to Get Enumerations

TRUE

>>orgTxId

string

The unique ID string generated by BaaS partner to identify this each single transfer

TRUE

Response

{
  "orderId": ""
}

Result

Please refer to 0004 - Merchant Bulk Fund Transfer Result Notification

Query Merchant Bulk Transfer Details

POST /trans/getInternalBatchTransactionResult

<Use this endpoint to query merchant account details>

Parameters

Parameters
Type
Description
Is Required

orderId

string

The orderId returned by Choice

FALSE

orgBatchId

string

The orgBatchId generated by BaaS Parnter.

Either orderId or orgBatchId is mandatory.

FALSE

Response

{
  "orderId": "",
  "orgBatchId": "",
  "resultArray": [
    {
      "payeeAccountId": "",
      "payeeAccountName": "",
      "payerAccountId": "",
      "payerAccountName": "",
      "payeeBankCode": "",
      "orgTxId": "",
      "externalTxId": "",
      "payeeSubAccount": "",
      "paymentChannel": "",
      "payeeType": "",
      "currency": "",
      "amount": "",
      "txId": "",
      "txStatus": "",
      "failedReason": "",
      "completedTime": "",
    }, {}
  ]
}

Query Merchant Account Details

POST /query/getMerchantAccountDetails

<Use this endpoint to query merchant account details>

Parameters

Parameters
Type
Description
Is Required

accountId

string

Merchant account number

TRUE

Response

{
  "accountId": "",
  "accountName": "",
  "customerId": "",
  "currency": "",
  "accountType": "",
  "shortCode": "",
  "createTime": "",
  "balance": "", //available balance
  "frozenBalance": "",
  "dormantStatus": "", //0-Normal; 1-Dormant
  "abnormalStatus": "",//0-Normal; 1-Dormant; 2-Restricted; 3-Frozen
  "restrictStatus": "",//0-Normal; 1-Restrict In; 2-Restrict Out
  "freezeStatus": "", //0-Normal; 1-Frozen;
}

Last updated