SpareSpare Docs
GuidesAPI Reference

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 typeUse whenGuide
SingleInstantPaymentOne-off checkout or invoicePayment Types Β· Deep Dive
Periodic (Fixed / Variable)Subscriptions, rent, installments on a regular schedulePayment Types Β· Payment Request Deep Dives
On-demand (Fixed / Variable)You trigger each debit within consented limitsPayment Types Β· Payment Request Deep Dives
Defined schedule (Fixed / Variable)Known future dates with fixed or max amountsPayment Types Β· Payment Request Deep Dives

User Journeys

Optional create-time controls that skip hosted steps or expand consent scope:

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).

SDKRoleStatus
TypeScript / Node (@spare-technologies/spare-api)Server API clientAvailable
React Native (@spare-technologies/spare-link)Spare Link payment UI in iOS and Android appsAvailable
Flutter (spare_link)Spare Link payment UI in Flutter appsAvailable
Python (spare-api)Server API clientUnder review
Java (com.spare:spare-api)Server API clientUnder review
C# (SpareApi)Server API clientUnder review
GoServer API clientUnder 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

Where Next

On this page