Accounts API

Endpoints

You can find more detailed API Docs here

GET /v1/open-banking/accounts-list

Required scope to access endpoint: accounts:list OR accounts

Response:

{
  "accounts": [
    {
      "iban": "LT9451465134843514548454",
      "currency": "eur",
      "name": "Account name"
    }
  ]
}

GET /v1/open-banking/accounts

Required scope to access endpoint: accounts.

User must allow you to access accounts information.

Response:

{
  "accounts": [
    {
      "resource_id": "922ec9531b1f94add983a8ce2ebdc97d",
      "iban": "LT9451465134843514548454",
      "currency": "eur",
      "name": "Account name"
    }
  ]
}

GET /v1/open-banking/accounts/{accountId}

Required scope to access endpoint: accounts.

User must allow you to access accounts information.

Response:

{
  "resource_id": "922ec9531b1f94add983a8ce2ebdc97d",
  "iban": "LT9451465134843514548454",
  "currency": "eur",
  "name": "Account name"
}

GET /v1/open-banking/accounts/{accountId}/balances

Required scope to access endpoint: accounts.

User must allow you to access accounts balances.

Response:

{
  "account": {
    "iban": "LT9451465134843514548454"
  },
  "balances": [
    {
      "balance_type": "basic",
      "reference_date": "2019-11-06",
      "balance_amount": {
        "currency": "eur",
        "amount": "10.00"
      }
    }
  ]
}

GET /v1/open-banking/accounts/{accountId}/transactions

Required scope to access endpoint: accounts.

User must allow you to access accounts transactions.

query_param	required	description
date_from	true	Start date
date_to	true	End date, period should not exceed 3 months
page	false	Page of list, positive integer

Response:

{
  "account": {
    "iban": "LT9451465134843514548454"
  },
  "transactions": [
    {
      "transaction_id": "922ec9531b1f94add983a8ce2ebdc97d",
      "debtor_name": "Mark Debtor",
      "debtor_account": {
        "iban": "LT9451465134843514548454"
      },
      "creditor_name": "Dwain Creditor",
      "creditor_account": {
        "iban": "LT9451465134843514548454"
      },
      "transaction_amount": {
        "currency": "eur",
        "amount": "10.00"
      },
      "booking_date": "2019-09-01T00:00:00.000Z",
      "value_date": "2019-09-01T00:00:00.000Z",
      "remittance_information_unstructured": "details of transaction"
    }
  ],
  "page": 1,
  "limit": 1,
  "total": 1,
  "total_pages": 1
}