API Reference

Large Domestic Interbank Transfer

POST /trans/largeDomesticInterBankTransfer

<Use this endpoint to request for a large domestic interbank transfer>

Parameters

Parameters	Type	Description	Is Required
accountId	string	The ID of the account that is to make the transfer. Rules: The currency of the accountId and beneficiaryAccountCcy have to be the same. E.g both USD, both GBP etc. For now, the account can only be USD, KES, GBP, EUR accounts Or no matter what currency the beneficiaryAccountCcy is, the currency of accountId is KES. E.g, accountId is KES, beneficiaryAccountCcy can be USD/GBP/EUR/TZS/UGX/RWF.	TRUE
beneficiaryBankCode	string	The bank code of the receiving bank Use /staticData/getBankCodes endpoint to get the list of bank codes	TRUE
beneficiaryBankName	string	The name of the receiving bank	TRUE
beneficiaryBranchCode	string	The branch code of the receiving bank	FALSE
beneficiaryAccountId	string	The number of the receiving account	TRUE
beneficiaryAccountCcy	string	The currency of the receiving account Allow it to be the following currencies: KES/USD/GBP/EUR/TZS/UGX/RWF	TRUE
beneficiaryName	string	Beneficiary name	TRUE
beneficiaryEmail	string	The email address of the beneficiary	FALSE
amount	decimal	Transfer amount	TRUE
amountType	Int	0 - In Debit Account Currency 1 - In Credit Account Currency	TRUE
messageToBeneficiary	string	The message to beneficiary. Not more than 100 characters.	FALSE
paymentChannel	string	EFT RTGS	TRUE
paymentPurposeId	string	Please refer to Payment Purpose	TRUE
paymentPurpose	string	When paymentPurposeId == OTHR, specify the payment payment in this parameter. Not more than 35 characters.	FALSE
senderAddress	string	Sender's address	TRUE
supportDocument	string	Base 64 string	FALSE
supportDocumentType	string	PDF Image	FALSE

Response

00000

{
  "applicationId": ""
}

Get Interbank Transfer list

POST /trans/getInterBankTransferList

<Use this endpoint to get the list of large volume interbank transfers>

Parameters

Parameters	Type	Description	Is Required
clientId	String	Client ID	TRUE
accountId	string	Account number	TRUE
startTime	long	Start time	TRUE
endTime	long	End time	TRUE
pageNo	int	Page number	TRUE
pageSize	int	Page size	TRUE

Response

00000

{
  "result": [
    {
      "applicationId": "",
      "accountId": "",
      "type": "", //1-Domestic Fund Transfer; 2-Cross-border Fund Transfer
      "currency": "",
      "amount": "",
      "createTime": "",
      "status": "",
    }
  ]
}

Query Interbank Transfer Details

POST /trans/getInterBankTransferDetails

<Use this endpoint to get the large volume interbank transfer details>

Parameters

Parameters	Type	Description	Is Required
applicationId	string	Application ID	TRUE

Response

00000

{
  "applicationId": "",
  "type": "", //1-Domestic Fund Transfer; 2-Cross-border Fund Transfer
  "debitAccountId": "",
  "beneficiaryBankName": "",
  "beneficiaryBankCode": "",
  "beneficiaryBranchCode": "",
  "beneficiaryBankAddress": "",
  "country": "",
  "city": "",
  "address": "",
  "beneficiaryName": "",
  "beneficiaryEmail": "",
  "beneficiaryAccountId": "",
  "beneficiaryAccountCurr": "",
  "requestAmtType": "",//Query Interbank transfer details0-In debit account currency; 1-in beneficiary account currency
  "requestAmt": "",//requested transfer amount in the selected requestAmtType
  "transferAmt": "",//Actual transfer amount in debit account currency
  "bankCharge": "",
  "debitAmt": "",
  "chargeType": "",
  "paymentChannel": "",
  "paymentPurpose": "",
  "messageToBeneficiary": "",
  "supportDocument": ""
  "referenceNumber": "",
  "createTime": "",
  "updateTime": "",
  "status": "",
}