سرویس های تبدیلی و استعلامی

اصطلاحات#

API key: یک توکن برای احراز هویت کاربر و دسترسی به اپلیکیشن، به منظور فراخوانی وبسرویسهای بانکداری باز است. این توکن باید در تمامی وبسرویسها به عنوان توکن bearer در هدر authorization ارسال شود.

refresh token: توکن API key به مدت 24 ساعت معتبر است. لذا برای ایجاد API key جدید به refresh token نیاز میباشد.

application_id: شناسه اپلیکیشن، که بعد از ایجاد اپلیکیشن در اختیار کاربر قرار میگیرد.

access_password: رمز دسترسی به اپلیکیشن، که بعد از ایجاد اپلیکیشن در اختیار کاربر قرار میگیرد.

access_IP: آیپی های مجاز برای فرخوانی وبسرویسها که در اپلیکیشن تنظیم شده اند.

وبسرویس refresh api key#

برای دریافت API key جدید، سرویس زیر با متد POST فراخوانی شود:

https://core.paystar.ir/api/open-banking/application/refresh-api-key

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
refresh_token	string	توکن بازیابی API key	بله

در پاسخ دریافتی اگر status برابر 1 باشد به معنی درخواست موفق بوده و به شرح زیر است:

{
    "status": 1,
    "data": {
       "api_key": "api_key",
       "api_key_expire_date": "api_key_expire_date"
    },
    "message": "درخواست با موفقیت انجام شد"
}

وبسرویس تبدیل شماره حساب به شماره شبا#

به منظور ایجاد درخواست، باید سرویس زیر با متد POST فراخوانی شود:

https://core.paystar.ir/api/open-banking/service/bank-inquiry/account-to-iban

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
account_number	string	شماره حساب	بله
bank_id	string	شناسه بانک حساب مورد نظر	بله

لیست شناسه بانک ها:

نام بانک	شناسه
مرکزی	010
صنعت و معدن	011
ملت	012
رفاه	013
مسکن	014
سپاه	015
کشاورزی	016
ملی	017
تجارت	018
صادرات	019
توسعه تعاون	020
پست بانک	021
توسعه تعاون	022
توسعه	051
قوامین	052
کارآفرین	053
پارسیان	054
اقتصاد نوین	055
سامان	056
پاسارگاد	057
سرمایه	058
سینا	059
مهر ایران	060
شهر	061
آینده	062
انصار	063
گردشگری	064
حکمت ایرانیان	065
دی	066
ایران زمین	069
رسالت	070
مهر ایران	090
ایران ونزوئلا	095
نور	080
کوثر	073
ملل	075
خاورمیانه	078
مهر اقتصاد	079

پاسخ موفق به شکل زیر است:

{
    "status": 1,
    "data": {
      "iban": "your_sheba_number",
      "for_account_number": "account_number_sent_in_request"
      "response_variant": 0,
    }, 
    "message": "درخواست با موفقیت انجام شد"
}

وبسرویس تبدیل شماره کارت به شماره شبا#

به منظور ایجاد درخواست، باید سرویس زیر با متد POST فراخوانی شود:

https://core.paystar.ir/api/open-banking/service/bank-inquiry/card-to-iban

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
card	string	شماره کارت	بله

پاسخ موفق به شکل زیر است:

{
    "status": 1,
    "data": {
      "iban": "sheba_number",
      "response_variant": 0,
    }, 
    "message": "درخواست با موفقیت انجام شد"
}

وبسرویس استعلام شبا#

به منظور ایجاد درخواست، باید سرویس زیر با متد POST فراخوانی شود:

https://core.paystar.ir/api/open-banking/service/bank-inquiry/iban-inquiry

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
iban	string	شماره شبا	بله

پاسخ موفق به شکل زیر است:

{
    "status": 1,
    "data": {
      "iban": "iban",
      "owners_info": [
       {
         "firstName" : "",
         "lastName" : ""
       }
      ],
      "bank_title":"bank_title"
    }, 
    "message": "درخواست با موفقیت انجام شد"
}

جدول نوع داده status#

عنوان	نوع داده	شرح
0	integer	خطای سرور
1	integer	درخواست موفق
2	integer	برنامه یافت نشد
3	integer	برنامه فعال نیست
4	integer	توکن احراز هویت اشتباه است
5	integer	توکن احراز هویت منقضی شده است
6	integer	رمز دسترسی برنامه استباه است
7	integer	آی پی مجاز نمی باشد
8	integer	سرویس مورد نظر برای شما فعال نمی باشد
9	integer	اعتبار کیف بانکداری باز کافی نمی باشد
10	integer	اطلاعات ارسال شده صحیح نمی باشد
11	integer	خطای سرویس دهنده
12	integer	تنظیمات بانکداری باز یافت نشد
13	integer	توکن بازیابی API key اشتباه است

جدول response_variant سرویس دهنده مربوطه#

عنوان	شرح
0	موفق
1	کارت نامعتبر است
2	شبا نامعتبر است
3	اطلاعات هویتی یافت نشد
4	تاریخ تولد نامعتبر است
5	بانک مربوط به کارت غیرفعال است
6	کارت غیرفعال است
7	خطای سرویس دهنده
8	خطای داخلی سرور
9	زمان پاسخ‌دهی به پایان رسید
999	سایر خطا ها