Get All Accounts - Multigate

Request

Query Params

pageSize

integer

optional

page size - int64

pageOffset

integer

optional

page offset- int64

sortField

string

optional

field to sort by - string

sortDirection

enum<string>

optional

Allowed values:

ASCDESC

sourceBankBicOrCode

string

optional

field to input sourceBankBicOrCode - string

sourceAccountNumber

string

optional

field to input sourceAccountNumber - string

sourceCurrencyIso3Code

string

optional

field to input sourceCurrencyIso3Code - string

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/accounts?pageSize&pageOffset&sortField&sortDirection&sourceBankBicOrCode&sourceAccountNumber&sourceCurrencyIso3Code'

Responses

🟢200OK

application/json

success response

Body

AccountOutputArray type

message

string

optional

the response message

count

number

optional

the data count

items

array[object (AccountOutput) {7}]

optional

the response data object

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": "string",
  "count": 1,
  "items": [
    {
      "entityId": "MeMjZgLaixUunSHLRqP9d",
      "currencyIso3Code": "NGN",
      "accountName": "ABC Limited",
      "fundingDetails": [
        {
          "bankOrSortCode": "100039",
          "accountNumber": "9832903324",
          "bankCountry": "NGA",
          "bankName": "Paystack Titan",
          "bankAddress": null
        }
      ],
      "status": "active",
      "availableBalance": 543754.76,
      "accountType": "multigate"
    }
  ]
}

🟠400Bad Request

🟠401Unauthorized