Generate a transaction activity CSV

Generates a transaction activity CSV. A transaction activity CSV is a list of all transactions generated for an account over a given period.

Ordered chronologically by creation date, with the most recent transaction appearing first.

The endDate can be any date after the startDate, including the date on which you're making the request.

You can use optional parameters to filter the transactions. For example, use budgetIds to return only transactions associated with a given list of budgets.

SecurityCommonAuth
Request
Request Body schema: application/json
required

Search parameters

accountId
required
string (accountId) <= 36 characters

The ID of the account to work with.

personId
string

The ID of the person to work with.

name
required
string <= 256 characters

The user's name. Used for personalization or identification in the CSV export.

startDate
required
string <date> (startDate)

The earliest date to retrieve records after (includes records on this date).

endDate
required
string <date> (endDate)

The latest date to retrieve records to (includes records on this date).

currencyCodes
string

A comma-separated list of selected currency codes, in ISO format.

budgetIds
Array of strings or null <uuid>

Array of budget IDs.

ignoreRunningBalanceErrors
boolean

When true, running balance errors are ignored.

(string or Array of strings) or (string or Array of strings)
sellCurrency
string

Filters orders that include selling these currencies. Use commas to pass multiple values.

buyCurrency
string

Filters orders that include purchasing these currencies. Use commas to pass multiple values.

type
Array of strings (type)

The type to filter orders by.

Items Enum: "exchange" "payment" "deposit" "forwardContract" "drawdown" "card" "cardCheck" "cardRefund" "cashWithdrawal" "atm" "unload" "otherDebit" "load" "cashback" "chargeback" "compensation" "otherCredit" "fee" "batchPayment"
status
Array of strings (status)

The status to filter orders by.

Items Enum: "needsApproval" "fundsRequired" "pending" "complete" "declined" "reverted" "refunded" "cancelled" "open" "cardCheck" "fundsSettled"
search
string (search) <= 100 characters

The term to search the records for.

settlementStartDate
string <date> (startDate)

The earliest date to retrieve records after (includes records on this date).

settlementEndDate
string <date> (endDate)

The latest date to retrieve records to (includes records on this date).

limit
integer <int32> (limit) [ 1 .. 10000 ]
Default: 100

The maximum amount of records to return.

offset
integer <int32> (offset)
Default: 0

The amount of records to skip before returning.

Responses
202

Accepted

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

post/activity/download
Request samples
application/json
{
  • "accountId": "F50072",
  • "personId": "530a5e60-0285-4c88-9671-53aba08a971a",
  • "name": "Firstname Surname",
  • "startDate": "2021-02-15",
  • "endDate": "2021-03-30",
  • "currencyCodes": "eur,gbp,usd",
  • "budgetIds": [
    ],
  • "ignoreRunningBalanceErrors": false,
  • "excludeBoxTransactionIds": "12345,67890",
  • "sellCurrency": "eur,gbp,usd",
  • "buyCurrency": "eur,gbp,usd",
  • "type": [
    ],
  • "status": [
    ],
  • "search": "string",
  • "settlementStartDate": "2021-02-15",
  • "settlementEndDate": "2021-03-30",
  • "limit": 100,
  • "offset": 200
}
Response samples
application/json
{
  • "message": "accepted"
}