List transaction activity
GET
/v2/activity/{accountId}Request
Use this request to get a list of transactions for a given account, based on itsid. Results are ordered chronologically by creation date, with the most recent transaction appearing first.
Sample request
Request structure
Path parameters
string
required
The ID of the account that you want to get a list of transactions for.Allowable values: An existing
accountIdQuery parameters
integer
The maximum amount of results to return. By default, this is set to
100.Allowable values: [ 1 .. 1000 ]integer
The amount of results to skip. By default, this is set to
0.Allowable values: A valid integerarray of strings
Optional additional information to return in the results.Allowable values:
bankFeedDetails, annotations, attachmentsarray of strings (uuid)
The ID of the person to filter results by. Use commas to pass multiple values. Has to be URL encoded.Example:
personId=34edaf73-49be-4669-83ee-1b1f8c680d29%2Ceee079a2-5453-4a69-8d5d-223db353f0f3array of strings
The
type to filter results by. Use commas to pass multiple values. Has to be URL encoded. For example, type=payment%2Cload. For more information about each type, see About transaction types.Allowable values: exchange, payment, deposit, forwardContract, drawdown, card, cardCheck, cardRefund, cashWithdrawal, atm, unload, otherDebit, load, cashback, chargeback, otherCredit, fee, batchPaymentarray of strings
The type to exclude in the transactions list. Use commas to pass multiple values. Has to be URL encoded.Allowable values:
exchange, payment, deposit, forwardContract, drawdown, card, cardCheck, cardRefund, cashWithdrawal, atm, unload, otherDebit, load, cashback, chargeback, otherCredit, fee, batchPaymentarray of strings
The
status to filter results by. Use commas to pass multiple values. Has to be URL encoded. For example, status=complete%2Ccancelled. For more information about each status, see About transaction statuses.Allowable values: needsApproval, fundsRequired, pending, complete, declined, reverted, refunded, cancelled, open, cardCheck, fundsSettledarray of strings (uuid) or null
The
budgetId to filter results by. Use commas to pass multiple values. Has to be URL encoded.Allowable values: An existing budgetId (≤ 36 characters)array of strings (uuid) or null
The
budgetName to filter results by. Use commas to pass multiple values. Has to be URL encoded. For example, budgetName=Account%2Cmarketing.Allowable values: An existing budgetName (≤ 36 characters)array of strings
Filters transactions that include selling these currencies. Use commas to pass multiple values. Has to be URL encoded. For example,
sellCurrency=usd%2Cgbp.Allowable values: 3 charactersarray of strings
Filters transactions that include purchasing these currencies. Use commas to pass multiple values. Has to be URL encoded. For example,
buyCurrency=usd%2Cgbp.Allowable values: 3 charactersstring (date)
The earliest date from which to retrieve results (includes transactions on this date). For example,
startDate=2021-02-15.Allowable values: Format: YYYY-MM-DDstring (date)
The latest date until which to retrieve results (includes transactions on this date). For example,
endDate=2021-03-30.Allowable values: Format: YYYY-MM-DDstring
default:"transaction.createdAt"
Selects which date field
startDate and endDate filter against. transaction.createdAt (the default) filters by the date the transaction was created; transactionBox.valueDateTime filters by the date the transaction was completed/settled. For example, dateField=transactionBox.valueDateTime.Note: under transactionBox.valueDateTime, transaction types that have no settlement date (currency purchases and orders) are excluded from the results.Allowable values: transaction.createdAt, transactionBox.valueDateTimestring
Filters results that include this string. For example,
search=Jane+Doe.Allowable values: A valid stringarray of strings
If
annotations is included in the include parameter, this will filter the transactions based on the status of the annotations. For example, annotationStatus=draft%2Csubmitted.Allowable values: draft, submitted, unannotatedarray of strings
If
attachments is included in the include parameter, this will filter the transactions based on whether transactions have attachments or not. For example, attachmentStatus=absent%2CpresentAllowable values: absent, present, lostResponse
If your request is successful, you’ll receive a200 response containing a list of transactions, ordered chronologically with the most recent transaction appearing first.
Annotations
When you passinclude=annotations, each transaction includes an annotationGroup describing the annotations applied to it (or null if it has none). An annotation group has a status (draft, submitted, approved, or exported) and contains one or more annotations — a transaction can be split across several, each with its own amount. Each annotation contains an array of annotationValues, one per annotation field that has been set.
Each annotationValue resolves the annotation field — and, for dropdown fields, the selected option — inline, so you don’t need to call the annotation-fields endpoints separately to map IDs to names and codes:
The value itself is held in a type-specific property, indicated by
annotationFieldType:
For any given
annotationValue, only the property matching its annotationFieldType is populated; the others are null.
Request transactions with annotations
Sample annotationGroup (included on a transaction row)
include=annotations with the annotationStatus query parameter (see Query parameters).
Pagination
Results are paginated using thelimit and offset query parameters. By default, the API returns up to 100 results starting from offset 0.
To retrieve the next page of results, increase the offset by the limit value. For example, to get the second page of 100 results, set offset=100. You can use the count field in the response to determine the total number of results available.
Example: Get the second page of 50 results
Filtering examples
You can combine query parameters to narrow down results. Here are some common examples. Filter by transaction type:Get only card transactions
Get transactions from January 2024
Get only completed transactions
Get completed card transactions from January 2024