API Reference Overview

The Amwal REST API empowers developers to create installment links, test sandbox transactions, and retrieve real-time payment data for both Online Checkout and In-Store POS integrations.

Authorization

Retrieve your secret API key from the Merchant Dashboard under Integrations → Secret Key, 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 select 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

Response Status Codes

Status Code	Description
`200`	The request succeeded.
`400`	Invalid input parameters or payload validation failure.
`401`	Authentication failed. Check your API key.
`404`	Resource not found or invalid URL path.

Interactive Testing & Checkout Flows

API Playground

Run live and simulated cURL requests, import commands, and generate multi-language client code.

Online Checkout Flow

Create installment links for web-based e-commerce transactions and reconcile via callbacks and webhooks.

In-Store Checkout (POS)

Create installment links for in-store physical retail transactions with cashier terminals and dynamic QR codes.