Use this collection to retrieve a paginated list of transactions. The transactions are returned sorted by account and then posted date descending order - with pending transactions appearing first. Transactions are paginated in chunks of 500. Absence of next link means that there are no more pages to retrieve.

Arguments

limit
string, optional

This represents the maximum number of items that may be included in the response (maximum of 500). Note that by default 500 items are returned if this value is not specified.

filter
string, optional

This list can be filtered by the following properties:

  • account.id

  • transaction.postDate

  • connection.id

  • transaction.status

  • institution.id

  • transaction.direction

  • transaction.class

Returns

Returns a paginated list with a data property that contains an array of transactions. Each entry in the array is a separate object. If no data is returned, the resulting array will be empty. Otherwise, this call returns an error in the event of a failure.

GET /users/{user.id}/transactions
GET /users/ea3a81/transactions HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
HTTP/1.1 200 OK
Content-Type: application/json

{
  "type": "list",
  "count": 1,
  "size": 432,
  "data": [
    {
      "type": "transaction",
      "id": "fx789e",
      "status": "posted",
      "description": "FLIGHT CENTRE CO    BRISB    QL",
      "postDate": "2017-11-10T21:46:44Z",
      "transactionDate": "2017-11-09T00:00:00Z",
      "amount": "-139.98",
      "balance": "356.50",
      "account": "s55bf3",
      "institution": "AU00101",
      "connection": "8fce3b",
      "direction": "debit",
      "class": "payment",
      "subClass": {
        "code": "722",
        "title": "Travel Agency and Tour Arrangement Services"
      },
      "links": {
        "self": "https://au-api.basiq.io/users/ea3a81/transactions/fx789e",
        "account": "https://au-api.basiq.io/users/ea3a81/accounts/s55bf3",
        "institution": "https://au-api.basiq.io/institutions/AU00101",
        "connection": null
      }
    }
  ],
  "links": {
    "self": "https://au-api.basiq.io/users/ea3a81/transactions",
    "next": "https://au-api.basiq.io/users/ea3a81/transactions?next=049fde"
  }
}