openbankproject / obp-cli

A command line interface for OBP API

Open Bank Project CLI

A command line utility (CLI) to work with the Open Bank Project sandbox called obp.

With the obp cli you can:

• Initiate an api connection to the sandbox
  • note you still need to sign-up from the sandbox homepage first to create your username & password
• Get your DirectLogin token
• Get your user information
• Get your user id
• Get banks
• Get (your) accounts held at the bank

Also, depending on your account access you may:

• Create a bank account
• Add roles to a user
• Import/Delete branches
• Import dummy bank data

Install

• Requires python3
• Requires pip (see https://pip.pypa.io/en/stable/installing/)

pip install --user obp-python # Requires at least python 3

pip install obp-python # If you are using a python 3 virtual environment

Warning: If your operating system defaults to python 2, your pip command might be:

pip3 install --user obp-python
#or 
pip3.6 install --user obp-python

Usage

Usage: obp [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  addaccount              📁 Add a bank account
  addbank                 🏦 Add a bank
  addcustomer             🧙 Add a customer
  addfx                   📉 Add exchange rate (FX)
  addrole                 🚧 Add a role for current user
  adduser                 📝 Add a user
  addview                 🧐 Add a view
  answerconsent           🚧 Answer consent
  createconsent           🚧 Add a consent
  deletebranches          ⚠️ 🏦 Delete all branches
  deletecardbyid          ⚠️ 💳 Delete card by id
  getaccountbyid          📁 Get account by id (includes balance)
  getaccountsheld         📁 Get list of accounts held
  getaccounttransactions  📁 Get transactions for an account
  getauth                 🔑 Get your DirectLogin token
  getbanks                🏦 Get list of banks
  getcardbyid             💳 Get card by id
  getcardbynumber         💳 Get card by card number
  getcards                💳 Get list of cards at bank
  getconsents             🚧 Get consents
  getconsentstatus        🚧 Get consent status- with certificate
  getcustomers            👥 Get list of customers
  getuser                 😃 Get your user info
  getuserid               📋 Get your user id
  getuseridbyusername     📋 Get user id by username
  getusers                😃 Get all users
  importaccounts          🚜 Import accounts from spreadsheet template
  importatms              🚜 Import atms from spreadsheet template
  importbranches          🚜 Import branches from spreadsheet template
  importcardattribues     🚜 Import card attributes from spreadsheet template
  importcards             🚜 Import cards from spreadsheet template
  importcustomers         🚜 Import customers from spreadsheet template
  importfx                🚜 📉 Load all foreign exchange rates (FX) to all...
  importtransactions      🚜 Import transactions from spreadsheet template
  importusers             🚜 Import users from spreadsheet template
  init                    💡 Initalize connection to your Open Bank Project...
  linkusertocustomer      🔗 Link user to a customer
  revokeconsent           🚧 Revoke consent
  sandboximport           🚜 Bulk import sandbox data from json input

Examples

You must initalize the obp cli once, by doing:

obp init

Generate Direct Login Token

obp init 
Please enter your API_HOST: api.example.com
Please enter your username:
Please enter your password: : 
Repeat for confirmation: 
... generating direct login token
Please enter your OBP_CONSUMER_KEY: # Go to api.example.com, then "Get API Key" to generate consumer key.
obp getauth # Displays your DirectLogin token

Create Bulk Users for load testing

obp bulkcreateusers --name-prefix=magniaffaffel --number-users=3 --number-transactions=3 --bank-id=rbs --seed-account-id=26fa77a2-028f-4022-b47d-26caa8db359b --seed-bank-id=rbs --seed-account-currency=GBP

Will create Users up to --number-users, username will be --name-prefix + usernumber (iterated per user starting from 1 till --number-users) with 5 Accounts with each having --number-transactions transactions. Needs a seed account to make the transactions from.

Contributing

Note You can ignore this is your just using the utlity. This is just for developing the utlity.

To work on this utility as a developer:

Building

# Setup python3 environment
virtualenv -p python3 venv
. venv/bin/activate
git clone <this-repo>
# Building wheels etc
python setup.py sdist bdist_wheel
# Installing your edits locally:
pip install -e <path-to-this-repo> # -e means Install  a  project  in editable mode (i.e.  setuptools "developmode")
# Work on utility..submit pull request 

Update history

• 0.19 Added sandboximport utility obp sandboximport --example
• 0.0.9 Switch to use OBP_API_HOST instead of OBP_ENDPOINT

obp-cli's Issues

Import Users from spreadsheet template

For demos, banks and fin-techs often provide spreadsheets of example data they want to show for an app demo or online banking with a small dataset. This includes bank accounts.

Scenario: Import Users from spreadsheet
Ability to import Users based on a standard template.

We already provide this facility for importing branches and accounts , so long as the user provides a valid Users template, we can import them via obp cli.

Add delete card to obp

• Blocking #43 Create Card import template

Import Loans from spreadsheet template

For demos, banks and fin-techs often provide spreadsheets of example data they want to show for an app demo or online banking with a small dataset. This includes bank accounts.

Scenario: Import Loans from spreadsheet
Ability to import Loans based on a standard template.

We already provide this facility for importing branches and accounts , so long as the user provides a valid Loans template, we can import them via obp cli.

• Blocked by #40

Revoke consent via cli

Add delete cards obp

Blocking #43 Create card import template

Create Card attributes import template

Related:

• Card import template #43

Customer number not being set during import

Implement getCardByCardNumber

Ability to add roles by bank_id and another user_id

Allow importing of bank data via templated spreadsheets

Background:
Often banks and fintechs want to present a demo scenario to their stakeholders showing them an app or website running with some small sample data they have prepared especially for a demo. The motivation for this issue is to allow non technical users to provide the data they want to demo, in a structured form so that it may easily be imported into Open Bank Project via the CLI.

Scenario: Importing banking related data for the purposes of demos

When I have some sample bank data, then I expect to be able to locate a spreadsheet template for this data.
When I submit this template filled in correctly , then I expect the OBP CLI tool to be able to import this data for me into my Open Bank Project sandbox.

Create a withdrawal account for dummy transaction imports

OBP only supports the transfer of money from/to an account.
To simulate a withdrawal for the purposes of dummy data demonstrations, a 'withdrawal' account needs to be created.

Include branch_routing schema and address during import of branches from template

Scenario: Importing branches from sheet
When the sheet template includes branch_routing scheme and address, include this data in the import.

Currently the importer hard codes it to:
"branch_routing":{ "scheme":"OBP", "address":"123abc" }

Get consents via cli

Add from_account_id to transactions import template

Import Customers from spreadsheet template

For demos, banks and fin-techs often provide spreadsheets of example data they want to show for an app demo or online banking with a small dataset. This includes bank accounts.

Scenario: Import customers from spreadsheet
Ability to import customers based on a standard template.

We already provide this facility for importing branches and accounts , so long as the user provides a valid customer template, we can import them via obp cli.

Answer consent challenge via cli

Implement answerConsentChallenge

See
https://apiexplorersandbox.openbankproject.com/#OBPv3_1_0-answerConsentChallenge

/obp/v3.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge

{  "answer":"12345678"}

Import Transactions from spreadsheet template

For demos, banks and fin-techs often provide spreadsheets of example data they want to show for an app demo or online banking with a small dataset. This includes bank accounts.

Scenario: Import Transactions from spreadsheet
Ability to import Transactions based on a standard template.

We already provide this facility for importing branches and accounts , so long as the user provides a valid Transaction template, we can import them via obp cli.

Create Card import template

implement getconsent status cli

curl -X GET \
  http://127.0.0.1:8080/berlin-group/v1.3/consents/CONSENTID/status \
  -H 'Authorization: DirectLogin token=eyJhbGciOiJIUzI1NiJ9.eyIiOiIifQ.xflStTeAfTvHJNkKhZsajHJ2yhbLVOgG5dJmuhjTcLQ' \
  -H 'Cache-Control: no-cache' \
  -H 'PSD2-CERT: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' \

Check permissions before importing to ensure data integrity during import

Verify canCreateAnyTransactionRequest and CanCreateAccount permissions before performing accounts import

• CanCreateAccount - for account creation
• canCreateAnyTransactionRequest needed for setting initial balance

Ability to create views via cli

obp addview

Create Product import template

Blocks

• #42 Create product attributes import
• #30 Import loans from sheet

Implement get customers (via `/obp/v3.1.0/banks/BANK_ID/firehose/customers`)

Blocking #43

Call update customer number api during import

Call PATCH /obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/number during customer import

Import historical transactions with date

Ability to import transactions with date set

Using api call: /obp/v3.1.0/management/historical/transactions

curl -X POST \
  http://127.0.0.1:8080/obp/v3.1.0/management/historical/transactions \
  -H 'Accept: */*' \
  -H 'Authorization: DirectLogintoken="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyIiOiIifQ.plUgi_AdZnSt97hTQLdpdg_eGYISNjyODh5n8nC1EeE"' \
  
  -d '{
    "from": {
        "bank_id": "gh.29.uk",
        "account_id": "1"
    },
    "to": {
        "bank_id": "gh.29.uk",
        "account_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"
    },
    "value": {
        "currency": "EUR",
        "amount": "10"
    },
    "description": "this is for work2",
    "posted": "2010-09-19T02:11:29Z",
    "completed": "2016-09-19T02:31:28Z",
    "transaction_request_type": "SANDBOX_TAN",
    "charge_policy": "SHARED"
}'

openbankproject/obp-cli

pull request for user test @ github

Add new exchange rates rates to OBP

When importing transactions, exchange rates need to be present for all of the currencies being imported in order to support conversion.

otherwise we see:

OBP-10006: Invalid Currency Value. The requested currency conversion (EUR to XYZ) is not supported."} during import

Get transactions via cli

To verify transaction import easily

createCard issue

inside the cards-import-template-v1.does the last column, it is customer-number.
It should be customer-id.

I know we should use customer-number better,
but for somereason we can not create cusotmer-number in api level.
eg: https://apiexplorersandbox.openbankproject.com/?tags=#OBPv3_1_0-createCustomer

So there is no sense to use real customer-number there for now.

does not handle user passwords containing "/"

Using Customers import template, create dummy data using a 'real' dataset provided from a bank.

Create Product attributes import template

Related:

• #40

Ability to edit bank name via cli

Implement `obp linkUserCustomer`

https://apiexplorersandbox.openbankproject.com/#OBPv2_0_0-createUserCustomerLinks

add getAccounts full(including balance)

add getTransactions

Import foreign exchange rates

Problem: Cannot quickly import fx rates into new sandbox

Solution: Add ability do obp importfx

Notes:

Use package https://github.com/chrisjsimpson/fx2obp which already has the ability to post fx rates to an obp sandbox.

Implement email CreateConsent cli

e.g https://apiexplorersandbox.openbankproject.com/#OBPv3_1_0-createConsentEmail

Create initial balance during import

If an account has an initial balance specified on the sheet, then create an transaction request to set the initial balance.

ability to update and upload datas for Customers, Loans, Accounts, Transactions

Scenario: Adding and Updating entities
As a boostrap user, I would like to have the ability to update and upload data for Customers, Loans, Accounts, Transactions.

Ability to create consents of a type via cli

https://apiexplorersandbox.openbankproject.com/#group-Consent

Individual account Users need the `CanCreateAccount` permissions in order for account imports to be accepted

Import bank accounts from spreadsheet template

For demos, banks and fin-techs often provide spreadsheets of example data they want to show for an app demo or online banking with a small dataset. This includes bank accounts.

Scenario: Import bank accounts from spreadsheet
Ability to import accounts based on a standard template.

We already provide this facility for importing branches , so long as the user provides a valid branches template, then can import via obp importbranches.
This issue is to add the same for accounts.