← Products
REST API & SDK

Build Anything.
Ship Fast.

A modern, fully-documented REST API built for developers who need full control. OpenAPI 3.0 spec, sandbox environment, webhooks, and SDKs in Node.js, Python, and PHP.

99.9%
Uptime SLA
3
Official SDKs
OpenAPI
3.0 Documented
Sandbox
Test Environment

Core API Endpoints

POST/v1/paymentsCreate a new payment — card, crypto, or COD. Returns payment_id and checkout URL.
GET/v1/payments/:idRetrieve full payment details — status, amount, currency, method, timestamps.
POST/v1/refundsIssue a full or partial refund against any settled payment.
GET/v1/settlementsList all settlement records — dates, amounts, fees, net payouts per currency.
POST/v1/webhooksRegister a webhook endpoint to receive real-time payment events.
GET/v1/balanceGet your current merchant balance per currency in real time.

Official SDKs

🟩Node.jsnpm install zyrix-sdk
const zyrix = require('zyrix-sdk');
const payment = await zyrix.payments.create({
  amount: 25000,
  currency: 'IQD',
  method: 'card'
});
🐍Pythonpip install zyrix
import zyrix
client = zyrix.Client(api_key)
payment = client.payments.create(
  amount=250,
  currency='SAR',
  method='crypto'
)
🐘PHPcomposer require zyrix/sdk
$zyrix = new Zyrix\Client($apiKey);
$payment = $zyrix->payments->create([
  'amount' => 1500,
  'currency' => 'TRY',
  'method' => 'card'
]);

Webhook Events

payment.completed

Fired when a payment is fully confirmed and funds are captured.

payment.failed

Fired when a payment attempt fails — includes error code and reason.

payment.pending

Fired for crypto payments awaiting blockchain confirmation.

refund.issued

Fired when a refund is successfully processed.

dispute.opened

Fired when a chargeback or dispute is raised by the customer's bank.

settlement.completed

Fired when a settlement batch is processed and funds are on their way.

Developer Experience

📖

OpenAPI 3.0 Spec

Full machine-readable API specification. Import into Postman, Insomnia, or any API client. Auto-generate client code in 40+ languages.

🧪

Sandbox Environment

Complete test environment with simulated payment flows, webhook delivery, and settlement cycles. Test cards, test crypto wallets, test COD.

🔑

API Key Management

Generate separate live and test API keys. Restrict keys by IP, domain, or permission scope. Rotate keys without downtime.

📊

Request Logs

Full request and response logs for every API call — filterable by endpoint, status, time. Debug integration issues without guessing.

Low Latency

API response times under 200ms for most endpoints. Hosted on edge infrastructure across MENA & Europe for minimal latency.

🔒

HMAC Webhook Signing

Every webhook is signed with HMAC-SHA256. Verify signatures on your server to ensure events are genuinely from Zyrix.

Start Building

Get your sandbox API keys and start integrating in minutes.