المرتجع

قبل أن تبدأ

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

Base URL

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

طلب مراجعة المرتجع

POST /credit/transactions/{transaction_id}/chargeback — يطلب مراجعة مرتجع لمعاملة محددة.

Headers

Header	القيمة
Authorization	Bearer {token} — رمز وصول صالح.

Body

{
  "datetime": "2023-01-05T03:00:00.000Z",
  "requestor": { "key": "cpf", "value": "USER_CPF" },
  "name": "USER_NAME",
  "reason": "REQUEST_REASON",
  "observation": "GENERAL_OBSERVATIONS",
  "documents": [
    { "label": "FILE_NAME", "data": "JVBERi0xLjQKMSAwI==" }
  ]
}

الحقل	النوع	إلزامي	الوصف
datetime	string	نعم	تاريخ ووقت طلب المرتجع، بصيغة ISO 8601.
requestor	object	نعم	معلومات مقدّم الطلب.
requestor.key	string	نعم	نوع مفتاح تعريف مقدّم الطلب (مثل cpf).
requestor.value	string	نعم	قيمة مفتاح تعريف مقدّم الطلب.
name	string	نعم	اسم مقدّم الطلب.
reason	string	نعم	سبب طلب المرتجع.
observation	string	لا	ملاحظات عامة حول الطلب.
documents	array	لا	المستندات المتعلقة بالمرتجع. حتى 3 عناصر، كل منها مُرمّز بصيغة Base64 — بصيغة PDF فقط.
documents[].label	string	نعم (لكل عنصر)	اسم الملف أو وصفه.
documents[].data	string	نعم (لكل عنصر)	ملف PDF مُرمّز بصيغة Base64.

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}

الحقل	الوصف
id	معرّف المرتجع الذي تم إنشاؤه.

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

الحصول على حالة مراجعة المرتجع

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

Headers

Header	القيمة
Authorization	Bearer {token} — رمز وصول صالح.

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "status": "waiting"
}

الحقل	الوصف
id	معرّف المرتجع.
status	الحالة الحالية للمرتجع.

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