Banking Provider

Manage banking providers in VARIO Cloud, including provider settings, parameters, user assignments, login checks, and provider creation via REST API.

Bankdienstleister

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

bpNamestringRequired

banking provider name

bpIdentifierstring · enumRequired

banking provider identifier

Possible values:

404

Resource with given ID was not found

application/json

get/banking/banking-provider/{id}

GET /banking/banking-provider/{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",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": []
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bpNamestringRequired

banking provider name

bpIdentifierstring · enumRequired

banking provider identifier

Possible values:

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bpNamestringRequired

banking provider name

bpIdentifierstring · enumRequired

banking provider identifier

Possible values:

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/banking/banking-provider/{id}

PUT /banking/banking-provider/{id} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "version": "text",
  "info": {},
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": []
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": []
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete/banking/banking-provider/{id}

DELETE /banking/banking-provider/{id} HTTP/1.1
Host: api.example.com
Accept: */*

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

get

Path parameters

bankingProviderIdinteger · int64Required

keystring · enumRequiredPossible values:

Responses

200

OK

application/json

stringOptional

get/banking/banking-provider/{bankingProviderId}/parameter/{key}

GET /banking/banking-provider/{bankingProviderId}/parameter/{key} HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

text

put

Path parameters

bankingProviderIdinteger · int64Required

bankingProviderId

keystring · enumRequiredPossible values:

Body

anyOptional

Responses

200

OK

No content

put/banking/banking-provider/{bankingProviderId}/parameter/{key}

PUT /banking/banking-provider/{bankingProviderId}/parameter/{key} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*

200

OK

No content

Create new Resource

post

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bpNamestringRequired

banking provider name

bpIdentifierstring · enumRequired

banking provider identifier

Possible values:

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bpNamestringRequired

banking provider name

bpIdentifierstring · enumRequired

banking provider identifier

Possible values:

422

Resource was not valid to process

application/json

post/banking/banking-provider

POST /banking/banking-provider HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "version": "text",
  "info": {},
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": []
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": []
}

post

Body

bankTypestring · enumOptional

Bankschnittstelle

Possible values:

usernamestringOptional

Username für Bankschnittstelle (falls benötigt)

passwordstringOptional

Password für Bankschnittstelle (falls benötigt)

Responses

200

OK

application/json

anyOptional

post/banking/banking-provider/create

POST /banking/banking-provider/create HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "bankType": "FINAPI",
  "username": "text",
  "password": "text"
}

200

OK

No content

Checks if the general parameters are correct

get

Path parameters

bankingProviderIdinteger · int64Required

Responses

200

OK

application/json

contextstringOptional

message context

messageValuestringOptional

message

get/banking/banking-provider/{bankingProviderId}/check_login

GET /banking/banking-provider/{bankingProviderId}/check_login HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

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

get

Path parameters

keystring · enumRequiredPossible values:

Responses

200

OK

application/json

stringOptional

get/banking/banking-provider/meta/{key}

GET /banking/banking-provider/meta/{key} HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

text