Czech-BA / COBS

This repository contains the technical form of the Czech Standard for Open Banking defined by the CBA working group.
29 stars 7 forks source link

Define "COBS miniAPI" endpoints for AISP (V2) #6

Open petrdvorak opened 6 years ago

petrdvorak commented 6 years ago

Currently, doing simple stuff, such as obtaining a "variable symbol" or account balance, is painful with COBS standard. I understand the philosophy of COBS being an "assembly language" for open banking data. However, since the implementations are (and probably will remain) slightly fragmented among the banks and I still need to have 5 COBS generators, I would like to propose a "COBS miniAPI" endpoints, suitable mainly for accounting software and apps that do not require such level of precision as current COBS provides.

It would provide following simplified endpoints:

Account List

Returns list of all current and savings accounts (generally, payment accounts that have IBAN as an identifier).

GET /miniapi/accounts

{
    "accounts": [
        {
            "id": "CZ0555000000000000000123",
            "name": "John's Current Account",
            "productName": "Current Account Basic",
            "accountNumber": "CZ0555000000000000000123",
            "ownerName": "John Doe",
            "balance": {
                "disposable": 100.00,
                "current": 100.00,
                "currency": "CZK"
            }
        }
    ]
}

List of Transactions

Returns all transactions in a given month.

GET /miniapi/accounts/{id}/transactions?period=2018-02

{
    "transactions": [
        {
            "id": "1332555123",
            "amount": {
                "value": 100.00,
                "currency": "CZK"
            },
            "party": {
                "name": "Mark Weinstein",
                "identification": "CZ0555000000000000000123"
            },
            "date": "2018-03-22",
            "symbols": {
                "variable": "1234567890",
                "specific": "1234567890",
                "constant": "0308"
            },
            "description": "Regular Domestic Payment",
            "noteForSender": "Payment for a lunch",
            "noteForRecipient": "Payment for a lunch"
        }
    ]
}