List all transaction activity

Returns a list of transactions for a given account. Ordered chronologically by creation date, with the most recent transaction appearing first.

You can use optional parameters to filter the transactions. For example, use budgetId to return only transactions associated with a given budget.

SecurityCommonAuth
Request
path Parameters
accountId
required
string

The ID of the account to work with.

Example: F50091
query Parameters
limit
integer [ 1 .. 10000 ]
Default: 100

The maximum number of results to return.

Example: limit=200
offset
integer
Default: 0

The number of items to skip before returning results.

Example: offset=100
string or Array of strings

Controls which optional properties should be attached to the response.

Enum: "bankFeedDetails" "annotations" "attachments"
Example: include=bankFeedDetails,annotations
string or Array of strings

The ID of the person to work with. Use commas to pass multiple values. Has to be URL encoded.

string or Array of strings

The type to filter transactions by. Use commas to pass multiple values. Has to be URL encoded. Learn more about transaction types.

Enum: "exchange" "payment" "deposit" "forwardContract" "drawdown" "card" "cardCheck" "cardRefund" "cashWithdrawal" "atm" "unload" "otherDebit" "load" "cashback" "chargeback" "compensation" "otherCredit" "fee" "batchPayment"
Example: type=payment%2Cload
string or Array of strings

The type to exclude in the transactions list. Use commas to pass multiple values. Has to be URL encoded. Learn more about transaction types.

Enum: "exchange" "payment" "deposit" "forwardContract" "drawdown" "card" "cardCheck" "cardRefund" "cashWithdrawal" "atm" "unload" "otherDebit" "load" "cashback" "chargeback" "compensation" "otherCredit" "fee" "batchPayment"
Example: excludeType=payment%2Cload
string or Array of strings

The status to filter transactions by. Use commas to pass multiple values. Has to be URL encoded. Learn more about transaction statuses.

Enum: "needsApproval" "fundsRequired" "pending" "complete" "declined" "reverted" "refunded" "cancelled" "open" "cardCheck" "fundsSettled"
Example: status=complete%2Ccancelled
string or Array of strings

The budgetId to filter transactions by. Use commas to pass multiple values. Has to be URL encoded.

string or Array of strings

The budgetName to filter transactions by. Use commas to pass multiple values. Has to be URL encoded.

Example: budgetName=Account%2Cmarketing
string or Array of strings

Filters transactions that include selling these currencies. Use commas to pass multiple values. Has to be URL encoded.

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SEK" "SGD" "SHN" "SLL" "SOS" "SRD" "SSP" "STN" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMK" "ZMW" "ZWD"
Example: sellCurrency=USD%2CEUR
string or Array of strings

Filters orders that include purchasing these currencies. Use commas to pass multiple values. Has to be URL encoded.

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SEK" "SGD" "SHN" "SLL" "SOS" "SRD" "SSP" "STN" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMK" "ZMW" "ZWD"
Example: buyCurrency=GBP
startDate
string

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

Example: startDate=2021-02-15
endDate
string

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

Example: endDate=2021-02-16
search
string <= 100 characters

The term to search the records for.

Example: search=Cesar+Treutel
string or Array of strings

If annotations is included in the include parameter, this will filter the transactions based on the status of the annotations.

Enum: "draft" "submitted" "unannotated"
Example: annotationStatus=draft%2Csubmitted
string or Array of strings

If attachments is included in the include parameter, this will filter the transactions based on whether transactions have attachments or not.

Enum: "absent" "present" "lost"
Example: attachmentStatus=absent%2Cpresent
batchPaymentOrders
string

description: 'If true, returns orders instead of the list of all payments from batches.

Enum: "true" "false"
Example: batchPaymentOrders=true
Responses
200

OK

get/activity/{accountId}
Request samples 
Response samples 
application/json
{
  • "limit": 200,
  • "offset": 100,
  • "count": 67,
  • "rows": [
    ]
}