Introduction
What the Spare Open Finance Platform is and how to begin integrating, for any use case.
Spare Open Finance Platform
Who this is for
Backend engineers integrating open banking into web or mobile apps, fintech platforms, marketplaces, and ERP systems, whatever your product does: read account data, initiate payments, or verify an identity.
Core services
- Payment Initiation Services (PIS), initiate electronic fund transfers between bank accounts or to a merchant, on the payer's authorization
- Verification services, confirm the beneficiary name behind an IBAN before a payment
Capability varies by market
Not every service is available in every country. See Coverage for what's live in your market before you plan an integration.
How you integrate
Integrate over the REST API, or use the TypeScript SDK (available now). The Python, Java, C#, and Go SDKs are coming soon (under review). See Integration Flow for base URLs and authentication.
Core concepts
| Term | Meaning |
|---|---|
| Provider | A bank or financial institution available in your tenant |
| Consent | The customer's authorization for Spare to access data or initiate an action on their behalf |
| Tenant | The regulatory jurisdiction your request routes to (set via the tenant field or header) |
| Webhook | An outbound event Spare sends your server when something changes state |
Explore each concept in depth under Concepts.
Before you begin
You will need:
- A Spare sandbox account with an App ID and API key
- Familiarity with bearer token authentication for server-to-server calls
- A webhook endpoint if you want real-time event delivery instead of polling
Keep credentials server-side
Keep your API key off mobile apps and browser code. Authenticate from your backend only.
Getting up and running
- Get your API key, App ID, and configure webhooks
- Understand the integration flow, authenticate, discover providers, and request consent
- Learn the data types and error codes used across every response
- Invite your team to the dashboard
- Test end-to-end in sandbox
- Pick the concrete guide for your use case in Guides or check Coverage for your market
Next steps
- Quick Start Setup, credentials and webhooks
- Concepts, how consent and providers fit together
- API Reference, interactive endpoint documentation