Retrieve an account statement
You can get information about all transactions related to a managed accountManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr. by retrieving its statement. Transactions represent operations on an account and may involve fund movements.
Prerequisites
- An existing managed account
id. - An authenticated end-user token for a user that belongs to the account owner.
Retrieve a statement
- Response
{
"entry": [
{
"transactionId": {
"type": "AUTHORISATION",
"id": "string"
},
"entryState": "PENDING",
"originalAmount": {
"currency": "str",
"amount": 0
},
"forexRate": {
"value": 0,
"scale": -128
},
"transactionAmount": {
"currency": "str",
"amount": 0
},
"availableBalanceAdjustment": {
"currency": "str",
"amount": 0
},
"actualBalanceAdjustment": {
"currency": "str",
"amount": 0
},
"balanceAfter": {
"currency": "str",
"amount": 0
},
"availableBalanceAfter": {
"currency": "str",
"amount": 0
},
"actualBalanceAfter": {
"currency": "str",
"amount": 0
},
"transactionFee": {
"currency": "str",
"amount": 0
},
"cardholderFee": {
"currency": "str",
"amount": 0
},
"processedTimestamp": 0,
"sourceAmount": {
"currency": "str",
"amount": 0
},
"userCurrencyTransactionDetails": {
"userTransactionAmount": {
"currency": "str",
"amount": 0
},
"userExchangeRate": "string"
},
"additionalFields": {
"property1": "string",
"property2": "string"
}
}
],
"count": 0,
"responseCount": 0,
"startBalance": {
"currency": "str",
"amount": 0
},
"endBalance": {
"currency": "str",
"amount": 0
},
"footer": "string"
}
You can also download a copy of a managed accountManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr. statement in CSV format.
The statement endpoint returns entries for transactions of a given account where each entry represents balance movements taking place at the different stages of the transaction.
Entries can be in a PENDING or COMPLETED state. Entries in a PENDING state, represent balance movements which have already been completed, but also imply that further balance movements are expected as the transaction transitions into future stages.
Learn more about transaction states in the transactions guide.
Query parameters
The statement endpoint accepts the following query parameters. Combine them to page through results, narrow to a time range, or filter by transaction type.
| Parameter | Type | Default | Values | Notes |
|---|---|---|---|---|
offset | integer | 0 | 0 or greater | Zero-based offset for paging through results. |
statementLimit | integer | none | 1–500 | Page size, capped at 500. |
orderByTimestamp | string | DESC | ASC | DESC | DESC returns the most recent transactions first; ASC returns the oldest first. |
fromTimestamp | integer | none | Epoch milliseconds | Only return transactions with a timestamp at or after this value. |
toTimestamp | integer | none | Epoch milliseconds | Only return transactions with a timestamp at or before this value. Must be greater than fromTimestamp if both are provided. |
singleEntryPerTransaction | boolean | true for PDF statements, false otherwise | true | false | When true, multiMulti Weavr Multi is an embedded finance solution that allows you to integrate financial services into your own application, providing a seamless experience for your customers. It enables you to offer managed accounts, managed cards, and transactions without requiring financial expertise.-movement transactions are returned as a single entry, and only completed transactions are included. |
transactionType | array | all types | One or more TransactionType values (repeat the parameter for each value) | Filter by one or more transaction types. Omit to fetch all entries. |