المرتجع

Markdown

قبل أن تبدأ

تتم مصادقة طلبات 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 — يُبلغ Unico بأنه تم تلقي مرتجع لمعاملة محددة.

الإبلاغ ليس اعتراضًا

تقتصر نقطة النهاية هذه على الإبلاغ عن المرتجع. ولا تفتح تحليل مرتجع ولا تُفعّل ضمان المسؤولية. لكي تحلّل Unico المرتجع، افتح اعتراضًا على المعاملة في البوابة.

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"
}

الحقل	النوع	إلزامي	الوصف
datetime	string	نعم	تاريخ ووقت تلقي المرتجع، بصيغة ISO 8601.
requestor	object	نعم	معلومات مقدّم الطلب.
requestor.key	string	نعم	نوع مفتاح تعريف مقدّم الطلب (مثل cpf).
requestor.value	string	نعم	قيمة مفتاح تعريف مقدّم الطلب.
name	string	نعم	اسم مقدّم الطلب.
reason	string	نعم	سبب المرتجع.
observation	string	لا	ملاحظات عامة حول المرتجع.

201 Created

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

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

تحتوي المعاملة على مرتجع واحد فقط. يؤدي الإبلاغ عن معاملة لديها مرتجع بالفعل إلى إرجاع 200 OK مع 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	الحالة الحالية للمرتجع.

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