BankingProvider

Bankdienstleister

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/banking/banking-provider/{id}

HTTPcURLJavaScriptPython

GET /api/banking/banking-provider/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:22:37.679Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:22:37.679Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:22:37.679Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:22:37.679Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "bankingProviderRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "username": "text",
      "email": "text",
      "replicated": false,
      "requiredUserAction": "NO_ACTION_REQUIRED",
      "autoUpdateEnabled": true,
      "varioUserRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ]
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

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:

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/banking/banking-provider/{id}

HTTPcURLJavaScriptPython

PUT /api/banking/banking-provider/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "version": "text",
  "info": {},
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "bankingProviderRef": {
        "id": "text"
      },
      "username": "text",
      "password": "text",
      "email": "text",
      "requiredUserAction": "NO_ACTION_REQUIRED",
      "autoUpdateEnabled": true,
      "varioUserRef": {
        "id": "text"
      }
    }
  ]
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:22:37.679Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:22:37.679Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:22:37.679Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:22:37.679Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "bankingProviderRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "username": "text",
      "email": "text",
      "replicated": false,
      "requiredUserAction": "NO_ACTION_REQUIRED",
      "autoUpdateEnabled": true,
      "varioUserRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ]
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

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}

HTTPcURLJavaScriptPython

DELETE /api/banking/banking-provider/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

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

get

Path parameters

bankingProviderIdinteger · int64Required

keystring · enumRequiredPossible values:

Responses

200

OK

application/json

Responsestring

get

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

HTTPcURLJavaScriptPython

GET /api/banking/banking-provider/{bankingProviderId}/parameter/{key} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

text

put

Path parameters

bankingProviderIdinteger · int64Required

bankingProviderId

keystring · enumRequiredPossible values:

Body

application/json

objectOptional

Responses

200

OK

No content

put

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

HTTPcURLJavaScriptPython

PUT /api/banking/banking-provider/{bankingProviderId}/parameter/{key} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

OK

No content

Create new Resource

post

Body

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:

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/banking/banking-provider

HTTPcURLJavaScriptPython

POST /api/banking/banking-provider HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "version": "text",
  "info": {},
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "bankingProviderRef": {
        "id": "text"
      },
      "username": "text",
      "password": "text",
      "email": "text",
      "requiredUserAction": "NO_ACTION_REQUIRED",
      "autoUpdateEnabled": true,
      "varioUserRef": {
        "id": "text"
      }
    }
  ]
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:22:37.679Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:22:37.679Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bpName": "text",
  "bpIdentifier": "FINAPI",
  "bankingUsers": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:22:37.679Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:22:37.679Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "bankingProviderRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "username": "text",
      "email": "text",
      "replicated": false,
      "requiredUserAction": "NO_ACTION_REQUIRED",
      "autoUpdateEnabled": true,
      "varioUserRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    }
  ]
}

post

Body

application/json

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

Responseobject

post

/banking/banking-provider/create

HTTPcURLJavaScriptPython

POST /api/banking/banking-provider/create HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 57

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

200

OK

{}

Checks if the general parameters are correct

get

Path parameters

bankingProviderIdinteger · int64Required

Responses

200

OK

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/banking/banking-provider/{bankingProviderId}/check_login HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

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

get

Path parameters

keystring · enumRequiredPossible values:

Responses

200

OK

application/json

Responsestring

get

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

HTTPcURLJavaScriptPython

GET /api/banking/banking-provider/meta/{key} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

text