Get Accounts By

GET

/client-service/api/v1/accounts/by

Retrieve accounts by accountNumber or, if no accountNumber is available, the account entityId.

Request

Query Params

accountNumber

string

optional

Account number

Example:

1238286123

entityId

string

optional

Account entityId

Example:

8nlhb1PyH1M5IdvcNOab9

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

success response

Body

message

string

required

account

object (AccountOutput)

required

AccountOutput type

entityId

string

required

Account id

currencyIso3Code

string

required

Account currency

accountName

string

required

Account name

fundingDetails

array [object {6}]

required

Account funding details (SSIs)

status

enum<string>

required

Account status

Allowed values:

processingactivedisconnecteddisabledfailed

availableBalance

number

required

Available balance

accountType

enum<string>

optional

Account type

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

Get Account

Get All Accounts