Open Banking Api (0.0.1)

Download OpenAPI specification:Download

Authentication

BearerAuth

Security scheme type:	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Authorization

Return authentication url

query Parameters

client_id	integer Example: client_id=tpp
redirect_uri	integer Example: redirect_uri=https%3A%2F%2Ftpp.to%2Fsucccess
scope	string Example: scope=accounts%3Alist%20accounts%20payments%20consents%20funds%3Aconfirmation
state	string Example: state=12as3d56xc1zx3

Responses

200

400

invalid_parameters

403

payment_institution_not_allowed

get /v1/open-banking/authentication-url

/v1/open-banking/authentication-url

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"redirect_uri": "https://tpp.com/redirect"

}

Exchange authorization code or refresh token to access token

Request Body schema: application/json

One of

object
object

code	string
grant_type	string
client_id	string
client_secret	string
redirect_uri	string

Responses

200

Access tokens

400

invalid_parameters

403

payment_institution_not_allowed

post /v1/open-banking/token

/v1/open-banking/token

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"code": "e90ujhnckadsbhoiu8qewh1p2e8jhpsbalsdchp9a8ewuhpcdsngja09sdir2qrnljdhfiuosadhfp9a8wesurfjpaosdgpwrfpasradpp",
"grant_type": "authorization_code",
"client_id": "tpp",
"client_secret": "tpp_secret",
"redirect_uri": "https://tpp.com/redirect"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"token_type": "Bearer",
"expires_in": 3600,
"access_token": "jwtlkalksdklaskld",
"refresh_token": "qoiweioqioweoqwoie"

}

Payments

Create new payment

Authorizations:

BearerAuth

Request Body schema: application/json

amount	string
currency	string
sender_account	string
receiver_account	string
receiver_bic	string
receiver_full_name	string
receiver_country_code	string
receiver_city	string
receiver_street	string
receiver_street_number	string
details	string
redirect_uri	string

Responses

200

400

invalid_parameters

401

Access token is missing or invalid

403

forbidden
payment_institution_not_allowed

post /v1/open-banking/payments

/v1/open-banking/payments

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"amount": "10.00",
"currency": "eur",
"sender_account": "LT330006100519786457841326",
"receiver_account": "TR330006100519786457841326",
"receiver_bic": "AKBBTR21312",
"receiver_full_name": "uab Testuva",
"receiver_country_code": "tr",
"receiver_city": "Vilnius",
"receiver_street": "Klaipedos",
"receiver_street_number": "10a",
"details": "payment for something",
"redirect_uri": "https://tpp.com/authredirect"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"id": "922ec9531b1f94add983a8ce2ebdc97d",
"amount": "10.00",
"currency": "eur",
"sender_account": "LT330006100519786457841326",
"receiver_account": "TR330006100519786457841326",
"receiver_bic": "AKBBTR21312",
"receiver_full_name": "uab Testuva",
"receiver_country_code": "tr",
"receiver_city": "Vilnius",
"receiver_street": "Klaipedos",
"receiver_street_number": "10a",
"details": "payment for something"

}

Get payment by id

Authorizations:

BearerAuth

path Parameters

paymentId

required

string

Example: 12sad8412x3c5a4sd812zxc315asd4

Responses

200

401

Access token is missing or invalid

403

forbidden
payment_institution_not_allowed

get /v1/open-banking/payments/{paymentId}

/v1/open-banking/payments/{paymentId}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"id": "922ec9531b1f94add983a8ce2ebdc97d",
"amount": "10.00",
"currency": "eur",
"sender_account": "LT330006100519786457841326",
"receiver_account": "TR330006100519786457841326",
"receiver_bic": "AKBBTR21312",
"receiver_full_name": "uab Testuva",
"receiver_country_code": "tr",
"receiver_city": "Vilnius",
"receiver_street": "Klaipedos",
"receiver_street_number": "10a",
"details": "payment for something"

}

Accounts

Get account list without PSU consent. accounts:list scope is needed

Authorizations:

BearerAuth

Responses

200

401

Access token is missing or invalid

403

forbidden
payment_institution_not_allowed

get /v1/open-banking/accounts-list

/v1/open-banking/accounts-list

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Get account list with PSU consent. accounts scope is needed

Authorizations:

BearerAuth

Responses

200

401

Access token is missing or invalid

403

forbidden
payment_institution_not_allowed

get /v1/open-banking/accounts

/v1/open-banking/accounts

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Get accounts list with PSU consent. accounts scope is needed

Authorizations:

BearerAuth

path Parameters

accountId

required

string

Example: 12sad8412x3c5a4sd812zxc315asd4

Responses

200

401

Access token is missing or invalid

403

forbidden
payment_institution_not_allowed

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

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

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Get accounts list with PSU consent. accounts scope is needed

Authorizations:

BearerAuth

path Parameters

accountId

required

string

Example: 922ec9531b1f94add983a8ce2ebdc97d

Responses

200

401

Access token is missing or invalid

403

forbidden
payment_institution_not_allowed

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

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

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Get accounts list with PSU consent. accounts scope is needed

Authorizations:

BearerAuth

path Parameters

accountId

required

string

Example: 922ec9531b1f94add983a8ce2ebdc97d

query Parameters

date_from required	string Example: date_from=2019-09-01
date_to required	string <date> Example: date_to=2019-09-01
page required	number Example: page=1

Responses

200

400

invalid_parameters

401

Access token is missing or invalid

403

forbidden
payment_institution_not_allowed

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

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

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"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

}

Funds

Check funds availability

Authorizations:

BearerAuth

Request Body schema: application/json

account	object
instructed_amount	object

Responses

200

400

invalid_parameters

403

forbidden
payment_institution_not_allowed

post /v1/open-banking/funds-confirmations

/v1/open-banking/funds-confirmations

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"account":
{
- "iban": "LT9451465134843514548454"
},
"instructed_amount":
{
- "currency": "eur",
- "amount": "10.00"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"funds_available": true

}