Overview

Create installment links, test transactions, and retrieve installment data for Amwal Online Checkout and POS integrations.

Authorization

Get your secret API key from the merchant dashboard's Integration tab, then include it in the Authorization header for every request.

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

Use the optional X-Amwal-Key header to choose an environment:

Sandbox: X-Amwal-Key: sandbox-amwal-xxx
Production: X-Amwal-Key: prod-amwal-xxx, or omit the header.

Request headers

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

🚀
Bank integration
Offer credit-card installment plans in partnership with AlRajhi Bank, Saudi National Bank, and other supported banks. Available installment terms include 3, 6, 12, and 24 months.

🔐
Biometric authentication
Amwal uses FIDO passkey technology for biometric checkout authentication.

Responses

Status code	Description
`200`	The request succeeded.
`401`	Authentication failed. Check your API key.
`404`	The resource was not found or the request data is invalid.

Explore the API

shopping-cart

Online Checkout

Create an installment link for a web-based transaction, then test the checkout flow.

credit-card

In-Store (POS) Checkout

Create installment links for in-store transactions with the Amwal POS integration.

chart-line

Transaction Management

Retrieve transaction details, handle webhook notifications, and manage installment data.