Get All Accounts - Multigate

Retrieve all accounts. Both linked and virtual accounts will be returned.

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

success response

Body

AccountOutputArray type

message

string

required

the response message

totalItems

number

required

the data count

pageSize

number

required

currentPage

number

required

totalPages

number

required

data

array[object (AccountOutput) {7}]

optional

the response data object

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",
    "data": [
        {
            "entityId": "tVJI2FPpe1zymSpxXB8eQ",
            "currencyIso3Code": "NGN",
            "accountName": "UAT Test NGN Account",
            "status": "active",
            "accountType": "multigate",
            "fundingDetails": [
                {
                    "bankOrSortCode": "multigate",
                    "accountNumber": "1238263316",
                    "bankCountry": "NGA",
                    "bankName": "FAZZ",
                    "bankAddress": null,
                    "countryIso3Code": "NGA"
                }
            ]
        },
        {
            "entityId": "R3Qu56ZgqSvdvpqElf8_m",
            "currencyIso3Code": "USD",
            "accountName": "UAT Test USD Account",
            "status": "failed",
            "accountType": "multigate",
            "fundingDetails": []
        },
        {
            "entityId": "e7XtK5Mu0KMwZ6wRJR4312",
            "currencyIso3Code": "NGN",
            "accountName": "WOW Test Linked NGN Acc 3",
            "status": "active",
            "accountType": "multigate",
            "fundingDetails": []
        },
        {
            "entityId": "ScBF1LUQNdi0VcHvouf4O",
            "currencyIso3Code": "SGD",
            "accountName": "UAT Test SGD Account",
            "status": "active",
            "accountType": "multigate",
            "fundingDetails": [
                {
                    "bankOrSortCode": "straitx",
                    "accountNumber": "3373124362307",
                    "bankName": "FAZZ",
                    "bankAddress": null,
                    "countryIso3Code": "NGA"
                }
            ]
        },
        {
            "entityId": "6P1-uE58fkOMDV74KuvFQ",
            "currencyIso3Code": "USD",
            "accountName": "Hwymdgj Vtrk Test USD Account",
            "status": "active",
            "accountType": "multigate",
            "fundingDetails": [
                {
                    "bankOrSortCode": "easyeuro",
                    "accountNumber": "5482056683",
                    "bankName": null,
                    "bankAddress": null,
                    "countryIso3Code": "NGA"
                },
                {
                    "bankOrSortCode": "pingpong",
                    "accountNumber": "4769302857",
                    "bankName": null,
                    "bankAddress": null,
                    "countryIso3Code": "NGA"
                }
            ]
        },
        {
            "entityId": "9nj14yqBkz1lOTjha3Fdl",
            "currencyIso3Code": "NGN",
            "accountName": "UAT Test NGN Account - Disregard",
            "status": "active",
            "accountType": "multigate",
            "fundingDetails": [
                {
                    "bankOrSortCode": "test-bank",
                    "accountNumber": "123826331611",
                    "bankCountry": "NGA",
                    "bankName": "Paystack Titan",
                    "bankAddress": null,
                    "countryIso3Code": "NGA"
                }
            ]
        },
        {
            "entityId": "yJM1EJDMI9K6b5IPN9QyZ",
            "currencyIso3Code": "USD",
            "accountName": "New Test USD Account NaN",
            "status": "failed",
            "accountType": "multigate",
            "fundingDetails": []
        },
        {
            "entityId": "nnFAp0A3Mtv7qnYVlo_wX",
            "currencyIso3Code": "USD",
            "accountName": "Another Test USD Account NaN",
            "status": "failed",
            "accountType": "multigate",
            "fundingDetails": []
        },
        {
            "entityId": "NxCGX_C9tza2v6zwZ2I6-",
            "currencyIso3Code": "USD",
            "accountName": "B Test USD Account NaN",
            "status": "processing",
            "accountType": "multigate",
            "fundingDetails": []
        },
        {
            "entityId": "vIOsk8cNRUNNmaAmkkiIL",
            "currencyIso3Code": "USD",
            "accountName": "C Test USD Account NaN",
            "status": "active",
            "accountType": "multigate",
            "fundingDetails": []
        }
    ],
    "totalItems": 105,
    "pageSize": 10,
    "currentPage": 1,
    "totalPages": 11
}

🟠400Bad Request

🟠401Unauthorized