finn-bank-api v1.25.1

Finn Bank API

This application acts as a standalone app to serve data for Bank integration.

To simulate a realistic scenario, the following APIs are included:

GET /balance: Get balance of all accounts
GET /accounts/interestrates: Get interest rates of all accounts
GET /transactions: Get transactions for a certain account
GET /billpayees: Get all bill payees
GET /etransferpayees: Get all e-transfer payees
POST /payments: Make a payment - bill, e-transfer, self
GET /payment: Get payment history
GET /etransfers/recipients: Get recipient auto deposit information
GET /retrieveURL/accounts/orderchecks: Get the URL to order the checks
POST /card/status: To freeze and unfreeze a card.

See docs for details.

Running the service

To build the service first build it using "npm run build" - There is just one optional argument for ENV_CODE. If no ENV_CODE is passed as an argument, it will be built using ENV_CODE=local

To run the service after it has been build run "npm run start"

Running with Kubernetes

Finn Bank API can be run locally against a dev Kubernetes bot through Tilt.dev. Setup and running instructions can be found in this confluence document.

Locale-based mock data

Finn Bank API now contains two sets of mock data: 1. American English data (locale en-US) 2. American Spanish data (locale es-US)

By default, American English (en-US) data is used. Only if the client_id is specified in Vault as a key in the CUSTOM_LOCALE_MAPPING object, data for another supported locale (currently just es-US) will be used instead, as specified in the value.

Example:

CUSTOM_LOCALE_MAPPING = {
  "banco-xyz": "es-US"
}
DEFAULT_LOCALE = "en-US"

TODO

• Full test coverage. Need to check responses conform to expected types and headers