SpareSpare Docs
GuidesAPI Reference

Refunds, Link Web SDK, and Reconciliation

UAE refunds, the Link Web SDK, and one call for every status on a payment request.

You can now return money to a payer after a UAE payment has settled. Send part of the amount, or refund the same payment more than once. Spare creates the refund payment for you, or you read the payer's account and pay it through your own channel.

The Link Web SDK puts Spare Link on your website. A checkout, a mandate, or an account-information flow can show bank selection in a modal, inline, or as a redirect.

Reconciliation reads the ids and statuses Spare has stored for one payment request.

Highlights

The short version:

  • Refunds are live for UAE. Return part of a completed payment, or return it more than once. Spare can pay the refund, or you can read the payer account and pay it yourself. Start with Refunds, then follow Issue a Refund.
  • The Link Web SDK is live for UAE. A website checkout, a mandate the payer approves in the browser, or an account-information flow can show Spare Link in a modal, inline, or as a redirect. The package is on npm as @spare-technologies/spare-link-web. Start with the Link Web SDK.
  • Reconciliation reads a payment in one call. It returns the payment request, its payments, and its mandates. Call GET /payments/{paymentId} when you need the bank's latest status for a payment. See Reconciliation.

The sections below have the requests, the trusted-origin setting, and the contract list.

What to Do Next

  • Read Refunds, then create one from Issue a Refund.
  • Add ReadRefundAccount to create the refund when the original payment request has no debtorAccount. POST /payment/refunds/account always needs that permission. The codes are on Consent Permissions.
  • Install @spare-technologies/spare-link-web and register your website on the API key your backend uses.
  • Read every id and status on a payment request in one call with Reconciliation, and call GET /payments/{paymentId} when you need the bank's latest status for a payment.

On this page