MakeCrypto

مرجع API

API من الروابط المدفوعة

إنشاء وإدراج وفحص وإيقاف مؤقت وأرشفة وإرسال روابط الدفع MakePay.

الطرق

استخدم هذه المسارات لإنشاء وإدارة روابط الدفع MakePay المستضافة من MakeCrypto.

MethodRoute
GET/api/partner/v1/companies

Auth

جلسة

الاستخدام

عرض شركات المستخدم

يرجع الفرق المتاحة لأدوات البوابة الخاصة بمستخدم MakeCrypto المصادق عليه.

POST/api/partner/v1/onboarding/company

Auth

سر onboarding للشريك

الاستخدام

إنشاء رابط onboarding للشركة

ينشئ مسودة onboarding مملوءة مسبقًا بواسطة الشريك ويرجع URL مطالبة للmerchant.

GET/api/partner/v1/makepay/payment-links

Auth

مفتاح MakePay API

الاستخدام

عرض أو إنشاء روابط الدفع

يقرأ روابط الدفع الخاصة بشركة مفتاح API أو ينشئ روابط checkout مستضافة عبر MakePay.

POST/api/partner/v1/makepay/payment-links

Auth

مفتاح MakePay API أو عام

الاستخدام

عرض أو إنشاء روابط الدفع

يقرأ روابط الدفع الخاصة بشركة مفتاح API أو ينشئ روابط checkout مستضافة عبر MakePay.

POST/gateway/pay/{makepayKeyId}

Auth

مفتاح نموذج عام

الاستخدام

إرسال نموذج دفع HTML

يستقبل حقول النموذج من المتصفح، وينشئ رابط دفع مستضافًا، ثم يعيد توجيه العميل إلى checkout.

GET/api/partner/v1/makepay/payment-links/{uid}

Auth

مفتاح MakePay API

الاستخدام

قراءة أو تحديث رابط دفع

يقرأ تفاصيل رابط الدفع أو يغير حالته إلى active أو paused أو archived.

PATCH/api/partner/v1/makepay/payment-links/{uid}

Auth

مفتاح MakePay API

الاستخدام

قراءة أو تحديث رابط دفع

يقرأ تفاصيل رابط الدفع أو يغير حالته إلى active أو paused أو archived.

POST/api/partner/v1/makepay/payment-links/{uid}/send-request-email

Auth

مفتاح MakePay API

الاستخدام

إرسال طلب دفع

يرسل الرابط المستضاف أو يعيد إرساله إلى بريد العميل.

GET/api/partner/v1/makepay/subscriptions

Auth

مفتاح MakePay API

الاستخدام

عرض أو إنشاء الاشتراكات

يرجع خطط الاشتراك المتكررة في MakePay أو ينشئ اشتراكًا وأول فاتورة.

POST/api/partner/v1/makepay/subscriptions

Auth

مفتاح MakePay API

الاستخدام

عرض أو إنشاء الاشتراكات

يرجع خطط الاشتراك المتكررة في MakePay أو ينشئ اشتراكًا وأول فاتورة.

GET/api/partner/v1/makepay/customers

Auth

مفتاح MakePay API

الاستخدام

عرض أو تحديث العملاء

يرجع ملفات عملاء MakePay أو ينشئ/يحدث العملاء عبر البريد الإلكتروني.

POST/api/partner/v1/makepay/customers

Auth

مفتاح MakePay API

الاستخدام

عرض أو تحديث العملاء

يرجع ملفات عملاء MakePay أو ينشئ/يحدث العملاء عبر البريد الإلكتروني.

POST/api/partner/v1/makepay/customers/{customerId}/portal

Auth

مفتاح MakePay API

الاستخدام

إنشاء رابط بوابة العميل

ينشئ عند الطلب URL موقعًا لبوابة عميل MakePay صالحًا لمدة 24 ساعة.

GET/api/partner/v1/timezones

Auth

عام

الاستخدام

عرض المناطق الزمنية

يرجع معرفات المناطق الزمنية IANA المدعومة.

GET/api/partner/v1/makepay/settings

Auth

مفتاح MakePay API

الاستخدام

قراءة أو تحديث إعدادات MakePay

يقرأ أو يحدث إعدادات التسوية، وإعادة التوجيه، والرسوم، ومعالجة نقص الدفع.

PUT/api/partner/v1/makepay/settings

Auth

مفتاح MakePay API

الاستخدام

قراءة أو تحديث إعدادات MakePay

يقرأ أو يحدث إعدادات التسوية، وإعادة التوجيه، والرسوم، ومعالجة نقص الدفع.

GET/api/partner/v1/makepay/destination-assets

Auth

مفتاح MakePay API

الاستخدام

عرض أصول الوجهة

يرجع أصول التسوية المدعومة والأصل الافتراضي الحالي.

GET/api/partner/v1/makepay/webhook-requests

Auth

مفتاح MakePay API

الاستخدام

عرض تسليمات Webhook

يعرض محاولات تسليم webhooks الدفع والاشتراك وحالة إعادة المحاولة.

إنشاء رابط الدفع

يقوم مسار الإنشاء بإدراج رابط دفع MakePay، ويحل العلامات التجارية للتاجر والتسويات الافتراضية، ويدخل حقول فوترة وقت التشغيل، ويعيد checkout العام URL.

POST /api/partner/v1/makepay/payment-links
json
{
  "status": "active",
  "sendPaymentRequestEmail": false,
  "payload": {
    "title": "Website order #1042",
    "description": "Checkout for order #1042",
    "amount": "129.99",
    "fiatCurrency": "USD",
    "currency": "USDT",
    "orderId": "order_1042",
    "customerEmail": "buyer@example.com",
    "returnUrl": "https://merchant.example/orders/1042",
    "successUrl": "https://merchant.example/orders/1042/success",
    "failureUrl": "https://merchant.example/orders/1042/failure",
    "expirationTime": "12h",
    "metadata": {
      "cartId": "cart_7M2V",
      "source": "api"
    }
  }
}

بالنسبة إلى زر checkout، متصفح بدون تعليمات برمجية أو بدون تعليمات برمجية منخفضة، راجع دفعة إرسال النموذج. فهو يقبل HTML POST العادي، وينشئ نفس النوع من رابط الدفع المستضاف، ويعيد توجيه المتسوق إلى MakePay checkout.

الإعداد المطلوب

يجب أن يكون لدى الشركة أصل الوجهة الافتراضية MakePay. إذا لم يتم تكوين التسوية، فسيقوم المسار بإرجاع 409 مع errorCode: "onboarding_required".

حقول المبلغ والأصول

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

انتهاء

يقبل payload.expirationTime 15m أو 1h أو 12h أو 24h أو 72h أو never. يقوم API بتخزين الطابع الزمني expires_at الذي تم حله على رابط الدفع.

إنشاء الرد

json
{
  "ok": true,
  "paymentRequestEmailSent": false,
  "paymentRequestEmailError": null,
  "paymentLink": {
    "id": "8d15bb78-d0f8-45ef-88d7-2a1f1f79644b",
    "uid": "01hzy4k6p4w9y2x7e2z7n8a2xm",
    "status": "active",
    "expires_at": "2026-04-19T12:00:00.000Z",
    "created_at": "2026-04-19T00:00:00.000Z",
    "updated_at": "2026-04-19T00:00:00.000Z",
    "publicUrl": "https://makepay.io/payment/01hzy4k6p4w9y2x7e2z7n8a2xm",
    "payload": {
      "title": "Website order #1042",
      "description": "Checkout for order #1042",
      "amount": "129.99",
      "fiatCurrency": "USD",
      "currency": "USDT",
      "orderId": "order_1042",
      "customerEmail": "buyer@example.com",
      "returnUrl": "https://merchant.example/orders/1042",
      "successUrl": "https://merchant.example/orders/1042/success",
      "failureUrl": "https://merchant.example/orders/1042/failure",
      "expirationTime": "12h",
      "metadata": {
        "cartId": "cart_7M2V",
        "source": "api"
      },
      "asset": "ETH.USDT-0xdac17f958d2ee523a2206206994597c13d831ec7",
      "runtimeMode": "merchant_target_net_v2",
      "billingVersion": "v2",
      "merchantName": "Merchant Co",
      "merchantPaymentLinkTheme": "system"
    }
  }
}

قائمة روابط الدفع

استخدم مسار القائمة لتسوية المكتب الخلفي ولوحات المعلومات واختبارات الدخان.

curl
curl "https://www.makecrypto.io/api/partner/v1/makepay/payment-links" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

احصل على تفاصيل رابط الدفع

استخدم المسار التفصيلي عندما يكون لديك بالفعل رابط دفع UID وتحتاج إلى الرابط العادي وcheckout العام URL وآخر جلسة دفع وأحداث المخطط الزمني.

curl
curl "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

إيقاف رابط الدفع مؤقتًا أو أرشفته

استخدم مسار الحالة لإيقاف الدفع لرابط أو لإخفائه من العمليات النشطة.

curl
curl -X PATCH "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}'

يجب أن يكون status هو active أو paused أو archived.

إرسال بريد إلكتروني لطلب الدفع

يمكن لـ MakeCrypto إرسال الرابط المستضاف مباشرة إلى البريد الإلكتروني للعميل على حمولة رابط الدفع، أو إلى بريد إلكتروني متجاوز في نص الطلب.

curl
curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID/send-request-email" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"email":"buyer@example.com"}'

يمكن إرسال روابط الدفع النشطة فقط عبر البريد الإلكتروني. لا يمكن إعادة إرسال روابط الدفع المكتملة.

هل تحتاج مساعدة في إعداد الشريك؟

افتح عرض تفاصيل رابط الدفع في MakeCrypto لنسخ المقتطفات المولدة لـ payment UID حقيقي، أو عد إلى البوابة لإدارة إعدادات merchant.

فتح البوابة