Retrieve statement entries as JSON

GET

/api/v1/banking/statements

const url = 'https://core.example.com/api/v1/banking/statements?statement%5Btimezone%5D=UTC';
const options = {method: 'GET', headers: {'session-token': '<session-token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://core.example.com/api/v1/banking/statements?statement%5Btimezone%5D=UTC' \
  --header 'session-token: <session-token>'

Authorizations

SessionToken

Parameters

Query Parameters

segregated_account_id

integer

ID of a business account accessible to the current user

statement[bank_account_id]

integer

statement[statement_range]

string format: date

statement[statement_range_to]

string format: date

statement[timezone]

string

default: UTC

Responses

200

Statement data

application/json

object

success

required

boolean

status

required

integer

Example

{
  "success": true,
  "status": 200
}

403

Authorization, validation, or business-rule error

application/json

object

success

required

boolean

status

required

integer

errors

required

One of:

Array<object>

object

code

string

kind

string

nullable

expiration

string

nullable

session

string

nullable

key

additional properties

any

key

additional properties

any

Example

{
  "success": false,
  "status": 403
}