وب سرویس به بانک – راهنمای استفاده

راهنما و مستندات اتصال به درگاه به بانک برای برنامه نویسان

 

به نام خداوند لوح و قلم

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

www.BehBank.com

 

 راهنما و مستندات اتصال به درگاه به بانک برای برنامه نویسان


- راهنمای وب سرویس

انتقال اطلاعات بین پذیرنده و به بانک توسط پروتکل SOAP که مخفف (Simple Object Access Protocol) انجام خواهد گردید. در این پروتکل از استاندارد XML جهت دسته بندی و مدیریت داده ها استفاده می شود و انتقال داده ها توسط پروتکل HTTP و HTTPS انجام می شود.

تمامی داده های برگشتی از به بانک به صورت json می باشد



=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

- درخواست پرداخت : متد request

- آدرس ارسال درخواست

https://behbank.com/ws/payments/request.json

نوع درخواست : POST


1-1 پارامترهای ورودی متد Payment :

نام پارامتر نوع داده توضیحات نوع فیلد
* merchantCode String مرچنت درگاه اجباری
* amount Double مبلغ تراکنش به ریال اجباری
* callBackUrl String آدرس بازگشت از درگاه اجباری
* invoiceNumber String شماره فاکتور اجباری
payerEmail String پست الکترونیکی پرداخت کننده اختیاری
payerMobile String موبایل پرداخت کننده اختیاری
Description String توضیحات اختیاری

جدول شماره 1 : شرح پرامترهای وروردی متد Payment



نکته 1 : پارامترهای ارسالی باید مطالبق جدول شماره 1 ارسال گردد ، مقادیر حساس به حروف کوچک و بزرگ می باشند.

نکته 2 : مبلغ تراکنش حتما باید به ریال ارسال گردد.

 



پارامترهای خروجی :

نتیجه تراکنش مطابق جدول زیر برای پذیرنده ارسال خواهد شد :

نام نوع داده توضیحات
Status Integer کد وضعیت
Message String شرح وضعیت
paymentNumber String کد توکن پرداخت

جدول شماره 2 : پارامترهای خروجی



نکته :اگر مقدار فیلد status برابر با عدد 1 باشد ، باید شماره پرداختی که در فیلد PaymentNumber قراردارد را به آدرس درگاه پرداخت به بانک با متد GET ارسال کنید

 

- آدرس درگاه :

http://behbank.com/payment/[paymentNumber]

مثال :

http://behbank.com/payment/445646126

 



=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

- اعتبارسنجی پرداخت : متد verify

- آدرس ارسال درخواست :

http://behbank.com/ws/payments/verify.json

- نوع درخواست : POST

 

پارامترهای ورودی :

نام پارامتر نوع داده توضیحات نوع فیلد
* merchantCode String مرچنت درگاه اجباری
* paymentNumber Double مبلغ تراکنش به ریال اجباری

جدول شماره 3 : پارامترهای ورودی

 

نکته :paymentNumber شماره پرداختی است که در مرحله درخواست پرداخت دریافت کرده اید.

 

 

پارامترهای خروجی :

نام پارامتر نوع داده توضیحات
status Integer کد وضعیت
message String شرح وضعیت

جدول شماره 4 : پارامترهای خروجی

 

نکته :در صورتی که مقدار status برابر با عدد 1 باشد پرداخت با موفقیت انجام شده است در غیر این صورت عدد 0 برگردانده می شود و علت خطا در فیلد message قرار میگیرد.

 


=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=


 

- دریافت موجودی حساب : متد credit

- آدرس ارسال درخواست :

http://behbank.com/ws/users/credit.json

- نوع درخواست : POST

 

پارامترهای ورودی :

نام پارامتر نوع داده توضیحات نوع فیلد
* apiKey String کلید وب سرویس/td> اجباری
* wallet integer کیف پول )حساب اصلی عدد 1 – حساب پیامکی عدد 2 اجباری

جدول شماره 5 : پارامترهای ورودی

 

 

 

پارامترهای خروجی :

نام پارامتر نوع داده توضیحات
status Integer کد وضعیت
message String شرح وضعیت

جدول شماره 6 : پارامترهای خروجی

 

نکته :در صورتی غیر این صورت عدد 0در صورتی که مقدار status برابر با عدد 1 باشد ، عملیات با موفقیت انجام شده و مبلغ موجودی حساب در فیلد credit قابل دسترسی است.

برای دسترسی به apiKey به بخش پروفایل حساب کاربری خود مراجعه کنید.  


=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=


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

آدرس :

https://behbank.com/ws/payment-widgets/add-link.json

ورودی:

نام پارامتر نوع داده توضیحات نوع فیلد
* merchantCode String مرچنت کد درگاهی که قصد ایجاد لینک پرداخت برای آن را دارید اجباری
* Title String عنوان لینک پرداخت اجباری
* Amount String مبلغ لینک اجباری
* Successful_url String آدرس بازگشت در زمانی که پرداخت موفق انجام شده است اختیاری
Failed_url String آدرس بازگشت در زمانی که تراکنش ناموفق می شود اختیاری
Limit Integer مقدار محدودیت در پرداخت اختیاری

جدول شماره 7 : شرح پرامترهای وروردی





پارامترهای خروجی :

نام نوع داده توضیحات
Status Integer مقدار 1 : در صورت موفقیت

مقدار 0 : در صورت وجود خطا
Message String در صورت رخ دادن خطا شرح خطا را بر میگرداند
linkUrl String در صورت موفقیت آمیز بودن عملیات آدرس لینک پرداخت را بر میگرداند

جدول شماره 8 : پارامترهای خروجی



 

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=


 

 

دانلود نمونه کد های اتصال به وب سرویس :

برای دانلود نمونه کدهای اتصال به درگاه بهبانک ورژن Soap بر روی لینک زیر کلیک کنید :


https://www.behbank.com/plugins/view/1


دانلود نمونه کدها آموزش فرمت (Pdf) آموزش فرمت (Word)