Open Banking
Get connected open banking accounts
API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Open Banking
Get connected open banking accounts
Get all connected open banking accounts, which allows to access transactions, balances and other information
Required permissions:open-banking-account:readGET
/
open-banking-accounts
curl -X GET \
/open-banking-accounts \
--header "Authorization: Bearer <token>"{
"data": [
{
"id": "ad8f1b9e-0b1e-4e1a-8e0a-0b0b0b0b0b0b",
"alias": "My Bank Account",
"bankName": "My Bank",
"iban": "DE1234567*********5678",
"status": "linked",
"provider": "klarna",
"createdAt": "2021-01-01T00:00:00+00:00",
"validUntil": "2021-01-01T00:00:00+00:00",
"lastAccessedAt": "2021-01-01T00:00:00+00:00",
"lastInformedAt": "2021-01-01T00:00:00+00:00"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Authorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
Required range:
0 <= x <= 100Response
200
application/json
OpenBankingAccount collection
Example:
"ad8f1b9e-0b1e-4e1a-8e0a-0b0b0b0b0b0b"
Example:
"My Bank Account"
Example:
"My Bank"
Example:
"DE1234567*********5678"
Possible values:
linked: The account is linked and can be used for fetching transactionsdisabled: The account is disabled and cannot be used for fetching transactionsexpired: The account access is expired (usally after 90 days) and cannot be used for fetching transactionsfailed: The account linking is failed. Try to link the account again
Available options:
linked, disabled, expired, failed Example:
"linked"
Possible values:
klarna: The account is linked with Klarna
Available options:
klarna Example:
"klarna"
Example:
"2021-01-01T00:00:00+00:00"
The date when the account access expires and a new consent is required
Example:
"2021-01-01T00:00:00+00:00"
The last time the system accessed the account to obtain data
Example:
"2021-01-01T00:00:00+00:00"
The last time the user was informed about the account expiration
Example:
"2021-01-01T00:00:00+00:00"
Was this page helpful?
curl -X GET \
/open-banking-accounts \
--header "Authorization: Bearer <token>"{
"data": [
{
"id": "ad8f1b9e-0b1e-4e1a-8e0a-0b0b0b0b0b0b",
"alias": "My Bank Account",
"bankName": "My Bank",
"iban": "DE1234567*********5678",
"status": "linked",
"provider": "klarna",
"createdAt": "2021-01-01T00:00:00+00:00",
"validUntil": "2021-01-01T00:00:00+00:00",
"lastAccessedAt": "2021-01-01T00:00:00+00:00",
"lastInformedAt": "2021-01-01T00:00:00+00:00"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}