Home Getting Started Introduction & base URL

Introduction & base URL

Last updated on Jun 07, 2026

The PalCards API lets you — a registered dealer — integrate PalCards into your own system: browse the product catalog with your pricing, check your wallet balance, and place orders (vouchers and top‑ups) programmatically.

Base URL

Production:

https://api.palcards.ps

There is also a sandbox for testing — see Sandbox & production. Send Content-Type: application/json on requests with a JSON body.

Who can use it

The API is for dealers. You authenticate with an API key that you create yourself in the PalCards dealer panel. Every request runs on behalf of your dealer account — with your pricing and your wallet.

How authentication works

  1. Create an API key in the panel (API keys / مفاتيح API).
  2. Add the public IP address(es) of your server to the key's allowlist — this is required.
  3. Send your key in the x-api-key header on every request.
curl -H "x-api-key: sk_prod_your_key_here" \
  "https://api.palcards.ps/user/profile"

See Create & manage your API key and Authenticating requests for the details.

What you can do

Area Endpoint Article
Catalog & pricing GET /product/catalog Browse the product catalog
Wallet & balance GET /user/profile Wallet & balance
Place an order POST /order Create an order
Track orders GET /order, GET /order/{id} Retrieve orders
Get notified notificationUrl callback Order webhooks

Quick start

  1. Create an API key and allowlist your server's IP.
  2. Check your balance (GET /user/profile) to confirm the key works.
  3. Browse the catalog (GET /product/catalog) to get product IDs.
  4. Create an order (POST /order).

All responses are JSON. Amounts are returned as { "currency": "USD", "value": 12.5 } objects. For a full copy‑paste walkthrough, see the Quickstart.