مرجع عام

Payments

كل نقاط النهاية في هذه المجموعة. افتح أي واحدة لعرض معاملاتها ومثال عملي عليها.

14 نقاط النهاية

اعرض الصفحة بصيغة Markdown

Payments

GET /api/v1/admin/payments/config List configured gateways prm_settings

Just the tenant's configured rows, with credentials masked, for a page that already holds the catalogue.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_settings Manage settings

افتح المرجع الكامل

POST /api/v1/admin/payments/config Configure a gateway prm_settings

Upserts one gateway's credentials and settings. Every field is keep-existing, so a partial payload leaves unsent credentials alone rather than clearing them.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_settings Manage settings
حد المعدل: t_mutate

المعاملات

المعامل	الوصف
`gateway`مطلوب body · string	Driver id from the catalogue.

افتح المرجع الكامل

DELETE /api/v1/admin/payments/config/{gateway} Remove a gateway configuration prm_settings

Deletes the tenant's credentials for one driver. Transactions already recorded against it are untouched.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_settings Manage settings
حد المعدل: t_mutate

المعاملات

المعامل	الوصف
`gateway`مطلوب path · string	Driver id.

افتح المرجع الكامل

PATCH /api/v1/admin/payments/config/{gateway} Update one gateway's configuration prm_settings

The same upsert as the POST, with the gateway named in the path. The PATH wins over any gateway field in the body, so a stale client cannot retarget an edit at a different gateway.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_settings Manage settings
حد المعدل: t_mutate

المعاملات

المعامل	الوصف
`gateway`مطلوب path · string	Driver id.

افتح المرجع الكامل

POST /api/v1/admin/payments/config/{gateway}/test Test a gateway configuration prm_settings

Checks the stored credentials against the provider.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_settings Manage settings
حد المعدل: t_mutate

المعاملات

المعامل	الوصف
`gateway`مطلوب path · string	Driver id.

افتح المرجع الكامل

GET /api/v1/admin/payments/config/{gateway}/webhook-url Read a gateway's callback URL prm_settings

The exact URL to register with the provider, including the per-tenant secret path segment. Copy it verbatim.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_settings Manage settings

The URL contains a secret. It is what proves an inbound callback came from the provider you configured, so treat the response as a credential and do not paste it into a ticket.

المعاملات

المعامل	الوصف
`gateway`مطلوب path · string	Driver id.

افتح المرجع الكامل

POST /api/v1/admin/payments/deposit Top up own wallet online prm_managers_self_deposit

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_managers_self_deposit Top up own wallet online
حد المعدل: pay_init

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

افتح المرجع الكامل

GET /api/v1/admin/payments/deposit/gateways Top up own wallet online prm_managers_self_deposit

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_managers_self_deposit Top up own wallet online

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

افتح المرجع الكامل

GET /api/v1/admin/payments/gateways List the gateway catalogue and what is configured prm_settings

The drivers this build supports, the tenant's own configured rows with secrets masked, and the public base URL a gateway should call back to.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_settings Manage settings

Read implemented and pollable before building against a driver. implemented false is a registry stub whose vendor contract is not verified; pollable false means the gateway has no merchant-readable status API, so its callback is the only channel and a lost callback is a lost payment. min_amount is the PSP's own floor in major units, and 0 means no floor.

افتح المرجع الكامل

الاستجابة 200 OK

{
  "data": {
    "catalog": [
      {
        "id": "paymob",
        "label": "Paymob",
        "methods": [],
        "fields": [],
        "ttl_seconds": 900,
        "min_amount": 0,
        "implemented": true,
        "pollable": true
      }
    ],
    "configured": [],
    "public_base_url": "https://acme.example.com"
  }
}

GET /api/v1/admin/payments/transactions/{id}

المصادقة: رمز موظّف أو جلسة
تتطلب أيًّا من: prm_report_gateway_transactions prm_report_gateway_transactions_all

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

افتح المرجع الكامل

POST /api/v1/admin/payments/transactions/{id}/recheck Re-check and write off gateway transactions prm_payments_manage

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_payments_manage Re-check and write off gateway transactions
حد المعدل: pay_init

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

افتح المرجع الكامل

POST /api/v1/admin/payments/transactions/{id}/refund Mark gateway payments paid / refunded (moves money) prm_payments_settle

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_payments_settle Mark gateway payments paid / refunded (moves money)
حد المعدل: pay_init

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

افتح المرجع الكامل

POST /api/v1/admin/payments/transactions/{id}/settle Mark gateway payments paid / refunded (moves money) prm_payments_settle

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_payments_settle Mark gateway payments paid / refunded (moves money)
حد المعدل: pay_init

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

افتح المرجع الكامل

POST /api/v1/admin/payments/transactions/{id}/status Re-check and write off gateway transactions prm_payments_manage

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_payments_manage Re-check and write off gateway transactions
حد المعدل: t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

افتح المرجع الكامل

مكتوب لتقرأه الأدوات الآلية أيضًا

المرجع عام ولا يتطلب حسابًا، فتستطيع أداة لم تَرَ X-Radius من قبل أن تصل إلى أول استدعاء صحيح بنفسها.

/llms.txt: فهرس لكل صفحة، مع ملخّص من سطر واحد.
/llms-full.txt: المرجع كاملًا في ملف Markdown واحد، دون تنقّل يحتاج إلى زحف.
/openapi.json: ‏OpenAPI 3.1، مُولَّد من الموجّه الذي يخدم هذه النسخة.
/skill.md: ملف مهارة جاهز لمساعد آلي: المصادقة وشكل الاستجابة ورموز الأخطاء في صفحة واحدة.
<page-url>.md: أضف ‎.md إلى رابط أي صفحة في المرجع لتحصل على الصفحة نفسها بصيغة Markdown.
Accept: text/markdown: أرسل هذه الترويسة على الرابط المعتاد فتصلك الإجابة بصيغة Markdown بدلًا من الصفحة.

سلّم هذا السطر إلى مساعدك الآلي

اقرأ https://x-radius.com/llms.txt، ثم اجلب نقطة النهاية التي تحتاجها بصيغة Markdown بإضافة ‎.md إلى رابطها.

جرّبه على شبكتك.

50 مشترك لمدة 7 أيام، من غير ما تدفع حاجة.

جرّب ببلاش كلّمنا