إصدار المطورين v1.0.4

وثائق الربط البرمجي API

دليل تقني شامل لدمج حلول PayPcl المالية في أنظمتكم البرمجية بكفاءة عالية وأمان فائق.

الأساسيات

المدفوعات

الأكواد والأخطاء

نظرة عامة

تعتمد واجهة PayPcl على RESTful architecture. نستخدم طرق HTTP القياسية للتعامل مع العمليات، حيث POST للإنشاء، GET للجلب، و PUT للتحديث. نظامنا مصمم لخدمة العمليات المالية الضخمة بزمن استجابة لا يتعدى 200ms.

التوثيق والأمان

يتم تضمين المفتاح السري في كل طلب HTTP داخل الـ Header. تأكد دائماً من استخدام مفاتيح البيئة التجريبية (Test Keys) أثناء التطوير.

Authorization: Bearer sk_live_51Mxxxxxxxxxxxxxxxxxx
POST

إنشاء طلب دفع (Create Payment)

هذا المسار هو نقطة البداية لأي عملية دفع. يقوم بإنشاء سجل مؤقت في قاعدة بياناتنا وانتظار تحويل العميل.

الحقل النوع الإلزامي الوصف
amountfloatمطلوبالقيمة الإجمالية
currencystringمطلوبرمز العملة (ISO 4217)
order_idstringاختياريرقم الطلب في نظامكم

الويب هوك (Webhooks)

نرسل إشعارات لحظية لروابطكم عند حدوث تغييرات. هيكل البيانات المرسلة يكون كالتالي:

{ "event": "payment.succeeded", "data": { "id": "pay_987654", "status": "completed", "amount": 500.00 } }

رموز الاستجابة

200 تم الطلب بنجاح
400 خطأ في الباراميترز
401 المفتاح غير صالح