Step 1: List all transaction activity

Get a list of all the transactions that have occurred on your account in standard JSON payload format. Note that in sandbox, orders are excluded from the results.

info

There are a number of additional parameters available for you to filter your results. For more information, see the API reference.

In this example, we're retrieving a list of all transactions without adding any filters. Replace {accountId} with your account ID and {apiKey} with your API key.

SandboxProduction

Copy

Copied

curl -i -X GET \
  'https://api-sandbox.equalsmoney.com/v2/activity/{accountId}' \
  -H 'Authorization: ApiKey {apiKey}'

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/{accountId}' \
  -H 'Authorization: ApiKey {apiKey}'

If your request is successful, you'll receive a 200 response containing a list of transactions. These are ordered chronologically by creation date, with the most recent transaction appearing first.

info

In sandbox, only credit and debit box transactions are returned. In production, you'll also see other resource types such as payment, card, and order. For more information about different transaction types, see About transaction types.

Copy

Copied

{
  "count": 6,
  "limit": 100,
  "offset": 0,
  "rows": [
    {
      "resourceType": "box",
      "id": "6453e570-211c-4419-9db8-0e9dcf61d390",
      "accountId": "F12345",
      "transactionGroupId": "a4ae697e-7bbf-4857-906f-deb1b49d565a",
      "sourceGroupId": null,
      "transactionType": "Boxes",
      "status": "complete",
      "transactionDate": null,
      "createdAt": "2023-11-23T17:55:41.000Z",
      "updatedAt": "2023-11-23T17:55:41.000Z",
      "transactionGroup": {
        "id": "a4ae697e-7bbf-4857-906f-deb1b49d565a",
        "accountId": "F12345",
        "personId": null,
        "firstName": null,
        "lastName": null,
        "budgetId": "0cbcee03-ca47-4437-a5b9-433d6914b476",
        "budgetName": "Account balance",
        "createdAt": "2023-11-23T17:55:41.000Z",
        "updatedAt": "2023-11-23T17:55:41.000Z"
      },
      "transactionBox": {
        "id": "5a63d758-da59-4a90-a809-45be9533a287",
        "transactionId": "6453e570-211c-4419-9db8-0e9dcf61d390",
        "transactionBoxableId": "6453e570-211c-4419-9db8-0e9dcf61d390",
        "boxId": "a522954d-8652-4e9f-87b5-7ba965867bc4",
        "type": "credit",
        "amount": 5,
        "currency": "GBP",
        "paymentType": "UK.OBIE.BalanceTransfer",
        "transactionReference": "",
        "statementReference": "",
        "creditDebitIndicator": "Credit",
        "debitId": null,
        "creditId": 495,
        "boxTransactionId": 1562,
        "thirdPartyReference": "",
        "marqetaTransactionToken": null,
        "marqetaTransactionIdentifier": null,
        "internalAccountTransferId": "473",
        "affectsLedgerBalance": true,
        "runningBalance": "405.00",
        "blockId": null,
        "blockTag": null,
        "valueDateTime": "2023-11-23T17:50:37.000Z",
        "transactionBoxableType": "transaction",
        "orderId": null,
        "eventSource": "PaaS",
        "createdAt": "2023-11-23T17:55:41.000Z",
        "updatedAt": "2023-11-23T17:55:41.000Z",
        "chargeBearer": null,
        "transactionDebtorAccount": {
          "id": "cc47f828-ce62-4def-9cba-6b6d92eaa0b9",
          "transactionBoxId": "5a63d758-da59-4a90-a809-45be9533a287",
          "ownerId": null,
          "accountId": null,
          "schemeName": "UK.OBIE.SortCodeAccountNumber",
          "identification": "00000000000000",
          "name": "Sonja Stark",
          "address": "300 Long Avenue, Manchester, M260DG",
          "institutionName": null,
          "institutionAddress": null,
          "institutionBic": null
        },
        "transactionCreditorAccount": {
          "id": "2108c5e4-72ac-4545-88fe-dcca015fcc0b",
          "transactionBoxId": "5a63d758-da59-4a90-a809-45be9533a287",
          "ownerId": "a522954d-8652-4e9f-87b5-7ba965867bc4",
          "accountId": "8bd9c0d453",
          "schemeName": "UK.OBIE.SortCodeAccountNumber",
          "identification": "23188440549969",
          "name": "Rodolfo Marks"
        }
      }
    },
    {
      "resourceType": "box",
      "id": "1e7d3c9c-60d9-4573-9a2b-b29391845bd0",
      "accountId": "F12345",
      "transactionGroupId": "f9467313-aa96-4f3f-beac-cc22ddc08d78",
      "sourceGroupId": null,
      "transactionType": "Boxes",
      "status": "complete",
      "transactionDate": null,
      "createdAt": "2023-11-07T14:26:15.000Z",
      "updatedAt": "2023-11-07T14:26:15.000Z",
      "transactionGroup": {
        "id": "f9467313-aa96-4f3f-beac-cc22ddc08d78",
        "accountId": "F12345",
        "personId": null,
        "firstName": null,
        "lastName": null,
        "budgetId": "0cbcee03-ca47-4437-a5b9-433d6914b476",
        "budgetName": "Account balance",
        "createdAt": "2023-11-07T14:26:15.000Z",
        "updatedAt": "2023-11-07T14:26:15.000Z"
      },
      "transactionBox": {
        "id": "bcc20855-9ca3-417e-a983-a1778a9e62ab",
        "transactionId": "1e7d3c9c-60d9-4573-9a2b-b29391845bd0",
        "transactionBoxableId": "1e7d3c9c-60d9-4573-9a2b-b29391845bd0",
        "boxId": "a522954d-8652-4e9f-87b5-7ba965867bc4",
        "type": "debit",
        "amount": 300,
        "currency": "GBP",
        "paymentType": "UK.OBIE.BalanceTransfer",
        "transactionReference": "",
        "statementReference": "Internal Transfer",
        "creditDebitIndicator": "Debit",
        "debitId": 454,
        "creditId": null,
        "boxTransactionId": 1326,
        "thirdPartyReference": "",
        "marqetaTransactionToken": null,
        "marqetaTransactionIdentifier": null,
        "internalAccountTransferId": "1 11",
        "affectsLedgerBalance": true,
        "runningBalance": "-600.00",
        "blockId": null,
        "blockTag": null,
        "valueDateTime": "2023-11-07T14:21:11.000Z",
        "transactionBoxableType": "transaction",
        "orderId": "",
        "eventSource": "PaaS",
        "createdAt": "2023-11-07T14:26:15.000Z",
        "updatedAt": "2023-11-07T14:26:15.000Z",
        "chargeBearer": null,
        "transactionDebtorAccount": {
          "id": "4b0f19c0-a2fa-442b-9074-527c708266bc",
          "transactionBoxId": "bcc20855-9ca3-417e-a983-a1778a9e62ab",
          "ownerId": "a522954d-8652-4e9f-87b5-7ba965867bc4",
          "accountId": "8bd9c0d453",
          "schemeName": "UK.OBIE.SortCodeAccountNumber",
          "identification": "23188440549969",
          "name": "FRIENDS KITCHEN LTD.",
          "address": null,
          "institutionName": null,
          "institutionAddress": null,
          "institutionBic": null
        },
        "transactionCreditorAccount": {
          "id": "8190ced4-e1be-40c3-a748-835903a4c6bb",
          "transactionBoxId": "bcc20855-9ca3-417e-a983-a1778a9e62ab",
          "ownerId": "",
          "accountId": "",
          "schemeName": "UK.OBIE.SortCodeAccountNumber",
          "identification": "23188489077153",
          "name": ""
        }
      }
    }
  ]
}

Understanding the response

Each transaction in the rows array contains these key fields:

resourceType — The type of transaction record (e.g., box , payment , card ). In sandbox, you'll mainly see box transactions.
status — The current status of the transaction (e.g., complete , pending ). See About transaction statuses for all possible values.
transactionGroup — Contains the budget and person associated with the transaction, including the budgetId and budgetName .
transactionBox.type — Whether the transaction is a credit (money in) or debit (money out).
transactionBox.amount and transactionBox.currency — The transaction amount and currency.
transactionBox.creditDebitIndicator — Indicates whether the transaction is a Credit or Debit .
transactionBox.runningBalance — The balance after this transaction was applied.
transactionDebtorAccount and transactionCreditorAccount — Details of the sending and receiving accounts.

For the full response structure and all available fields, see the API reference.