Other Functions
Query Account Details
POST /query/getAccountDetails
<This endpoint allows you to query a certain account's details>
Parameters
accountId
string
The number of the account that you want to query the details of.
TRUE
Response
{
"accountId": "",
"accountName": "",
"currency": "",
"accountType": "",
"shortCode": "",
"createTime": "",
"balance": "",
"dormantStatus": "", //0-Normal; 1-Dormant
"freezeStatus": "", //0-Normal; 1-Frozen
}Get All Accounts of a Client
POST /account/queryAccountListByUserId
<This endpoint allows you to get all accounts of a certain client>
Parameters
userId
string
The unique string to identify the user in the BaaS partner system.
TRUE
Response
{
"accounts": [
{
"accountId": "",
"accountName": "",
"currency": "",
"accountType": "",
//C001-Current Account
//C002-Wallet Account
//C004-Loan Account
//C006-Fixed Deposit Account
//B001-SME Account
//B005-Business Loan Account
//B006-Business Fixed Deposit Account
"dormantStatus": "", //0-Normal; 1-Dormant;
"freezeStatus": "", //0-Normal; 1-Frozen;
}
]
}Get Abnormal Account List
POST /query/getAbnormalAccountList
<This endpoint allows you to get all abnormal accounts in BaaS partner's channel>
Parameters
pageNo
int
Page number
TRUE
pageSize
int
Page size
TRUE
Response
{
"total": "",
"resultArray": [
{
"userId": "",
"accountId": "",
"accountType": "",
"status": [
{1},
{2},
//Abnormal status; 1-Dormant; 2-Restricted; 3-Frozen
]
}
]
}Apply for Short Code
POST /account/applyForShortCode
<This endpoint allows end users to apply for a shortcode for its account>
Parameters
accountId
string
The number of the account that the end user wants to apply for shortcode for.
TRUE
Response
{
"accountId": "",
"shortCode": "", //generated shortcode
}Query Shortcode By AccountId
POST /account/queryForShortCode
<This endpoint allows you to query shortcode using account number>
Parameters
accountId
string
The number of the account that the end user wants to query its short code.
TRUE
Response
{
"accountId": "",
"shortCode": "",
}Query AccountId By Shortcode
POST /account/queryAccountByShortCode
<This endpoint allows you to query accountId by shortcode>
Parameters
shortCode
string
The shortcode of the account that the end user wants to query its account number.
TRUE
Response
{
"accountId": "",
"shortCode": "",
}Activate Dormant Account
POST /account/activateAccount
<This endpoint allows you to activate dormant account (account inactive above 6 months)>
Parameters
accountId
string
The number of the dormant account that the user wants to activate.
TRUE
Response
{
"accountId": "",
"shortCode": "",
}Apply for Account Statement
POST /statement/applyAccountStatement
<This endpoint allows end users to apply for account statement>
Parameters
accountId
string
The number of the account
TRUE
startTime
long
start time of the statement
TRUE
endTime
long
end time of the statement
TRUE
fileType
string
pdf or xlsx
FALSE
Response
{
"jobId": "",
}Query Account Statement Job Status
POST /statement/queryAccountStatement
<This endpoint allows end users to query account statement job status>
Parameters
jobId
string
Account Statement job Id
TRUE
Response
{
"jobId": "",
"status": "", //0-Not Completed; 1-Completed
"statementUrl": "",
}Add Email
POST /user/addOrUpdateEmail
<This endpoint allows end users to add Email information if they didn't fill in Email when they were onboarding, or update Email information if it's changed>
Parameters
onboardType
string
personal
business
TRUE
personalIdType
string
This parameter is only required when onboardType == personal
101 - (Kenya) National ID
102 - (Kenya) Alien ID
103 - Passport
FALSE
documentNumber
string
The ID number for personal customer, or the business certificate number
TRUE
email
string
Email address
TRUE
Response
{
"applicationId": "",
}Update Mobile
POST /account/v2/mobileChange
<This endpoint allows end users to update it mobile number>
Parameters
accountId
string
End user's account number
TRUE
newMobileCountryCode
string
New mobile number's country code. i.e. 254
TRUE
newMobileNumber
string
New mobile number
TRUE
Response
{
"applicationId": "",
}Verify Email or Mobile
POST /user/verifyEmailAddress
<This endpoint allows end users verify its Email or Mobile Number, only verified Email / Mobile can be used to receive OTP.>
Parameters
onboardType
string
personal
business
TRUE
personalIdType
string
This parameter is only required when onboardType == personal
101 - (Kenya) National ID
102 - (Kenya) Alien ID
103 - Passport
FALSE
documentNumber
string
The ID number for personal customer, or the business certificate number
TRUE
verifyType
string
MOBILE
TRUE
Response
{
"applicationId": "",
}Edit SME Sub-Account Name
POST /account/editSubAccountName
<This endpoint allows SME customers to edit its sub-account/virtual account's name>
Parameters
accountId
string
It has to be the number of the SME account
TRUE
subAccountName
string
By default, SME's sub-account/virtual account's name is the same as its Business Name. Choice allows users to edit its subAccountName, but the Business Name must be fully displayed. The final account name would be the conbination of business name and the added sub-account name. E.g Business Name is Choice Microfinance Bank, the added sub-account name is ABC Company. Then the final account name is Choice Microfinance Bank_ABC Company. If subAccountName is empty in a request call, the Account Name will be returned back to be the same as Business Name.
FALSE
Response
{
"applicationId": "",
}Last updated