invoiceninja/app/Helpers/Bank/Nordigen/Nordigen.php

<?php
/**
 * Invoice Ninja (https://invoiceninja.com).
 *
 * @link https://github.com/invoiceninja/invoiceninja source repository
 *
 * @copyright Copyright (c) 2023. Invoice Ninja LLC (https://invoiceninja.com)
 *
 * @license https://www.elastic.co/licensing/elastic-license
 *
 * Documentation of Api-Usage: https://developer.gocardless.com/bank-account-data/overview
 *
 * Institutions: Are Banks or Payment-Providers, which manages bankaccounts.
 *
 * Accounts: Accounts are existing bank_accounts at a specific institution.
 *
 * Requisitions: Are registered/active user-flows to authenticate one or many accounts. After completition, the accoundId could be used to fetch data for this account. After the access expires, the user could create a new requisition to connect accounts again.
 */

namespace App\Helpers\Bank\Nordigen;

use App\Helpers\Bank\Nordigen\Transformer\AccountTransformer;
use App\Helpers\Bank\Nordigen\Transformer\TransactionTransformer;

class Nordigen
{
    public bool $test_mode; // https://developer.gocardless.com/bank-account-data/sandbox

    public string $sandbox_institutionId = "SANDBOXFINANCE_SFIN0000";

    protected \Nordigen\NordigenPHP\API\NordigenClient $client;

    public function __construct()
    {
        $this->test_mode = config('ninja.nordigen.test_mode');

        if (!(config('ninja.nordigen.secret_id') && config('ninja.nordigen.secret_key')))
            throw new \Exception('missing nordigen credentials');

        $this->client = new \Nordigen\NordigenPHP\API\NordigenClient(config('ninja.nordigen.secret_id'), config('ninja.nordigen.secret_key'));

        $this->client->createAccessToken(); // access_token is valid 24h -> so we dont have to implement a refresh-cycle
    }

    // metadata-section for frontend
    public function getInstitutions()
    {
        if ($this->test_mode)
            return [$this->client->institution->getInstitution($this->sandbox_institutionId)];

        return $this->client->institution->getInstitutions();
    }

    // requisition-section
    public function createRequisition(string $redirect, string $initutionId, string $reference)
    {
        if ($this->test_mode && $initutionId != $this->sandbox_institutionId)
            throw new \Exception('invalid institutionId while in test-mode');

        return $this->client->requisition->createRequisition($redirect, $initutionId, null, $reference);
    }

    public function getRequisition(string $requisitionId)
    {
        try {
            return $this->client->requisition->getRequisition($requisitionId);
        } catch (\Exception $e) {
            if (strpos($e->getMessage(), "Invalid Requisition ID") !== false)
                return false;

            throw $e;
        }
    }

    // TODO: return null on not found
    public function getAccount(string $account_id)
    {
        try {
            $out = new \stdClass();

            $out->data = $this->client->account($account_id)->getAccountDetails()["account"];
            $out->metadata = $this->client->account($account_id)->getAccountMetaData();
            $out->balances = $this->client->account($account_id)->getAccountBalances()["balances"];
            $out->institution = $this->client->institution->getInstitution($out->metadata["institution_id"]);

            $it = new AccountTransformer();
            return $it->transform($out);
        } catch (\Exception $e) {
            if (strpos($e->getMessage(), "Invalid Account ID") !== false)
                return false;

            throw $e;
        }
    }

    public function isAccountActive(string $account_id)
    {
        try {
            $account = $this->client->account($account_id)->getAccountMetaData();

            if ($account["status"] != "READY") {
                nlog('nordigen account was not in status ready. accountId: ' . $account_id . ' status: ' . $account["status"]);
                return false;
            }

            return true;
        } catch (\Exception $e) {
            if (strpos($e->getMessage(), "Invalid Account ID") !== false)
                return false;

            throw $e;
        }
    }

    /**
     * this method returns booked transactions from the bank_account, pending transactions are not part of the result
     * @todo @turbo124 should we include pending transactions within the integration-process and mark them with a specific category?!
     */
    public function getTransactions(string $accountId, string $dateFrom = null)
    {
        $transactionResponse = $this->client->account($accountId)->getAccountTransactions($dateFrom);

        $it = new TransactionTransformer();
        return $it->transform($transactionResponse);
    }
}