API Reference
DashboardFAQSystem Status

Get the transactions 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

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

date

The start date in UTC (in the format YYYY-MM-DD) you want to query transactions for.

date

The end date in UTC (in the format YYYY-MM-DD) you want to query transactions for.

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
string
required

The status of the request.

OK PENDING FAILED CONSENT_EXPIRED

object
required
array of objects
required
transactions*
object
string
required

Unique identifier for the account where the transaction is credited/debited from

string
required

Unique identifier for a transaction

string
required
string
required

CREDIT DEBIT UNSUPPORTED

object
required
string
required

Whether this transaction can be considered in a final state or may change in future fetches of transaction data.

MUTABLE IMMUTABLE UNSUPPORTED

string
required

The UTC datetime the transaction was executed. Note that in the case the bank only provides the date with no time, we assume the transaction ocurred at 00:00 in the local timezone and then convert to UTC.

object
required
string
required

Status of the transaction

BOOKED PENDING REJECTED UNSUPPORTED

integer
required

Indicates the order of the transactions. For each date, the first transaction will have an index of 0.

object
required

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

object
required
string
required

The endpoint the original request was made to

string
required
string
required
string
required
Headers
object
Language
Credentials
URL