سرویس های اعتبارسنجی و احرازهویت

اصطلاحات#

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/info-matching/mobile-national-id

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

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

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

{
    “status”: 1,
    “data”: {
      "response_variant": 0,
      "is_matched": true/false
    }, 
    “message”: “درخواست با موفقیت انجام شد”
}

همچنین فیلد is_matched در حالت true به معنی انطباق اطلاعات ارسالی و در حالت false به معنی عدم انطباق آنها می باشد.

وبسرویس تطبیق کارت، کدملی (همراه با تاریخ تولد)#

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

https://core.paystar.ir/api/open-banking/service/info-matching/card-national-id

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
national_id	string	کد ملی	بله
card_number	string	شماره کارت	بله
birth_date	date_format Y-m-d	تاریخ تولد میلادی	بله

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

{
    “status”: 1,
    “data”: {
      "response_variant": 0,
      "is_matched": true/false
    }, 
    “message”: “درخواست با موفقیت انجام شد”
}

همچنین فیلد is_matched در حالت true به معنی انطباق اطلاعات ارسالی و در حالت false به معنی عدم انطباق آنها می باشد.

وبسرویس تطبیق شبا، کدملی (همراه با تاریخ تولد)#

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

https://core.paystar.ir/api/open-banking/service/info-matching/iban-national-id

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
national_id	string	کد ملی	بله
iban	string	شماره شبا	بله
birth_date	date_format Y-m-d	تاریخ تولد میلادی	بله

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

{
    “status”: 1,
    “data”: {
      "response_variant": 0,
      "is_matched": true/false
    }, 
    “message”: “درخواست با موفقیت انجام شد”
}

همچنین فیلد is_matched در حالت true به معنی انطباق اطلاعات ارسالی و در حالت false به معنی عدم انطباق آنها می باشد.

جدول نوع داده 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	سایر خطا ها