For the complete documentation index, see llms.txt. This page is also available as Markdown.

Bank

Manage banks and accounts in VARIO Cloud, including connections, authentication, account sync, transaction downloads, and CRUD operations via REST API.

Banks and accounts

Find an existing Resource by identifier

get
Path parameters
idinteger · int64Required

an identifier

Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Creditor identifier.

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Is the bank active?

Default: true
logoUrlstringOptional

Bank logo URL.

get/erp/bank/{id}
GET /erp/bank/{id} HTTP/1.1
Host: api.example.com
Accept: */*
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [],
  "providerId": 1,
  "userForSyncRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "active": true,
  "logoUrl": "text"
}

Update existing Resource

put
Path parameters
idinteger · int64Required

Bank identifier.

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Creditor identifier.

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Is the bank active?

Default: true
logoUrlstringOptional

Bank logo URL.

Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Creditor identifier.

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Is the bank active?

Default: true
logoUrlstringOptional

Bank logo URL.

put/erp/bank/{id}
PUT /erp/bank/{id} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text"
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "accounts": [],
  "providerId": 1,
  "userForSyncRef": {
    "id": "text"
  },
  "logoUrl": "text"
}
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [],
  "providerId": 1,
  "userForSyncRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "active": true,
  "logoUrl": "text"
}

Delete an existing Resource

delete
Path parameters
idinteger · int64Required

an identifier

Responses
200

successful operation

application/json
contextstringOptional

message context

messageValuestringOptional

message

delete/erp/bank/{id}
DELETE /erp/bank/{id} HTTP/1.1
Host: api.example.com
Accept: */*
{
  "context": "text",
  "messageValue": "text"
}

Deactivate an existing resource

put
Path parameters
idinteger · int64Required

identifier

Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Creditor identifier.

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Is the bank active?

Default: true
logoUrlstringOptional

Bank logo URL.

put/erp/bank/{id}/deactivate
PUT /erp/bank/{id}/deactivate HTTP/1.1
Host: api.example.com
Accept: */*
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [],
  "providerId": 1,
  "userForSyncRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "active": true,
  "logoUrl": "text"
}

Activate an existing resource

put
Path parameters
idinteger · int64Required

identifier

Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Creditor identifier.

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Is the bank active?

Default: true
logoUrlstringOptional

Bank logo URL.

put/erp/bank/{id}/activate
PUT /erp/bank/{id}/activate HTTP/1.1
Host: api.example.com
Accept: */*
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [],
  "providerId": 1,
  "userForSyncRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "active": true,
  "logoUrl": "text"
}

Create new Resource

post
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Creditor identifier.

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Is the bank active?

Default: true
logoUrlstringOptional

Bank logo URL.

Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Creditor identifier.

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Is the bank active?

Default: true
logoUrlstringOptional

Bank logo URL.

post/erp/bank
POST /erp/bank HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text"
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "accounts": [],
  "providerId": 1,
  "userForSyncRef": {
    "id": "text"
  },
  "logoUrl": "text"
}
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [],
  "providerId": 1,
  "userForSyncRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "active": true,
  "logoUrl": "text"
}
post
Path parameters
idinteger · int64Required

Bank identifier.

Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

post/erp/bank/{id}/new_connection
POST /erp/bank/{id}/new_connection HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "context": "text",
  "messageValue": "text"
}
post
Path parameters
idinteger · int64Required

Bank identifier.

Responses
200

OK

application/json
booleanOptional
post/erp/bank/{id}/authentication_status
POST /erp/bank/{id}/authentication_status HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

true
get
Path parameters
idinteger · int64Required

Bank identifier.

Responses
200

OK

application/json

accounts

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bankIdinteger · int64Optional

id of the bank

labelstringOptional

description

ibanstringOptional

IBAN

accountNumberstringOptional

account number

subAccountNumberstringOptional

sub account number

holderNamestringOptional

account holder

currencystringOptional

currency

accountCreditnumberOptional

Current account amount.

sortOrderinteger · int32Optional

Account position.

defaultBankAccountbooleanOptional

Default account.

Default: false
activebooleanOptional

Is this active?

externalReferenceIdstringRead-onlyOptional

Reference identifier from an external system.

balancenumberOptional

Account balance.

get/erp/bank/{id}/accounts
GET /erp/bank/{id}/accounts HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

[]
post
Path parameters
idinteger · int64Required

Bank identifier.

Body

accounts

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bankIdinteger · int64Optional

id of the bank

labelstringOptional

description

ibanstringOptional

IBAN

accountNumberstringOptional

account number

subAccountNumberstringOptional

sub account number

holderNamestringOptional

account holder

currencystringOptional

currency

accountCreditnumberOptional

Current account amount.

sortOrderinteger · int32Optional

Account position.

defaultBankAccountbooleanOptional

Default account.

Default: false
activebooleanOptional

Is this active?

externalReferenceIdstringRead-onlyOptional

Reference identifier from an external system.

balancenumberOptional

Account balance.

Responses
200

OK

application/json

accounts

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bankIdinteger · int64Optional

id of the bank

labelstringOptional

description

ibanstringOptional

IBAN

accountNumberstringOptional

account number

subAccountNumberstringOptional

sub account number

holderNamestringOptional

account holder

currencystringOptional

currency

accountCreditnumberOptional

Current account amount.

sortOrderinteger · int32Optional

Account position.

defaultBankAccountbooleanOptional

Default account.

Default: false
activebooleanOptional

Is this active?

externalReferenceIdstringRead-onlyOptional

Reference identifier from an external system.

balancenumberOptional

Account balance.

post/erp/bank/{id}/accounts
POST /erp/bank/{id}/accounts HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "version": "text",
  "info": {},
  "id": "text",
  "bankId": 1,
  "label": "text",
  "iban": "text",
  "accountNumber": "text",
  "subAccountNumber": "text",
  "holderName": "text",
  "currency": "text",
  "accountCredit": 1,
  "sortOrder": 1,
  "defaultBankAccount": false,
  "active": true,
  "balance": 1
}
200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bankId": 1,
  "label": "text",
  "iban": "text",
  "accountNumber": "text",
  "subAccountNumber": "text",
  "holderName": "text",
  "currency": "text",
  "accountCredit": 1,
  "sortOrder": 1,
  "defaultBankAccount": false,
  "active": true,
  "externalReferenceId": "text",
  "balance": 1
}
post
Path parameters
idinteger · int64Required

Bank identifier.

Bodystring[]
string[]Optional

Reference identifiers of the accounts to import.

Responses
200

OK

application/json

accounts

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bankIdinteger · int64Optional

id of the bank

labelstringOptional

description

ibanstringOptional

IBAN

accountNumberstringOptional

account number

subAccountNumberstringOptional

sub account number

holderNamestringOptional

account holder

currencystringOptional

currency

accountCreditnumberOptional

Current account amount.

sortOrderinteger · int32Optional

Account position.

defaultBankAccountbooleanOptional

Default account.

Default: false
activebooleanOptional

Is this active?

externalReferenceIdstringRead-onlyOptional

Reference identifier from an external system.

balancenumberOptional

Account balance.

post/erp/bank/{id}/accounts/sync
POST /erp/bank/{id}/accounts/sync HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
200

OK

[]
post
Path parameters
bankIdinteger · int64Required

Bank identifier.

Body
importNewAccountsbooleanOptional

Should new bank accounts be imported?

Default: false
manageSavedSettingsstring · enumOptional

Should the stored consents be edited?

Default: NONEPossible values:
Responses
200

OK

application/json
idstringOptional

External task identifier.

createdAtstring · date-timeOptional

When the task was created.

statusstring · enumOptional

What the current task status is.

Possible values:
post/erp/bank/update_connection/{bankId}
POST /erp/bank/update_connection/{bankId} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "importNewAccounts": false,
  "manageSavedSettings": "NONE"
}
200

OK

{
  "id": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "status": "NOT_YET_STARTED",
  "payload": {
    "bankConnectionId": 1,
    "paymentId": 1,
    "standingOrderId": 1
  },
  "webform": {
    "webformId": "text",
    "type": "BANK_CONNECTION_IMPORT",
    "status": "NOT_YET_OPENED",
    "payload": {
      "bankConnectionId": 1,
      "paymentId": 1,
      "standingOrderId": 1
    },
    "expiresAt": "2026-01-01T00:00:00.000Z",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "url": "text"
  }
}
post
Path parameters
backendTypestring · enumRequired

Banking interface.

Possible values:
providerIdinteger · int64Required

Banking provider identifier.

Responses
200

OK

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Creditor identifier.

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Is the bank active?

Default: true
logoUrlstringOptional

Bank logo URL.

post/erp/bank/sync/{backendType}/{providerId}
POST /erp/bank/sync/{backendType}/{providerId} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

[]
post
Path parameters
bankIdinteger · int64Required

Bank identifier.

Responses
200

OK

application/json
idstringOptional

External task identifier.

createdAtstring · date-timeOptional

When the task was created.

statusstring · enumOptional

What the current task status is.

Possible values:
post/erp/bank/start_transaction_download/{bankId}
POST /erp/bank/start_transaction_download/{bankId} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "id": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "status": "NOT_YET_STARTED",
  "payload": {
    "bankConnectionId": 1,
    "paymentId": 1,
    "standingOrderId": 1
  },
  "webform": {
    "webformId": "text",
    "type": "BANK_CONNECTION_IMPORT",
    "status": "NOT_YET_OPENED",
    "payload": {
      "bankConnectionId": 1,
      "paymentId": 1,
      "standingOrderId": 1
    },
    "expiresAt": "2026-01-01T00:00:00.000Z",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "url": "text"
  }
}
get
Path parameters
idinteger · int64Required

Bank identifier.

Responses
200

OK

application/json
descriptionstringOptional

Description of the action

typestring · enumOptional

action type

Possible values:
expirationstring · date-timeOptional

Expiration of the action

get/erp/bank/{id}/actions
GET /erp/bank/{id}/actions HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

[]
get
Path parameters
backendTypestring · enumRequired

Banking interface.

Possible values:
searchTermstringRequired

Search term.

providerIdinteger · int64Required

Banking provider identifier.

Responses
200

OK

application/json
referenceIdstringOptional

reference id

labelstringOptional

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

logoUrlstringOptional

Bank logo URL.

get/erp/bank/search/{backendType}/{searchTerm}/{providerId}
GET /erp/bank/search/{backendType}/{searchTerm}/{providerId} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

[]
get
Path parameters
bankIdinteger · int64Required

Bank identifier.

webformIdstringRequired

webformIdentifier

Responses
200

OK

application/json

Information about a webform, if one was created.

webformIdstringOptional

web form Id

typestring · enumOptional

web form Type

Possible values:
statusstring · enumOptional

web form Status

Possible values:
expiresAtstring · date-timeOptional

time expires at

createdAtstring · date-timeOptional

time created At

urlstringOptional

web form Url

get/erp/bank/get_webform_by_id/{bankId}/{webformId}
GET /erp/bank/get_webform_by_id/{bankId}/{webformId} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "webformId": "text",
  "type": "BANK_CONNECTION_IMPORT",
  "status": "NOT_YET_OPENED",
  "payload": {
    "bankConnectionId": 1,
    "paymentId": 1,
    "standingOrderId": 1
  },
  "expiresAt": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "url": "text"
}
get
Path parameters
bankIdinteger · int64Required

Bank identifier.

taskIdstringRequired

taskIdentifier

Responses
200

OK

application/json
idstringOptional

External task identifier.

createdAtstring · date-timeOptional

When the task was created.

statusstring · enumOptional

What the current task status is.

Possible values:
get/erp/bank/get_external_task/{bankId}/{taskId}
GET /erp/bank/get_external_task/{bankId}/{taskId} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "id": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "status": "NOT_YET_STARTED",
  "payload": {
    "bankConnectionId": 1,
    "paymentId": 1,
    "standingOrderId": 1
  },
  "webform": {
    "webformId": "text",
    "type": "BANK_CONNECTION_IMPORT",
    "status": "NOT_YET_OPENED",
    "payload": {
      "bankConnectionId": 1,
      "paymentId": 1,
      "standingOrderId": 1
    },
    "expiresAt": "2026-01-01T00:00:00.000Z",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "url": "text"
  }
}

Liefert den Verbindungszustand der Bank aus der Bankschnittstelle

get

Ist die gespeicherte Bankverbindung der Schnittstelle unbekannt, wird sie auf eine noch vorhandene Verbindung desselben Instituts umgestellt. Gibt es keine, wird die veraltete Zuordnung entfernt und der Zustand gemeldet — die Bank muss dann neu autorisiert werden.

Path parameters
bankIdinteger · int64Required

Bank identifier.

Responses
200

successful operation

application/json
referenceIdstringOptional
bankReferenceIdstringOptional
labelstringOptional
bankNamestringOptional
bicstringOptional
blzstringOptional
lastManualUpdatestring · date-timeOptional
lastManualUpdateMessagestringOptional
lastManualUpdateStatestring · enumOptionalPossible values:
lastAutoUpdatestring · date-timeOptional
lastAutoUpdateMessagestringOptional
lastAutoUpdateStatestring · enumOptionalPossible values:
consentExpiresAtstring · date-timeOptional
get/erp/bank/get_external_state/{bankId}
GET /erp/bank/get_external_state/{bankId} HTTP/1.1
Host: api.example.com
Accept: */*
{
  "referenceId": "text",
  "bankReferenceId": "text",
  "label": "text",
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "lastManualUpdate": "2026-01-01T00:00:00.000Z",
  "lastManualUpdateMessage": "text",
  "lastManualUpdateState": "OK",
  "lastAutoUpdate": "2026-01-01T00:00:00.000Z",
  "lastAutoUpdateMessage": "text",
  "lastAutoUpdateState": "OK",
  "consentExpiresAt": "2026-01-01T00:00:00.000Z"
}
delete
Path parameters
idinteger · int64Required

Unique identifier.

Responses
200

OK

No content

delete/erp/bank/{id}/delete_connection
DELETE /erp/bank/{id}/delete_connection HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

No content

delete
Path parameters
backendTypestring · enumRequiredPossible values:
Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

delete/erp/bank/reset_for_provider_type/{backendType}
DELETE /erp/bank/reset_for_provider_type/{backendType} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "context": "text",
  "messageValue": "text"
}

Last updated

Was this helpful?