Banking API (BaaS)

baas_list_assignments

Lists the tenant/account contexts (assignments) available for the user's banking API credentials. Use it when another tool asks for assignmentId.

Parameters

No parameters.

Returns

{ assignments[] }

assignments = available contexts with assignment_id, tenant_code, owner_type, country_code and status.

baas_diagnostics

Checks the user's banking API credentials, the login, the token exchange and access to accounts. Use it when a query fails.

Parameters

Returns

{ checks[], failed }

checks = one row per check (credentials, login + assignments, accounts) with ok and detail; failed = how many failed. The credential email comes back masked.

baas_list_accounts

Lists the accessible banking API accounts, without balances: identifier type, value and currency.

API operation: GET /api/public/v1/accounts — see the operation page

Parameters

Returns

{ result }

result = the banking API response as returned.

baas_list_balances

Lists the real-time balances of the accessible accounts: account, amounts and cut-off date.

API operation: GET /api/public/v1/accounts/balances — see the operation page

Parameters

Returns

{ result }

result = the banking API response as returned.

baas_get_balance

Gets the current balance of a banking API account identified by IBAN.

API operation: GET /api/public/v1/accounts/balance — see the operation page

Parameters

Returns

{ result }

result = the banking API response as returned.

baas_list_payments

Reads the payments of an owned account identified by IBAN, with date, status, currency, method and direction filters. Cursor pagination.

API operation: GET /api/public/v1/transactions/payments — see the operation page

Parameters

Returns

{ result }

result = the banking API response as returned, with its pagination cursor.

baas_search_payment

Finds a payment inside an account by exactly one of: paymentId (UUID), publicId (number) or clientReference. Sending more than one returns an error.

API operation: POST /api/public/v1/transactions/payments/search — see the operation page

Parameters

Returns

{ result }

result = the banking API response as returned.

baas_get_payment

Gets the detail of a banking API payment from its internal UUID, read only.

API operation: GET /api/public/v1/transactions/payments/{payment_id} — see the operation page

Parameters

Returns

{ result }

result = the banking API response as returned.

baas_request_statement

Requests the generation of an account statement for a banking API account, with a 60-day maximum range. It moves no money: it generates a read-only document and returns request_id with status PENDING.

API operation: POST /api/public/v1/accounts/statements — see the operation page

Parameters

Returns

{ result }

result = the banking API response with request_id and status. The tool requests the document without email notification.

baas_get_statement_status

Reads the status of an account statement request. When it is DONE it includes the signed download link and its expiry.

API operation: GET /api/public/v1/accounts/statements/{request_id} — see the operation page

Parameters

Returns

{ result }

result = the banking API response as returned.

baas_analyze_payments

Analyses, read only, the payments of an account in a date range and returns a natural-language report: success, failures, reversals, net amounts and recommendations. It runs a language model over the computed figures.

Parameters

Returns

{ summary }

summary carries account, range, totals {count, succeeded, failed, reversed, pending, successRate}, byCurrency with succeededAmount, reversedAmount, netAmount and averageTicket, failureReasons and sample. The written report comes in the text. With no payments in the range it says so and does not analyse.