Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Accounts

Get accounts using filter

Gives the ability to find accounts and get their details using filters

get/accounts

Query parameters

idstring[]

ID of Customer(s) to fetch

qstring

ID or name of the account to search for

ID or name of the account to search for

identifierType'SCAN' | 'IBAN' | 'DD' | 'INTL'

Accounts that contain this identifier type

Example:SCAN

Accounts that contain this identifier type

name.type'WORD_MATCH' | 'WORD_MATCH_ALPHANUMERIC' | 'PREFIX' | 'SUFFIX' | 'CONTAINS' | 'EXACT'

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

name.valuestring
externalReference.type'WORD_MATCH' | 'WORD_MATCH_ALPHANUMERIC' | 'PREFIX' | 'SUFFIX' | 'CONTAINS' | 'EXACT'

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

externalReference.valuestring
customerIdstring[]

The customer ID for getting account by customer ID

The customer ID for getting account by customer ID

[
  "C1234567"
]
accountNumber.type'WORD_MATCH' | 'WORD_MATCH_ALPHANUMERIC' | 'PREFIX' | 'SUFFIX' | 'CONTAINS' | 'EXACT'

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

accountNumber.valuestring
iban.type'WORD_MATCH' | 'WORD_MATCH_ALPHANUMERIC' | 'PREFIX' | 'SUFFIX' | 'CONTAINS' | 'EXACT'

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

WORD_MATCH - using word boundaries, WORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match, PREFIX - same case prefix, SUFFIX - same case suffix, CONTAINS - same case contains EXACT - same case exact

iban.valuestring
statusesstring[]
minBalancenumber

Accounts with balance equal or more than this amount

Accounts with balance equal or more than this amount

maxBalancenumber

Accounts with balance equal or less than this amount

Accounts with balance equal or less than this amount

fromCreatedDatestring

Accounts created after and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

Example:2017-01-28T01:01:01+0000

Accounts created after and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

toCreatedDatestring

Accounts created before and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

Example:2017-01-28T01:01:01+0000

Accounts created before and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

pageinteger

Page to fetch (0 indexed)

Page to fetch (0 indexed)

sizeinteger

Size of Page to fetch

Size of Page to fetch

sortFieldstring

Sort by field

Sort by field

sortOrderstring

Sorting order

Sorting order

currency'GBP' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'SHP' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'

The currency for getting account by currency. Expected ISO Standard currency name i.e. GBP, EUR etc

Example:GBP

The currency for getting account by currency. Expected ISO Standard currency name i.e. GBP, EUR etc

showAvailableBalanceboolean

Show available balance

Show available balance

Response

OK

sizeinteger

Page size

totalSizeinteger

Total count

pageinteger

Current page number, 0 based; i.e first-page = 0, second-page = 1

totalPagesinteger

Total pages

Example response

{
  "content": [
    {
      "id": "A0000001",
      "balance": "10000.00",
      "availableBalance": "10000.00",
      "currency": "GBP",
      "status": "ACTIVE",
      "identifiers": [
        {
          "accountNumber": "12345678",
          "sortCode": "000000",
          "iban": "GB20MODR04001401100000",
          "bic": "MODRGB21",
          "currency": "GBP",
          "countrySpecificDetails": {
            "bankName": "Apple Bank",
            "bankAddress": "2100 Broadway",
            "bankCity": "New York City",
            "bankBranchName": "New York",
            "bankBranchCode": "44-04",
            "chineseId": "01101201901018889",
            "province": "Zhejiang",
            "business": true,
            "bankCodeType": "ABA",
            "bankCountry": "US",
            "abaRoutingNumber": "123456789"
          },
          "productId": "O2100001"
        }
      ],
      "customerId": "C0000001",
      "externalReference": "aReference_00001",
      "createdDate": "2017-01-28T01:01:01+0000"
    }
  ]
}