API v2

درگاه پرداخت کلرا برای سایت‌ها

این API فقط باید از سرور سایت شما فراخوانی شود؛ API Key را داخل JavaScript مرورگر قرار ندهید.

در همه درخواست‌های ساخت و استعلام، هدر X-Api-Key الزامی است. مبلغ‌ها در API به تومان هستند.
POST /api/v2/payments

ساخت پرداخت و دریافت آدرس درگاه

POST https://klora.ir/api/v2/payments
Content-Type: application/json
X-Api-Key: YOUR_API_KEY

{
  "mobile": "09123456789",
  "amount": 990000,
  "returnUrl": "https://client.example/payment-result",
  "trackId": "ORDER-123"
}
{
  "paymentId": "00000000-0000-0000-0000-000000000000",
  "gatewayUrl": "https://sep.shaparak.ir/OnlinePG/OnlinePG?Token=...",
  "amount": 990000,
  "status": "pending",
  "trackId": "ORDER-123"
}
GET /api/v2/payments/{paymentId}

پس از بازگشت کاربر، وضعیت را با همین endpoint و API Key استعلام کنید. مقادیر وضعیت: pending، paid و failed.

جریان پرداخت
  1. سرور سایت شما درخواست ساخت پرداخت را ارسال می‌کند.
  2. کاربر به gatewayUrl هدایت می‌شود.
  3. کلرا callback بانک، شناسه سفارش و مبلغ را تأیید می‌کند.
  4. کاربر به returnUrl همراه paymentId، status، trackId و refNum برمی‌گردد.
  5. سرور سایت شما وضعیت نهایی را با endpoint استعلام تأیید می‌کند.