Get Account Statements

curl --request GET \
  --url https://api.yapily.com/accounts/{accountId}/statements \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'consent: <consent>'

{
  "meta": {
    "tracingId": "fd5c215acd034401a8eaa8aeec1eafc7",
    "count": 1,
    "pagination": {
      "totalCount": 1,
      "self": {
        "limit": 1000,
        "sort": "-date",
        "offset": 0
      }
    }
  },
  "data": [
    {
      "id": "700014000000000000000002",
      "startDateTime": "2017-08-01T00:00:00Z",
      "endDateTime": "2017-08-31T23:59:59Z",
      "creationDateTime": "2017-09-01T00:00:00Z"
    }
  ],
  "links": {
    "self": "https://api.yapily.com/accounts/700004000000000000000002/statements?from&before&limit=1000&sort=-date&offset=0"
  }
}

curl --request GET \
  --url https://api.yapily.com/accounts/{accountId}/statements \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'consent: <consent>'

{
  "meta": {
    "tracingId": "fd5c215acd034401a8eaa8aeec1eafc7",
    "count": 1,
    "pagination": {
      "totalCount": 1,
      "self": {
        "limit": 1000,
        "sort": "-date",
        "offset": 0
      }
    }
  },
  "data": [
    {
      "id": "700014000000000000000002",
      "startDateTime": "2017-08-01T00:00:00Z",
      "endDateTime": "2017-08-31T23:59:59Z",
      "creationDateTime": "2017-09-01T00:00:00Z"
    }
  ],
  "links": {
    "self": "https://api.yapily.com/accounts/700004000000000000000002/statements?from&before&limit=1000&sort=-date&offset=0"
  }
}

Learn more: Financial Data Features for statement availability

Authorizations

Authorization

string

header

required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

Mandatory. The consent-token containing the user's authorisation to make the request.

sub-application

string<uuid>

The sub-application ID to which event type is being subscribed to

Path Parameters

accountId

string

required

Mandatory. The account Id of the user's bank account.

Query Parameters

from

string

Optional. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

before

string

Optional. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

limit

integer<int32>

Optional. The maximum number of transaction records to be returned. Must be between 1 and 1000.

sort

enum<string>

Optional. Sort transaction records by date ascending with 'date' or descending with '-date'. The default sort order is descending The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.

Available options:

date,

-date

offset

integer<int32>

Optional. The number of transaction records to be skipped. Used primarily with paginated results.

Getting Started

Authorisations

Financial Data

Payments

Consents

Institutions

Users

Notifications

Variable Recurring Payments

Data Plus

Hosted Consent Pages

Hosted Payment Pages

Constraints

Application Management

Webhooks

Application Beneficiaries

User Beneficiaries

Get Account Statements

Authorizations

Headers

Path Parameters

Query Parameters

Response