curl --request GET \
--url https://api.oneclickdz.com/v3/ocpay/checkPayment/OCPL-A1B2C3-D4E5 \
--header 'X-Access-Token: YOUR_API_KEY'
const response = await fetch(
"https://api.oneclickdz.com/v3/ocpay/checkPayment/OCPL-A1B2C3-D4E5",
{
method: "GET",
headers: {
"X-Access-Token": "YOUR_API_KEY",
},
}
);
const data = await response.json();
console.log("Payment Status:", data.data.status);
console.log("Message:", data.data.message);
import requests
ref = "OCPL-A1B2C3-D4E5"
url = f"https://api.oneclickdz.com/v3/ocpay/checkPayment/{ref}"
headers = {
"X-Access-Token": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
data = response.json()
print(f"Payment Status: {data['data']['status']}")
print(f"Message: {data['data']['message']}")
<?php
$ref = 'OCPL-A1B2C3-D4E5';
$url = "https://api.oneclickdz.com/v3/ocpay/checkPayment/{$ref}";
$headers = [
'X-Access-Token: YOUR_API_KEY'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
$data = json_decode($response, true);
echo "Payment Status: " . $data['data']['status'] . "\n";
echo "Message: " . $data['data']['message'] . "\n";
?>
Navio
التحقق من حالة الدفع
تحقق من الحالة الحالية لدفع باستخدام كود مرجعه
GET
/
v3
/
ocpay
/
checkPayment
/
:ref
curl --request GET \
--url https://api.oneclickdz.com/v3/ocpay/checkPayment/OCPL-A1B2C3-D4E5 \
--header 'X-Access-Token: YOUR_API_KEY'
const response = await fetch(
"https://api.oneclickdz.com/v3/ocpay/checkPayment/OCPL-A1B2C3-D4E5",
{
method: "GET",
headers: {
"X-Access-Token": "YOUR_API_KEY",
},
}
);
const data = await response.json();
console.log("Payment Status:", data.data.status);
console.log("Message:", data.data.message);
import requests
ref = "OCPL-A1B2C3-D4E5"
url = f"https://api.oneclickdz.com/v3/ocpay/checkPayment/{ref}"
headers = {
"X-Access-Token": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
data = response.json()
print(f"Payment Status: {data['data']['status']}")
print(f"Message: {data['data']['message']}")
<?php
$ref = 'OCPL-A1B2C3-D4E5';
$url = "https://api.oneclickdz.com/v3/ocpay/checkPayment/{$ref}";
$headers = [
'X-Access-Token: YOUR_API_KEY'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
$data = json_decode($response, true);
echo "Payment Status: " . $data['data']['status'] . "\n";
echo "Message: " . $data['data']['message'] . "\n";
?>
نظرة عامة
تحقق من حالة الدفع في الوقت الفعلي باستخدام مرجع الدفع. ضروري لمعالجة الطلبات والاستعلام عن الحالة والتحقق من المدفوعات.الكشف التلقائي عن البيئة: يتحقق هذا الـ endpoint تلقائياً من معاملات الإنتاج (SATIM) والـ sandbox بناءً على مكان إنشاء الدفع.
معاملات المسار
string
مطلوب
كود مرجع الدفع (التنسيق:
OCPL-XXXXXX-YYYY)هذا هو
paymentRef الذي يُعاد عند إنشاء رابط الدفعالاستجابة
boolean
يشير إلى نجاح العملية
object
معلومات حالة الدفع
إظهار خصائص data
إظهار خصائص data
string
حالة الدفع الحالية -
PENDING - الدفع لم يُبدأ بعد أو قيد المعالجة - CONFIRMED - الدفع ناجح - FAILED - فشل الدفع أو انتهت صلاحية الرابطstring
وصف قابل للقراءة للحالة
string
كود مرجع الدفع
object
شرح قيم الحالة
PENDING
PENDING
عند رؤية هذه الحالة:
- لم يبدأ العميل عملية الدفع بعد
- الدفع قيد المعالجة من قِبل البنك
- الرابط تم إنشاؤه للتو ولم يُستخدم بعد
- استمر في الاستعلام عن تحديثات الحالة
- اعرض “الدفع معلق” للعميل
- لا تُنفِّذ الطلب بعد
CONFIRMED
CONFIRMED
عند رؤية هذه الحالة: - اكتمل الدفع بنجاح - ستُضاف الأموال إلى رصيد OneClick الخاص بكما يجب فعله:
- ضع علامة على الطلب كمدفوع في نظامك
- نفِّذ الطلب/قدِّم الخدمة
- أرسل تأكيداً للعميل
FAILED
FAILED
عند رؤية هذه الحالة:
- تم رفض الدفع أو فشل
- انتهت صلاحية رابط الدفع (20 دقيقة)
- ألغى العميل الدفع
- ضع علامة على الطلب كفاشل/ملغى
- أنشئ رابط دفع جديداً إذا أراد العميل إعادة المحاولة
- لا تُنفِّذ الطلب
انتهاء صلاحية الرابط
تنتهي صلاحية روابط الدفع بعد 20 دقيقة من الإنشاء إذا لم يُبدأ أي دفع. بعد انتهاء الصلاحية ستكون الحالة
FAILED.curl --request GET \
--url https://api.oneclickdz.com/v3/ocpay/checkPayment/OCPL-A1B2C3-D4E5 \
--header 'X-Access-Token: YOUR_API_KEY'
const response = await fetch(
"https://api.oneclickdz.com/v3/ocpay/checkPayment/OCPL-A1B2C3-D4E5",
{
method: "GET",
headers: {
"X-Access-Token": "YOUR_API_KEY",
},
}
);
const data = await response.json();
console.log("Payment Status:", data.data.status);
console.log("Message:", data.data.message);
import requests
ref = "OCPL-A1B2C3-D4E5"
url = f"https://api.oneclickdz.com/v3/ocpay/checkPayment/{ref}"
headers = {
"X-Access-Token": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
data = response.json()
print(f"Payment Status: {data['data']['status']}")
print(f"Message: {data['data']['message']}")
<?php
$ref = 'OCPL-A1B2C3-D4E5';
$url = "https://api.oneclickdz.com/v3/ocpay/checkPayment/{$ref}";
$headers = [
'X-Access-Token: YOUR_API_KEY'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
$data = json_decode($response, true);
echo "Payment Status: " . $data['data']['status'] . "\n";
echo "Message: " . $data['data']['message'] . "\n";
?>
{
"success": true,
"data": {
"status": "CONFIRMED",
"message": "Payment confirmed successfully",
"paymentRef": "OCPL-A1B2C3-D4E5",
"transactionDetails": {
"amount": 5000,
"currency": "DZD",
"isSandbox": false,
"createdDate": "2025-01-15T10:30:00Z"
}
},
"meta": {
"timestamp": "2025-01-15T10:35:00Z",
"requestId": "req_abc123xyz"
}
}
{
"success": true,
"data": {
"status": "PENDING",
"message": "Payment not yet initiated",
"paymentRef": "OCPL-A1B2C3-D4E5",
"transactionDetails": {
"amount": 5000,
"currency": "DZD",
"isSandbox": false
}
},
"meta": {
"timestamp": "2025-01-15T10:32:00Z",
"requestId": "req_abc123xyz"
}
}
مثال التكامل
إليك كيفية تنفيذ التحقق من الحالة في نظام الطلبات الخاص بك:async function checkOrderPayment(orderId) {
// Get payment ref from your database
const order = await db.orders.findOne({ id: orderId });
if (!order || !order.paymentRef) {
throw new Error("Order not found or no payment link");
}
// Check payment status
const response = await fetch(
`https://api.oneclickdz.com/v3/ocpay/checkPayment/${order.paymentRef}`,
{
headers: { "X-Access-Token": process.env.ONECLICK_API_KEY },
}
);
const data = await response.json();
// Update order status based on payment status
switch (data.data.status) {
case "CONFIRMED":
await db.orders.update(orderId, {
status: "paid",
paidAt: new Date(),
});
await fulfillOrder(orderId);
break;
case "FAILED":
await db.orders.update(orderId, {
status: "payment_failed",
});
break;
case "PENDING":
// Keep polling
break;
}
return data.data;
}
الخطوات التالية
إنشاء رابط دفع
تعلم كيفية إنشاء روابط الدفع
دليل التكامل
دليل تكامل Navio الكامل