Skip to main content
GET
List all transaction activity

Authorizations

Authorization
string
header
required

Path Parameters

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Query Parameters

limit
integer
default:100

The maximum number of results to return.

Required range: 1 <= x <= 10000
Example:

200

offset
integer
default:0

The number of items to skip before returning results.

Example:

100

include
enum<string>

Controls which optional properties should be attached to the response. forwardDetails attaches the forward contract's payments, events, deposits and drawdowns to forwardContract rows.

Available options:
bankFeedDetails,
annotations,
attachments,
forwardDetails
Example:

"bankFeedDetails,annotations"

personId

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

type
enum<string>

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

Available options:
exchange,
payment,
deposit,
forwardContract,
drawdown,
card,
cardCheck,
cardRefund,
cashWithdrawal,
atm,
unload,
otherDebit,
load,
cashback,
chargeback,
compensation,
otherCredit,
fee,
batchPayment,
currencyPurchase
Example:

"payment%2Cload"

excludeType
enum<string>

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

Available options:
exchange,
payment,
deposit,
forwardContract,
drawdown,
card,
cardCheck,
cardRefund,
cashWithdrawal,
atm,
unload,
otherDebit,
load,
cashback,
chargeback,
compensation,
otherCredit,
fee,
batchPayment,
currencyPurchase
Example:

"payment%2Cload"

status
enum<string>

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

Available options:
needsApproval,
fundsRequired,
pending,
complete,
declined,
reverted,
refunded,
cancelled,
open,
cardCheck,
fundsSettled
Example:

"complete%2Ccancelled"

budgetId

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

budgetName

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

Example:

"Account%2Cmarketing"

currency
enum<string>

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

Available options:
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:

"GBP%2CUSD"

sellCurrency
enum<string>

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

Available options:
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:

"USD%2CEUR"

buyCurrency
enum<string>

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

Available options:
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:

"GBP"

startDate
string

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

Example:

"2021-02-15"

endDate
string

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

Example:

"2021-02-16"

dateField
enum<string>
default:transaction.createdAt

Selects which date field startDate and endDate filter against. transaction.createdAt filters by the date the transaction was created; transactionBox.valueDateTime filters by the date the transaction was completed/settled. Defaults to transaction.createdAt.

Available options:
transaction.createdAt,
transactionBox.valueDateTime
Example:

"transaction.createdAt"

The term to search the records for.

Maximum string length: 100
Example:

"Cesar+Treutel"

annotationStatus
enum<string>

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

Available options:
draft,
submitted,
unannotated
Example:

"draft%2Csubmitted"

attachmentStatus
enum<string>

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

Available options:
absent,
present,
lost
Example:

"absent%2Cpresent"

batchPaymentOrders
enum<string>

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

Available options:
true,
false
Example:

true

directDebitId

Filters transactions by direct debit mandate ID(s). Use commas to pass multiple values. Has to be URL encoded.

sortBy
enum<string>
default:createdAt

Field to sort by. Only createdAt is currently supported.

Available options:
createdAt
sortDirection
enum<string>
default:desc

Sort direction. desc = newest first (default). asc = oldest first.

Available options:
asc,
desc

Response

200 - application/json

OK

count
integer
required

The total amount of records matching the querying when "limit" is ignored.

Example:

67

rows
object[]
required
limit
integer
default:100

The maximum number of results to return.

Required range: 1 <= x <= 1000
Example:

200

offset
integer
default:0

The number of items to skip before returning results.

Example:

100