الانتقال إلى المحتوى الرئيسي

معاملات الدفع

قبل أن تبدأ

تتم مصادقة طلبات API الخاصة بك باستخدام رمز وصول. أي طلب لا يتضمن رمز وصول صالحًا سيُعيد خطأ. تعرف على المزيد في المصادقة.

Base URL
  • UAT: https://transactions.transactional.uat.unico.app/api/public/v1
  • الإنتاج (Production): https://transactions.transactional.unico.app/api/public/v1

إنشاء معاملة

POST /credit/transaction — ينشئ معاملة جديدة.

خطر

لضمان تحويل أفضل، قم بإنشاء المعاملة فقط بعد إكمال أي مصادقة مسبقة أو تحقق قد ينهي العملية قبل تجربة التحقق من البطاقة غير الحاضرة.

خطر

يجب تعبئة حقل orderNumber برقم الطلب الفريد لتلك العملية الشرائية في نظام التجارة الإلكترونية — استخدام معرّف معاملة مختلف أمر غير صحيح. قد يؤدي إعادة استخدامه إلى انخفاض معدل التحويل (رقم الطلب يساعد المستخدم النهائي على إكمال المسار) وإلى أخطاء API مثل replicated transaction إذا تم استخدام نفس رقم الطلب و CPF و BIN وآخر 4 أرقام.

Headers
Headerالقيمة
AuthorizationBearer {token} — رمز وصول صالح.
Body
{
"identity": { "key": "cpf", "value": "12345678900" },
"orderNumber": "order-98765",
"company": "company-id",
"redirectUrl": "https://yourapp.com/checkout/return",
"card": {
"binDigits": "12345678",
"lastDigits": "1234",
"expirationDate": "12/2028",
"name": "John Doe"
},
"value": 199.90,
"mainContacts": [
{ "key": "phone", "value": "5543999999999" }
]
}
الحقلالنوعإلزاميالوصف
identityobjectنعمبيانات تعريف المستخدم.
identity.keystringنعمنوع مفتاح تعريف المستخدم. يُوصى باستخدام cpf — معدل تحويل أعلى.
identity.valuestringنعمقيمة مفتاح تعريف المستخدم، بدون نقاط أو شرطات.
orderNumberstringنعمرقم الطلب المرتبط بالمعاملة. يُستخدم كفهرس في البوابة وكمفتاح خارجي بين نظامك والتحقق من البطاقة غير الحاضرة.
companystringنعممعرّف الشركة المسؤولة عن المعاملة، مُقدَّم من Unico.
redirectUrlstringلاعنوان URL لإعادة توجيه المستخدم بعد إكمال المعاملة (عنوان URL بصيغة HTTPS للويب، أو مخطط URL لتطبيقات الجوال الأصلية).
cardobjectنعممعلومات حول البطاقة المُستخدمة في المعاملة.
card.binDigitsstringنعمأول 8 أرقام من البطاقة.
card.lastDigitsstringنعمآخر 4 أرقام من البطاقة.
card.expirationDatestringلاتاريخ انتهاء صلاحية البطاقة.
card.namestringنعماسم حامل البطاقة. أرسله بشكل صحيح، متجنبًا مشكلات الترميز — تُستخدم هذه البيانات في تجربة المستخدم والتواصل.
valuenumberنعمالقيمة الإجمالية للشراء.
mainContactsarrayلاقائمة جهات الاتصال الرئيسية (بريد إلكتروني و/أو هاتف) المُستخدمة لإشعار المستخدم، عندما يكون التحقق من البطاقة غير الحاضرة مسؤولاً عن الإشعار.
fallbackContactsarrayلاقائمة جهات الاتصال الاحتياطية، التي يتم تفعيلها في حال فشلت محاولات إشعار جهات الاتصال الرئيسية.
200 OK
{
"id": "6ab1771e-dfab-4e47-8316-2452268e5481",
"status": "processing",
"link": "https://developers/regional-solutions/card-not-present-verification.unico.app/t/6ab1771e-dfab-4e47-8316-2452268e5481",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiresAt": "2026-07-22T15:30:00Z"
}
الحقلالوصف
idمعرّف المعاملة التي تم إنشاؤها.
statusحالة المعاملة الحالية.
linkالرابط المرتبط بالمعاملة.
tokenرمز موقّع يحتوي على المعلمات اللازمة لتهيئة SDK الويب الخاص بالتحقق من البطاقة غير الحاضرة.
expiresAtتاريخ ووقت انتهاء صلاحية المعاملة، بصيغة ISO 8601 (UTC).
تحذير

إذا حدد التحقق أن الالتقاط البيومتري غير مطلوب، تكون الاستجابة بحالة مختلفة ولا يتم إنشاء رابط التقاط:

{
"id": "6ab1771e-dfab-4e47-8316-2452268e5481",
"status": "fast-inconclusive"
}

يحدث هذا عند استخدام وحدتي Pre أو Super Pre لصفحة الدفع (Checkout)، وفقًا لـ الميزة.

للاطلاع على استجابات الأخطاء، راجع الأخطاء — إنشاء المعاملة.

الحصول على حالة المعاملة

GET /credit/transactions/{transaction_id} — يتحقق من الحالة الحالية لمعاملة محددة.

Headers
Headerالقيمة
AuthorizationBearer {token} — رمز وصول صالح.
200 OK
{
"status": "processing"
}
الحقلالوصف
statusالحالة الحالية للمعاملة.

راجع القيم التعدادية للاطلاع على جميع الحالات الممكنة. لتحسين الأداء، نفّذ Webhook بدلاً من الاستقصاء المتكرر (polling) لهذه النقطة النهائية.

للاطلاع على استجابات الأخطاء، راجع الأخطاء — الحصول على حالة المعاملة.

الحصول على مجموعة إثباتات المعاملة

GET /credit/transactions/{transaction_id}/probative — يسترجع مجموعة الإثباتات لمعاملة محددة.

تحذير

لا يمكن إنشاء مجموعة الإثباتات إلا للمعاملات التي تمت الموافقة عليها.

خطر

الرابط المُعاد لمجموعة الإثباتات صالح لمدة خمس دقائق بعد الحصول عليه — لا تقم بحفظه، استخدمه لتنزيل مجموعة الإثباتات فورًا.

Headers
Headerالقيمة
AuthorizationBearer {token} — رمز وصول صالح.
200 OK
{
"link": "https://unico.io/probative.pdf"
}
الحقلالوصف
linkعنوان URL لملف الإثبات.

للاطلاع على استجابات الأخطاء، راجع الأخطاء — استرداد مجموعة الإثباتات الخاصة بالمعاملة.

إعادة إرسال إشعار المعاملة

POST /credit/transactions/{transaction_id}/notify — يعيد إرسال الإشعارات عبر البريد الإلكتروني و/أو الهاتف لمعاملة محددة.

ملاحظة

من الممكن أيضًا تهيئة إعادة إرسال الإشعارات عبر البوابة، دون تنفيذها عبر API. تحدث مع نقطة الاتصال الخاصة بمشروعك لفهم الإمكانيات المتاحة.

Headers
Headerالقيمة
AuthorizationBearer {token} — رمز وصول صالح.
Body
{
"phone": "NOTIFICATION_PHONE",
"email": "NOTIFICATION_EMAIL"
}
الحقلالنوعإلزاميالوصف
phonestringنعمرقم الهاتف لإرسال الإشعار إليه.
emailstringنعمعنوان البريد الإلكتروني لإرسال الإشعار إليه.
200 OK
{
"id": "b50ee24c-71eb-4a5d-ade1-41c48b44c240",
"link": "https://aces.so/example"
}
الحقلالوصف
idالمعرّف الفريد للإشعار الذي تم إنشاؤه.
linkالرابط الذي تم إنشاؤه للإشعار.

للاطلاع على استجابات الأخطاء، راجع الأخطاء — إعادة إرسال إشعار المعاملة.