Payments
Overview of Spare payment initiation, supported payment types, user journeys, SDKs, and quick integration guides.
Spare Payments lets you create a payment request, collect the payer's consent at their bank, and settle funds to your registered creditor account. One create endpoint (POST /payment-requests) serves every payment type. Optional user journeys change which hosted pages the payer sees, or what account data Spare can read and share after consent.
See Coverage for what is live in each market, and Payment flow for the end-to-end sequence.
What Spare Payments Covers
- Payment initiation for UAE Open Finance, including Spare hosted pages for bank selection, summary, and redirect to the payer's bank
- Payment types under one create contract: single instant, periodic, on-demand, and defined schedule (fixed and variable variants)
- Creditor bank accounts that receive settlements
- User journeys that pre-select the bank or account, request extra consent permissions, or recognise returning payers
- Official SDKs for server and mobile integrations (UAE), with REST available for every market today
Field-level create rules live in Payment Request Deep Dives. Product-oriented type guides live in Payment Types.
Payment Types
| Payment type | Use when | Guide |
|---|---|---|
SingleInstantPayment | One-off checkout or invoice | Payment Types Β· Deep Dive |
Periodic (Fixed / Variable) | Subscriptions, rent, installments on a regular schedule | Payment Types Β· Payment Request Deep Dives |
On-demand (Fixed / Variable) | You trigger each debit within consented limits | Payment Types Β· Payment Request Deep Dives |
Defined schedule (Fixed / Variable) | Known future dates with fixed or max amounts | Payment Types Β· Payment Request Deep Dives |
User Journeys
Optional create-time controls that skip hosted steps or expand consent scope:
Debtor Account
Pre-supply the payer IBAN and skip account selection.
Pre-selected Provider
Pre-supply the bank and skip bank selection.
Consent Permissions
Request account and balance data with the payment consent.
Existing User
Capture, list, and reuse saved debtor accounts.
See the User Journeys hub for combining rules.
SDKs
Official Spare SDKs cover the UAE payment surface. All markets can integrate over REST today (schemas, examples, and in-browser Try-it in the API Reference).
| SDK | Role | Status |
|---|---|---|
TypeScript / Node (@spare-technologies/spare-api) | Server API client | Available |
React Native (@spare-technologies/spare-link) | Spare Link payment UI in iOS and Android apps | Available |
Flutter (spare_link) | Spare Link payment UI in Flutter apps | Available |
Python (spare-api) | Server API client | Under review |
Java (com.spare:spare-api) | Server API client | Under review |
C# (SpareApi) | Server API client | Under review |
| Go | Server API client | Under review |
Until a server SDK ships for your language, call the REST endpoints directly. Full install targets, language pages, and status detail live on the SDK Overview.
Quick Integration Guides
Setup your Bank Account
Register creditor accounts and set a default for settlements.
Make Your First Payment
Complete a Single Instant Payment in the UAE sandbox using Spare hosted pages.
Setup Your First Mandate
Create a Variable On Demand payment request, complete bank consent, and obtain a mandate.
Manage Your Mandates
List, approve, schedule, and immediately post mandate transactions.
Where Next
Payment Types
Choose the commercial pattern and follow the type guide.
Payment Request Deep Dives
Create-request fields and instructions per payment type.
User Journeys
Hosted-flow and consent controls for smoother payer UX.
Manage Your Mandates
List, approve, schedule, and immediately post mandate transactions.
SDK Overview
Official client libraries for UAE payments, or REST where an SDK is not yet published.
Payment Requests
API reference for create, get, list, and cancel.