مقدمه

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

 فعالسازی سرویس

ارسال درخواست در سایت پادیوم www.podium.ir:

ابتدا وارد سایت پادیوم شده، سپس در بازارچه‌ی API، سرویسهای مورد نظر خود را انتخاب و درخواست استفاده از آن مجموعه سرویس را ارسال کنید.

clasor

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

clasor

منو: پنل کسب و کار – منوی میزکار سرویس گیرنده – درخواستهای ارسالی – در بخش مربوط به سرویس مورد نظر با کلیک بر روی "جزئیات درخواست"

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

لینک پنل کسب و کار                                                                                                                                                                                     https://panel.pod.ir/Businesses/Requestwebservices

clasor

 

 

نکته : این کلید در تمام درخواست‌های ارسالی از آن سرویس ، ثابت است تا زمانی که کلید جدیدی برای آن سرویس دریافت نشود و به محض دریافت مقدار جدید برای سرویس مورد نظر, کلید قبلی منقضی خواهد شد.

-این کلید در فیلد scApiKey در بخش body درخواست HTTP ، استفاده می شود.

clasor

دریافت کلیدهای سرویس یک (دسته/مجموعه) سرویس در قالب یک فایل:

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

clasor

تطبیق شماره کارت و کد ملی و تاریخ تولد

این سرویس تطابق سه پارامتر کدملی، تاریخ تولد و شماره کارت باهم را بصورت True/False برمی‌گرداند.

این سرویس قابل استفاده برای همه بانک‌ها است.

شناسه سرویس: 16530454

(سندباکس: ندارد)

توضیحات

مقدار

نام پارامتر

ورودی

Header

توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است

yourBusinessToken

_token_

این پارامتر همواره دارای مقدار ثابت 1 است .

1

_token_issuer_

این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded'  باشد

application/x-www-form-urlencoded

Content-Type

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

 نتیجه  نهایی سرویس نیز به صورت Parse شده نمایش داده میشود.

true/false

scWrapper

Body

شناسه سرویس

16530454

scProductId

کلید فراخوانی سرویس 

 

scApiKey

الزامی - شماره کارت 16 رقم – بدون فاصله و یا کارکتر جداکننده

 

cardNumber

کدملی – 10 رقم

 

nationalCode

تاریخ تولد – تقویم خورشیدی و با فرمت YYYYmmDD

نمونه:

13670305

 

birthDate

خروجی

در صورت وقوع خطا در فراخوانی سرویس true خواهد بود

true/false

hasError

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

string

referenceNumber

نتیجه ی نهایی سرویس 

string

result.result

result

تطابق یا عدم تطابق نام دارنده کارت با کدملی فرد موردنظر

boolean

matched

نمونه درخواست

HTML

 

نمونه پاسخ

JSON

 

تطبیق شماره شبا و کد ملی و تاریخ تولد

این سرویس تطابق سه پارامتر کدملی، تاریخ تولد و شماره شبای فرد باهم را بصورت True/False برمی‌گرداند. 

این سرویس قابل استفاده برای همه بانک‌ها است.

شناسه سرویس: 16530455

(سندباکس:  ندارد)

توضیحات

مقدار

نام پارامتر

ورودی

Header

توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است

yourBusinessToken

_token_

این پارامتر همواره دارای مقدار ثابت 1 است .

1

_token_issuer_

این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded'  باشد

application/x-www-form-urlencoded

Content-Type

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

 نتیجه  نهایی سرویس نیز به صورت Parse شده نمایش داده میشود.

true/false

scWrapper

Body

شناسه سرویس

16530455

scProductId

کلید فراخوانی سرویس 

 

scApiKey

الزامی - شماره شبا

 

iban

کدملی – 10 رقم

 

nationalCode

تاریخ تولد – تقویم خورشیدی و با فرمت YYYYmmDD

نمونه:

13670305

 

 

birthDate

خروجی

در صورت وقوع خطا در فراخوانی سرویس true خواهد بود

true/false

hasError

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

string

referenceNumber

نتیجه ی نهایی سرویس 

string

result.result

result

تطابق یا عدم تطابق نام دارنده کارت با کدملی فرد موردنظر

boolean

matched

نمونه درخواست

HTML

 

نمونه پاسخ

JSON 

 

تطابق شماره حساب با نام و نام خانوادگی

این سرویس تطابق نام و نام خانوادگی با شماره حساب را بصورت True/False برمی‌گرداند. 
این سرویس قابل استفاده برای همه بانک‌ها است.

  • شناسه سرویس : 16590079  
  • (سندباکس: ندارد)

توضیحات

مقدار

نام پارامتر

ورودی

Header

توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است

yourBusinessToken

_token_

این پارامتر همواره دارای مقدار ثابت 1 است .

1

_token_issuer_

این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded'  باشد

application/x-www-form-urlencoded

Content-Type

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

 نتیجه  نهایی سرویس نیز به صورت Parse شده نمایش داده میشود.

true/false

scWrapper

Body

شناسه سرویس

16590079 

scProductId

کلید فراخوانی سرویس 

 

scApiKey

کد بانک

 

bankCode

شماره حساب بانک

 

depositNumber

نام و نام خانوادگی (با یک فاصله جدا از هم )

 

name

خروجی

در صورت وقوع خطا در فراخوانی سرویس true خواهد بود

true/false

hasError

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

string

referenceNumber

نتیجه ی نهایی سرویس 

string

result.result

result

تطابق یا عدم تطابق نام دارنده کارت با کدملی فرد موردنظر

boolean

matched

نمونه درخواست

HTML

 

نمونه پاسخ

JSON 

 

تطابق کارت با نام و نام خانوادگی

این سرویس تطابق نام و نام خانوادگی با شماره کارت را بصورت True/False برمی‌گرداند.
این سرویس قابل استفاده برای همه بانک‌ها است.

  • شناسه­ سرویس: 16579691
  • (سندباکس: ندارد)
  • پارامترهای ورودی:

 فیلد

نوع

توضیحات

cardNumber*

string

شماره کارت

name*

string

نام مورد نظر برای بررسی تطابق با شماره کارت

  • خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.

 بدنۀ پاسخ دریافتی در صورت موفقیت سرویس:

فیلد

نوع

توضیحات

matched

boolean

تطابق / عدم تطابق نام دارندۀ کارت با نام مورد نظر

بدنۀ پاسخ دریافتی در صورت خطای سرویس:

فیلد

نوع

توضیحات

code

string

متن خطای سرویس

message

string

پیام مربوط به خطا

خطاهای مربوط به سرویس تطابق کارت با نام و نام خانوادگی:

code

message

invalid.request_body

بدنۀ درخواست خالی و یا نامعتبر است.

forbidden

غیر مجاز (با پشتیبانی تماس بگیرید)

card.not_valid

کارت نامعتبر است.

query_parameters.too_many

ترکیب پارامترهای ارسالی قابل شناسایی نیست.

daily_limit.reached

در فراخوانی این سرویس به محدودیت روزانه رسیده‌اید.

card.not_active

کارت غیرفعال است.

card.is_expired

کارت منقضی شده است.

card.account_number_not_valid

شماره حساب مربوط به کارت معتبر نیست.

card.owner_not_authorized

هویت دارندۀ کارت نامعتبر است.

card.registered_as_lost

این کارت به‌عنوان کارت گم‌شده ثبت شده است.

card.registered_as_stolen

این کارت به‌عنوان کارت مسروقه ثبت شده است.

card.black_listed

استعلام این کارت امکان‌پذیر نیست.

card.source_bank_is_not_active

بانک مربوط به کارت فعال نیست.

card.provider_is_not_active

سرویس‌دهندۀ مربوط به کارت فعال نیست.

providers.not_available

در حال حاضر سرویس‌دهنده‌ای در دسترس نیست.

server.error

خطای داخلی سرور

خطاهای معمول در پلتفرم

کد خطا

توضیح

21

توکن کسب­­وکاری وارد نشده است

227

تایم اوت سرویس اصلی

378

ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است

403

اجازه انجام انتقال وجه را ندارید" – شما دسترسی لازم به شماره حساب مبدا را ندارید.

خطاهای سرویس دهنده (جیبیت)

invali.request_body

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

forbidden

با پادیوم تماس گرفته شود.

token.is_required

توکن الزامی است.

bank.not_valid

بانک نامعتبر است.

 تطابق شبا با نام و نام خانوادگی

شناسه سرویس: 17368771

شناسه سرویس سند باکس: ندارد

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

Body

توضیحات

نوع

نام پارامتر

شماره شبا

String

iban

نام و نام خانوادگی

String

fullName

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

Respone

توضیحات

نوع

نام پارامتر

جزئیات نتیجه از پروایدر

StringifyJSON

result.result

وضعیت نتیجه در پروایدر

Int

result.statusCode

تطابق یا عدم تطابق نام دارنده شبا با نام مورد نظر

Boolean

result.result.matched

کد خطای پروایدر

String

result.result.code

متن خطای پروایدر

String

result.result.message

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

Body

مقدار

نام پارامتر

-

scProductId

-

iban

-

fullName

نمونه درخواست و پاسخ

نمونه درخواست با مقادیر درست

HTML

 

نمونه پاسخ موفقیت آمیز

JSON

 

نمونه درخواست با مقادیر نا درست

HTML

 

نمونه پاسخ خطا

JSON

 

نمونه درخواست با مقادیر درست

HTML

 

نمونه پاسخ خطا ناشی از مشکل در سرور

JSON

 

کد خطاهای رسپانس

Response

کد خطا

توضیح

صفحه HTML با خطای 404

منبع درخواستی در سرور پیدا نشد

صفحه HTML با خطای 408

پایان مهلت زمانی سرور به کانکشن کلاینت

صفحه HTML با خطای 502

خطا در دریافت در درگاه سرور از سرور پروایدر

صفحه HTML با خطای 503

سرور آماده سرویس دهی نیست

صفحه HTML با خطای 504

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

 

 

کد خطاهای پادیوم

errorCode

کد خطا

توضیح

0

بدون خطا

21

توکن کسب وکاری وارد نشده است

227

تایم اوت سرویس اصلی

378

ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است

404

خطا در شبکه. برنامه موقتا در دسترس نیست

500

خطا در دریافت اطلاعات

502

خطای داخلی

999

خطای داخلی سیستم

 

 

کد خطاهای پروایدر

result.result.code

کد خطا

توضیح

iban.not_found

شبا یافت نشد

iban.owner_not_found

دارنده شبا یافت نشد

daily_limit.reached

در فراخوانی این سرویس به محدودیت روزانه رسیده اید

providers.not_available

در حال حاضر سرویس دهنده ای در دسترس نیست

server.error

خطای داخلی سرور

invalid.request_body

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

forbidden

غیر مجاز (توکن نامعتبر است یا حساب کاربری شما غیر فعال است)

token.is_required

توکن الزامی است

iban.not_valid

شبا نامعتبر است

query_parameters.too_many

ترکیب پارامترهای ارسالی قابل شناسایی نیست

Clasor npm package version 2.1.4
به پادیوم قدرت داده اند:
pasargad
fanap
pod