View transactions
View a list of transactions that have occurred on an account.
List transaction activity
Get/v2/activity/{accountId}
Request
Use this request to get a list of transactions for a given account, based on its id
. Results are ordered chronologically by creation date, with the most recent transaction appearing first.
Sample requestRequest structure
curl -i -X GET \
'https://api.equalsmoney.com/v2/activity/F12345' \
-H 'Authorization: ApiKey YOUR_API_KEY_HERE'
curl -i -X GET \
'https://api.equalsmoney.com/v2/activity/{accountId}' \
-H 'Authorization: ApiKey YOUR_API_KEY_HERE'
Path parameters
Parameter | Description |
---|---|
accountId integer required |
The ID of the account that you want to get a list of transactions for. Allowable values: An existing accountId |
Query parameters
Parameter | Description |
---|---|
limit integer |
The maximum amount of results to return. By default, this is set to 100 . Allowable values: [ 1 .. 1000 ] |
offset integer |
The amount of results to skip. By default, this is set to 0 . Allowable values: A valid integer |
include array of strings |
Optional additional information to return in the results. Allowable values: bankFeedDetails , annotations , attachments |
type array of strings |
The type to filter results by. Use commas to pass multiple values. Has to be URL encoded. For example, type=payment%2Cload . Allowable values: exchange , payment , deposit , forwardContract , drawdown , card , cardCheck , cardRefund , cashWithdrawal , atm , unload , otherDebit , load , cashback , chargeback , compensation , otherCredit , fee |
status array of strings |
The status to filter results by. Use commas to pass multiple values. Has to be URL encoded. For example, status=complete%2Ccancelled . Allowable values: needsApproval , fundsRequired , pending , complete ,declined , reverted , refunded , cancelled , open , cardCheck |
budgetId array 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) |
budgetName 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) |
sellCurrency 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 characters |
buyCurrency array 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 characters |
startDate string (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-DD |
endDate string (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-DD |
search string |
Filters results that include this string. For example, search=Jane+Doe . Allowable values: A valid string |
annotationStatus array 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 , unannotated |
attachmentStatus array 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%2Cpresent Allowable values: absent , present , lost |
Response
If your request is successful, you'll receive a 200
response containing a list of transactions, ordered chronologically with the most recent transaction appearing first.
Sample responseResponse structure
{
"count": 3,
"limit": 100,
"offset": 0,
"rows": [
{
"budget": "companyBalance",
"resourceType": "payment",
"id": 123456,
"orderId": 654321,
"userId": "4bf13dc8-d128-4521-99b8-4002b8987499",
"originId": "0684fc07-4abc-46de-b664-da45ef3c4072",
"originOrderId": "F6VOXCZ1AMND",
"companyId": "F12345",
"status": "fundsRequired",
"isMultiBeneficiary": false,
"remitterName": null,
"beneficiaryId": "7l2nks3eh",
"beneficiaryName": "William Walker",
"beneficiaryAddress": "",
"beneficiaryAccountNumber": "12345678",
"beneficiarySortCode": "123456",
"beneficiaryIban": "",
"beneficiaryBankCode": "",
"beneficiaryCountryCode": "GB",
"beneficiaryBankAddress": "UPPER THAMES STREET, 68 VINTNERS PLACE FAIRFX FLOOR 3 LONDON EC4V 3BJ",
"beneficiaryRoutingInfo": "Payment will be routed from Bank of England and then through Lloyds bank",
"reference": "Invoice 3468 payment",
"amount": 99.99,
"currency": "GBP",
"buyCurrency": "GBP",
"sellCurrency": "GBP",
"settlementAmountWithoutFee": 99.99,
"settlementAmount": 99.99,
"settlementFee": 0,
"customerRate": 1,
"customerInverseRate": 1,
"uniqueId": "8233f929-94d3-4390-8d27-da92b733cafb",
"confirmationKey": "F12345/pdf/F12345-F6VOXCZ1AMND.pdf",
"cardLastFour": null,
"cardExpiry": null,
"cardNetwork": null,
"type": "payment",
"budgetId": "63f4b801-70d6-4bba-b3f3-7b9acd051633",
"budgetName": "Account balance",
"createdAt": "2022-11-14T10:55:28.000Z",
"updatedAt": "2022-11-14T10:55:30.000Z",
"order": {
"id": 123456,
"companyId": "F12345",
"originId": "F6VOXCZ1AMND",
"parentOriginId": null,
"userId": "d4fd55fe-836d-48d2-8d49-e5629bd508a6",
"userName": "",
"status": "fundsRequired",
"type": "payment",
"createdAt": "2022-11-14T10:55:28.000Z",
"updatedAt": "2022-11-14T10:55:30.000Z",
"events": [
{
"id": "beec0eb3-3e11-44a4-86de-65404510038a",
"eventId": "4c191b59-685b-454b-bad7-e832505ee51c",
"orderCreatedAt": "2022-11-14T10:55:28.000Z",
"eventType": 0,
"orderId": 123456,
"title": "Order created",
"description": "Payment to William Walker created"
}
]
},
"transactionBoxes": []
},
{
"resourceType": "box",
"id": "1352a456-b53f-4930-a151-1694c5655549",
"accountId": "F12345",
"transactionGroupId": "ef0b2cd8-119d-4403-9cde-5d19414f05a9",
"sourceGroupId": null,
"transactionType": "Boxes",
"status": null,
"transactionDate": null,
"createdAt": "2022-11-12T06:02:53.000Z",
"updatedAt": "2022-11-12T06:02:53.000Z",
"transactionGroup": {
"id": "ef0b2cd8-119d-4403-9cde-5d19414f05a9",
"accountId": "F12345",
"personId": null,
"firstName": null,
"lastName": null,
"budgetId": "fe64b139-4824-41b5-93c2-0fad876ceac0",
"budgetName": "Account balance",
"createdAt": "2022-11-12T06:02:53.000Z",
"updatedAt": "2022-11-12T06:02:53.000Z"
},
"transactionBox": {
"id": "992e9652-d313-4ea7-aa93-b96b247627c2",
"transactionId": "1352a456-b53f-4930-a151-1694c5655549",
"transactionBoxableId": "1352a456-b53f-4930-a151-1694c5655549",
"boxId": null,
"type": "credit",
"amount": 99.99,
"currency": "GBP",
"paymentType": "UK.OBIE.FPS",
"transactionReference": "02FP000000199076071020221",
"statementReference": "Ref",
"creditDebitIndicator": "Credit",
"debitId": null,
"creditId": 48731088,
"boxTransactionId": null,
"thirdPartyReference": "",
"marqetaTransactionToken": null,
"marqetaTransactionIdentifier": null,
"internalAccountTransferId": "Test 123456",
"affectsLedgerBalance": true,
"runningBalance": null,
"blockId": null,
"blockTag": null,
"valueDateTime": "2022-11-12T06:01:52.000Z",
"transactionBoxableType": "transaction",
"orderId": null,
"eventSource": "External Credit",
"createdAt": "2022-11-12T06:02:53.000Z",
"updatedAt": "2022-11-12T06:02:53.000Z",
"chargeBearer": null,
"transactionDebtorAccount": {
"id": "4a13687d-7543-4809-96c4-4bd1a24a006e",
"transactionBoxId": "992e9652-d313-4ea7-aa93-b96b247627c2",
"ownerId": null,
"accountId": null,
"schemeName": "UK.OBIE.SortCodeAccountNumber",
"identification": "00999718976098",
"name": "William Walker",
"address": null,
"institutionName": null,
"institutionAddress": null,
"institutionBic": ""
},
"transactionCreditorAccount": {
"id": "97e652a1-ca0b-40ce-8926-73a2f450c974",
"transactionBoxId": "992e9652-d313-4ea7-aa93-b96b247627c2",
"ownerId": "3de6732e39",
"accountId": "d767e2390c",
"schemeName": "UK.OBIE.SortCodeAccountNumber",
"identification": "00999734593642",
"name": "John Smith"
}
}
},
{
"resourceType": "card",
"id": "19bbf64b-ddfb-48ee-b125-66ed4455d534",
"accountId": "F12345",
"transactionGroupId": "f863de54-1cac-49b2-b624-ffd3a54dfcc7",
"sourceGroupId": "71013bb0-f3fa-48a9-917e-39434df17aa7",
"transactionType": "Marqeta",
"status": null,
"transactionDate": "2022-08-18T13:38:01.000Z",
"createdAt": "2022-08-17T07:07:10.000Z",
"updatedAt": "2022-08-18T14:25:22.000Z",
"transactionGroup": {
"id": "f863de54-1cac-49b2-b624-ffd3a54dfcc7",
"accountId": "F12345",
"personId": "e5098eb4-4800-4276-a234-2a9185399430",
"firstName": "John",
"lastName": "Smith",
"budgetId": "650b2c1b-21fa-4d79-b73c-7aa9482c0e66",
"budgetName": "Account Balance",
"createdAt": "2022-08-17T07:07:12.000Z",
"updatedAt": "2022-08-17T07:07:12.000Z"
},
"cardTransaction": {
"id": "7a5e1306-794c-4ccb-a0d1-e647eff79c6b",
"transactionToken": null,
"identifier": 1234,
"transactionId": "19bbf64b-ddfb-48ee-b125-66ed4455d534",
"localAmount": 99.99,
"localAmountCurrency": "GBP",
"baseCurrency": null,
"feeAmount": 0,
"feeCurrency": "GBP",
"exchangeRate": 1,
"total": 0,
"cardName": "Debit Card",
"cardId": "8fe9cd43-d79f-4025-a0dc-3ee4ace98eb8",
"cardProductToken": null,
"cardType": "PHYSICAL_MSR",
"cardLastDigits": "1234",
"status": "unknown",
"type": "unknown",
"approvalCode": 654321,
"acquirerInstitutionIdCode": "000000",
"acquirerReferenceNumber": null,
"paymentChannel": null,
"transactionCompletedAt": "2022-08-19T00:00:00.000Z",
"transactionCreatedAt": "2022-08-17T07:07:10.000Z",
"boxesResponse": null,
"createdAt": "2022-08-18T14:25:22.000Z",
"updatedAt": "2022-08-18T14:25:22.000Z",
"chargedTotalAmount": null,
"chargedAmount": null,
"chargedCurrency": null,
"response": {
"code": null,
"memo": null
}
},
"merchant": {
"id": "7221d41b-69c3-4fbc-8317-d3210d97b3ab",
"merchantCategoryId": "d780ae34-dfe1-4e24-82f0-2043c7fa30d4",
"mid": "5009545",
"subMerchantId": null,
"originalName": "ACME COFFEE",
"name": "ACME COFFEE",
"description": null,
"address": null,
"city": "LONDON",
"state": "GBR",
"postalCode": "EC3V 2BJ",
"countryCode": "GBR",
"website": null,
"logo": null,
"emoji": "",
"notes": "",
"createdAt": "2022-01-11T09:46:07.000Z",
"updatedAt": "2022-01-11T09:46:07.000Z",
"merchantCategory": {
"id": "d780ae34-dfe1-4e24-82f0-2043c7fa30d4",
"code": "5814",
"description": "Fast food restaurants",
"createdAt": "2021-09-10T08:55:06.000Z",
"updatedAt": "2021-09-10T08:55:06.000Z"
}
}
}
]
}
{
"count": integer,
"limit": integer,
"offset": integer,
"rows": [
{
"budget": "string",
"resourceType": "string",
"id": integer,
"orderId": integer,
"userId": "string",
"originId": "string",
"originOrderId": "string",
"companyId": "string",
"status": "string",
"isMultiBeneficiary": boolean,
"remitterName": "string",
"beneficiaryId": "string",
"beneficiaryName": "string",
"beneficiaryAddress": "string",
"beneficiaryAccountNumber": "string",
"beneficiarySortCode": "string",
"beneficiaryIban": "string",
"beneficiaryBankCode": "string",
"beneficiaryCountryCode": "string",
"beneficiaryBankAddress": "string",
"beneficiaryRoutingInfo": "string",
"reference": "string",
"amount": number,
"currency": "string",
"buyCurrency": "string",
"sellCurrency": "string",
"settlementAmountWithoutFee": number,
"settlementAmount": number,
"settlementFee": number,
"customerRate": number,
"customerInverseRate": number,
"uniqueId": "string",
"confirmationKey": "string",
"cardLastFour": "string",
"cardExpiry": "string",
"cardNetwork": "string",
"type": "string",
"budgetId": "string",
"budgetName": "string",
"createdAt": "string",
"updatedAt": "string",
"order": {
"id": integer,
"companyId": "string",
"originId": "string",
"parentOriginId": null,
"userId": "string",
"userName": "string",
"status": "string",
"type": "string",
"createdAt": "string",
"updatedAt": "string",
"events": [
{
"id": "string",
"eventId": "string",
"orderCreatedAt": "string",
"eventType": number,
"orderId": number,
"title": "string",
"description": "string"
}
]
},
"transactionBoxes": []
},
{
"resourceType": "string",
"id": "string",
"accountId": "string",
"transactionGroupId": "string",
"sourceGroupId": null,
"transactionType": "string",
"status": null,
"transactionDate": null,
"createdAt": "string",
"updatedAt": "string",
"transactionGroup": {
"id": "string",
"accountId": "string",
"personId": null,
"firstName": null,
"lastName": null,
"budgetId": "string",
"budgetName": "string",
"createdAt": "string",
"updatedAt": "string"
},
"transactionBox": {
"id": "string",
"transactionId": "string",
"transactionBoxableId": "string",
"boxId": null,
"type": "string",
"amount": number,
"currency": "string",
"paymentType": "string",
"transactionReference": "string",
"statementReference": "string",
"creditDebitIndicator": "string",
"debitId": null,
"creditId": number,
"boxTransactionId": null,
"thirdPartyReference": "",
"marqetaTransactionToken": null,
"marqetaTransactionIdentifier": null,
"internalAccountTransferId": "string",
"affectsLedgerBalance": true,
"runningBalance": null,
"blockId": null,
"blockTag": null,
"valueDateTime": "string",
"transactionBoxableType": "string",
"orderId": null,
"eventSource": "string",
"createdAt": "string",
"updatedAt": "string",
"chargeBearer": null,
"transactionDebtorAccount": {
"id": "string",
"transactionBoxId": "string",
"ownerId": null,
"accountId": null,
"schemeName": "string",
"identification": "string",
"name": "string",
"address": null,
"institutionName": null,
"institutionAddress": null,
"institutionBic": ""
},
"transactionCreditorAccount": {
"id": "string",
"transactionBoxId": "string",
"ownerId": "string",
"accountId": "string",
"schemeName": "string",
"identification": "string",
"name": "string"
}
}
},
{
"resourceType": "string",
"id": "string",
"accountId": "string",
"transactionGroupId": "string",
"sourceGroupId": "string",
"transactionType": "string",
"status": null,
"transactionDate": "string",
"createdAt": "string",
"updatedAt": "string",
"transactionGroup": {
"id": "string",
"accountId": "string",
"personId": "string",
"firstName": "string",
"lastName": "string",
"budgetId": "string",
"budgetName": "string",
"createdAt": "string",
"updatedAt": "string"
},
"cardTransaction": {
"id": "string",
"transactionToken": null,
"identifier": number,
"transactionId": "string",
"localAmount": number,
"localAmountCurrency": "string",
"baseCurrency": null,
"feeAmount": number,
"feeCurrency": "string",
"exchangeRate": number,
"total": number,
"cardName": "string",
"cardId": "string",
"cardProductToken": null,
"cardType": "string",
"cardLastDigits": "1234",
"status": "string",
"type": "string",
"approvalCode": number,
"acquirerInstitutionIdCode": "string",
"acquirerReferenceNumber": null,
"paymentChannel": null,
"transactionCompletedAt": "string",
"transactionCreatedAt": "string",
"boxesResponse": null,
"createdAt": "string",
"updatedAt": "string",
"chargedTotalAmount": null,
"chargedAmount": null,
"chargedCurrency": null,
"response": {
"code": null,
"memo": null
}
},
"merchant": {
"id": "string",
"merchantCategoryId": "string",
"mid": "string",
"subMerchantId": null,
"originalName": "string",
"name": "string",
"description": null,
"address": null,
"city": "string",
"state": "string",
"postalCode": "string",
"countryCode": "string",
"website": null,
"logo": null,
"emoji": "string",
"notes": "string",
"createdAt": "string",
"updatedAt": "string",
"merchantCategory": {
"id": "string",
"code": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
]
}
For more information about this request and its response, see the API reference.
Searchable fields
The following table lists the fields that are searched when you use the optional search
parameter. These fields vary depending on the transaction's resourceType
.
Field | Transaction type(s) |
---|---|
sellAmount |
payment |
sellCurrency |
payment |
buyAmount |
payment |
buyCurrency |
payment |
beneficiaryName |
payment |
reference |
payment |
amount |
payment |
currency |
payment |
originOrderId |
payment |
settlementAmountWithoutFee |
payment |
settlementAmount |
payment |
settlementFee |
payment |
order.type |
payment |
order.userName |
payment |
transactionGroupId |
card and box |
cardTransaction.cardName |
card |
cardTransaction.cardLastDigits |
card |
cardTransaction.localAmount |
card |
transactionGroup.budgetName |
card |
merchant.name |
card |
merchant.originalName |
card |
bankFeedDetails |
card |
transactionGroup.bankFeedTransactions .batchSync.reference |
card |
type |
box |
transactionBox.statementReference |
box |
transactionBox.boxTransactionId |
box |
transactionBox.transactionDebtorAccount.name |
box |
transactionBox.transactionCreditorAccount.name |
box |
transactionBox.transactionDebtorAccount .identification |
box |
transactionBox.transactionCreditorAccount .identification |
box |
transactionBox.amount |
box |
transactionBox.currency |
box |