latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Bank Transactions

Gets the latest bank transactions from a banking service provider for a business.

get/bankTransactions

Query parameters

businessNamestring required
serviceName'plaid' required
offsetnumber
limitnumber
orderBystring
startDatestring
endDatestring

Response

countinteger required

Example response

{
  "count": 1,
  "reports": [
    {
      "meta": {
        "reportId": "5fad8a342a88364234392fb6",
        "serviceName": "xero",
        "businessName": "Railz",
        "startDate": "2020-11-25T01:02:03Z",
        "endDate": "2020-11-30T01:02:03Z",
        "createdAt": "2020-11-25T01:02:03Z",
        "updatedAt": "2020-11-30T01:02:03Z"
      },
      "data": [
        {
          "id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
          "accountId": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
          "date": "2017-01-29",
          "authorizedOnDate": "2017-01-29",
          "amount": 100,
          "currency": "CAD",
          "transactionType": "directDebit",
          "paymentChannel": "online",
          "categories": [
            "Shops",
            "Computers and Electronics"
          ],
          "merchantName": "Apple",
          "merchantStoreNumber": "1235",
          "description": "Apple Store",
          "location": {
            "line1": "300 Post St",
            "city": "San Francisco",
            "region": "CA",
            "country": "USA",
            "postalCode": "94108"
          },
          "section": "Assets",
          "subSection": "Current Assets",
          "group": "Office General Administrative Expenses",
          "subGroup": "Office Supplies & Software"
        }
      ]
    }
  ]
}