NAV
shell

مستندات درگاه پراخت جیب

درگاه پرداخت جیب -‌ Jeeb Payment Gateway - یک سرویس اینترنتی است که به کاربران خود امکان دریافت ارزهای دیجیتال در قالب یک سیستم پرداخت را می‌دهد. درنتیجه کاربران می‌توانند در کنار ارزهای رایح از جمله تومان، دلار و... ارزهایی از جمله بیت‌کوین، اتریوم، لایت‌کوین، دوج‌کوین، تتر(دلار الکترونیک) و... از سراسر دنیا و بدون محدودیت دریافت کنند.

بخش مهمی از خدماتی که جیب ارائه می‌دهد در بستر وب سرویس‌ها قابل استفاده می‌باشد. در این بخش به بررسی وب سرویس‌ها و نحوه‌ی استفاده از آن‌ها می‌پردازیم.

برخی از ویژگی‌های کلی وب سرویس‌ها جیب

قبل از شروع به کار به موارد زیر توجه نمایید

روش‌های پیاده سازی

روش اول

هدف: ایجاد پرداخت و انتقال پرداخت کننده به جیب

این روش بسیار شبیه به مدل‌های مرسوم درگاه‌های پرداخت می‌باشد. کافیست با استفاده از وب سرویس issue یک پرداخت ایجاد کنید و سپس کاربر را با token دریافتی در خروجی وب سرویس مذکور، به جیب انتقال دهید.

مراحل اجرابی:

  1. پذیرنده با استفاده از وب سرویس issue یک پرداخت ایجاد می‌کند. پذیرنده با استفاده از token ایجاد شده برای پرداخت، کاربر را به محیط درگاه منتقل می کند.

  2. در این مرحله با تغییر وضعیت پرداخت، کاربر به آدرس تنظیم شده در callbackUrl باز می‌گردد.

    تغییر وضعیت به سه عامل بستگی دارد:

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

  3. بعد از بازگشت به وب سایت پذیرنده سه حالت کلی پیش می‌آید:

    اگر مقدار فیلد state برابر با PendingConfirmation بود و مقدار refund ‍ برابر با false، به معنی این است که تراکنش انجام شده و مبلغ ارسال شده از نظر جیب مشکلی نداشته و پرداخت بعد از دریافت تاییدیه‌های مورد نیاز، تکمیل می‌شود.

    اگر مقدار فیلد state برابر با PendingConfirmation بود و مقدار refund برابر با ‍true ،به معنی این است که تراکنش انجام شده ولی مبلغ ارسال شده با مبلغ درخواستی یکسان نبوده است. در نتیجه پرداخت بعد از دریافت تاییدیه‌های مورد نیاز رد می‌شود و پذیرنده می‌بایست جهت استرداد وجه اقدام نمایید.

    اگر مقدار فیلد ‍state برابر با Expired بود، به این معنی است که پرداخت منقضی یا توسط کاربر باطل شده است.

  4. پس از دریافت تاییدیه‌های مورد نیاز جهت تکمیل پرداخت، در صورتی که شرایط رد شدن پرداخت وجود نداشته باشد، جیب از طریق وب هوک‌ها، اعلان نهایی شامل وضعیت Completed را برای پذیرنده ارسال می‌کند. بعد از اینکه پرداخت به وضعیت ‍Completed رسید، پذیرنده می‌تواند یکبار از سمت خود و از طریق وب سرویس seal پرداخت را ببندد.

مزایا و معایب:

روش دوم

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

در این روش نیاز است که با توجه به شرایط نرم‌افزاری و پلتفرمی خود یک محیط مناسب جهت نمایش جزئیات پرداخت ایجاد کنید. با ایجاد یک پرداخت با استفاده از وب سرویس issue و با نمایش آدرس ها و مبالغ متناظر با آن‌ها به کاربر، یک سفارش مدیریت و تکمیل می‌شود.

مراحل اجرابی:

  1. پذیرنده با استفاده از وب سرویس issue یک پرداخت ایجاد می‌کند.

  2. پذیرنده با درنظر گرفتن زمان انقضای پرداخت ایجاد شده، جزئیات پرداخت را به کاربر نمایش می‌دهد.

  3. در این مرحله با تغییر وضعیت پرداخت، برای پذیرنده از طریق وب هوک‌ها اعلان ارسال می‌شود:

    تغییر وضعیت به سه عامل بستگی دارد:

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

  4. بعد از دریافت اعلان شامل فیلد state برابر با PendingTransaction سه حالت کلی پیش می‌آید:

    اگر در اعلان بعدی مقدار فیلد state برابر با PendingConfirmation بود و مقدار refund ‍ برابر با false، به معنی این است که تراکنش انجام شده و مبلغ ارسال شده از نظر جیب مشکلی نداشته و پرداخت بعد از دریافت تاییدیه‌های مورد نیاز، تکمیل می‌شود.

    اگر در اعلان بعدی مقدار فیلد state برابر با PendingConfirmation بود و مقدار refund برابر با ‍true ،به معنی این است که تراکنش انجام شده ولی مبلغ ارسال شده با مبلغ درخواستی یکسان نبوده است. در نتیجه پرداخت بعد از دریافت تاییدیه‌های مورد نیاز رد می‌شود و پذیرنده می‌بایست جهت استرداد وجه اقدام نمایید.

    اگر در اعلان بعدی مقدار فیلد ‍state برابر با Expired بود، به این معنی است که پرداخت منقضی است.

  5. پس از دریافت تاییدیه‌های مورد نیاز جهت تکمیل پرداخت، در صورتی که شرایط رد شدن پرداخت وجود نداشته باشد، جیب از طریق وب هوک‌ها، اعلان نهایی شامل وضعیت Completed را برای پذیرنده ارسال می‌کند. پذیرنده بعد از اینکه پرداخت به وضعیت ‍Completed رسید، می‌تواند یکبار از سمت خود و از طریق وب سرویس seal پرداخت را ببندد.

مزایا و معایب:

وب سرویس‌‌ها

احراز هویت - Authentication

جهت احراز هویت وب سرویس‌ها با استفاده از کلید ارائه شده در حساب کاربری، کافیست آن را در header هر درخواست به صورت زیر ارسال نمایید:

‍‍‍X-API-KEY=YOUR_API_KEY_GOES_HERE

ایحاد پرداخت - Issue

curl --verbose 
 --header "X-API-KEY: YOUR_API_KEY"
 --data '{  "orderNo": "626012080",  "client": "Internal",  "type": "Restricted",  "mode": "Standard",    "payableCoins": "BTC/ETH/USDT/LTC/DOGE",  "baseAmount": 10,  "baseCurrencyId": "USD",  "webhookUrl": "https://webhook.site/b2720390...",  "callbackUrl":"https://webhook.site/b2720390...",  "allowReject": false,  "allowTestNets": false,  "expiration": 15}' 
 --request "POST" "https://core.jeeb.io/api/v3/payments/issue"

خروجی این وب سرویس JSON می‌باشد. نمونه:

{
    "result": {
        "id": 20000123,
        "type": "Restricted",
        "state": "PendingTransaction",
        "mode": "Standard",
        "client": "Internal",
        "referenceNo": "fTWeGaTmVO",
        "orderNo": "626012080",
        "language": null,
        "payableCoins": "BTC/ETH/USDT/LTC/DOGE",
        "webhookUrl": "https://webhook.site/b2720390...",
        "callbackUrl": "https://webhook.site/b2720390...",
        "baseCurrencyId": "USD",
        "baseAmount": 100.0,
        "baseBtcAmount": 0.01014354,
        "paidCurrencyId": null,
        "checkAmount": null,
        "paidAmount": null,
        "paidBtcAmount": null,
        "isSealed": false,
        "sealTime": null,
        "expiration": 15,
        "allowReject": false,
        "allowTestNets": false,
        "refund": false,
        "expirationTime": "2020-09-05T14:12:38.4116296+04:30",
        "completionTime": null,
        "creationTime": "2020-09-05T13:57:38.4116296+04:30",
        "details":[{
            "index": 0,
            "currencyId": "BTC",
            "state": "Quoted",
            "address": null,
            "transactionId": null,
            "amount": 0.01014354,
            "paidAmount": null,
            "rate": 1.0
            },
            {
            "index": 1,
            "currencyId": "ETH",
            "state": "Quoted",
            "address": null,
            "transactionId": null,
            "amount": 0.30232215,
            "paidAmount": null,
            "rate": 29.804402646750
            },
            ...
        ],
        "token": "XMVD7QZXEJKCFY....."
    },
    "succeed": true,
    "status": 200,
    "version": "3.0.0"
}

جهت ایجاد یک پرداخت از این وب سرویس استفاده کنید. از فیلد token در خروجی جهت پیگیری های آتی در وب سرویس های دیگر استفاده می‌شود.

اگر مطابق با روش دوم پیش می‌روید حتما فیلد client در ورودی را External قرار دهید تا جزئیات پرداخت ایجاد شده در خروجی شامل addressباشد. این جزئیات در فیلد details در خروجی قرار گرفته اند. از ‍address و amount ارزهای قابل پرداخت ارائه شده، جهت نمایش به کاربر استفاده کنید. توجه کنید آدرس های ارائه شده فقط برای پرداخت جاری ایجاد نشده اند و ممکن است در آینده از آن‌ها مجدد استفاده شود.

درخواست

POST https://core.jeeb.io/api/v3/payments/issue

Content-Type=application/json

ورودی

نام فیلد نوع فیلد اجباریست پیش‌فرض توضیحات
type string خیر Restricted اگر مبلغ پایه‌ای وجود ندارد مقدار Arbitrary ارسال کنید
mode string خیر Standard اگر تمایل به پایین آوردن تعداد تاییدیه های مورد نیاز دارید، مقدار Fast ارسال کنید
client string خیر Internal اگر پرداخت کننده را به جیب منتقل نمی‌کنید، External قرار دهید
orderNo string بله شماره سفارش در سیستم پذیرنده
payableCoins string خیر لیست ارزهای قابل پرداخت، اگر خالی باشد تمام ارزهای ممکن اضافه می‌شوند‌
language string خیر زبان انتخابی درگاه
baseCurrencyId string خیر واحد مبلغ پایه پرداخت
baseAmount number خیر مبلغ پایه پرداخت
webhookUrl string خیر لینک ارسال اعلان‌های سیستمی از طریق وب هوک‌‌ها
callbackUrl string خیر لینک بازگشت کاربر از جیب به پذیرنده
allowReject boolean خیر true اگر نوع پرداخت مبلغ ثابت باشد و در این فیلد true ارسال شود، پرداخت کننده فقط و فقط می‌بایست مبلغ درخواستی را ارسال کند در غیر این صورت پرداخت رد می‌شود
allowTestNets boolean خیر false جهت اضافه شدن ارزهای تست مقدار true ارسال کنید
expiration ‌number خیر 15 زمان انقضای خودکار پرداخت به دقیقه - حداکثر می‌تواند 2880

خروجی

مدل خروجی این وب سرویس مدل پرداخت می‌باشد.

وضعیت پرداخت - Status

curl --verbose 
 --header "X-API-KEY: YOUR_API_KEY"
 --data '{  "token": "XMVD7QZXEJKCFY....."}' 
 --request "POST" "https://core.jeeb.io/api/v3/payments/status"

خروجی این درخواست دقیقا مشابه با خروجی وب سرویس issue می‌باشد.

جهت بررسی وضعیت و دریافت مجدد جزئیات کامل یک پرداخت، می‌توانید از این وب سرویس استفاده نمایید.

درخواست

POST https://core.jeeb.io/api/v3/payments/status

Content-Type=application/json

ورودی

نام فیلد نوع فیلد اجباریست توضیحات
token string بله token ایجاد شده در وب سرویس issue

خروجی

مدل خروجی این وب سرویس مدل پرداخت می‌باشد.

بستن پرداخت - Seal

curl --verbose 
 --header "X-API-KEY: YOUR_API_KEY"
 --data '{  "token": "XMVD7QZXEJKCFY....."}' 
 --request "POST" "https://core.jeeb.io/api/v3/payments/seal"

خروجی این درخواست دقیقا مشابه با خروجی وب سرویس issue می‌باشد.

جهت جلوگیری از هرگونه سوءاستفاده احتمالی، پیشنهاد می‌شود هر پرداخت توسط پذیرنده بسته شود. هر پرداخت تنها یکبار بعد از اینکه به وضعیت Completed رسید، می‌تواند بسته شود.

درخواست

POST https://core.jeeb.io/api/v3/payments/seal

Content-Type=application/json

ورودی

نام فیلد نوع فیلد اجباریست توضیحات
token string بله token ایجاد شده در وب سرویس issue

خروجی

مدل خروجی این وب سرویس مدل پرداخت می‌باشد.

انتقال به درگاه - Redirect

بعد از ایجاد یک پرداخت و تنها درصورتی که client پرداخت Internal هست، می‌توانید کاربر را جهت استفاده از بخش پرداخت جیب، به آدرس زیر redirect کنید.

جزئیات درخواست

GET https://core.jeeb.io/api/v3/payments/invoice?token=YOUR_TOKEN_GOES_HERE

بازگشت و اعلان‌‌

بازگشت - Callback

در روش پیاده‌سازی اول و در هنگام بازگشت کاربر از جیب به وب سایت پذیرنده مورد استفاده قرار می‌گیرد. آدرس این درخواست توسط پذیرنده و در فیلد callbackUrl در وب سرویس ایجاد پرداخت تنظیم می‌شود.

درخواست

POST‍ (آدرس درخواست در callbackUrl تنظیم می‌شود)

Content-Type=application/x-www-form-urlencoded

متغییر‌های ارسالی

نام فیلد نوع فیلد اجباریست توضیحات
type string بله نوع پرداخت - Restricted یا Arbitrary
state string بله وضعیت پرداخت - در اینجا یا می‌تواند PendingConfirmation باشد یا Expired
mode string بله مد پرداخت - Standard یا Fast
orderNo string بله شماره سفارش در سیستم پذیرنده
referenceNo string بله کد پیگیری در جیب
baseCurrencyId string خیر واحد مبلغ پایه پرداخت
baseAmount number خیر مبلغ پایه پرداخت
paidCurrencyId string خیر واحد ارز پرداخت شده ‌
checkAmount number خیر مبلغی که می‌بایست پرداخت می‌شد - هم واحد با paidAmount
paidAmount number خیر مبلغ پرداخت شده
address string خیر آدرسی که تراکنش بر روی آن دریافت شد
transactionId string خیر شناسه شبکه تراکنش یا همان TXID
refund boolean بله اگر true باشد پرداخت در جیب رد می‌شود اگر نباشد مشکلی نبوده و پرداخت بعد از دریافت تاییدیه تکمیل می‌شود

اعلان‌ - Webhook

هر تغییری در وضعیت پرداخت از طریق اعلان‌های سیستمی به اطلاع پذیرنده می‌رسد. در حال حاضر تنها روش دریافت اعلان‌ها از طریق وب هوک‌ها می‌باشد. نوع دیتای وب هوک‌ JSON می‌باشد که به آدرس ثبت شده برای ارسال وب هوک، یعنی webhookUrl ارسال می‌شود.

درحال حاضر وب هوک‌ها فقط از آدرس‌های IP زیر ارسال می‌شوند. می‌توانید جهت افزایش ضریب امنیت، آدرس‌های دریافت وب هوک را با IPهای زیر محدود کنید.

درخواست

POST‍ (آدرس درخواست در ‍webhookUrl تنظیم می‌شود)

Content-Type=application/json

متغییر‌های ارسالی

نام فیلد نوع فیلد اجباریست توضیحات
attempts number بله تعداد دفعات ارسال وب هوک

باقی فیلد‌های ارسالی در وب هوک، مطابق با مدل پرداخت می‌باشد.

ارزها و نرخ‌ها

ارزها - Currencies

curl --verbose
 --request "GET" "https://core.jeeb.io/api/v3/markets/currencies"

خروجی این وب سرویس JSON می‌باشد. نمونه:

{
    "result": [
    {
        "id": "BTC",
        "parent": null,
        "index": 1,
        "name": "Bitcoin",
        "type": "Crypto",
        "network": "Mainnet",
        "precision": 8,
        "isActive": true,
        "allowDeposit": true,
        "allowWithdraw": true,
        "allowPayment": true,
        "minDepositLimit": null,
        "maxDepositLimit": null,
        "minWithdrawLimit": 0.00050000,
        "maxWithdrawLimit": null,
        "minPaymentLimit": null,
        "maxPaymentLimit": null
    },
    {
        "id": "ETH",
        "parent": null,
        "index": 2,
        "name": "Ethereum",
        "type": "Crypto",
        "network": "Mainnet",
        "precision": 8,
        "isActive": true,
        "allowDeposit": true,
        "allowWithdraw": true,
        "allowPayment": true,
        "minDepositLimit": null,
        "maxDepositLimit": null,
        "minWithdrawLimit": 0.05000000,
        "maxWithdrawLimit": null,
        "minPaymentLimit": null,
        "maxPaymentLimit": null
    },
    ...
],
"succeed": true,
"status": 200,
"version": "3.0.0"
}

برای دریافت لیست کامل ‌ارزهای موجود و وضعیت کلی آن‌ها در جیب، می‌توانید از این وب سرویس استفاده نمایید.

جزئیات درخواست

GET https://core.jeeb.io/api/v3/markets/currencies

جزئیات خروجی

مدل خروجی این وب سرویس لیستی از مدل ارز می‌باشد.

نرخ‌ها - Rates

curl --verbose
 --request "GET" "https://core.jeeb.io/api/v3/markets/rates"

خروجی این وب سرویس JSON می‌باشد. نمونه:

{
    "result": [
    {
        "id": "ETH/BTC",
        "baseCurrencyId": "ETH",
        "targetCurrencyId": "BTC",
        "baseCurrencyName": "Ethereum",
        "targetCurrencyName": "Bitcoin",
        "baseCurrencyPrecision": 8,
        "targetCurrencyPrecision": 8,
        "buyRate": 0.033165,
        "sellRate": 0.034011635,
        "averageRate": 0.0335883175,
        "change24": 7.755
    },
    {
        "id": "DOGE/BTC",
        "baseCurrencyId": "DOGE",
        "targetCurrencyId": "BTC",
        "baseCurrencyName": "Dogecoin",
        "targetCurrencyName": "Bitcoin",
        "baseCurrencyPrecision": 8,
        "targetCurrencyPrecision": 8,
        "buyRate": 0.0000002574,
        "sellRate": 0.00000027405,
        "averageRate": 0.000000265725,
        "change24": 3.571
    },
    ...
],
"succeed": true,
"status": 200,
"version": "3.0.0"
}

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

درخواست

GET https://core.jeeb.io/api/v3/markets/rates

ورودی

نام فیلد نوع فیلد اجباریست توضیحات
filter string خیر جهت اعمال فیلتر بر روی شناسه‌ی مارکت

خروجی

مدل خروجی این وب سرویس لیستی از مدل نرخ می‌باشد.

دیتا مدل‌ها

پرداخت - Payment

{
    "id": 28,
    "type": "Restricted",
    "state": "Completed",
    "mode": "Standard",
    "client": "Internal",
    "referenceNo": "lIV8oIFlab",
    "orderNo": "221628317",
    "language": "auto",
    "payableCoins": "BTC/ETH/LTC/DOGE/",
    "webhookUrl": "https://webhook.site/b2720390...",
    "callbackUrl": "https://webhook.site/b2720390...",
    "baseCurrencyId": "USD",
    "baseAmount": 100.0,
    "baseBtcAmount": 0.01014354,
    "paidCurrencyId": "ETH",
    "checkAmount": 0.30232215,
    "paidAmount": 0.30232215,
    "paidBtcAmount": 0.01014354,
    "isSealed": true,
    "sealTime": "2020-09-06T13:01:23.290573+04:30",
    "expiration": 15,
    "allowReject": true,
    "allowTestNets": true,
    "refund": false,
    "expirationTime": "2020-09-06T13:07:28.639888+04:30",
    "completionTime": "2020-09-06T13:01:21.836229+04:30",
    "creationTime": "2020-09-06T12:52:28.639888+04:30",
    "details":[ 
        {
            "index": 0,
            "currencyId": "BTC",
            "state": "Deployed",
            "address": "346yfgqo9W2yizBMudbA3ynSBxVZcvkMQb",
            "transactionId": null,
            "amount": 0.01014354,
            "paidAmount": null,
            "rate": 1.0
        },
        {
            "index": 1,
            "currencyId": "ETH",
            "state": "Used",
            "address": "0xeeba5cafeba4a370c934859164bce60427d91789",
            "transactionId": "0x75a1892fe8045dcf71d41da74ec4af187ab5def9d93c937f8a8cb70d513ac380",
            "amount": 0.30232215,
            "paidAmount": 0.30232215,
            "rate": 29.804402646750
        },
        ...
    ],
    "token": "TNCIQ5IJLSHFEQ66..."
}
نام فیلد نوع فیلد اجباریست توضیحات
id number بله شناسه پرداخت
type string بله نوع پرداخت که می‌تواند Restricted یا Arbitrary باشد
state string بله وضعیت پرداخت - مراجعه شود به جدول وضعیت پرداخت
mode string بله مد پرداخت که می‌تواند Standard یا Fast باشد
client string بله نوع استفاده که می‌تواند Internal یا External باشد
referenceNo string بله کد پیگیری پرداخت در جیب
orderNo string بله شماره سفارش در سیستم پذیرنده
language string خیر زبان انتخابی درگاه
payableCoins string بله ارزهای قابل پرداخت
webhookUrl string خیر آدرس وب هوک تنظیم شده
callbackUrl string خیر آدرس بازگشت تنظیم شده
baseCurrencyId string خیر واحد ارز پایه
baseAmount number خیر مبلغ پایه
baseBtcAmount number خیر معادل مبلغ پایه به بیت کوین
paidCurrencyId string خیر شناسه ارز پرداخت شده
checkAmount nunmber خیر مبلغی که می‌بایست پرداخت می‌شد
paidAmount number خیر مبلغ پرداخت شده
paidBtcAmount number خیر معادل مبلغ پرداخت شده به بیت کوین
isSealed boolean بله وضعیت بسته شدن یا نشدن پرداخت توسط پذیرنده
sealTime time خیر زمان بسته شدن پرداخت توسط پذیرنده
expiration number خیر زمان انقضای تنظیم شده به دقیقه
allowReject boolean بله وضعیت مجوز رد شدن پرداخت
allowTestNets boolean بله وضعیت مجوز وجود ارزهای تست در ارزهای قابل پرداخت
refund boolean بله وضعیت رد شدن یا نشدن پرداخت
expirationTime time بله زمان انقضای پرداخت
completionTime time خیر زمان تکمیل شدن پرداخت
creationTime time بله زمان ایجاد پرداخت
details Array of Details بله لیستی از جزئیات پرداخت - مراجعه شود به مدل جزئیات پرداخت
token string بله توکن ایجاد شده برای پرداخت

جزئیات پرداخت - Payment Detail

{
    "index": 1,
    "currencyId": "ETH",
    "state": "Used",
    "address": "0xeeba5cafeba4a370c934859164bce60427d91789",
    "transactionId": "0x75a1892fe8045dcf71d41da74ec4af187ab5def9d93c937f8a8cb70d513ac380",
    "amount": 0.30232215,
    "paidAmount": 0.30232215,
    "rate": 29.804402646750
}
نام فیلد نوع فیلد اجباریست توضیحات
index number بله
currencyId string بله شناسه ارز
state string بله وضعیت جزئیات پرداخت که می‌تواند Quoted به معنی قیمت گذاری شده، Deployed به معنی آدرس گذاری شده و Used به معنی استفاده شده باشد
address string خیر آدرس درنظر گرفته شده برای این ارز
transactionId string خیر شناسه شبکه تراکنش ورودی به آدرس یا همان TXID
amount number خیر مبلغ درخواستی
paidAmount number خیر مبلغ پرداختی
rate number بله نرخ تبدیل واحد از بیت کوین

ارز - Currency

{
    "id": "BTC",
    "parent": null,
    "index": 1,
    "name": "Bitcoin",
    "type": "Crypto",
    "network": "Mainnet",
    "precision": 8,
    "isActive": true,
    "allowDeposit": true,
    "allowWithdraw": true,
    "allowPayment": true,
    "minDepositLimit": null,
    "maxDepositLimit": null,
    "minWithdrawLimit": 0.00050000,
    "maxWithdrawLimit": null,
    "minPaymentLimit": null,
    "maxPaymentLimit": null
}

جزئیات مدل ارز

نام فیلد نوع فیلد اجباریست توضیحات
id string بله شناسه ارز
parent string خیر ارز مادر - شبکه اصلی
index number بله
name string بله
type string بله نوع ارز که می‌تواند Crypto یا Fiat باشد
network string خیر شبکه ارز که می‌تواند Mainnet یا Testnet باشد
precision number بله دقت اعشار ارز
isActive boolean بله
allowDeposit boolean بله
allowWithdraw boolean بله
allowPayment boolean بله
minDepositLimit number خیر
maxDepositLimit number خیر
minWithdrawLimit number خیر
maxWithdrawLimit number خیر
minPaymentLimit number خیر
maxPaymentLimit number خیر

نرخ - Rate

{
    "id": "BTC/USD",
    "baseCurrencyId": "BTC",
    "targetCurrencyId": "USD",
    "baseCurrencyName": "Bitcoin",
    "targetCurrencyName": "US Dollar",
    "baseCurrencyPrecision": 8,
    "targetCurrencyPrecision": 2,
    "buyRate": 9925.0657773829968384,
    "sellRate": 10538.05157721583565760,
    "averageRate": 10229.327415515316477600,
    "change24": -1.223
}

جزئیات مدل نرخ

نام فیلد نوع فیلد اجباریست توضیحات
id string بله شناسه مارکت
baseCurrencyId string بله شناسه‌ی ارز پایه
targetCurrencyId string بله شناسه‌ي ارز هدف
baseCurrencyName string بله نام ارز پایه
targetCurrencyName string بله نام ارز هدف
baseCurrencyPrecision number بله دقت اعشار ارز پایه
targetCurrencyPrecision number بله دقت اعشار ارز هدف
buyRate number بله نرخ خرید
sellRate number بله نرخ فروش
averageRate number بله نرخ میانگین
change24 number خیر درصد تغییرات در ۲۴ ساعت گذشته

جداول کمکی

وضعیت پرداخت - Payment State

مقدار توضیحات
Created وضعیت اولیه
PendingTransaction در انتظار دریافت تراکنش بر روی یکی از آدرس‌های ارائه شده
PendingConfirmation در انتظار دریافت تاییدیه‌های تراکنش ارسال شده
Completed پرداخت تکمیل شده است
Expired پرداخت منقضی یا توسط پرداخت کننده باطل شده است
Rejected پرداخت رد شده است
Failed پرداخت خطا داشته است

نمادها - Symbols

نماد - شناسه نام نوع شبکه تعداد تاییدیه قرارداد
‌BTC Bitcoin Crypto Mainnet ۶
ETH Ethereum Crypto Mainnet ۷
LTC Litecoin Crypto Mainnet ۶
DOGE Dogecoin Crypto Mainnet ۱۰
USDT TetherUS Crypto Mainnet (ERC20) ۷ 0xdac17f958d2ee523a2206206994597c13d831ec7
USDC USD Coin Crypto Mainnet (ERC20) ۷ 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
BNB Binance Crypto Mainnet (ERC20) ۷ 0xB8c77482e45F1F44dE1745F52C74426C631bDD52
LINK ChainLink Crypto Mainnet (ERC20) ۷ 0x514910771af9ca656af840dff83e8264ecf986ca
ZRX 0x Crypto Mainnet (ERC20) ۷ 0xe41d2489571d322189246dafa5ebde1f4699f498
DIA Dia Crypto Mainnet (ERC20) ۷ 0x6b175474e89094c44da98b954eedeac495271d0f
PAX Paxos Standard Crypto Mainnet (ERC20) ۷ 0x8e870d67f660d95d5be530380d0ec0bd388289e1
IRT Toman Fiat
USD US Dollar Fiat
EUR Euro Fiat
GBP Pound Fiat
CAD CA Dollar Fiat
AUD AU Dollar Fiat
JPY Yen Fiat
CNY Yuan Fiat
AED Dirham Fiat
TRY Lira Fiat
TBTC Bitcoin Testnet Crypto Testnet ۲
TETH Ethereum Testnet Crypto Testnet (ropsten) ۳
TLTC Litecoin Testnet Crypto Testnet ۲
TDOGE Dogecoin Testnet Crypto Testnet ۵
TT1 Test Keef Token 1 Crypto Testnet (ropsten - ERC20) ۳ 0x8d24b956a93fbcb9717bd68afc990040600c7ffd
TT2 Test Keef Token 2 Crypto Testnet (ropsten - ERC20) ۳ 0x995dec5559ed78e8a2309bd5b6539c36c6c59502

خطاها - Errors

کد وضعیت HTTP کد خطا دلیل احتمالی
400 ورودی ها اشتباه هستند
401 کلید وب سرویس ارسال نشده یا اشتباه است
429 تعداد درخواست های انجام شده بیش از حد مجاز است
500 خطایی داخلی رخ داده است