Transactions

List transactions

Lists transactions on a bank account. Use an Accept: application/vnd.griffin+xero-csv header to receive transactions in a CSV format suitable for importing into Xero.

get/v0/bank/accounts/{bank-account-id}/transactions

Path parameters

bank-account-idstring required

Query parameters

sort'-created-at' | 'processed-at' | '-processed-at' | 'created-at'
page[size]integer
page[before]string byte

A base64 encoded opaque string returned in paginated responses.

page[after]string byte

A base64 encoded opaque string returned in paginated responses.

include'payment'

For each transaction returned, include its payment (if one exists) in the response under the included attribute.

filter[processed-at][lte]string date-time

Return only transactions processed at or before the given timestamp.

filter[processed-at][lt]string date-time

Return only transactions processed before the given timestamp.

filter[processed-at][gte]string date-time

Return only transactions processed at or after the given timestamp.

filter[processed-at][gt]string date-time

Return only transactions processed after the given timestamp.

Response

OK

{"stackTrail":"paths:/v0/bank/accounts/{bank-account-id}/transactions:get:responses:200:content:application/json:schema:properties:included","oasType":"schema","type":"unknown","title":"","description":"Present only when the request uses the `include` parameter."}

Example response

{
  "account-transactions": [
    {
      "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
      "reference": "Restaurant Charge - Sushi Palace",
      "balance-change": {
        "currency": "GBP",
        "value": "1000.00"
      },
      "account-balance": {
        "currency": "GBP",
        "value": "1000.00"
      },
      "description": "Interest earned in April from Alexa account."
    }
  ]
}