Servers
Auth
Operations
Get Users
Get all activated users. Requires an admin client - contact BANKSapi for access.
Authorizations
Parameters
Path Parameters
Tenant name plays a role in using the API. The tenant name is a URL component in the management API.
"demo"Query Parameters
Whether or not to also include inactive users
truefalseResponses
Returns an array of User
Encrypt plaintexts
Encrypt a given plaintext for the tenant identified by the given bearer token.
Authorizations
Request Body
Responses
Ciphertext (encrypted plaintext) encoded in Base64
Get Providers
Retrieve a list of and information for all providers.
Authorizations
Responses
Returns an array of providers.
Get Customer
Retrieves the customer object for the authenticated user. It is also the entry point to the deeper functions of the interface.
Authorizations
Responses
Returns customer object of the user.
Customer Bank Access
Operations
Get Bank Accesses
Retrieves all bank accesses for this user.
Authorizations
Responses
The success response contains an collection of bank accesses.
Push transactions for the given product
Pushes transactions for the given product identified by an access and a product ID
Authorizations
Parameters
Path Parameters
ID of the bank access
"d23710a9-8e4b-4595-b01c-dad9499c9fdb""uuid"ID of a banking product
"DE00123456789012345678"Request Body
Responses
Created
Start SCA
Starts the SCA renewal process
Authorizations
Parameters
Header Parameters
The IP address of the customer. Must be a public IP address. We recommend using IPv4, as some banks do not support IPv6.
"154.25.45.133"Path Parameters
ID of the bank access
"d23710a9-8e4b-4595-b01c-dad9499c9fdb""uuid"Query Parameters
URL the end user's browser is redirected to after the out-of-band user interaction finishes. Its purpose and whether it is required depend on whether you are a regulated or a non-regulated tenant (see the Quick Start for the distinction):
-
Regulated tenants (handle credentials directly and go through Redirect SCA themselves): required. The URL is the return target of the Redirect SCA flow. After the user authenticates at the bank, the bank redirects the browser here so your application can resume.
-
Non-regulated tenants (redirect the user to the REG/Protect webform to add a bank access, renew consent, or trigger a payment): optional on this call, because there are two supported ways to supply it, and only one of them is required:
- As this query parameter on the API call. The value is stored in the REG/Protect session and used as a fallback.
- Appended (URL-encoded) as a
callbackUrlquery parameter on theLocationURL before redirecting the user to the REG/Protect webform. This is the mechanism documented in the Quick Start and the Customer guide.
If both are supplied, the value appended to the
LocationURL takes precedence. If neither is supplied, REG/Protect aborts the flow withbaReentry=NO_CALLBACK_URL.
If an allow-list of permitted callback URL bases has been configured for your tenant, the value is checked against that list on every call regardless of tenant type. A mismatch on this query parameter returns HTTP 400. For non-regulated tenants, the Location-appended value is additionally re-checked by the REG/Protect frontend; a mismatch there aborts the flow with baReentry=INVALID_CALLBACK_URL.
"https://demo-tenant.com/callback?state=123""url"Flag to ignore saved TAN-settings and query them.
"true"Indicator if transactions older than 90 days should be fetched. Best used when first creating the bank access to avoid unnecessary SCAs during refresh operations.
"none""all""paymentAccounts"Request Body
Responses
HTTP status 201 (Created) is returned together with the HTTP header Location. Under the URL specified in the header, the added bank accesses can be queried analogously by means of an HTTP GET call.
Customer Bank Access Payment
Operations
Initiate a single transfer
Initiates a payment for the given bank access, without providing access credentials
Authorizations
Parameters
Header Parameters
The IP address of the customer. Must be a public IP address. We recommend using IPv4, as some banks do not support IPv6.
"154.25.45.133"If set to "true", the bank should reject the payment if there are insufficient funds. If set to "false", the bank may wait for a certain period for funds to arrive. This parameter may be ignored by the bank.
"true"Path Parameters
ID of the bank access
"d23710a9-8e4b-4595-b01c-dad9499c9fdb""uuid"ID of a banking product
"DE00123456789012345678"Query Parameters
URL the end user's browser is redirected to after the out-of-band user interaction finishes. Its purpose and whether it is required depend on whether you are a regulated or a non-regulated tenant (see the Quick Start for the distinction):
-
Regulated tenants (handle credentials directly and go through Redirect SCA themselves): required. The URL is the return target of the Redirect SCA flow. After the user authenticates at the bank, the bank redirects the browser here so your application can resume.
-
Non-regulated tenants (redirect the user to the REG/Protect webform to add a bank access, renew consent, or trigger a payment): optional on this call, because there are two supported ways to supply it, and only one of them is required:
- As this query parameter on the API call. The value is stored in the REG/Protect session and used as a fallback.
- Appended (URL-encoded) as a
callbackUrlquery parameter on theLocationURL before redirecting the user to the REG/Protect webform. This is the mechanism documented in the Quick Start and the Customer guide.
If both are supplied, the value appended to the
LocationURL takes precedence. If neither is supplied, REG/Protect aborts the flow withbaReentry=NO_CALLBACK_URL.
If an allow-list of permitted callback URL bases has been configured for your tenant, the value is checked against that list on every call regardless of tenant type. A mismatch on this query parameter returns HTTP 400. For non-regulated tenants, the Location-appended value is additionally re-checked by the REG/Protect frontend; a mismatch there aborts the flow with baReentry=INVALID_CALLBACK_URL.
"https://demo-tenant.com/callback?state=123""url"Flag to ignore saved TAN-settings and query them.
"true"Flag for REG/Protect to control whether fields on the frontend are editable
"false"Flag for REG/Protect to control whether payments can be entered without interaction. Currently only supported for EBICS.
"false"Unique UUID for the payment. Only for non-REG/Protect tenants: when provided, the same ID must be used for related VOP (Verification of Payee) requests. Do not use for REG/Protect tenants, the value is ignored and a payment ID is generated server-side for the REG/Protect session.
"d308a7ae-b762-4a20-8996-7fa22aed6b73""uuid"Request Body
Responses
Returns object with the transfer status
Customer Payment
Operations
Initiate Single Transfer
Initiates a single transfer (e.g. a SEPA transfer).
Authorizations
Parameters
Header Parameters
The IP address of the customer. Must be a public IP address. We recommend using IPv4, as some banks do not support IPv6.
"154.25.45.133"If set to "true", the bank should reject the payment if there are insufficient funds. If set to "false", the bank may wait for a certain period for funds to arrive. This parameter may be ignored by the bank.
"true"Query Parameters
URL the end user's browser is redirected to after the out-of-band user interaction finishes. Its purpose and whether it is required depend on whether you are a regulated or a non-regulated tenant (see the Quick Start for the distinction):
-
Regulated tenants (handle credentials directly and go through Redirect SCA themselves): required. The URL is the return target of the Redirect SCA flow. After the user authenticates at the bank, the bank redirects the browser here so your application can resume.
-
Non-regulated tenants (redirect the user to the REG/Protect webform to add a bank access, renew consent, or trigger a payment): optional on this call, because there are two supported ways to supply it, and only one of them is required:
- As this query parameter on the API call. The value is stored in the REG/Protect session and used as a fallback.
- Appended (URL-encoded) as a
callbackUrlquery parameter on theLocationURL before redirecting the user to the REG/Protect webform. This is the mechanism documented in the Quick Start and the Customer guide.
If both are supplied, the value appended to the
LocationURL takes precedence. If neither is supplied, REG/Protect aborts the flow withbaReentry=NO_CALLBACK_URL.
If an allow-list of permitted callback URL bases has been configured for your tenant, the value is checked against that list on every call regardless of tenant type. A mismatch on this query parameter returns HTTP 400. For non-regulated tenants, the Location-appended value is additionally re-checked by the REG/Protect frontend; a mismatch there aborts the flow with baReentry=INVALID_CALLBACK_URL.
"https://demo-tenant.com/callback?state=123""url"Flag to ignore saved TAN-settings and query them.
"true"Flag for REG/Protect to control whether fields on the frontend are editable
"false"Unique UUID for the payment. Only for non-REG/Protect tenants: when provided, the same ID must be used for related VOP (Verification of Payee) requests. Do not use for REG/Protect tenants, the value is ignored and a payment ID is generated server-side for the REG/Protect session.
"d308a7ae-b762-4a20-8996-7fa22aed6b73""uuid"Request Body
Responses
Returns object with the transfer status
Get Consent
Get the current status of the consent, without polling the provider
Authorizations
Parameters
Path Parameters
ID of the consent
"3e97fa51-ce7b-42a0-9101-50fd67dbc3e7""uuid"Responses
Returns the current status of the consent.
Create ONE/Connect Classic Token
Creates a ONE/Connect Classic token using API key authentication.
Authorizations
Your API key as displayed in the ONE/Connect dashboard, e.g. NDJlMjNhOD ... NzU0ZDc1NA==
Parameters
Header Parameters
Your API key as displayed in the ONE/Connect dashboard, e.g. NDJlMjNhOD ... NzU0ZDc1NA==
Responses
OK