Loam Customer API · معاينة

مركز المطورين

ابدأ من هنا للبناء على Loam Customer API.

كلا المسارين يتطلبان بيانات اعتماد. ابدأ بـإنشاء عميل API.

المدفوعات التي يمكنك عرضها اليوم

اعرض مدفوعات المؤسسة باستخدام رمز الحامل. صفحة فارغة تُعد نجاحًا — لم يُسجل أي شيء بعد. إرسال الأموال هو استدعاء مختلف: يتطلب نطاق money.write، ومنح المالك ضمن مصادقة تصعيدية، ووجهة معتمدة، ويظل مغلقًا في وضع المعاينة.

GET /api/v1/payments
curl -H "Authorization: Bearer $LOAM_TOKEN" \  "$LOAM_API_BASE/payments"// Response
{
  "ok": true,
  "data": [
    {
      "id": "c4d8e2f0-1a3b-45cd-8e9f-0a1b2c3d4e5f",
      "state": "settled",
      "source_kind": "wallet_transfer",
      "fiat_amount": 2500000,
      "fiat_currency": "USD",
      "crypto_amount": null,
      "crypto_currency": null,
      "trade_id": null,
      "created_at": "2026-07-14T09:12:04.118Z",
      "updated_at": "2026-07-14T09:14:11.004Z",
      "settled_at": "2026-07-14T09:14:11.004Z",
      "failed_at": null
    }
  ],
  "page": { "next_cursor": null }
}

ما يغطيه الـ API اليوم

وصول المعاينة أضيق عمدًا من العقد المنشور. كل ما أدناه قابل للاستدعاء الآن أو يذكر الإذن الذي ينتظره.

افتح في المعاينة النطاقان read وwrite

  • الأرصدة المسوّاة GET /api/v1/balances
  • المدفوعات المدرجة GET /api/v1/payments
  • مصطلحات خزنة الخزانة GET /api/v1/vaults
  • عروض أسعار الصرف POST /api/v1/fx/quotes

مغلق في المعاينة النطاق money.write

  • المدفوعات إلى وجهة معتمدة POST /api/v1/payments
  • أموال واردة من حساب بنكي POST /api/v1/onramp
  • أموال صادرة إلى حساب بنكي POST /api/v1/offramp
  • إيداعات وسحوبات الخزنة POST /api/v1/vaults/…

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

كيفية سلوك الـ API

  • OAuth 2.0

    منح بيانات اعتماد العميل

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

  • مغلف

    شكل واحد لكل مسار

    النجاح هو ok ثم data؛ الفشل هو ok: false مع رمز خطأ مقروء آليًا.

  • قابلية إعادة التنفيذ بأمان

    إعادة المحاولة لا تكلف شيئًا

    تتطلب كل عملية كتابة Idempotency-Key. نفس المفتاح وبنفس المحتوى يعيد نتيجة العملية الأولى بدلًا من الكتابة مرتين.

  • التقسيم إلى صفحات

    مؤشرات، لا إزاحات

    دوال القائمة تُرجع page.next_cursor. أعد تمريرها كـ cursor حتى تعود بقيمة null.

اختر مسارًا من هنا: البدء السريع إذا أردت طلبًا عمليًا جاهزًا أولًا، والمرجع إذا كنت تعرف بالفعل الاستدعاء الذي تحتاجه.