API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In

Get accounts using filter

get
https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts

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

Query Params
id
array of strings

ID of Customer(s) to fetch

id
string

ID or name of the account to search for

string
enum

Accounts that contain this identifier type

Allowed:
string
enum

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

Allowed:
string
length ≥ 1
string
enum

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

Allowed:
string
length ≥ 1
customerId
array of strings

The customer ID for getting account by customer ID

customerId
string
enum

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

Allowed:
string
length ≥ 1
string
enum

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

Allowed:
string
length ≥ 1
statuses
array of strings
statuses
number
≥ 0

Accounts with balance equal or more than this amount

number
≥ 0.01

Accounts with balance equal or less than this amount

string

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

string

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

int32

Page to fetch (0 indexed)

int32
≤ 500

Size of Page to fetch

string

Sort by field

string

Sorting order

string
enum

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

boolean

Show available balance

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 7 months ago