# BANKSapi BANKS/Connect API Reference API

> BANKSapi BANKS/Connect API Reference API on Apizie: 53 endpoints (Get Users, Create User, Create Token, Get Tenants, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:banksapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:banksapi`
- Category: Payments
- Status: byok
- Source: https://banksapi.de/en
- Page: https://apizie.tech/api/payments/banksapi
- OpenAPI: https://apizie.tech/api/payments/banksapi/openapi.json

We develop and operate REST-APIs and GUIs all around the topic of finance. As a specialised connectivity and payment provider, we are fully dedicated to the growth areas of Open Banking and Open Finance. To make this…

## Endpoints

### Get Users
`GET https://apizie.tech/v1/payments:banksapi/auth-get-activated-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tenant-name | string | yes | Tenant name plays a role in using the API. The tenant name is a URL component in the management API. |
| includeInactive | boolean | no | Whether or not to also include inactive users |

### Create User
`POST https://apizie.tech/v1/payments:banksapi/auth-create-tenant-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tenant-name | string | yes | Tenant name plays a role in using the API. The tenant name is a URL component in the management API. |
| body | object | yes | JSON request body |

### Create Token
`POST https://apizie.tech/v1/payments:banksapi/auth-create-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Get Tenants
`GET https://apizie.tech/v1/payments:banksapi/auth-get-tenants` (byok)

### Get User
`GET https://apizie.tech/v1/payments:banksapi/auth-get-activated-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tenant-name | string | yes | Tenant name plays a role in using the API. The tenant name is a URL component in the management API. |
| user-id | string | yes | User reference of the user |

### Change user details
`POST https://apizie.tech/v1/payments:banksapi/auth-change-user-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tenant-name | string | yes | Tenant name plays a role in using the API. The tenant name is a URL component in the management API. |
| user-id | string | yes | User reference of the user |
| reftype | string | no | Reference type of user ID ("id" (default) or "username") |
| body | object | no | JSON request body |

### Delete User
`POST https://apizie.tech/v1/payments:banksapi/auth-delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tenant-name | string | yes | Tenant name plays a role in using the API. The tenant name is a URL component in the management API. |
| user-id | string | yes | User reference of the user |
| reftype | string | no | Reference type of user ID ("id" (default) or "username") |

### Deactivate User
`POST https://apizie.tech/v1/payments:banksapi/auth-deactivate-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tenant-name | string | yes | Tenant name plays a role in using the API. The tenant name is a URL component in the management API. |
| user-id | string | yes | User reference of the user |
| reftype | string | no | Reference type of user ID ("id" (default) or "username") |

### Reactivate User
`POST https://apizie.tech/v1/payments:banksapi/auth-reactivate-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tenant-name | string | yes | Tenant name plays a role in using the API. The tenant name is a URL component in the management API. |
| user-id | string | yes | User reference of the user |
| reftype | string | no | Reference type of user ID ("id" (default) or "username") |
| body | object | yes | JSON request body |

### Revoke Token
`POST https://apizie.tech/v1/payments:banksapi/auth-revoke-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Introspect Token
`GET https://apizie.tech/v1/payments:banksapi/auth-token-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| token | string | yes | The Token to introspect |

### Encrypt plaintexts
`POST https://apizie.tech/v1/payments:banksapi/encrypt-plaintext` (byok)

### Get Providers
`GET https://apizie.tech/v1/payments:banksapi/providers-get-all` (byok)

### Get Providers core data
`GET https://apizie.tech/v1/payments:banksapi/providers-list-core-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| capability | string | no | Filter providers by capability |

### Get Providers job statistics
`GET https://apizie.tech/v1/payments:banksapi/providers-get-job-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| days | integer | no | Specifies the number of past days for fetching job statistics. When used together with "hours", their values are summed. If none of the… |
| hours | integer | no | Specifies the number of past hours for fetching job statistics. When used together with "days", their values are summed. If none of the… |
| ebics | boolean | no | If only EBICS jobs should be considered for the response. |
| sca | boolean | no | If only provider logos with at least one job including a strong customer authentication (SCA) should be considered for the response. In… |

### Get Provider
`GET https://apizie.tech/v1/payments:banksapi/providers-get-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider-id | string | yes | ID of a provider |

### Get Provider EBICS Info
`GET https://apizie.tech/v1/payments:banksapi/providers-get-ebics-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider-id | string | yes | ID of a provider |

### Get Customer
`GET https://apizie.tech/v1/payments:banksapi/customer-get-object` (byok)

### Get Bank Accesses
`GET https://apizie.tech/v1/payments:banksapi/customer-bank-access-get-all` (byok)

### Add Bank Access
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-add-bank-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Customer-IP-Address | string | yes | The IP address of the customer. Must be a public IP address (IPv4, IPv6) |
| callbackUrl | string | yes | A callback URL. |
| refresh | boolean | no | If the bank access already exists, regardless of the **background** update, all revenues and information are retrieved by the provider, if… |
| queryTanSettings | boolean | no | Flag to ignore saved TAN-settings and query them. |
| headOnly | boolean | no | Flag to solely fetch header data of the account without balances and transactions (e.g. to get the list of selectable bank products). If… |
| maxTransactions | string | no | Indicator if transactions older than 90 days should be fetched. |
| paymentAccountsOnly | boolean | no | Flag to solely fetch payment accounts. Other accounts will be ignored, which can result in fewer SCAs. |
| body | object | yes | JSON request body |

### Delete All Bank Accesses
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-remove-all-bank-accesses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Customer-IP-Address | string | yes | The IP address of the customer. Must be a public IP address (IPv4, IPv6) |

### Get Bank Access
`GET https://apizie.tech/v1/payments:banksapi/customer-bank-access-get-specific-bank-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |

### Delete Bank Access
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-delete-bank-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| Customer-IP-Address | string | yes | The IP address of the customer. Must be a public IP address (IPv4, IPv6) |

### Get Bank Access Issues
`GET https://apizie.tech/v1/payments:banksapi/customer-bank-access-get-issues` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |

### Get Bank Access Challenge PDF
`GET https://apizie.tech/v1/payments:banksapi/customer-bank-access-get-bank-access-challenge-pdf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |

### Get Bank Product
`GET https://apizie.tech/v1/payments:banksapi/customer-bank-access-get-bank-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |

### Get Transactions
`GET https://apizie.tech/v1/payments:banksapi/customer-bank-access-get-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |
| from | string | no | Only return transactions with a booking date after this Date/Time (ISO 8601 formatted timestamp); may be used with `to` to specify a time… |
| to | string | no | Only return transactions with a booking date before this Date/Time (ISO 8601 formatted timestamp); may be used with `from` to specify a… |
| tag | string | no | The resulting transactions will each contain Categorization objects of the corresponding tag type |
| filter | string | no | Filter to apply to result set. Filter expression must be URL-encoded. Filter expression must be in the form ` `. |

### Push transactions for the given product
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-builder-push-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |
| body | object | yes | JSON request body |

### modify categorisation of transactions
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-modify-transaction-categorization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |
| transaction-id | string | yes | ID of a transaction |
| changeExisting | boolean | no |  |
| createRule | boolean | no |  |
| body | object | yes | JSON request body |

### Get Portfolio
`GET https://apizie.tech/v1/payments:banksapi/customer-bank-access-get-depot-positions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |

### Start SCA
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-consent-start-sca-renewal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| Customer-IP-Address | string | yes | The IP address of the customer. Must be a public IP address (IPv4, IPv6) |
| callbackUrl | string | yes | A callback URL. |
| queryTanSettings | boolean | no | Flag to ignore saved TAN-settings and query them. |
| maxTransactions | string | no | Indicator if transactions older than 90 days should be fetched. |
| body | object | no | JSON request body |

### Poll Bank Access Consent
`GET https://apizie.tech/v1/payments:banksapi/customer-bank-access-consent-poll-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| consent-id | string | yes | ID of the consent |

### Update Bank Access Consent
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-consent-update-sca-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| consent-id | string | yes | ID of the consent |
| body | object | yes | JSON request body |

### Cancel Bank Access Consent
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-consent-cancel-sca-redirect` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| consent-id | string | yes | ID of the consent |

### Initiate a single transfer
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-payment-initiate-single-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |
| Customer-IP-Address | string | yes | The IP address of the customer. Must be a public IP address (IPv4, IPv6) |
| callbackUrl | string | yes | A callback URL. |
| body | object | yes | JSON request body |

### Initiate a bulk transfer
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-payment-initiate-bulk-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |
| Customer-IP-Address | string | yes | The IP address of the customer. Must be a public IP address (IPv4, IPv6) |
| callbackUrl | string | yes | A callback URL. |
| body | object | yes | JSON request body |

### Initiate a single debit
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-payment-initiate-single-debit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |
| body | object | yes | JSON request body |

### Initiate a bulk debit
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-payment-initiate-bulk-debit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |
| product-id | string | yes | ID of a banking product |
| body | object | yes | JSON request body |

### Initiate Single Transfer
`POST https://apizie.tech/v1/payments:banksapi/customer-payment-initiate-single-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Customer-IP-Address | string | yes | The IP address of the customer. Must be a public IP address (IPv4, IPv6) |
| callbackUrl | string | yes | A callback URL. |
| queryTanSettings | boolean | no | Flag to ignore saved TAN-settings and query them. |
| body | object | yes | JSON request body |

### Get Single Transfer
`GET https://apizie.tech/v1/payments:banksapi/customer-payment-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-id | string | yes | ID of the payment |

### Initiate Bulk Transfer
`POST https://apizie.tech/v1/payments:banksapi/customer-payment-initiate-bulk-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Customer-IP-Address | string | yes | The IP address of the customer. Must be a public IP address (IPv4, IPv6) |
| callbackUrl | string | yes | A callback URL. |
| queryTanSettings | boolean | no | Flag to ignore saved TAN-settings and query them. |
| body | object | yes | JSON request body |

### Get Bulk Transfer
`GET https://apizie.tech/v1/payments:banksapi/customer-payment-get-status-bulk-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-id | string | yes | ID of the payment |

### Initiate Single Debit
`POST https://apizie.tech/v1/payments:banksapi/customer-payment-initiate-single-debit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| queryTanSettings | boolean | no | Flag to ignore saved TAN-settings and query them. |
| body | object | yes | JSON request body |

### Get Single Debit
`GET https://apizie.tech/v1/payments:banksapi/customer-payment-get-debit-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-id | string | yes | ID of the payment |

### Initiate Bulk Debit
`POST https://apizie.tech/v1/payments:banksapi/customer-payment-initiate-bulk-debit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| queryTanSettings | boolean | no | Flag to ignore saved TAN-settings and query them. |
| body | object | yes | JSON request body |

### Get Bulk Debit
`GET https://apizie.tech/v1/payments:banksapi/customer-payment-get-status-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-id | string | yes | ID of the payment |

### Get Consent
`GET https://apizie.tech/v1/payments:banksapi/customer-consent-get-current-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consent-id | string | yes | ID of the consent |

### Update Consent
`POST https://apizie.tech/v1/payments:banksapi/customer-consent-submit-sca-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consent-id | string | yes | ID of the consent |
| body | object | yes | JSON request body |

### Poll Consent
`GET https://apizie.tech/v1/payments:banksapi/customer-consent-poll-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consent-id | string | yes | ID of the consent |

### Cancel a Consent
`POST https://apizie.tech/v1/payments:banksapi/customer-consent-cancel-sca-redirect` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consent-id | string | yes | ID of the consent |

### Delete all REG/Protect sessions
`POST https://apizie.tech/v1/payments:banksapi/customer-reg-protect-invalidate-sessions` (byok)

### Change bank product selection
`POST https://apizie.tech/v1/payments:banksapi/customer-reg-protect-change-bank-product-selection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access-id | string | yes | ID of the bank access |

### Create Bank Access Builder
`POST https://apizie.tech/v1/payments:banksapi/customer-bank-access-builder-create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/payments:banksapi/auth-get-activated-users" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the BANKSapi BANKS/Connect API Reference API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:banksapi/auth-get-activated-users with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the BANKSapi BANKS/Connect API Reference API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. BANKSapi BANKS/Connect API Reference itself also needs your own key from banksapi.io.

### Can AI agents use the BANKSapi BANKS/Connect API Reference API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:banksapi.

### What is the status of the BANKSapi BANKS/Connect API Reference API?
Needs your own provider key (bring your own key)