๐Ÿš€ Overview

This Quickstart is a brief introduction to Amwal's Online Checkout and POS APIs

Whether you're a seasoned developer or just getting started, this guide will help you integrate Amwal's cutting-edge installment and biometric checkout solutions with minimal effort. With a few copy-and-paste steps, you'll be testing real-time installment flows and secure biometric authentication in no time.

In just a few minutes, you'll be able to create installment links, simulate transactions, and retrieve installment data for both online and in-store experiences using Amwal's revolutionary passkeys-based payment platform.


๐Ÿงญ Authorization

All requests require the secret API key in the Authorization header. This key can be found in the merchant dashboard under the Integration tab.

Base URL https://backend.sa.amwal.tech

Use the optional X-Amwal-Key header to specify the environment for all API requests:

  • Sandbox testing X-Amwal-Key: sandbox-amwal-xxx
  • Production X-Amwal-Key: prod-amwal-xxx (or omit the header to default to production)

This allows you to safely test flows before going live.

Request Header

Authorization: your_api_key_here
Content-Type: application/json
X-Amwal-Key: sandbox-amwal-xxx  # Optional: for sandbox testing
๐Ÿš€

** Bank Integration**

Amwal now offers fully automated Credit Card Installment Solutions in partnership with AlRajhi Bank, Saudi National Bank and others to enable instant conversion of purchases into 3, 6, 12 & 24 month installments with 95% approval rates and zero friction checkout.

๐Ÿ”

Biometric Authentication

Leverage Amwal's FIDO-passkey technology for 10-second checkouts that are 3x more secure than OTP-based authentication and 10x faster than industry average.


Error Response

Status CodeDescription
200Success
401Authentication failed
404Not found or Invalid sent data

๐Ÿ“‹ What You'll Learn