Bank
Manage banks and accounts in VARIO Cloud, including connections, authentication, account sync, transaction downloads, and CRUD operations via REST API.
Banks and accounts
an identifier
successful operation
Version Identifier for this Object (for PUT)
Unique identifier of the Object
description
bank name
BIC
BLZ
External BankID
Creditor identifier.
Wether a call to bank init is needed.
ID of the banking provider
Is the bank active?
trueBank logo URL.
Resource with given ID was not found
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"
}Bank identifier.
Version Identifier for this Object (for PUT)
Unique identifier of the Object
description
bank name
BIC
BLZ
External BankID
Creditor identifier.
Wether a call to bank init is needed.
ID of the banking provider
Is the bank active?
trueBank logo URL.
successful operation
Version Identifier for this Object (for PUT)
Unique identifier of the Object
description
bank name
BIC
BLZ
External BankID
Creditor identifier.
Wether a call to bank init is needed.
ID of the banking provider
Is the bank active?
trueBank logo URL.
Resource was not found
Resource was not valid to process
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"
}an identifier
successful operation
message context
message
Resource was not found
unable to delete Resource, due to constraints, existing references or internal state
DELETE /erp/bank/{id} HTTP/1.1
Host: api.example.com
Accept: */*
{
"context": "text",
"messageValue": "text"
}identifier
successful operation
Version Identifier for this Object (for PUT)
Unique identifier of the Object
description
bank name
BIC
BLZ
External BankID
Creditor identifier.
Wether a call to bank init is needed.
ID of the banking provider
Is the bank active?
trueBank logo URL.
Resource was not found
Resource was not valid to process
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"
}identifier
successful operation
Version Identifier for this Object (for PUT)
Unique identifier of the Object
description
bank name
BIC
BLZ
External BankID
Creditor identifier.
Wether a call to bank init is needed.
ID of the banking provider
Is the bank active?
trueBank logo URL.
Resource was not found
Resource was not valid to process
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"
}Version Identifier for this Object (for PUT)
Unique identifier of the Object
description
bank name
BIC
BLZ
External BankID
Creditor identifier.
Wether a call to bank init is needed.
ID of the banking provider
Is the bank active?
trueBank logo URL.
successful operation
Version Identifier for this Object (for PUT)
Unique identifier of the Object
description
bank name
BIC
BLZ
External BankID
Creditor identifier.
Wether a call to bank init is needed.
ID of the banking provider
Is the bank active?
trueBank logo URL.
Resource was not valid to process
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"
}Bank identifier.
OK
message context
message
POST /erp/bank/{id}/new_connection HTTP/1.1
Host: api.example.com
Accept: */*
OK
{
"context": "text",
"messageValue": "text"
}Bank identifier.
OK
POST /erp/bank/{id}/authentication_status HTTP/1.1
Host: api.example.com
Accept: */*
OK
trueBank identifier.
OK
accounts
Version Identifier for this Object (for PUT)
Unique identifier of the Object
id of the bank
description
IBAN
account number
sub account number
account holder
currency
Current account amount.
Account position.
Default account.
falseIs this active?
Reference identifier from an external system.
Account balance.
GET /erp/bank/{id}/accounts HTTP/1.1
Host: api.example.com
Accept: */*
OK
[]Bank identifier.
accounts
Version Identifier for this Object (for PUT)
Unique identifier of the Object
id of the bank
description
IBAN
account number
sub account number
account holder
currency
Current account amount.
Account position.
Default account.
falseIs this active?
Reference identifier from an external system.
Account balance.
OK
accounts
Version Identifier for this Object (for PUT)
Unique identifier of the Object
id of the bank
description
IBAN
account number
sub account number
account holder
currency
Current account amount.
Account position.
Default account.
falseIs this active?
Reference identifier from an external system.
Account balance.
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
}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
}Bank identifier.
Reference identifiers of the accounts to import.
OK
accounts
Version Identifier for this Object (for PUT)
Unique identifier of the Object
id of the bank
description
IBAN
account number
sub account number
account holder
currency
Current account amount.
Account position.
Default account.
falseIs this active?
Reference identifier from an external system.
Account balance.
POST /erp/bank/{id}/accounts/sync HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 8
[
"text"
]OK
[]Bank identifier.
Should new bank accounts be imported?
falseShould the stored consents be edited?
NONEPossible values: OK
External task identifier.
When the task was created.
What the current task status is.
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"
}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"
}
}Banking interface.
Banking provider identifier.
OK
Version Identifier for this Object (for PUT)
Unique identifier of the Object
description
bank name
BIC
BLZ
External BankID
Creditor identifier.
Wether a call to bank init is needed.
ID of the banking provider
Is the bank active?
trueBank logo URL.
POST /erp/bank/sync/{backendType}/{providerId} HTTP/1.1
Host: api.example.com
Accept: */*
OK
[]Bank identifier.
OK
External task identifier.
When the task was created.
What the current task status is.
POST /erp/bank/start_transaction_download/{bankId} HTTP/1.1
Host: api.example.com
Accept: */*
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"
}
}Bank identifier.
OK
Description of the action
action type
Expiration of the action
GET /erp/bank/{id}/actions HTTP/1.1
Host: api.example.com
Accept: */*
OK
[]Banking interface.
Search term.
Banking provider identifier.
OK
reference id
description
bank name
BIC
BLZ
Bank logo URL.
GET /erp/bank/search/{backendType}/{searchTerm}/{providerId} HTTP/1.1
Host: api.example.com
Accept: */*
OK
[]Bank identifier.
webformIdentifier
OK
Information about a webform, if one was created.
web form Id
web form Type
web form Status
time expires at
time created At
web form Url
GET /erp/bank/get_webform_by_id/{bankId}/{webformId} HTTP/1.1
Host: api.example.com
Accept: */*
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"
}Bank identifier.
taskIdentifier
OK
External task identifier.
When the task was created.
What the current task status is.
GET /erp/bank/get_external_task/{bankId}/{taskId} HTTP/1.1
Host: api.example.com
Accept: */*
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"
}
}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.
Bank identifier.
successful operation
Bankverbindung ist der Schnittstelle nicht bekannt oder nicht mit dem angemeldeten Benutzer verknüpft
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"
}Unique identifier.
OK
No content
DELETE /erp/bank/{id}/delete_connection HTTP/1.1
Host: api.example.com
Accept: */*
OK
No content
OK
message context
message
DELETE /erp/bank/reset_for_provider_type/{backendType} HTTP/1.1
Host: api.example.com
Accept: */*
OK
{
"context": "text",
"messageValue": "text"
}Last updated
Was this helpful?