مقدمه

توسط این سرویس می توانید از صحت مالک حساب مطلع شوید

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

پیش از شروع

آدرس فراخوانی سرویس ها

https://api.pod.ir/srv/sc/nzh/doServiceCall

تمامی درخواست ها با متد Post ارسال می شود

Header درخواست ها

پارامترهای زیر در Header تمام درخواست ها ثابت است

پارامتر

توضیحات

_token_

API token دریافتی از پنل کسب و کاری

_token_issuer_

این پارامتر دارای مقدار ثابت "1" می باشد

Content-Type

مقدار ثابت application/x-www-form-urlencoded

به UnderLine قبل  و بعد از نام پارامترها دقت نمایید

Body درخواست ها

همچنین پارامترهای زیر در Body درخواست ها نیز ثابت است

پارامتر

توضیحات

scProductId

شناسه سرویس متناظر با هر سرویس که در توضیحات آن آمده است .

scApiKey

 API Key کلید فراخوانی سرویس – که بعد از درخواست سرویس / مجموعه سرویس ، از پنل کسب وکار قابل دریافت است .

 

otherParams

سایر پارامترهای مورد استفاده ی سرویس که بر اساس مستند سرویس باید اضافه شوند

 

کالکشن Postman

https://space.pod.ir/file/QZWDQ5IUO7XUVJ3I?dl=1

برای دریافت API KEY از طریق پنل کاربری پادیوم اقدام نمایید.

ارسال درخواست فعالسازی از سایت پادیوم و دریافت کلید از طریق پنل کسب وکار

  • توجه داشته باشید که درخواست از سایت ، برای سرویسهایی است که در حال حاضر در بازارچه موجود می باشند

 

تطابق کدملی و شماره سپرده/شبا

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

  • شناسه سرویس:  1257838
  • شناسه سرویس سندباکس: 168224
  • پارامتر ورودی سرویس:

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

NationalId

Integer

اجباری

کد ملی

DepositNumber

string

اجباری

شماره شبا/سپرده

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

referenceNumber

string

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

errorCode

int

کد ارور پلتفرمی.

Count

int

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

Ott

string

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

Result

object

نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد.

نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.

به صورت دقیق تر، بدنه ی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است:

  • نمونه پاسخ سرویس موفق در Result:
json

 

 

  • نمونه پاسخ سرویس نا موفق در Result:
json

 

 

  • پارامتر های موجود در Result:

نام پارامتر

نوع

توضیحات

Status

boolean

در صورت تطبیق داشتن مقدار true و در غیر اینصورت مقدار false برمی گردد

statusCode

String

کد پاسخ طبق جدول زیر

message

String

شرح برای کد نمایش داده می شود

  •  پارامتر های موجود در statusCode:

نام کد

توضیحات

1

این شماره حساب متعلق به این کد ملی می باشد

2

این شماره حساب متعلق به این کد ملی نمی باشد

3

شماره حساب یافت نشد

4

خطا در فراخوانی سرویس (نمایش پاسخ علت خطا)

255

خطای ناشناخته

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

کد خطا

عنوان

توضیحات

1

با موفقیت انجام شد

سرویس با موفقیت اجرا شده است

0

خطا

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

999

خطای ناشناخته

لازم است سرویس مجدد فراخوانی گردد

227

عدم دریافت پاسخ از سرویس دهنده

لازم است سرویس مجدد فراخوانی گردد

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