Search Account
Last updated
Last updated
Get all customer account information using the search account endpoint. The customer's accountNumber is required for this request and must be passed as a query request.
PUT /api/account/v1/api/account/v1/SearchAccount
Headers
| Name | Value |
|---|---|
Query Parameter
| Name | Data Type (length) | Required | Description |
|---|---|---|---|
Content-Type*
application/json
Authorization*
Bearer <token>
Request-Reference
{unique-reference}
accountNumber
string
Customer's account number
customerID
string
The identifier of an existing customer (Individual, group or corporate). This is not the customer Guid
accountName
string
The customer's account name
referenceNumber
string
Reference number for the account.
accountType
integer
Type of account. The enumerations are:
1 = Saving (Default),
2 = Current
accountStatus
integer
Status of the account. The enumerations are:
1 = Active (Default),
2 = Dormant,
3 = Closed,
4 = PND (Post No Debit),
5 = PNC (Post No Credit),
6 = Inactive,
7 = Frozen
branchCode
string
The customer's bank account branch code.
productCode
string
The customer's savings/current account product code.
accountOfficerStaffID
string
Account officer's staff ID.
accountTierLevel
integer
Account tier level. The enumerations are:
1 = Tier 1 (default),
2 = Tier 2,
3 = Tier 3
accessLevel
integer
The customer's access level enables restriction of balance and transaction amounts when viewed by users with lower access levels on the CBA portal.
Access levels range from 1 to 5
enableEmailNotification
boolean
This enable the system to send email notifications to customers
enableSMSNotification
boolean
This enable the system to send SMS notifications to customers
statementDeliveryMode
integer
Mode of statement delivery (e.g., 1 for email) The enumerations are:
1 = Handpicked,
2 = Email,
3 = Postage
statementDeliveryFrequenc
integer
Frequency of statement delivery (e.g., 1 for monthly) The enumerations are:
1 = Weekly
2 = Monthly
minimumBalanceRequired
integer
Minimum balance required for the account
applicableFee
integer
Customer's applicable fee
applicableInterest
integer
Customer's applicable fee interest
accountCreationChannel
string
The customer's account creation channel
The enumerations are:
1 = Web,
2 = OpenAPI,
3 = InternetBanking
PageNumber
Integer
Page number for pagination purposes
PageSize
Integer
Number of items per page for pagination
SortColumn
string
Column by which you want to sort the results: (e.g., accountName, accountType, accesslevel)
Direction
string
Sort the query result direction in the following order:
- ascending
- descending