إنشاء دفعات

post
https://api.cryptomus.com/v1/payout
ينسخ

يتم إجراء دفعات من خلال API فقط من أرصدة محافظ عملك.

يمكن أن يتم الدفع بطرق مختلفة:

  1. يمكنك اختيار تلقي الدفع في عملة مشفرة محددة وسيتم معالجة الدفع تلقائيًا في هذه العملة المشفرة المحددة. للقيام بذلك ، تأكد من أن لديك توازنًا كافيًا في تلك العملة المعينة لتغطية جميع الرسوم المرتبطة بها.
  2. بدلاً من ذلك ، لديك خيار تحديد مبلغ الدفع بعملة FIAT. في هذه الحالة ، سيتم تحويل المبلغ تلقائيًا إلى عملة مشفرة محددة من رصيدك المتاح. على سبيل المثال ، إذا طلبت دفع تعويضات قدرها 20 دولارًا في LTC ، فسيتم خصم القيمة المكافئة من رصيد LTC الخاص بك. من المهم أن يكون لديك ما يكفي من الأموال في العملة المشفرة المقابلة لتغطية جميع الرسوم المطبقة.
  3. الاحتمال الآخر هو تحديد مبلغ الدفع بالعملة فيات ، والتي سيتم تحويلها تلقائيًا إلى عملة مشفرة محددة باستخدام رصيد USDT الخاص بك. يكون هذا الخيار مفيدًا بشكل خاص عندما يتم تمكين AutoConvert ، حيث يتم تحويل الأموال من فواتيرك تلقائيًا إلى USDT. على سبيل المثال ، إذا كنت ترغب في الحصول على مدفوعات 20 دولارًا أمريكيًا في LTC ولكن لديك رصيدًا فقط في USDT ، فتأكد من أن لديك أموالًا كافية من USDT لتغطية جميع الرسوم.
  4. بالإضافة إلى ذلك ، يمكنك اختيار تحديد مبلغ الدفع في أي عملة مشفرة لتفضيلاتك. سيتم بعد ذلك معالجة الدفع تلقائيًا في تلك العملة المشفرة المحددة ، باستخدام رصيد USDT المتاح. من الأهمية بمكان الحصول على توازن ما يكفي من USDT لتغطية جميع الرسوم المرتبطة.

طلب

معلمات الاستعلام

اسمنوع المعلمةالقيمة الافتراضيةتعريف
amount*stringمبلغ الدفع
currency*stringرمز العملة للدفعإذا كانت العملة إذا كانت المعلمة to_currency مطلوبة .
order_id*stringmin:1max:100alpha_dashطلب معرف في نظامكيجب أن تكون المعلمة عبارة عن سلسلة تتكون من الأحرف الأبجدية والأرقام والرسومات الساحرة والشرطات. لا ينبغي أن تحتوي على أي مسافات أو أحرف خاصة.يجب أن يكون order_id فريدًا ضمن مدفوعات التاجرعندما نجد دفعًا موجودًا مع order_id ، فإننا نعيد تفاصيله ، ولن يتم إنشاء دفعات جديدة.
address*stringعنوان المحفظة التي سيتم فيها الانسحاب
is_subtract*booleanيحدد مكان خصم رسوم السحبصحيح - من رصيدكخطأ - من مبلغ الدفع ، سيتم تقليل مبلغ الدفع
network*stringرمز شبكة blockchainغير مطلوب عندما تكون currency/to_currency عملة مشفرة ولها شبكة واحدة فقط ، على سبيل المثال BTC
url_callbackعنوان URL الذي سيتم إرسال كتاب Webhooks مع حالة الدفع
to_currencyرمز العملة المشفرة التي سيتم فيها الدفع. يتم استخدامه عندما تكون المعلمة currency fiat. انظر الأمثلة أدناه
course_sourcestringالقيم المتاحةBinanceBinanceP2pExmoKucoinالقيمة من إعدادات التاجرالخدمة التي يتم من خلالها أخذ أسعار الصرف للتحويل في الفاتورة.يتم تطبيق المعلمة فقط إذا كانت العملة هي فيات ، وإلا فإن القيمة الافتراضية مأخوذة من إعدادات التاجر.
from_currencystringnullيسمح بتحويل مبلغ الانسحاب تلقائيًا واستخدام رصيد From_Currency. فقط USDT متوفر.
prioritystringmin: 4max: 11القيم المتاحةrecommendedeconomyhighhighestrecommendedالمعلمة لاختيار أولوية السحب. تعتمد تكلفة رسوم السحب على المعلمة المحددة.يتم تطبيق هذه المعلمة فقط في حالة استخدام شبكات BTC و ETH و Polygon و BSC.
memostringmin: 1max: 30معرف إضافي للطن ، يستخدم لتحديد مستلم أو هدف معين

نوع المعلمة

string

تعريف

مبلغ الدفع

نوع المعلمة

string

تعريف

رمز العملة للدفعإذا كانت العملة إذا كانت المعلمة to_currency مطلوبة .

نوع المعلمة

stringmin:1max:100alpha_dash

تعريف

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

نوع المعلمة

string

تعريف

عنوان المحفظة التي سيتم فيها الانسحاب

نوع المعلمة

boolean

تعريف

يحدد مكان خصم رسوم السحبصحيح - من رصيدكخطأ - من مبلغ الدفع ، سيتم تقليل مبلغ الدفع

نوع المعلمة

string

تعريف

رمز شبكة blockchainغير مطلوب عندما تكون currency/to_currency عملة مشفرة ولها شبكة واحدة فقط ، على سبيل المثال BTC

تعريف

عنوان URL الذي سيتم إرسال كتاب Webhooks مع حالة الدفع

تعريف

رمز العملة المشفرة التي سيتم فيها الدفع. يتم استخدامه عندما تكون المعلمة currency fiat. انظر الأمثلة أدناه

نوع المعلمة

string
القيم المتاحة
- Binance- BinanceP2p- Exmo- Kucoin

تعريف

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

نوع المعلمة

string

تعريف

يسمح بتحويل مبلغ الانسحاب تلقائيًا واستخدام رصيد From_Currency. فقط USDT متوفر.

نوع المعلمة

stringmin: 4max: 11
القيم المتاحة
- recommended- economy- high- highest

تعريف

المعلمة لاختيار أولوية السحب. تعتمد تكلفة رسوم السحب على المعلمة المحددة.يتم تطبيق هذه المعلمة فقط في حالة استخدام شبكات BTC و ETH و Polygon و BSC.

نوع المعلمة

stringmin: 1max: 30

تعريف

معرف إضافي للطن ، يستخدم لتحديد مستلم أو هدف معين

* - المعلمة الإلزامية

طلب مثال


curl https://api.cryptomus.com/v1/payout \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{ 
    "amount": "5",
    "currency": "USDT", 
    "network": "TRON", 
    "order_id": "1",
    "address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm", 
    "url_callback": "https://your.site/callback", 
    "is_subtract": "1",
}'
ينسخ

إجابة

معلمات الاستجابة

اسمتعريف
uuiduuid من الدفع
amountمبلغ الدفع بالعملة
currencyرمز العملة للدفع
networkرمز شبكة blockchain التي يتم فيها إجراء الدفع فيها
addressعنوان المحفظة التي يتم الدفع لها
txidمعرف المعاملة في blockchain
statusحالة الدفع شاهد جميع الحالات المتاحة
is_finalما إذا تم الانتهاء من الدفعيتم اعتبار عملية الدفع الانتهاء بمجرد دفعها بنجاح أو إذا فشلت. في حالة فشل الدفع ، سيتم إرجاع الأموال إلى رصيدك ، مما يتطلب منك بدء عملية الدفع مرة أخرى.
balanceالأموال المتبقية على توازن التاجر.
payer_currencyرمز العملة المشفرة التي سيتم فيها إجراء الدفع. سيحصل عنوان الدفع على عملة الدفع.
payer_amountالمبلغ في payer_currency من الدفع.

تعريف

uuid من الدفع

تعريف

مبلغ الدفع بالعملة

تعريف

رمز العملة للدفع

تعريف

رمز شبكة blockchain التي يتم فيها إجراء الدفع فيها

تعريف

عنوان المحفظة التي يتم الدفع لها

تعريف

معرف المعاملة في blockchain

تعريف

حالة الدفع شاهد جميع الحالات المتاحة

تعريف

ما إذا تم الانتهاء من الدفعيتم اعتبار عملية الدفع الانتهاء بمجرد دفعها بنجاح أو إذا فشلت. في حالة فشل الدفع ، سيتم إرجاع الأموال إلى رصيدك ، مما يتطلب منك بدء عملية الدفع مرة أخرى.

تعريف

الأموال المتبقية على توازن التاجر.

تعريف

رمز العملة المشفرة التي سيتم فيها إجراء الدفع. سيحصل عنوان الدفع على عملة الدفع.

تعريف

المبلغ في payer_currency من الدفع.

مثال على الاستجابة


1{
2    "state": 0,
3    "result": {
4        "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594", 
5        "amount": "3",
6        "currency": "USDT",
7        "network": "TRON",
8        "address": "TJ...",
9        "txid": null,
10        "status": "process",
11        "is_final": false,
12        "balance": 129,
13        "payer_currency": "USD",
14        "payer_amount": 3
15    }
16}
17
ينسخ

الأخطاء المحتملة

أخطاء التحقق من الصحة

شفرة : 422

الإجابات مثال:


1{
2	"state": 1,
3	"errors": {
4		"amount": ["validation.required"]
5	}
6}
ينسخ

إذا تم حظر الدفع على التاجر أو المستخدم ، فستتلقى رسالة الخطأ هذه. يحدث هذا ، على سبيل المثال ، عند تغيير كلمة المرور الخاصة بك ويتم حظر المدفوعات لمدة 24 ساعة.


1{
2    "state": 1,
3    "message": "You are forbidden"
4}
ينسخ

إذا لم ندعم رمز العملة الذي قدمته بالمعلمة العملة ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "The currency was not found"
4}
ينسخ

إذا لم نتمكن من العثور على الخدمة لتنفيذ الدفع ، فستتلقى رسالة الخطأ هذه. عليك التأكد من دعم العملة المشفرة. تحقق من صحة القيم التي تم إدخالها في. العملة ، الشبكة ، من _currency ، to_currency:


1{
2    "state": 1,
3    "message": "The service was not found"
4}
ينسخ

إذا كان مبلغ السحب صغيرًا جدًا ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "The withdrawal amount is too small"
4}
ينسخ

إذا لم يكن لديك محفظة تجارية نشطة مع عملة مشفرة للدفع ، فستتلقى هذا الخطأ:


1{
2    "state": 1,
3    "message": "Wallet not found"
4}
ينسخ

إذا كان مبلغ الدفع ، بما في ذلك جميع اللجان ، أكثر من رصيدك ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "Not enough funds"
4}
ينسخ

إذا لم نعثر على خدمة الدفع للعملة التي تم تمريرها في معلمة To_Currency ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "Not found service to_currency"
4}
ينسخ

إذا حدث شيء ما عند التحويل إلى to_currency ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "Error convert to_currency"
4}
ينسخ

إذا كان مبلغ الدفع أقل من الحد الأدنى للمبلغ المدعوم للعملة المشفرة ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "Minimum amount 0.5 USDT"
4}
ينسخ

إذا كان مبلغ الدفع أكبر من الحد الأقصى المدعوم للعملة المشفرة ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "Maximum amount 10000000 USDT"
4}
ينسخ

إذا لم يكن لديك ما يكفي من الأموال لإجراء تعويضات ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "Not enough funds"
4}
ينسخ

إذا لم يكن لديك ما يكفي من الأموال لتحويل مبلغ الدفع من من _Currency ، فستتلقى رسالة الخطأ هذه:


1{
2    "state": 1,
3    "message": "Not enough balance for convert USDT to LTC"
4}
ينسخ

في حالة حدوث عمل فني وكانت الدفع غير متوفرة مؤقتًا ، ستتلقى رسالة الخطأ هذه


1{
2    "state": 1,
3    "message": "The terminal was not found"
4}
ينسخ

خطأ في الخادم الداخلي

شفرة : 500

الإجابات مثال:


1{
2	"message": "Server error, #1",
3	"code": 500,
4	"error": null
5}
ينسخ