Multigate

Get Accounts By

GET

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

Account

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

accounts

array[object (AccountOutput) {7}]

required

entityId

string

optional

Account id

currencyIso3Code

string

optional

Account currency

accountName

string

optional

Account name

fundingDetails

array [object {5}]

optional

Account funding details (SSIs)

status

enum<string>

optional

Account status

Allowed values:

processingactivedisconnecteddisabledfailed

availableBalance

number

optional

Available balance

accountType

enum<string>

optional

Account type

Allowed values:

multigatelinked

Example

{
  "message": "account(s) successfully retrieved",
  "accounts": [
    {
      "entityId": "8nlhb1PyH1M5IdvcNOvab9",
      "currencyIso3Code": "NGN",
      "accountName": "ABC Limited NGN Acct",
      "status": "active",
      "accountType": "multigate",
      "fundingDetails": [
        {
          "bankOrSortCode": "test-bank",
          "accountNumber": "1238286123",
          "bankCountry": null,
          "bankName": "Paystack Titan",
          "bankAddress": null
        }
      ]
    }
  ]
}

🟠400Bad Request

🟠401Unauthorized

Get Account

Get All Accounts