استعلام چک

خدمت‌دهنده

داتین

فراخوانی آزمایشی _BETA اطلاعات مجموعه سرویس

مقدمه

با استفاده از این سرویس میتوان اطلاعات مربوط به چک موردنظر را در خروجی دریافت نمود.

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

نحوه‌ی ارسال درخواست فعالسازی سرویس ، و دریافت کلید فراخوانی سرویس ( _scApiKey_ ):
برای استفاده از هر سرویس ابتدا باید درخواست فعالسازی آن سرویس را به پادیوم اعلام کنید.
بعد از بررسی و تایید آن درخواست ، توسط پادیوم ، باید کلید استفاده و فراخوانی از آن سرویس را دریافت نمایید.

برای استفاده از هر سرویس یک کلید فراخوانی باید دریافت شود. :

❖ نکته: این کلید در تمام درخواستهای ارسالی از آن سرویس، ثابت بوده و نیاز نیست برای هر بار فراخوانی سرویس، کلید جدید دریافت نمایید.

دربافت APIKey از طریق سرویس:

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

این سرویس دارای سه پارامتر می باشد:

پارامتر	توضیحات	اجباری/اختیاری
scProductId	شناسه سرویس (1384158)	اجباری
serviceNumbers	یک یا لیستی از شماره سرویسهای مورد درخواست ، که داخل براکت [] می آیند و میتوانند بوسیله (کاما) از یکدیگر جدا شوند	اجباری
Deposits	یک یا لیستی از شماره حسابهای بانک پاسارگاد مشتری که در نیاز سرویس میتواند داخل [] ارسال و با(کاما) از یکدیگر جدا شوند. *اگر فراخوانی سرویس نیاز به شماره حساب داشته باشد ، و شماره حساب ثبت شده باشد ، بدون نیاز به ارسال کردن این پارامتر میتوان کلید را دریافت کرد	اختیاری

به عنوان مثال، در درخواست زیر برای سرویس‌های استعلام شبا 34254 و استعلام کارت 34255 درخواست استفاده از سرویس ارسال می‌شود.

HTTP

نمونه خروجی

JSON

❖ متناسب با وضعیت پارامتر statusCode به شما پیغام مناسب داده خواهد شد:

پارامتر statusCode	توضیحات
scApiKey_REQUESTED	درخواست استفاده از سرویس ارسال شده است و در مرحله بررسی و تایید توسط پادیوم است . می توانید با استفاده از شناسه درخواست requestId و شناسه بیزنس businessId خود ، از پادیوم پیگیری نمایید.
scApiKey_GENERATED	کلید فراخوانی ایجاد شده است ، و میتوانید از کلید تولید شده در فیلد مورد نظر scApiKey استفاده نمایید. توجه نمایید که کلید تولید شده ی قبلی منقضی می‌شود .
REQUEST_FAILED	اگر درخواست با خطا مواجه شود این وضعیت ایجاد میشود ، به عنوان مثال ممکن است شما سرویسی را درخواست داده باشید ، که نیازمند شماره حساب بانکی باشد ، ولی شماره حسابی را جهت استفاده ، به پادیوم اعلام نکرده باشید و پیغام "برای استفاده از این سرویس نیاز به شماره حساب دارید" دریافت کنید.

❖ بعداز تایید ، می‌توانید مجدد این سرویس را برای بدست آوردن کلید scApiKey فراخوانی کنید.

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

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

HTTP

2. اگر قبلا یک یا چند شماره حساب شما, توسط پادیوم ثبت شده باشد و تنها نیاز داشته باشید که برای استفاده یک یا برخی از آن‌ها کلید فراخوانی سرویس دریافت نمایید,

کافیست لیستی از شماره حساب‌های بانک پاسارگاد خود (اعلام شده در فرم بانکی) را وارد نمائید.

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

HTTP

جستجوی چک بر روی سپرده

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

با این سرویس میتوانید چک‌هایی که توسط شما به سایرین واگذار شده ، یا از سایرین دریافت کرده اید را بدست آورید.

به نحوی‌که در ورودی اطلاعاتی نظیر شماره چک،کد بانک متعهد و غیره دریافت شده و در خروجی مبلغ چک ، تاریخ چک و غیره نمایش داده میشود

توجه کنید که این سرویس برای مشتریان بانک پاسارگاد و چک هایی که مبدا یا مقصد(حساب) آنها بانک پاسارگاد باشد ، قابل استفاده است .

ورودی
Header:
_token_	بیزنس توکن ( توکن ثابت کسب وکار که باید از پنل کسب وکار دریافت شود
_token_issuer_	همواره باید مقدار 1 در این فیلد ارسال شود
Method:
POST
URL:
Production = https://api.pod.ir/srv/sc/nzh/doServiceCall Sandbox = در حال حاضر فاقد سرویس تست می باشد
Parameters:
scProductId	1287428
scApiKey	به ازای هر سرویس ، بعد از درخواست آن سرویس ، و تایید درخواست توسط پادیوم ، یک کلید فراخوانی سرویس ApiKey باید از پنل یا توسط سرویس موردنظر دریافت کنید و دراین پارامتر ارسال نمایید
	ارسال درخواست استفاده از سرویس
	HTTP
	businessId=1623 این مقدار همواره ثابت است productId=1287428 شناسه سرویس استعلام و جستجوی چک است depositNumber=w.x.y.z شماره حساب بانک پاسارگاد شماست که قبلا توسط فرمی که به بانک ارائه کرده اید ، دسترسی به این سرویس برای شماره حساب فعال شده است . (فعال بودن این دسترسی را با پادیوم بررسی کنید)
	خروجی: ارسال درخواست استفاده از سرویس (دریافت id شناسه درخواست)
	JSON
	id شناسه درخواست : درخواست استفاده از این سرویس مخصوص آن شماره حساب با این شماره ثبت شده است. این شناسه را جهت فعالسازی وب سرویس ، به پادیوم اعلام نمایید و از آن جهت دریافت کلید فراخوانی سرویس در سرویس زیر (در پارامتر URL ) استفاده نمایید.
	دریافت کلید بعد از تایید توست پادیوم
	HTTP
	در پاسخ سرویس بالا ، کلید فراخوانی سرویس را دریافت خواهید کرد (بخشی از پاسخ در زیر آورده شده است)
	JSON
body	پارامترهای مورد نیاز که در قالب یک JSON باید ارسال شود .
	body's JSON Fields
	FirstResult	الزامی	0	رکورد شروع نمایش لیست
	MaxResult	الزامی	10	تعداد رکورد
	CommittedDepositNumber	الزامی/اختیاری	w.x.y.z	شماره سپرده پاسارگادی واگذار کننده چک
	PayeeDepositNumber	الزامی/اختیاری	w.x.y.z	شماره سپرده پاسارگادی دریافت کننده چک
	IssuerBankId	الزامی	1-	کد بانک مقصد ( مراجعه شود به جدول کد بانک ) ( میتوانید از مقدار -1 برای تمامی بانکها استفاده کنید )
	FomChequeDepositDate	اختیاری		تاریخ سپرده چک (از)
	ToChequeDepositDate	اختیاری		تاریخ سپرده چک (تا)
	FromChequeDate	اختیاری		تاریخ چک (از)
	ToChequeDate	اختیاری		تاریخ چک(تا)
	MinChequeAmount	اختیاری		حداقل مبلغ چک (ریال)
	MaxChequeAmount	اختیاری		حداکثر مبلغ چک (ریال)
	ChequeNumber	اختیاری		شماره چک (شماره/ سری)
	ChequeStateId	اختیاری		شناسه وضعیت چک
	CurrencyId	اختیاری		شناسه ارز
	ChequeBookId	اختیاری		شناسه دسته چک
نمونه درخواست
HTTP
خروجی
JSON

سرویس جستجوی چک

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

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

وضعیت های چک ChequeState شامل : (کد/عنوان)
1-   قابل استفاده
2-   واگذاری سایر
3-   ثبت شده
4-   برگشتی
5-   نقد شده
6-   واگذاری داخلی
7-   پرداخت قسمتی از چک
8-   باطل
9-   صادر شده
10-   عودتی
11-   خام
12-   عودت شده به مشتری

نوع رسانه چک ChequeMediaType :
1- کاغذی
2- دیجیتال

توضیحات		مقدار	نام پارامتر
ورودی
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
الزامی - شناسه سرویس		8621116	scProductId
الزامی -کلید فراخوانی سرویس			scApiKey
الزامی - درخواست استعلام و جستجوی چک ، که حاوی یک JSON با مقادیر زیر است . JSON		{}	request
فیلدهای پارامتر request
شماره چک			ChequeNumber
شماره صفحه – مقدار پیشفرض 1			PagerNumber
تعداد در صفحه – مقدار پیشفرض 1000 می باشد.			MaxResult
شماره سپرده متعهد			CommittedDepositNumber
شماره سپرده ذینفع			AcquireDepositNumber
کد رهیگیری صیاد			SayadRequestCode
نوع رسانه چک			ChequeMediaTypeCode
وضعیت چک			ChequeStateCode
وضعیت مسدودی - مقادیر مجاز : true / false با توجه به اختیاری بودن میتواند ارسال نگردد یا خالی ارسال گردد			IsBlocked
وضعیت رفع سوء اثر – true / false با توجه به اختیاری بودن میتواند ارسال نگردد یا خالی ارسال گردد			IsResolvedNegativeEffect
شناسه صیاد			SayadSerialNumber
خروجی
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود		true/false	hasError
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید.		string	referenceNumber
نتیجه ی نهایی سرویس		string	result.result
فیلدهای result.result
نتیجه موفق یا ناموفق - true/false			IsSuccess
کد پاسخ			rsCode
پیغام			Message
خروجی در صورت موفق بودن عملیات			ResultData
خروجی در صورت ناموفق بودن عملیات : Code : کد خطا Desc : پیغام خطا ParamName : نام پارامتر دارای خطا ParamPath : مسیر پارامتر دارای خطا			ErrorList
فیلدهای ResultData
نتیجه موفق / یا ناموفق			IsSuccess
کد پاسخ			RsCode
پیغام			Message
تعداد کل چکها با فیلتر ورودی بدون اعمال صفحه بندی			Count
اطلاعات چک ها			ChequesInfo
فیلدهای ChequesInfo
شماره سپرده متعهد			CommitedDepositNumber
شماره چک			ChequeNumber
شماره صیاد			SayadSerialNumber
مبلغ چک			Amount
اطلاعات ارز چک : SwiftCode : کد سوئیف Name : نام ارز			Currency
تاریخ چک			Date
اطلاعات بانک متعهد			OwnerBank
اطلاعات شعبه متعهد : Code : کد شعبه Name : نام شعبه samCode : کد سام شعبه			OwnerBranch
شماره سپرده ذینفع			AcquireDepositNumber
اطلاعات وضعیت چک : Code : کد Name : نام			ChequeState
اطلاعات نوع رسانه چک : Code : کد Name : نام			ChequeMediaType
اطلاعات نوع چک : Code : کد Name : نام			ChequeType
وضعیت مسدودی			IsBlocked
وضعیت رفع سوء اثر			IsResolvedNegativeEffect
نمونه درخواست
JSON
نمونه پاسخ
JSON
خطاهای معمول در پلتفرم
کد خطا	توضیح
21	توکن کسبوکاری وارد نشده است
227	تایم اوت سرویس اصلی
378	ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است
RsCode
1	عملیات با موفقیت انجام شد
1038	اطلاعات ورودی اشتباه است
2941	مقدار برای پارامتر ورودی اجباری ارسال نشده است – در صورتیکه مطابق با مستند پارامترهای اجباری ارسال نشود.
0	چکی با مشخضات وارد شده پیدا نشد
0	وضعیت چک تنها مقادیر عددی را می پذیرد
0	وضعیت چک باید بین 1 و 12 باشد
0	نوع رسانه تنها مقادیر 1 و 2 را می پذیرد