API Reference
DashboardFAQSystem Status

Get the standing orders for a specific account given an accountId. The accountId can be found by making a call to the /accounts endpoint.

Path Params
string
required
Query Params
boolean
Defaults to false

When true the API will only return a results_id which can be fetched from the /results endpoint when ready.

int32
Defaults to 0

The page you're requesting - returns page 0 of a response if not specified.

int32
≤ 100
Defaults to 50

The number of objects you want to return as a page size.

string
required

The entity_id you're querying for.

string

Additional data you would like to store against the request. Example: {"foo": "val"}

boolean
Defaults to false

Ignore Lean's caching and force a call to the bank. This may have unwanted performance issues.

boolean
Defaults to false

Shows regional_data values in responses when true. Defaults to false.

Headers
string

IP Address of the customer. Required to indicate that the user is currently on-session. When this value isn't supplied the request is treated as a background refresh. Banks may place limits on the number of background refreshes can be performed over 24 hours.

Response

Response body
object
object
string

The endpoint the original request was made to

object
array of objects
standing_orders
object
string
required
string
required

Unique identifier for a standing order

string

ACTIVE INACTIVE

date-time
required
date-time
date-time
date-time
required
object
int32
required
string
object
required
object
object
object
required
object
object
object

Region specific data response. Only provided when verbose=true in the originating request.

string

The status of the request.

OK FAILED PENDING CONSENT_EXPIRED

string

The ID for this result, this is used when retrieving results from the /results endpoint.

string

Further explanation of the response

date-time

The timestamp of when the response was retrieved

string
object

Further detail on the error if status=FAILED

string

Detailed error code

string

Further detail on the encountered error

Headers
object
Language
Credentials
URL