Get accounts by customer

get

https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/{customerId}/accounts

Get details of accounts belonging to a particular customer using the customer’s ID as a reference

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

ID of customer to fetch accounts for

Query Params

customerStatuses

array of strings

customerStatuses

Allowed:

statuses

array of strings

statuses

Allowed:

minBalance

number

≥ 0

Accounts with balance equal or more than this amount

maxBalance

number

≥ 0.01

Accounts with balance equal or less than this amount

fromCreatedDate

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

toCreatedDate

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

page

int32

Page to fetch (0 indexed)

size

int32

≤ 500

Size of Page to fetch

sortField

string

Sort by field

sortOrder

string

Sorting order

currency

string

enum

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

showAvailableBalance

boolean

Show available balance

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200OK

400Bad Request