API docs by Redocly

BankProxy API (0.9.0)

Download OpenAPI specification:Download

License: GNU Affero General Public License 3.0

transaction

Trigger a transaction

This is the central API endpoint get transactions from the bank and initiate payments. It supports two different modes of operation.

Redirect mode

In this mode the API call will return only a URL. The end-user opening this URL, will be presented with the required steps to get the transactions from the bank and redirected to the previously provided callbackUri.

To trigger this mode callbackUri must be provided in the request body.

Headless mode

This optional mode does not require any end-user interaction and can therefore used for automatic pariodic execution. If this mode is supported depends on how bankproxy interacts with the bank.

Authorizations:
basicAuth
Request Body schema: application/json
callbackUri
string <url>

The URI the end-user will be redirected to, after interacting with the bank. If this property is not given, the call works in headless mode.

required
Array of objects
object
user
string

Identifier of the user triggering the execution

reconfigure
boolean

Show UI to configure the connection, even if already configured

language
Array of strings <lang>

List of preferred language tags as defined in RFC 5646

Responses

Request samples

Content type
application/json
Example

For the most simple request only the IBAN of the bank account is required.

{
  • "accounts": [
    ]
}

Response samples

Content type
application/json
{
  • "result": [
    ]
}

admin

Get list of supported connectors

Authorizations:
jwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get list of created connection

Authorizations:
jwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new connection

Authorizations:
jwtAuth
Request Body schema: application/json
type
required
string

Identifier of the connector

name
string

Name for the connection

required
object

Connector specific options

Responses

Request samples

Content type
application/json
{
  • "type": "com.example.id",
  • "name": "Demo Bank Connection",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "credentials": {
    }
}

Update a connection

Authorizations:
jwtAuth
Request Body schema: application/json
required
object
name
string

Name of the connection

required
object

Connector specific options

Responses

Request samples

Content type
application/json
{
  • "credentials": {
    },
  • "name": "Demo Bank Connection",
  • "config": {
    }
}

Response samples

Content type
application/json
{ }

Delete a connection

Authorizations:
jwtAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "credentials": {
    }
}

Response samples

Content type
application/json
{ }