API Reference
Interactive reference for all Spare Open Finance Platform endpoints.
The API reference is generated from our OpenAPI specification and stays in sync with each release. Each group bundles related operations with schemas, examples, and a Try it panel. The endpoints shown depend on the market selected in the country selector.
Authentication
Sessions, refresh, and JWKS.
Providers
Banks and institutions in your tenant.
Payment Requests
Create and manage payment intents.
Payment Consents
Consent lifecycle and status.
Bank Accounts
Creditor account registration.
Payments
Settled payment records.
Payment Purpose Codes
Regional purpose code lookup.
Mandates
Schedule and approve mandates.
Webhooks
Manage subscriptions and browse the event catalog.
Beneficiary Verification
Confirm payee name before payment.
Account Information
Account access, consents, authorization, and risk reports.
New to the API?
Read Payment flow first, then open Payment Requests and Payment Consents while following Payments. For account data, see Account Information.