Spare API Documentation
Developer documentation for the Spare Open Finance Platform
Welcome to the Spare API documentation. This site covers integration guides, SDK references, and an interactive API reference driven by our OpenAPI specification.
Quick Start
Credentials, integration flow, data types, error codes, and sandbox testing, for any use case.
Concepts
Payment flow, consent lifecycle, mandates, Spare Link, webhooks.
Guides
Step-by-step walkthroughs for common integration paths.
SDK
TypeScript and Python clients with automatic auth refresh.
API Reference
Interactive OpenAPI docs for all public endpoints.
New to Spare?
Start with the 15-minute quickstart, then read how payments work before diving into guides or the API reference.
What you can build
- One-off payments, create payment requests, collect bank consent, and settle funds
- Hosted authorization, launch Spare Link instead of building bank redirect UI
- Recurring payments, schedule and approve mandate transactions
- Account operations, register creditor bank accounts and manage defaults
Sandbox first
Use the sandbox environment for all development. Production credentials are issued after go-live review.
Platform primitives
| Concept | Description |
|---|---|
| Payment request | Intent to collect a specific amount from a payer |
| Payment consent | Payer authorization tied to a request |
| Payment | Settled transaction record |
| Mandate | Scheduled or recurring payment instruction |
| Spare Link | Hosted UI for bank login and consent |
Read Open Banking for a conceptual overview, or jump straight to the Quickstart.