GetbeelDocs
API referenceBank connections

Connect a bank

Checks the Enable Banking application (a real call with your key), saves it and starts the bank login. Open authorization_url in a browser: a getbeel page names your team, the user continues to the bank, logs in and lands in the getbeel app, and the first sync (last 90 days) starts right away. Add getbeel's redirect URL (https://getbeel.com/api/open-banking/callback) to your application's allowed redirect URLs first. Pay as you go: €2.00 per connected bank account per month and €0.02 per imported movement, from the prepaid balance (402 insufficient_balance when it does not cover them). Each team uses its own Enable Banking application (application id + RSA private key from the Enable Banking control panel); getbeel stores the key encrypted and never returns it. Live keys only (403 livemode_required with a test key): bank and connection data is real, there is no sandbox for it.

POST
/bank-connections

Checks the Enable Banking application (a real call with your key), saves it and starts the bank login. Open authorization_url in a browser: a getbeel page names your team, the user continues to the bank, logs in and lands in the getbeel app, and the first sync (last 90 days) starts right away. Add getbeel's redirect URL (https://getbeel.com/api/open-banking/callback) to your application's allowed redirect URLs first. Pay as you go: €2.00 per connected bank account per month and €0.02 per imported movement, from the prepaid balance (402 insufficient_balance when it does not cover them). Each team uses its own Enable Banking application (application id + RSA private key from the Enable Banking control panel); getbeel stores the key encrypted and never returns it. Live keys only (403 livemode_required with a test key): bank and connection data is real, there is no sandbox for it.

Authorization

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Header Parameters

Idempotency-Key?string

Recommended. Retrying with the same key and body within 24 hours replays the first response (header Idempotent-Replayed: true) instead of acting twice. The same key with a different body returns 422 idempotency_key_reused.

Lengthlength <= 255
Getbeel-Company?string

Act on one of the account's client companies (its id from GET /companies) instead of the key's own account. 404 company_not_found when the key cannot act on it.

Formatuuid

Request Body

application/json
  1. body
application_id*string

The Enable Banking application id.

Match^[A-Za-z0-9-]{8,100}$
private_key*string

The application's RSA private key in PEM ("-----BEGIN PRIVATE KEY-----…"). Stored encrypted, never returned.

Length100 <= length <= 16000
bank*
psu_type*string
Default"business"
Value in"business""personal"
language?string
Value in"it""en""es""fr"

Response Body

OK

application/json
  1. response
object*string
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
provider*string
application_id*string

Your Enable Banking application id (the key is never returned).

bank*|null
psu_type*string
Value in"business""personal"
status*string

pending: the bank login was not completed yet. active: synced every 6 hours. requires_reconnect: the consent expired or was revoked; reconnect (POST /bank-connections/{id}/reconnect or the app).

Value in"pending""active""requires_reconnect"
consent_expires_at*|null
expires_soon*boolean

The consent ends within 7 days: reconnect (POST /bank-connections/{id}/reconnect or the app).

last_synced_at*|null
last_error*string|null
accounts*array<>
created_at*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
authorization_url*string

Open it in a browser: a getbeel page (/bank-login) names your team, then the user continues to the bank, logs in and lands in the getbeel app. Valid for 30 minutes.

Formaturi
redirect_url_registered*|

Whether getbeel's redirect URL is in your application's allowed redirect URLs (null when unknown).

Example Request
curl -X POST 'https://www.getbeel.com/api/v1/bank-connections' \  -H 'Content-Type: application/json' \  -d '{  "application_id": "string",  "private_key": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",  "bank": {    "name": "string",    "country": "IT"  },  "psu_type": "business"}'
Example Response
{  "object": "bank_connection",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "provider": "enable_banking",  "application_id": "string",  "bank": {    "name": "Intesa Sanpaolo",    "country": "IT"  },  "psu_type": "business",  "status": "pending",  "consent_expires_at": "2019-08-24T14:15:22Z",  "expires_soon": true,  "last_synced_at": "2019-08-24T14:15:22Z",  "last_error": "string",  "accounts": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "iban": "string",      "name": "string",      "currency": "string",      "active": true,      "balance": {        "amount": "122.00",        "currency": "string"      },      "last_synced_at": "2019-08-24T14:15:22Z",      "last_booking_date": "2026-10-29",      "transactions": -9007199254740991,      "pending_transactions": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "date": "2026-10-29",          "description": "string",          "counterparty_name": "string",          "amount": "122.00",          "currency": "string",          "type": "debit"        }      ]    }  ],  "created_at": "2019-08-24T14:15:22Z",  "authorization_url": "http://example.com",  "redirect_url_registered": true}