شروع کار › معرفی
معرفی
شبکهٔ پذیرنده سامانهای است که کسبوکارها را دور هم جمع کرده؛ مثلاً یک فروشگاهساز یا بازارگاه. با API رینگپی پذیرندههایتان را در رینگپی ثبت میکنید و برای سفارشهایشان پرداخت آنلاین میگیرید. پول به حساب خود پذیرنده تسویه میشود و سهم شبکه جدا حساب میشود.
export RINGPAY_BASE_URL="https://…"
export RINGPAY_API_KEY="…"دو API
- API شبکهٔ پذیرنده (
/merchant-network-api/v1): ثبت، بهروزرسانی و جستجوی پذیرندهها و ساختن لینک ورود مالک به پنل پذیرنده. - API درگاه (
/gateway-api/v1): ساختن صورتحساب، فرستادن مشتری به صفحهٔ پرداخت، خواندن وضعیت و تأیید مصرف.
هر API کلید جدای خودش را میخواهد؛ احراز هویت و کلید API را ببینید.
مسیر یک پرداخت
- پذیرنده را یک بار ثبت کنید و مالک را با لینک ورود به پنل بفرستید تا پذیرنده را فعال کند.
- برای هر سفارش صورتحساب بسازید و مشتری را به
pay_urlبفرستید. - مشتری روش پرداخت را انتخاب میکند، میپردازد و به
callback_urlشما برمیگردد. - وضعیت را از سرور با دریافت صورتحساب بخوانید؛ اگر
paidبود سفارش را ثبت کنید و تأیید مصرف را بزنید.
قراردادها
- درخواست و پاسخ JSON است؛ با بدنه
Content-Type: application/jsonبفرستید. - مبلغها رشتهٔ عددی به ریال است، مثلاً
"4900000"برای ۴۹۰ هزار تومان. - زمانها RFC 3339 به وقت UTC است، مثلاً
"2026-11-21T10:30:00Z". - شناسهها رشتهاند؛ ساختارشان را فرض نکنید.
- موبایلها با قالب E.164، مثلاً
"+989121234567". - فهرستها صفحهبهصفحهاند:
next_pageرا تا وقتیnullنشده بخوانید. - خطاها بدنهٔ
{"error": {"code", "message"}}دارند؛ خطاها را ببینید.