Managed accounts

Get an account statement

Returns a statement for the managed account identified by the id path parameter.

A statement is a settled view of the account. It contains only posted transactions where funds have definitively moved and the account's actual balance changed; pending transactions and authorizations are excluded. Repeating a request for the same period returns the same result, which makes statements safe to reconcile against.

:::note For an unsettled view, including transactions that are committed but not yet executed, use List transactions or List account transactions instead. :::

Response formats

Set the accept header to application/json (the default) or text/csv. Anything else falls back to JSON. Use CSV for reconciliation and JSON to render the statement yourself.

:::note application/pdf on this endpoint is deprecated. For a document the customer downloads, use Download an account statement as a PDF, which renders in a timezone you choose and covers the whole period rather than a single page. The JSON and CSV responses aren't deprecated. :::

Choosing a period

startPeriod and endPeriod are epoch timestamps in milliseconds. Page with offset and limit; limit is capped at 500. sortOrder defaults to ASC, oldest first. Pass DESC for a most-recent-first view.

Filtering

Narrow the statement by transaction.type, and by the instrument that initiated each entry using executingAccessInstrument.id and executingAccessInstrument.type. Both accept multiple values.

Access

This operation requires a stepped-up access token. Step up before calling it by issuing a challenge through Step-up.

get/managed_accounts/{id}/statement

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/managed_accounts/{id}/statement
  • Auth: HTTP bearer and API key in header api-key

Path parameters

idstring required
Example:123456789

The unique identifier of the managed account.

Query parameters

offsetinteger

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger

The maximum number of statement entries to return. Limit is capped at 500.

startPeriodinteger

Start of the statement period. Epoch timestamp using millisecond precision.

endPeriodinteger

End of the statement period. Epoch timestamp using millisecond precision.

sortOrder'ASC' | 'DESC'

Sort order for the results:

  • ASC: Ascending order, oldest first (default for statements).
  • DESC: Descending order, most recent first.
transaction.typeStatementResponseEntryTransactionType[]

Filter statement entries by one or more transaction types.

executingAccessInstrument.idstring

Filter statement entries by the ID of the access instrument that initiated the transaction.

executingAccessInstrument.typeAccessInstrumentType[]

Filter statement entries by the type of access instrument that initiated the transaction (managed cards or IBANs).

Headers

accept'application/json' | 'text/csv' | 'application/pdf'
Example:application/json

A request parameter specifying the type of response the client would like. Must be one of application/json, application/pdf or text/csv.

The default response type (application/json) will be returned if specified incorrectly or not specified.

x-api-version'LATEST'

Opts the call in to the latest version of the endpoint. Set to LATEST to be routed to the newest implementation; omit to retain the default routing for your tenant.

Response

Success

countinteger

The total number of entries matching the filter criteria.

responseCountinteger

The number of entries returned in this response.

footerstring

Regulatory and card scheme footer text for the statement.

Example response

{
  "openingBalance": {
    "currency": "GBP",
    "amount": 1250
  },
  "closingBalance": {
    "currency": "GBP",
    "amount": 1250
  },
  "entries": [
    {
      "entryId": "123456789",
      "transaction": {
        "id": "123456789"
      },
      "description": "Invoice 1042",
      "timestamp": 1786118400000,
      "balanceAdjustment": {
        "currency": "GBP",
        "amount": 1250
      },
      "balanceAfter": {
        "currency": "GBP",
        "amount": 1250
      },
      "counterparty": {
        "name": "Coffee Corner",
        "id": "MID123456",
        "categoryCode": "5812",
        "country": "GB"
      },
      "fee": {
        "id": "123456789",
        "amount": {
          "currency": "GBP",
          "amount": 1250
        }
      },
      "forex": {
        "originalAmount": {
          "currency": "GBP",
          "amount": 1250
        },
        "exchangeRate": {
          "value": 1250,
          "scale": 2
        },
        "paddingAmount": {
          "currency": "GBP",
          "amount": 1250
        },
        "feeAmount": {
          "currency": "GBP",
          "amount": 1250
        }
      },
      "relatedEntryId": "987654321",
      "executingAccessInstrument": {
        "id": "123456789"
      }
    }
  ],
  "count": 42,
  "responseCount": 10,
  "footer": "Statement generated for information purposes only."
}

Changes

No recorded changes to this operation across all 1 revision of this API.