پرش به مطلب اصلی

مستندات API درگاه پرداخت ارز دیجیتال OrcaRail

به مستندات API ‏OrcaRail خوش آمدید. OrcaRail یک API و SDK استاندارد و ساده برای برنامه‌نویسان است تا در سایت یا اپلیکیشن خود پرداخت با ارز دیجیتال (رمز ارز یا کریپتو) را با استیبل کوین‌هایی مثل تتر (USDT) و USDC دریافت کنید.

شروع سریع​

  1. داشبورد را باز کنید و ثبت‌نام کنید (یا وارد شوید)؛ راهنمای ساخت حساب را ببینید.
  2. پس از ورود، اولین سازمان (organization) خود را بسازید. بدون سازمان نمی‌توانید در داشبورد ادامه دهید.
  3. از داشبورد ← API Keys کلید API بسازید.
  4. از SDK نود جی‌اس یا SDK پی‌اچ‌پی استفاده کنید، یا نسخه نمایشی را امتحان کنید.
  5. برای شروع دریافت پرداخت، یک Payment Intent بسازید.

OrcaRail چیست؟​

OrcaRail یک درگاه پرداخت ارز دیجیتال است که به شما امکان می‌دهد از مشتریان خود با استیبل کوین پرداخت بگیرید. با OrcaRail می‌توانید:

  • ✅ پرداخت با استیبل کوین (USDC، تتر USDT و ...) را بپذیرید
  • ✅ Payment Intent بسازید و مشتری را به صفحه پرداخت آماده (hosted pay) بفرستید
  • ✅ اعلان‌های لحظه‌ای وب‌هوک دریافت کنید
  • ✅ از چند شبکه بلاکچین پشتیبانی کنید (مرور چندشبکه‌ای)
  • ✅ پرداخت دوره‌ای را با اشتراک‌ها اجرا کنید، از جمله برداشت خودکار (auto-charge) روی EVM و سولانا
  • ✅ پرداخت‌ها را با یک API و SDK استاندارد و ساده مدیریت کنید

تعرفه: نسخه میزبانی‌شده OrcaRail برای هر تراکنش تکمیل‌شده ۰٫۵٪ کارمزد دارد و ۱٬۰۰۰ تراکنش اول رایگان است؛ نصب روی سرور خودتان (self-hosted) هیچ هزینه نرم‌افزاری از طرف ما ندارد. SDKها، MCP و افزونه‌ها با مجوز MIT منتشر شده‌اند؛ مجموعه میزبانی‌شده api / app / pay متن‌باز نیست. پیش‌فاکتور پرداخت می‌تواند ردیف‌های اختیاری جداگانه (پشتیبانی، کمیسیون، بریج) داشته باشد؛ کارمزدها و محدودیت‌ها را ببینید.

ویژگی‌های اصلی​

Payment Intent (درخواست پرداخت)​

برای دریافت پرداخت از مشتری، Payment Intent بسازید. روند ساده است:

  1. یک Payment Intent بسازید
  2. آن را تأیید (confirm) کنید تا آدرس هدایت (redirect URL) را بگیرید
  3. مشتری را به صفحه پرداخت آماده هدایت کنید
  4. اعلان وب‌هوک را دریافت کنید

درباره Payment Intent بیشتر بخوانید ←

اشتراک (پرداخت دوره‌ای)​

با API اشتراک OrcaRail پرداخت دوره‌ای با ارز دیجیتال بگیرید: بازه‌های ثابت، دوره آزمایشی، لینک پرداخت برای هر دوره، یا برداشت خودکار (برداشت دوره‌ای پس از تأیید پرداخت‌کننده روی EVM یا سولانا).

مرور اشتراک‌ها ←

چندشبکه‌ای (Multichain)​

روی شبکه‌های متعدد پرداخت بگیرید، برای هر نوع زنجیره آدرس برداشت تعیین کنید و فهرست شبکه‌ها و توکن‌های پشتیبانی‌شده را با Relay هماهنگ نگه دارید. فهرست به‌روز در شبکه‌ها و توکن‌ها آمده است.

مرور چندشبکه‌ای ←

وب‌هوک‌ها​

از رویدادهای پرداخت به‌صورت لحظه‌ای باخبر شوید:

  • payment_intent.completed - پرداخت تکمیل شد
  • payment_intent.processing - پرداخت در حال پردازش است
  • payment_intent.canceled - پرداخت لغو شد

وب‌هوک را برای هر کلید API جداگانه تنظیم کنید و تحویل آن را در لاگ وب‌هوک‌ها پیگیری کنید.

درباره وب‌هوک‌ها بیشتر بخوانید ←

احراز هویت​

OrcaRail از دو روش احراز هویت پشتیبانی می‌کند:

  • Bearer Token (JWT) - برای درخواست‌هایی که کاربر در آن‌ها وارد شده است
  • کلید API (Basic Auth) - برای درخواست‌های سرور به سرور

درباره احراز هویت بیشتر بخوانید ←

SDK نود جی‌اس (Node.js)​

پرداخت را با SDK رسمی پیاده‌سازی کنید. نصب از npm: @orcarail/node.

  • ساخت و تأیید Payment Intent
  • پرداخت با slug
  • بررسی امضای وب‌هوک و پردازش رویدادها

راهنمای SDK نود جی‌اس ←

SDK پی‌اچ‌پی (PHP)​

پرداخت را از PHP 8.1 به بالا با پکیج رسمی Composer یعنی orcarail/orcarail-php پیاده‌سازی کنید.

  • یک OrcaRailClient با سرویس‌های lazy
  • Payment Intent، اشتراک، پرداخت با slug، کاتالوگ و نرخ‌ها
  • بررسی امضای وب‌هوک و پردازش رویدادها

راهنمای SDK پی‌اچ‌پی ←

سرور MCP​

دستیارهای برنامه‌نویسی هوش مصنوعی مثل Claude Code، Cursor و Codex را با سرور رسمی Model Context Protocol یعنی @orcarail/mcp وصل کنید.

  • ساخت و تأیید Payment Intent از داخل دستیار
  • مدیریت اشتراک‌ها، محصولات و قیمت‌ها
  • دریافت نرخ تبدیل و جزئیات صفحه پرداخت (برای rates.* و pay.* نیازی به کلید نیست)

راهنمای سرور MCP ←

اپلیکیشن نمونه (Demo)​

نسخه نمایشی متن‌باز را اجرا کنید تا کل روند را ببینید: ساخت intent، هدایت به صفحه پرداخت، صفحه موفقیت و وب‌هوک‌ها.

راهنمای اپلیکیشن نمونه ←

شروع کار​

تازه با OrcaRail آشنا شده‌اید؟ از اینجا شروع کنید:

در اولین ورود به داشبورد، پیش از ساخت کلید API باید یک سازمان بسازید.

  1. شروع کار - ساخت حساب، ساخت سازمان و ساخت کلید API
  2. SDK نود جی‌اس - پیاده‌سازی با @orcarail/node، یا SDK پی‌اچ‌پی با orcarail/orcarail-php
  3. اپلیکیشن نمونه - اجرای نسخه نمایشی متن‌باز (GitHub)
  4. راهنمای Payment Intent - یاد بگیرید چطور پرداخت بگیرید
  5. راهنمای وب‌هوک - اعلان‌های پرداخت را راه بیندازید
  6. تنظیم وب‌هوک - وب‌هوک را برای کلیدهای API تنظیم کنید
  7. اشتراک‌ها - پرداخت دوره‌ای و برداشت خودکار
  8. چندشبکه‌ای - شبکه‌ها، برداشت و هماهنگی با Relay
  9. مرجع API - مستندات کامل API

کمک لازم دارید؟​

پشتیبانی​

برای پشتیبانی به [email protected] ایمیل بزنید یا به مخزن GitHub سر بزنید.