مستندات وب سرویس

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

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

برخی از مزایا استفاده از درگاه پرداخت بیت والت به شرح زیر می باشد:

استفاده از وب سرویس های مبتنی بر http که به شما این امکان را می دهد در هر بستری به راحتی از درگاه بیت کوین استفاده نمایید.

کلیه فاکتور های ایجاد شده به دلیل نوسانات بیت کوین، دارای تاریخ انقضا می باشند. به این معنا که کاربر می بایست در مدت معینی اقدام به انجام تراکنش نماید، که این مدت زمان در حال حاضر 15 دقیقه پس از ایجاد فاکتور است.

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

نکته : کلیه API ها JSON Base می باشند. پس هنگام ارسال اطلاعات و فراخوانی API ها به این موضوع توجه نمایید.

نکته : Gateway Key و پسورد پذیرنده محرمانه می باشد ، این اطلاعات را به هیچ عنوان در اختیار کاربران وب سایت خود قرار ندهید.

نیازمندی ها

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

مرحله اول ( ارسال داده ها )

اولین مرحله برای اتصال به درگاه پرداخت بیت والت ارسال داده ها از طریق متد زیر است.

ساختار URL :
https://bitwallet.ir/service/invoice
داده های ارسالی :
توضیحات نوع فیلد نام فیلد
gateway_key درگاه شما (قابل دریافت در پنل کاربری) string gateway_key
password درگاه شما (قابل دریافت در پنل کاربری) string password

مبلغ فاکتور

مبلغ وارد شده باید چهار شرط زیر را داشته باشد :

در حالت btc کمتر از 0.000006 بیت کوین نباشد.

در حالت usd کمتر از 0.1 دلار نباشد.

در حالت rial کمتر از 10000 ریال نباشد.

در حالت toman کمتر از 1000 تومان نباشد.

double amount

نوع واحد محساباتی فاکتور :

rial , toman , usd , btc

string type
توضیحات فاکتور (اختیاری) string description
آدرس بازگشت بر اساس دامنه ثبت شده برای درگاه string callbackURL
مقدار : create string action
داده های دریافتی :

در صورتی که اطلاعات ارسالی صحیح باشد :

{
  "status": 0,
  "data": {
    "referenceNo": "کد فاکتور برای پیگیری",
    "invoice": "کد نمایشی فاکتور برای کاربر",
    "redirectURL": "آدرس فاکتور"
  }
}
            

در صورت بروز خطا :

{
  "status": 1,
  "data": []
}
            
کد خطا متن خطا
-1 داده های درخواست اشتباه است.
1 gateway_key یا password اشتباه است.
2 مبلغ وارد شده صحیح نیست.
3 نرخ وارد شده صحیح نیست.
4 آدرس بازگشت صحیح نیست.
5 خطا در ارتباط با سرور.
6 محدودیت ثبت فاکتور روزانه.
مرحله دوم ( انتقال به صفحه پرداخت )

در صورتی که در مرحله قبل (ارسال داده ها) ، اطلاعات ارسالی صحیح باشد و مقدار redirectURL را از بیت والت دریافت کرده باشید ، باید کاربر رو به آدرس داخل redirectURL انتقال دهید.

مرحله سوم ( بازگشت به سایت پذیرنده پس از پرداخت )

پس از انجام پرداخت بیت والت مقادیر زیر را به صورت POST به آدرس بازگشتی که در مرحله اول وارد کردید ارسال میکند.

توضیحات نوع نام
کد فاکتور string referenceNo
وضعیت فاکتور string status

مقادیر پارامتر status

مقدار متن
expire فاکتور منقضی شده است.
confirm فاکتور با موفقیت پرداخت شده است .
مرحله چهارم ( دریافت جزئیات تراکنش )

با API زیر هر زمانی میتوانید جزئیات تراکنش را دریافت کنید.

ساختار URL :
https://bitwallet.ir/service/invoice
داده های ارسالی :
توضیحات نوع فیلد نام فیلد
gateway_key درگاه شما (قابل دریافت در پنل کاربری) string gateway_key
password درگاه شما (قابل دریافت در پنل کاربری) string password
کد فاکتور string referenceNo
مقدار : detail string action
داده های دریافتی :

در صورتی که اطلاعات ارسالی صحیح باشد :

{
  "status": 0,
  "data": {
    "invoice": "کد نمایشی فاکتور برای کاربر",
    "btc": "مقدار بیت کوین فاکتور",
    "rial": "مقدار ریالی فاکتور",
    "usd": "مقدار دلاری فاکتور",
    "status": "وضعیت"
  }
}

مقادیر پارامتر status

مقدار متن
wait فاکتور در انتظار پرداخت است.
pay فاکتور پرداخت شده و در انتظار دریافت حداقل تاییده تعریف شده از شبکه بیت کوین می باشد.
expire فاکتور منقضی شده است.
confirm فاکتور با موفقیت پرداخت شده است .

در صورت بروز خطا :

{
  "status": 1,
  "data": []
}
            
کد خطا متن خطا
-1 داده های درخواست اشتباه است.
1 gateway_key یا password اشتباه است.
2 فاکتور پیدا نشد.

همین امروز کیف پول بیت کوین خود را رایگان بسازید

متخصصان و مشاوران ما آماده اند تا شما را در تمامی مراحل راهنمایی کنند

ساخت کیف پول