Get Accounts By
GET
/client-service/api/v1/accounts/by
Account
Request
Query Params
accountNumber
string
optional
Example:
1238286123
entityId
string
optional
Example:
8nlhb1PyH1M5IdvcNOab9
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/accounts/by?accountNumber=1238286123&entityId=8nlhb1PyH1M5IdvcNOab9'
Responses
🟢200OK
application/json
Body
message
string
required
account
object (AccountOutput)
required
entityId
string
required
currencyIso3Code
string
required
accountName
string
required
fundingDetails
array [object {6}]
required
status
enum<string>
required
Allowed values:
processingactivedisconnecteddisabledfailed
availableBalance
number
required
accountType
enum<string>
optional
Allowed values:
multigatelinked
Example
{
"message": "account(s) successfully retrieved",
"account": {
"entityId": "zqkLGh3pDQoXD4WBqttQH",
"currencyIso3Code": "NGN",
"accountName": "Lateef Reconfirmation Test Account",
"status": "active",
"availableBalance": 0,
"accountType": "multigate",
"fundingDetails": [
{
"bankOrSortCode": "test-bank",
"accountNumber": "1238286191",
"bankCountry": "NGA",
"bankName": "Paystack Titan",
"bankAddress": null,
"countryIso3Code": "NGA"
}
]
}
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-05-29 09:42:52