🚀 Add bank account transaction integration

.env.example

@@ -46,6 +46,13 @@ EMAIL_SERVER_PORT=
 EMAIL_SERVER_USER=
 EMAIL_SERVER_PASSWORD=
 
+# GoCardless options
+GOCARDLESS_COUNTRY=
+GOCARDLESS_SECRET_ID=
+GOCARDLESS_SECRET_KEY=
+# Bank Transactions will be fetched from today and 30 days back as default.
+GOCARDLESS_INTERVAL_IN_DAYS=
+
 # Google Provider : https://next-auth.js.org/providers/google
 GOOGLE_CLIENT_ID=
 GOOGLE_CLIENT_SECRET=

.husky/pre-commit

@@ -1 +1,2 @@
 pnpm lint-staged
+pnpm tsc --noEmit

.nvmrc

@@ -1 +1 @@
-22.16.0
+22.16.0

README.md

@@ -113,6 +113,7 @@ pnpm i
 - Copy the env.example file into .env
 - Setup google oauth required for auth https://next-auth.js.org/providers/google or Email provider by setting SMTP details
 - Login to minio console using `splitpro` user and password `password` and [create access keys](http://localhost:9001/access-keys/new-account) and the R2 related env variables
+- If you want to use bank integration please create a free account on [GoCardless](https://gocardless.com/bank-account-data/) and then enter the the related env variables
 
 ### Run the app
 

docker/prod/compose.yml

@@ -38,6 +38,10 @@ services:
       - EMAIL_SERVER_PORT=${EMAIL_SERVER_PORT}
       - EMAIL_SERVER_USER=${EMAIL_SERVER_USER}
       - EMAIL_SERVER_PASSWORD=${EMAIL_SERVER_PASSWORD}
+      - GOCARDLESS_COUNTRY=${GOCARDLESS_COUNTRY}
+      - GOCARDLESS_SECRET_ID=${GOCARDLESS_SECRET_ID}
+      - GOCARDLESS_SECRET_KEY=${GOCARDLESS_SECRET_KEY}
+      - GOCARDLESS_INTERVAL_IN_DAYS=${GOCARDLESS_INTERVAL_IN_DAYS}
       - GOOGLE_CLIENT_ID=${GOOGLE_CLIENT_ID}
       - GOOGLE_CLIENT_SECRET=${GOOGLE_CLIENT_SECRET}
       - AUTHENTIK_ID=${AUTHENTIK_ID}

package.json

@@ -55,6 +55,7 @@
     "next-i18next": "^15.4.2",
     "next-themes": "^0.2.1",
     "nodemailer": "^6.9.8",
+    "nordigen-node": "^1.4.1",
     "radix-ui": "^1.4.2",
     "react": "19.1.0",
     "react-day-picker": "^9.7.0",

prisma/migrations/20241026095834_add_gocardless_bank_transaction_integration/migration.sql

@@ -0,0 +1,22 @@
+-- AlterTable
+ALTER TABLE "Expense" ADD COLUMN     "transactionId" TEXT;
+
+-- AlterTable
+ALTER TABLE "User" ADD COLUMN     "bankingId" TEXT,
+ADD COLUMN     "obapiProviderId" TEXT;
+
+-- CreateTable
+CREATE TABLE "CachedBankData" (
+    "id" SERIAL NOT NULL,
+    "obapiProviderId" TEXT NOT NULL,
+    "data" TEXT NOT NULL,
+    "userId" INTEGER NOT NULL,
+    "lastFetched" TIMESTAMP(3) NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "CachedBankData_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "CachedBankData_obapiProviderId_key" ON "CachedBankData"("obapiProviderId");

prisma/schema.prisma

@@ -46,6 +46,8 @@ model User {
     id                  Int                  @id @default(autoincrement())
     name                String?
     email               String?              @unique
+    obapiProviderId     String?
+    bankingId           String?
     emailVerified       DateTime?
     image               String?
     currency            String               @default("USD")
@@ -66,6 +68,16 @@ model User {
     updatedExpenses     Expense[]            @relation("UpdatedByUser")
 }
 
+model CachedBankData {
+    id              Int      @id @default(autoincrement())
+    obapiProviderId String   @unique
+    data            String
+    userId          Int
+    lastFetched     DateTime
+    createdAt       DateTime @default(now())
+    updatedAt       DateTime @updatedAt
+}
+
 model VerificationToken {
     identifier String
     token      String   @unique
@@ -161,6 +173,7 @@ model Expense {
     updatedByUser       User?                @relation(name: "UpdatedByUser", fields: [updatedBy], references: [id], onDelete: SetNull)
     expenseParticipants ExpenseParticipant[]
     expenseNotes        ExpenseNote[]
+    transactionId       String?
 
     @@index([groupId])
     @@index([paidBy])

public/locales/de/account_page.json

@@ -66,6 +66,13 @@
     "support_us": "Unterstütze uns",
     "follow_on_x": "Folge uns auf X",
     "logout": "Abmelden",
+    "choose_bank_provider": "Bankanbieter auswählen",
+    "select_bank_provider": "Bankanbieter auswählen",
+    "search_bank": "Bank suchen",
+    "no_bank_providers_found": "Keine Bankanbieter gefunden",
+    "to_bank": "an die Bank",
+    "reconnect": "Wieder verbinden",
+    "connect": "Verbinden",
     "edit_name": {
       "title": "Namen bearbeiten",
       "placeholder": "Name eingeben"

public/locales/de/expense_details.json

@@ -68,6 +68,13 @@
       "are_settled_up": "bist ausgeglichen",
       "is_settled_up": "ist ausgeglichen"
     },
+    "verified_transaction": "Verifizierte Transaktion",
+    "clear": "Löschen",
+    "bank_transactions": "Transaktionen",
+    "submit_all": "Alle senden",
+    "pending": "Ausstehend",
+    "no_transactions_yet": "Noch keine Transaktionen",
+    "already_added": "Bereits hinzugefügt",
     "errors": {
       "amount_required": "Betrag eingeben",
       "description_required": "Beschreibung eingeben",

public/locales/de/home.json

@@ -58,6 +58,10 @@
     "i18": {
       "title": "Internationalisierung",
       "description": "Verfügbar in mehreren Sprachen, um das Teilen von Ausgaben weltweit zugänglich zu machen"
+    },
+    "bank_connection": {
+      "title": "Bankverbindung",
+      "description": "Füge Ausgaben schneller hinzu mit einer Integration in GoCardless Bankkonto-Transaktions-API"
     }
   },
   "footer": {

public/locales/en/account_page.json

@@ -66,6 +66,13 @@
     "support_us": "Sponsor us",
     "follow_on_x": "Follow us on X",
     "logout": "Logout",
+    "choose_bank_provider": "Choose bank provider",
+    "select_bank_provider": "Select bank provider",
+    "search_bank": "Search bank",
+    "no_bank_providers_found": "No bank providers found",
+    "to_bank": "to bank",
+    "reconnect": "Reconnect",
+    "connect": "Connect",
     "edit_name": {
       "title": "Edit name",
       "placeholder": "Enter name"

public/locales/en/expense_details.json

@@ -69,6 +69,13 @@
       "are_settled_up": "are settled up",
       "is_settled_up": "is settled up"
     },
+    "verified_transaction": "Verified transaction",
+    "clear": "Clear",
+    "bank_transactions": "Bank transactions",
+    "submit_all": "Submit all",
+    "pending": "Pending",
+    "no_transactions_yet": "No transactions yet",
+    "already_added": "Already added",
     "errors": {
       "amount_required": ""
     }

public/locales/en/home.json

@@ -58,6 +58,10 @@
     "i18": {
       "title": "Internationalization",
       "description": "Available in multiple languages to make expense splitting accessible worldwide"
+    },
+    "bank_connection": {
+      "title": "Bank connection",
+      "description": "Add expenses faster with a integration to GoCardless bank account transactions api"
     }
   },
   "footer": {