ایجاد پرداخت

post
https://api.cryptomus.com/v1/payout
کپی

پرداخت از طریق API فقط از مانده کیف پول های تجاری شما انجام می شود.

پرداخت ها را می توان به روش های مختلفی انجام داد:

  1. شما می توانید پرداخت را در یک رمزنگاری خاص دریافت کنید و پرداخت آن به طور خودکار در آن رمزنگاری خاص پردازش می شود. برای انجام این کار ، اطمینان حاصل کنید که تعادل کافی در آن ارز خاص برای تأمین تمام هزینه های مرتبط دارید.
  2. از طرف دیگر ، شما این گزینه را دارید که مبلغ پرداخت را در یک ارز فیات مشخص کنید. در این حالت ، مبلغ به طور خودکار از تعادل موجود شما به یک رمزنگاری خاص تبدیل می شود. به عنوان مثال ، در صورت درخواست پرداخت 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لازم نیست وقتی ارز/to_currency یک رمزنگاری است و فقط یک شبکه دارد ، به عنوان مثال BTC
url_callbackURL که در آن وب سایت هایی با وضعیت پرداخت ارسال می شود
to_currencyکد cryptocurrency که در آن پرداخت می شود. از آن استفاده می شود که پارامتر currency فیات است. مثالهای زیر را مشاهده کنید
course_sourcestringمقادیر موجودBinanceBinanceP2pExmoKucoinارزش از تنظیمات بازرگانخدماتی که نرخ ارز برای تبدیل در فاکتور گرفته می شود.این پارامتر فقط در صورتی اعمال می شود که ارز FIAT باشد ، در غیر این صورت مقدار پیش فرض از تنظیمات بازرگان گرفته می شود.
from_currencystringnullاجازه می دهد تا به طور خودکار مبلغ برداشت را تبدیل کرده و از تراز FROM_CURRENCY استفاده کنید. فقط USDT در دسترس است.
prioritystringmin: 4max: 11مقادیر موجودrecommendedeconomyhighhighestrecommendedپارامتر انتخاب اولویت برداشت. هزینه کارمزد برداشت بستگی به پارامتر انتخاب شده دارد.این پارامتر فقط در صورت استفاده از شبکه های BTC ، ETH ، چند ضلعی و BSC اعمال می شود.
memostringmin: 1max: 30شناسه اضافی برای تن ، برای مشخص کردن گیرنده یا هدف خاص استفاده می شود

نوع پارامتری

string

تعریف

میزان پرداختی

نوع پارامتری

string

تعریف

کد ارزی برای پرداختاگر ارز اگر فیات باشد ، پارامتر to_currency مورد نیاز است.

نوع پارامتری

stringmin:1max:100alpha_dash

تعریف

شناسه را در سیستم خود سفارش دهیداین پارامتر باید رشته ای باشد که از کاراکترهای الفبایی ، اعداد ، زیرکانها و خطوط تشکیل شده است. این نباید شامل هر فضایی یا شخصیت های خاص باشد. order_id باید در پرداخت های بازرگانی بی نظیر باشدوقتی یک پرداخت موجود را با order_id پیدا می کنیم ، جزئیات آن را برمی گردانیم ، پرداخت جدیدی ایجاد نمی شود.

نوع پارامتری

string

تعریف

آدرس کیف پول که در آن عقب نشینی خواهد شد

نوع پارامتری

boolean

تعریف

تعیین می کند که هزینه برداشت از کجا کسر می شوددرست - از تعادل شماکاذب - از مبلغ پرداخت ، مبلغ پرداخت کاهش می یابد

نوع پارامتری

string

تعریف

کد شبکه blockchainلازم نیست وقتی ارز/to_currency یک رمزنگاری است و فقط یک شبکه دارد ، به عنوان مثال BTC

تعریف

URL که در آن وب سایت هایی با وضعیت پرداخت ارسال می شود

تعریف

کد cryptocurrency که در آن پرداخت می شود. از آن استفاده می شود که پارامتر currency فیات است. مثالهای زیر را مشاهده کنید

نوع پارامتری

string
مقادیر موجود
- Binance- BinanceP2p- Exmo- Kucoin

تعریف

خدماتی که نرخ ارز برای تبدیل در فاکتور گرفته می شود.این پارامتر فقط در صورتی اعمال می شود که ارز FIAT باشد ، در غیر این صورت مقدار پیش فرض از تنظیمات بازرگان گرفته می شود.

نوع پارامتری

string

تعریف

اجازه می دهد تا به طور خودکار مبلغ برداشت را تبدیل کرده و از تراز FROM_CURRENCY استفاده کنید. فقط USDT در دسترس است.

نوع پارامتری

stringmin: 4max: 11
مقادیر موجود
- recommended- economy- high- highest

تعریف

پارامتر انتخاب اولویت برداشت. هزینه کارمزد برداشت بستگی به پارامتر انتخاب شده دارد.این پارامتر فقط در صورت استفاده از شبکه های BTC ، ETH ، چند ضلعی و 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
currencyکد ارزی برای پرداخت
networkکد شبکه blockchain که در آن پرداخت انجام می شود
addressآدرس کیف پولی که پرداخت آن انجام شده است
txidشناسه معامله در blockchain
statusوضعیت پرداخت به همه وضعیت های موجود مراجعه کنید
is_finalآیا پرداخت نهایی استپس از پرداخت موفقیت آمیز یا عدم موفقیت ، روند پرداخت نهایی نهایی می شود. در صورت خرابی پرداخت ، وجوه به تراز شما بازگردانده می شود و از شما خواسته می شود دوباره روند پرداخت را آغاز کنید.
balanceوجوه باقیمانده در تعادل بازرگان.
payer_currencyکد cryptocurrency که در آن پرداخت در واقع انجام می شود. آدرس پرداخت پول پرداخت را دریافت می کند.
payer_amountمبلغ در payer_currency پرداخت.

تعریف

UUID پرداخت

تعریف

مبلغ پرداخت در currency

تعریف

کد ارزی برای پرداخت

تعریف

کد شبکه blockchain که در آن پرداخت انجام می شود

تعریف

آدرس کیف پولی که پرداخت آن انجام شده است

تعریف

شناسه معامله در blockchain

تعریف

وضعیت پرداخت به همه وضعیت های موجود مراجعه کنید

تعریف

آیا پرداخت نهایی استپس از پرداخت موفقیت آمیز یا عدم موفقیت ، روند پرداخت نهایی نهایی می شود. در صورت خرابی پرداخت ، وجوه به تراز شما بازگردانده می شود و از شما خواسته می شود دوباره روند پرداخت را آغاز کنید.

تعریف

وجوه باقیمانده در تعادل بازرگان.

تعریف

کد cryptocurrency که در آن پرداخت در واقع انجام می شود. آدرس پرداخت پول پرداخت را دریافت می کند.

تعریف

مبلغ در 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}
کپی

اگر نتوانیم سرویس اجرای پرداخت را پیدا کنیم ، این پیام خطا را دریافت خواهید کرد. شما باید اطمینان حاصل کنید که cryptocurrency پشتیبانی می شود. صحت مقادیر وارد شده را بررسی کنید. ارز ، شبکه ، از_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}
کپی

اگر مبلغ پرداخت کمتر از حداقل مبلغ پشتیبانی شده برای cryptocurrency باشد ، این پیام خطا را دریافت خواهید کرد:


1{
2    "state": 1,
3    "message": "Minimum amount 0.5 USDT"
4}
کپی

اگر مبلغ پرداخت از حداکثر مبلغ پشتیبانی شده برای cryptocurrency بیشتر باشد ، این پیام خطا را دریافت خواهید کرد:


1{
2    "state": 1,
3    "message": "Maximum amount 10000000 USDT"
4}
کپی

اگر بودجه کافی برای پرداخت پرداخت ندارید ، این پیام خطا را دریافت خواهید کرد:


1{
2    "state": 1,
3    "message": "Not enough funds"
4}
کپی

اگر وجوه کافی برای تبدیل مبلغ پرداخت از from_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}
کپی