Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Transactions

Get transactions for a specific Account

Retrieves the last 6 months of transactions (successful payments in & out) of an account, specified by a unique account reference.

get/accounts/{accountId}/transactions

Path parameters

accountIdstring required

ID of account to fetch transactions for

Query parameters

qstring

Partial description text to search for

Partial description text to search for

minAmountnumber

Transactions with amount equal or more than this amount

Transactions with amount equal or more than this amount

maxAmountnumber

Transactions with amount equal or less than this amount

Transactions with amount equal or less than this amount

fromPostedDatestring

Transactions with posted date equal or after to this date

Transactions with posted date equal or after to this date

toPostedDatestring

Transactions with posted date equal or before to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

Transactions with posted date equal or before to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

typestring[]

Transaction types

creditboolean

If true only credit transactions will be returned, if false, only debit transactions will be returned

If true only credit transactions will be returned, if false, only debit transactions will be returned

sourceIdstring

Transactions with this sourceId

Transactions with this sourceId

sizeinteger

Size of Page to fetch

Size of Page to fetch

showAvailableBalanceboolean

Show available balance

Show available balance

fromTransactionDatestring

Transactions with transaction date equal or after to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

Transactions with transaction date equal or after to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

toTransactionDatestring

Transactions with transaction date equal or before to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

Transactions with transaction date equal or before to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

pageinteger

Page to fetch (0 indexed)

Page to fetch (0 indexed)

Response

OK

sizeinteger

Page size

totalSizeinteger

Total count

pageinteger

Current page number, 0 based; i.e first-page = 0, second-page = 1

totalPagesinteger

Total pages

pageStartBalancenumber

The sum of the transactions up to this page. This is only present if there are no filters other than page and size defined

Example response

{
  "content": [
    {
      "id": "T000000001",
      "currency": "GBP",
      "transactionDate": "2017-01-28T01:01:01+0000",
      "postedDate": "2017-01-28T01:01:01+0000",
      "account": {
        "id": "A0000001",
        "balance": "10000.00",
        "availableBalance": "10000.00",
        "currency": "GBP",
        "status": "ACTIVE",
        "identifiers": [
          {
            "accountNumber": "12345678",
            "sortCode": "000000",
            "iban": "GB20MODR04001401100000",
            "bic": "MODRGB21",
            "currency": "GBP",
            "countrySpecificDetails": {
              "bankName": "Apple Bank",
              "bankAddress": "2100 Broadway",
              "bankCity": "New York City",
              "bankBranchName": "New York",
              "bankBranchCode": "44-04",
              "chineseId": "01101201901018889",
              "province": "Zhejiang",
              "business": true,
              "bankCodeType": "ABA",
              "bankCountry": "US",
              "abaRoutingNumber": "123456789"
            },
            "productId": "O2100001"
          }
        ],
        "customerId": "C0000001",
        "externalReference": "aReference_00001",
        "createdDate": "2017-01-28T01:01:01+0000"
      }
    }
  ]
}