وب‌سرویس کارگزاری بانک پاسارگاد
خدمت‌دهنده
بانک پاسارگاد
مقدمه
پکیج کارگزاری بانک پاسارگاد مجموعه وب سرویس جهت ایجاد مراودات مالی و رابط بین بانک به عنوان تسهیل کننده تراکنش های مالی فعالیت میکند.
در این سیستم لازم است حساب بانکی ویژه کارگزاری توسط مشتری در بانک افتتاح و به کارگزاری معرفی شود تا فرایند های انسداد و برداشت از حساب از آن طریق انجام گردد.
نکته: مشتری باید دسترسی های لازم جهت برداشت از حساب خود را به کارگزاری بدهد (اعطای کارگزاری وکالت جهت انجام تراکنش روی حساب ارائه شود).
نکته: حساب مشتری باید ضمن امکان حق برداشت توسط وی نباید مشترک باشد.
همچنین در سوی دیگر پس از اعطای دسترسی به کارگزاری مربوطه فرایند خرید و فروش سهام توسط کارگزاری انجام میشود از این رو کارگزاری باید این اطمینان را داشته باشد که وجه معامله در حساب مشتری موجود است.
در این صورت کارگزاری به ازای خرید هر سهم معادل ریالی آنرا در حساب مشتری مسدود میکند تا پس از خرید نهایی مبلغ مسدودی از حساب مشتری به حساب کارگزاری منتقل گردد.
لذا در صورتی که به هر دلیلی کارگزاری نتواند سهم مورد نظر مشتری را خریداری نماید یا مبلغ نهایی سهم خریداری شده کمتر از مبلغ مسدودی باشد، در این صورت کارگزاری در انتهای هر روز مبلغ مسدود شده را آزاد و در حساب مشتری فعال مینماید.
پیش از شروع
- URL فراخوانی سرویسها:
Production Server: https://api.pod.ir/srv/sc/nzh/doServiceCall
Sandbox Server:https://sandbox.pod.ir/srv/sc/nzh/doServiceCall
- تمامی درخواستها با متد POST ارسال میشوند.
- فیلدهای زیر درHeader تمامی درخواستها ثابت است:
| پارامتر | توضیحات |
| _token_ | توکن کسبوکاری دریافتی از پنل |
| _token_issuer_ | مقدار ثابت "1" |
- فیلدهای زیر در بدنه‌ی تمامی درخواستها ثابت است (با فرمت x-www-form-urlencoded):
| پارامتر | توضیحات |
| scProductId | شناسه‌ی سرویس مدنظر |
| scApiKey | راهنمای دریافت این پارامتر در این لینک موجود است. |
- علاوه بر موارد بالا که ثابت هستند، اگر سرویس نیاز به پارامتر دیگری داشته باشد در داکیومنت مربوطه ذکر شده است.
- خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.
نکته: پس از درخواست سرویس به پادیوم، همکاران ما درخواستهای ارسالی را بررسی می‌کنند. در صورت عدم دریافت تایید کرد بر روی درخواست ارسالی ظرف یک روز کاری،به همکاران ما از طریق شماره تلفن (021-89518989) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.
سرویس مسدودی حساب
از این سرویس جهت مسدود نمودن مبلغ مشخصی از حساب در صورت موجود بودن آن مبلغ استفاده میشود.
-
شناسه سرویس: 2388198
- پارامتر ورودی سرویس
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| Body | Json | اجباری | اطلاعات ورودی سیستم |
- پارامتر های body :
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| ClientAddress | String | اجباری | آدرس اینترنتی کالینت |
| BrokerId | Integer | اجباری | کد کارگذاری بورس |
| Sheba | String | اجباری | شماره شبا مورد نظر در بانک |
| Amount | Integer | اجباری | مبلغ انسداد |
| BlockNumber | String | اجباری | شماره انسداد |
| Comment | String | اجباری | توضیحات |
- کدکارگزاری توسط بانک تعریف میگردد.
- پارامتر های خروجی :
| نام پارامتر | نوع | توضیحات |
| hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر. |
| messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| referenceNumber | string | شناسه ی درخواست در پلتفرم پاد. |
| errorCode | int | کد ارور پلتفرمی. |
| Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Result | object | نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد. |
نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.
به صورت دقیق تر، بدنه ی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است.
- پارامتر های پاسخ سرویس در Result :
در صورتی که سرویس با موفقیت اجرا شده و پاسخ صحیح بازگرداند خروجی به صورت زیر است:
- مشخصات پارامتر پاسخ
| نام پارامتر | نوع | توضیحات |
| IsSuccess | Boolean | نتیجه موفق یا ناموفق |
| Rscode | Int | کد پاسخ |
| Message | String | پیغام |
| ResultData | String | شماره یکتا انسداد |
سرویس رفع انسداد حساب
از این سرویس جهت رفع مسدود نمودن مبلغی که قبال مسدود شده، استفاده میشود.
-
شناسه سرویس: 2388210
- پارامتر ورودی سرویس
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| Body | Json | اجباری | اطلاعات ورودی سیستم |
- پارامتر های body :
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| ClientAddress | String | اجباری | آدرس اینترنتی کالینت |
| BrokerId | String | اجباری | کد کارگذاری بورس |
| Sheba | String | اجباری | شماره شبا مورد نظر در بانک |
| Amount | String | اجباری | مبلغ انسداد |
| BlockNumber | String | اجباری | شماره انسداد |
| Comment | String | اجباری | توضیحات |
- پارامتر های خروجی :
| نام پارامتر | نوع | توضیحات |
| hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر. |
| messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| referenceNumber | string | شناسه ی درخواست در پلتفرم پاد. |
| errorCode | int | کد ارور پلتفرمی. |
| Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Result | object | نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد. |
نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.
به صورت دقیق تر، بدنه ی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است.
- پارامتر های پاسخ سرویس در Result :
در صورتی که سرویس با موفقیت اجرا شده و پاسخ صحیح بازگرداند خروجی به صورت زیر است:
- مشخصات پارامتر پاسخ
| نام پارامتر | نوع | توضیحات |
| IsSuccess | Boolean | نتیجه موفق یا ناموفق |
| Rscode | Int | کد پاسخ |
| Message | String | پیغام |
| ResultData | String | شماره یکتا انسداد |
سرویس رفع انسداد و انتقال وجه
از این سرویس جهت رفع مسدود نمودن مبلغی که قبال مسدود شده، استفاده میشود.
-
شناسه سرویس: 2388214
- پارامتر ورودی سرویس
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| Body | Json | اجباری | اطلاعات ورودی سیستم |
- پارامتر های body :
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| ClientAddress | String | اجباری | آدرس اینترنتی کالینت |
| UnblockNumber | String | اجباری | شماره یکتا انسداد |
| SourceSheba | String | اجباری | شماره شبا مبدا مورد نظر در بانک |
| DestSheba | String | اجباری | شماره شبا مقصد مورد نظر در بانک |
| BlockedAmount | String | اجباری | مبلغ مسدود شده |
| Amount | String | اجباری | مبلغ انتقال |
| UnblockComment | String | اختیاری | شرح رفع انسداد |
| TransferComment | String | اختیاری | شرح انتقال وجه |
| BrokerId | String | اختیاری | شماره کارگذاری |
| IsUnblockRemainAmount | bool | اجباری | این فیلد به سیستم اعالم میکند که آیا پس از انتقال وجه، به صورت خودکار، مابقی مبلغ مسدود شده با این شماره را رفع انسداد کند یا خیر. |
- پارامتر های خروجی :
| نام پارامتر | نوع | توضیحات |
| hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر. |
| messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| referenceNumber | string | شناسه ی درخواست در پلتفرم پاد. |
| errorCode | int | کد ارور پلتفرمی. |
| Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Result | object | نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد. |
نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.
به صورت دقیق تر، بدنه ی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است.
- پارامتر های پاسخ سرویس در Result :
در صورتی که سرویس با موفقیت اجرا شده و پاسخ صحیح بازگرداند خروجی به صورت زیر است:
- مشخصات پارامتر پاسخ
| نام پارامتر | نوع | توضیحات |
| IsSuccess | Boolean | نتیجه موفق یا ناموفق |
| Rscode | Int | کد پاسخ |
| Message | String | پیغام |
| ResultData | String | شماره یکتا انسداد |
سرویس دریافت اطلاعات یک مسدودی بر اساس شماره پیگیری
از این سرویس جهت دریافت اطلاعاتیک مسدودی بر اساس شماره پیگیری استفاده می گردد.
-
شناسه سرویس: 2388218
- پارامتر ورودی سرویس
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| Body | Json | اجباری | اطلاعات ورودی سیستم |
- پارامتر های body :
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| ClientAddress | String | اجباری | آدرس اینترنتی کالینت |
| BrokerId | String | اختیاری | شماره کارگذاری |
| BlockNumber | String | اجباری | شماره یکتا انسداد |
- پارامتر های خروجی :
| نام پارامتر | نوع | توضیحات |
| hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر. |
| messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| referenceNumber | string | شناسه ی درخواست در پلتفرم پاد. |
| errorCode | int | کد ارور پلتفرمی. |
| Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Result | object | نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد. |
نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.
به صورت دقیق تر، بدنه ی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است.
- پارامتر های پاسخ سرویس در Result :
در صورتی که سرویس با موفقیت اجرا شده و پاسخ صحیح بازگرداند خروجی به صورت زیر است:
- مشخصات پارامتر پاسخ
| نام پارامتر | نوع | توضیحات |
| IsSuccess | Boolean | نتیجه موفق یا ناموفق |
| Rscode | Int | کد پاسخ |
| Message | String | پیغام |
| ResultData | Json | اطلاعات مسدودی شرح در جدول پیوست 1 |
| Unblockings | Josn | اطلاعاتعملیات رفع مسدودی )شرح در جدول پیوست 2) |
| IncreaseBlocks | Json | اطلاعاتعملیات ویرایش مبلغ مسدودی )شرح در جدول پیوست 3( |
سرویس ویرایش مبلغ انسداد
از این سرویس جهت ویرایش مبلغ مسدودی استفاده می گردد. (کاهش یا افزایش)
-
شناسه سرویس: 2388220
- پارامتر ورودی سرویس
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| Body | Json | اجباری | اطلاعات ورودی سیستم |
- پارامتر های body :
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| ClientAddress | String | اجباری | آدرس اینترنتی کالینت |
| BrokerId | String | اجباری | شماره کارگزاری |
| Sheba | String | اجباری | شماره شبا مورد نطر در بانک |
| Amount | String | اجباری | مبلغ |
| BlockNumber | String | اجباری | شماره یکتا انسداد |
| Comment | String | اجباری | توضیحات |
- پارامتر های خروجی :
| نام پارامتر | نوع | توضیحات |
| hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر. |
| messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| referenceNumber | string | شناسه ی درخواست در پلتفرم پاد. |
| errorCode | int | کد ارور پلتفرمی. |
| Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Result | object | نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد. |
نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.
به صورت دقیق تر، بدنه ی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است.
- پارامتر های پاسخ سرویس در Result :
در صورتی که سرویس با موفقیت اجرا شده و پاسخ صحیح بازگرداند خروجی به صورت زیر است:
- مشخصات پارامتر پاسخ
| نام پارامتر | نوع | توضیحات |
| IsSuccess | Boolean | نتیجه موفق یا ناموفق |
| Rscode | Int | کد پاسخ |
| Message | String | پیغام |
| ResultData | String | شماره یکتا انسداد |
سرویس استعلام لیست مسدودی‌های کارگزاری
از این سرویس جهت استعالم لیست مسدودی استفاده می گردد.
-
شناسه سرویس: 2388222
- پارامتر ورودی سرویس
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| Body | Json | اجباری | اطلاعات ورودی سیستم |
- پارامتر های body :
| نام پارامتر | نوع | اختیاری / اجباری | توضیحات |
| ClientAddress | String | اجباری | آدرس اینترنتی کالینت |
| BrokerId | String | اجباری | شماره کارگزاری |
- پارامتر های خروجی :
| نام پارامتر | نوع | توضیحات |
| hasError | bool | نشان دهنده ی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر. |
| messageId | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| referenceNumber | string | شناسه ی درخواست در پلتفرم پاد. |
| errorCode | int | کد ارور پلتفرمی. |
| Count | int | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Ott | string | پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد. |
| Result | object | نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد. |
نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.
به صورت دقیق تر، بدنه ی پاسخ را میتوان در فیلد result مشاهده کرد که دارای ساختار زیر است.
- پارامتر های پاسخ سرویس در Result :
در صورتی که سرویس با موفقیت اجرا شده و پاسخ صحیح بازگرداند خروجی به صورت زیر است:
- مشخصات پارامتر پاسخ
| نام پارامتر | نوع | توضیحات |
| IsSuccess | Boolean | نتیجه موفق یا ناموفق |
| Rscode | Int | کد پاسخ |
| Message | String | پیغام |
| ResultData | String | ظبق جدول شماره 1 |
جدول شماره 1 Result Data
| نام پارامتر | نوع | توضحیات |
| BlockNumber (شماره انسداد) | string | اجباری |
| BlockingTime (زمان) | string | اجباری |
| BlockedDeposit (شماره سپرده( | string | اجباری |
| BlockedAmount (مبلغ) | string | اجباری |
جدول شماره 2 Unblockings
| نام پارامتر | نوع | توضحیات |
| Key (زمان) | string | اجباری |
| Value (مبلغ) | string | اجباری |
جدول شماره 3 IncreaseBlocks
| نام پارامتر | نوع | توضحیات |
| Key (زمان) | string | اجباری |
| Value (مبلغ) | string | اجباری |
