انتقال وجه پایا و ساتنا گروهی
خدمتدهنده
بانک پاسارگاد
وب سرویس بانک پاسارگاد
مجموعه وب سرویسهای بانک پاسارگاد به شما این امکان را میدهد تا بخش زیادی از فرایندهای مرتبط با سپرده خود را که پیش از این از طریق شعبه و یا اینترنت بانک انجام می دادید
را بی واسطه و مستقیما، استفاده نمایید و در سیستمهای نرم افزاری خود پیاده سازی کنید. ابتدا با مراجعه به وب سایت www.podium.ir اقدام به ساخت کسب و کار نمایید
سپس براساس ماهیت حساب بانکی خود ، یکی از دو فرم حقیقی / یا حقوقی زیر را دانلود و بعد از کامل نموندن اطلاعات موردنیاز ، آن را به یکی از شعبه بانک پاسارگاد تحویل دهید .
دانلود فرم درخواست برای شخص حقیقی
دانلود فرم درخواست برای شخص حقوقی
مقدمه
از این سرویس جهت ثبت انتقال پایای گروهی به صورت async استفاده میشود. ورودی سرویس یک آبجکت لیستی میباشد که طبق جدول زیر لیستی از مبالغ، شبای مقصد و... در ورودی دریافت شده و در خروجی نتیجه موفق یا ناموفق ثبت عملیات بازگردانده میشود. پس از فراخوانی این سرویس میبایست سرویس گزارش انتقال پایای گروهی فراخوانی شود.
به زودی امکان نوتیفای فراخوانیکننده، پس از انجام تمامی رکوردهای پایا نیز فراهم خواهد شد. و پس از نوتیفای فراخوانیکننده میبایست سرویس گزارش را فراخوانی شود.
درخواست استفاده از سرویسهای مبتنی بر حساب بانک پاسارگاد متعلق به مشتری:
نحوهی ارسال درخواست فعالسازی سرویس ، و دریافت کلید فراخوانی سرویس ( _scApiKey_ ):
برای استفاده از هر سرویس ابتدا باید درخواست فعالسازی آن سرویس را به پادیوم اعلام کنید.
بعد از بررسی و تایید آن درخواست ، توسط پادیوم ، باید کلید استفاده و فراخوانی از آن سرویس را دریافت نمایید.
برای استفاده از هر سرویس یک کلید فراخوانی باید دریافت شود. :
❖ نکته: این کلید در تمام درخواستهای ارسالی از آن سرویس، ثابت بوده و نیاز نیست برای هر بار فراخوانی سرویس، کلید جدید دریافت نمایید.
دربافت APIKey از طریق سرویس:
شما میتوانید "کلید فراخوانی" سرویسهای مورد نظر خود را از طربق فراخوانی سرویس 1384158 ، درخواست دهید و یا کلید آن را دریافت نمایید.
شما از طریق این سرویس میتوانید، لیستی از شناسه های سرویس و لیستی از شماره حسابهای خود را که قصد استفاده از آنها را دارید ارسال نمایید.
این سرویس دارای سه پارامتر می باشد:
پارامتر | توضیحات | اجباری/اختیاری |
scProductId | شناسه سرویس (1384158) | اجباری |
serviceNumbers | یک یا لیستی از شماره سرویسهای مورد درخواست ، که داخل براکت [] می آیند و میتوانند بوسیله (کاما) از یکدیگر جدا شوند | اجباری |
Deposits | یک یا لیستی از شماره حسابهای بانک پاسارگاد مشتری که در نیاز سرویس میتواند داخل [] ارسال و با(کاما) از یکدیگر جدا شوند. | اختیاری |
به عنوان مثال، در درخواست زیر برای سرویسهای استعلام شبا 34254 و استعلام کارت 34255 درخواست استفاده از سرویس ارسال میشود.
نمونه خروجی
❖ متناسب با وضعیت پارامتر statusCode به شما پیغام مناسب داده خواهد شد:
پارامتر statusCode | توضیحات |
scApiKey_REQUESTED | درخواست استفاده از سرویس ارسال شده است و در مرحله بررسی و تایید توسط پادیوم است . می توانید با استفاده از شناسه درخواست requestId و شناسه بیزنس businessId خود ، از پادیوم پیگیری نمایید. |
scApiKey_GENERATED | کلید فراخوانی ایجاد شده است ، و میتوانید از کلید تولید شده در فیلد مورد نظر scApiKey استفاده نمایید. توجه نمایید که کلید تولید شده ی قبلی منقضی میشود . |
REQUEST_FAILED | اگر درخواست با خطا مواجه شود این وضعیت ایجاد میشود ، به عنوان مثال ممکن است شما سرویسی را درخواست داده باشید ، که نیازمند شماره حساب بانکی باشد ، ولی شماره حسابی را جهت استفاده ، به پادیوم اعلام نکرده باشید و پیغام "برای استفاده از این سرویس نیاز به شماره حساب دارید" دریافت کنید. |
❖ بعداز تایید ، میتوانید مجدد این سرویس را برای بدست آوردن کلید scApiKey فراخوانی کنید.
اگر سرویس درخواستی شما جزء سرویس هایی است که برای استفاده نیاز به شماره حساب دارد:
1. اگر قبلا یک یا چند، شماره حساب شما ، توسط پادیوم ثبت شده باشد:
تنها با ارسال شناسه ی سرویس ، میتوانید برای تمامی شماره حسابهای ثبت شده خود ، کلید فراخوانی سرویس scApiKey دریافت نمایید.
نمونه درخواست
2. اگر قبلا یک یا چند شماره حساب شما, توسط پادیوم ثبت شده باشد و تنها نیاز داشته باشید که برای استفاده یک یا برخی از آنها کلید فراخوانی سرویس دریافت نمایید,
کافیست لیستی از شماره حسابهای بانک پاسارگاد خود (اعلام شده در فرم بانکی) را وارد نمائید.
نمونه درخواست
ارسال درخواست
ابتدا وارد سایت پادیوم شده ، سپس در بازارچه ی API ، سرویسهای موردنظر خود را انتخاب و درخواست استفاده از آن مجموعه سرویس را ارسال کنید .
ایجاد TransactionId
javascript
orgCode = در تراکنشهای ساتنا 1311 و در بقیه 4321 ارسال شود.
Random String: یک رشتهی تصادفی که به ازای هر کلاینت یکتا است، حداقل طول 8 کاراکتر و حداکثر طول آن 100 است.
Timestamp: با دقت میلی ثانیه و با فرمت مقابل 20200927212945073
Sum Char Code: جمع کد اسکی کاراکترهای سه بخش قبل
* میتوانید به جای DataTime از فرمت Epoch TimeStamp استفاده کنید.
در ادامه نمونه کدی جهت ایجاد این مقدار در زبان جاوااسکریپت قرار داده میشود.
شناسه تراکنش (TransactionId) شامل چهار بخش به شکل زیر میباشد:
اطلاعیه مهم تراکنشهای انتقال وجه
در صورت بروز هرگونه خطا هنگام استفاده از سرویسهای انتقال (وجه پایا / ساتنا / داخلی)، پیش از ارسال مجدد درخواست انتقال وجه، موارد زیر را بررسی نمایید:
- ابتدا با استفاده از سرویس نمایش وضعیت تراکنش (1۴2۴918)، تراکنش موردنظر را استعالم نموده و پارامتر TransactionStatus را در خروجی بررسی نمایید .
- در صورتیکه وضعیت تراکنش inProgress بود، منتظر بمانید تا تراکنش به یکی از وضعیتهای Success یا UnSuccess یا Reversed یا Reversing تغییر نماید.
• توجه داشته باشید که وضعیت inProgress حداکثر تا پایان روز به یکی از حاالت گفته شده تغییر خواهد نمود.
- در صورتیکه وضعیت تراکنش success باشد، به این معنی است که درخواست با موفقیت ثبت و وارد فرایند (سیکل) پایا یا ساتنا و انتقال داخلی شده و از آن پس میتوانید از سرویس 1۴76957 جهت استعلام نهایی تراکنش در فرایند پایا و داخلی یا از سرویس 1۴76960 جهت استعلام نهایی تراکنش در فرایند ساتنا استفاده نمایید.
- اما در صورتیکه تراکنش در یکی از وضعیتهای UnSuccess یا (Reversing) Reversed بود به این معنی است که فرآیند ارسال درخواست، به سیکل پایا و ساتنا ناموفق بوده است، در نتیجه آن درخواست انتقال وجه که با خطا مواجه شده است را باید با همان TransactionId قبلی و بدون تغییر آن، مجددا در سرویس انتقال وجه (پایا /ساتنا / داخلی) ارسال نمایید تا بدین صورت از انجام پرداخت تکراری جلوگیری شود.
* توجه داشته باشید که به زودی سرویس جدیدی جهت استعلام یکپارچه تراکنشها ارائه خواهد شد.
* شناسه تراکنش (TransactionId): شناسه منحصر به فرد هر تراکنش با مقداری یکتا
استعلام تراکنش گروهی
از این سرویس جهت استعلام تراکنشهای گروهی پایا/ساتنا استفاده میشود.
-
شناسهی سرویس: 1370661
-
پارامترهای ورودی
پارامتر | نوع | توضیحات |
AsyncTrackerId* | string | شناسه پیگیری (برابر با AsyncTrackerId که در سرویس انتقال ارسال شده) |
TransactionType* | int | نوع تراکنش مدنظر برای استعلام 0: پایا 1: ساتنا |
- خروجی سرویس: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.
بدنهی پاسخ دریافتی دارای ساختار زیر است:
پارامتر | نوع | توضیحات |
IsSuccess | bool | موفق یا ناموفق بودن دریافت لیست سپردهها |
RsCode | int | کد وضعیت عملیات |
Message | string | پیام |
ResultData | object | اطلاعات مربوط به تراکنش گروهی |
آبجکت ResultData:
پارامتر | نوع | توضیحات |
IsSuccess | bool | موفق یا ناموفق بودن دریافت لیست سپردهها |
RsCode | int | کد وضعیت عملیات |
Message | string | پیام |
ResultData | Object list<ResponseObj> | اطلاعات مربوط به هرکدام از تراکنشها |
آبجکت ResponseObj:
پارامتر | نوع | توضیحات |
IsSuccess | bool | موفق یا ناموفق بودن دریافت لیست سپردهها |
RsCode | int | کد وضعیت عملیات |
Message | string | پیام |
TransactionId | string | شناسه یکتای تراکنش |
Amount | int | مبلغ تراکنش |
RecieverFullNam | string | نام کامل دریافتکننده وجه |
DestinationIban/DestinationDepNum | string | شبای دریافتکننده وجه بسته به نوع تراکنش (پایا/ساتنا) نام این فیلد متغیر است. |
Description | string | توضیحات تراکنش |
TransactionDate | string | تاریخ و ساعت تراکنش |
EndToEndId | string | شناسه پیگیری تراکنش |
TransactionCode | string | شناسه تراکنش |
انتقال پایای گروهی
شناسه سرویس: 1370646
از این سرویس جهت ثبت انتقال پایای گروهی به صورتasync استفاده میشود. ورودی سرویس یک آبجکت لیستی میباشد که طبق جدول زیر لیستی از مبالغ، شبای مقصد و... در ورودی دریافت شده و در خروجی نتیجه موفق یا ناموفق ثبت عملیات بازگردانده میشود. پس از فراخوانی این سرویس میبایست سرویس گزارش انتقال پایای گروهی فراخوانی شود.
به زودی امکان نوتیفای فراخوانیکننده، پس از انجام تمامی رکوردهای پایا نیز فراهم خواهد شد. و پس از نوتیفای فراخوانیکننده میبایست سرویس گزارش را فراخوانی کند.
- پارامترهای ورودی
پارامتر | نوع | توضیحات |
Amount* | long | مبلغ تراکنش |
DestinationIban* | string | شماره شبای مقصد |
RecieverFullName* | string | نام گیرندهی وجه |
TransactionDate* | string | تاریخ شمسی تراکنش (yyyy/mm/dd) |
SourceDepNum* | string | شماره سپرده مبدا |
Description* | string | توضیحات تراکنش |
TransactionId* | string | شناسه یکتای تراکنش |
srcComment | string | شرح مبدا |
DetailType* | string | بابت (مطابق جدول) |
DestComment | string | شرح مقصد |
NationalCode | string | کد ملی |
PhoneNumber | string | شماره تلفن |
MobileNumber | string | شماره تلفن همراه |
Address | string | آدرس |
TransactionBillNumber | string | شناسهی واریز جهت اعلام شناسه واریز در مقصد (کاربرد این فیلد در سمت بانک مقصد میباشد) |
SenderReturnDepositNumber* | string | شماره سپرده بازگشت وجه |
CustomerNumber | string | شماره مشتری |
CommissionDepositNumber | string | سپرده کارمزد در صورت خالی بودن با شماره سپرده مبدا پر میگردد. |
DestBankCode | string | کد بانک مقصد |
SourceTMBillNumber | string | شناسه قبض عملیات مالی (این فیلد به منظور شناسایی تراکنشها بوده و باید با فرمت *123 ارسال گردد) |
ShahabCode | string | کد شهاب |
PostalCode | string | کد پستی |
Nationality | string | تبعه |
FullName | string | نام و نام خانوادگی |
SendToCentralBankIban | string | شماره شبای پاد در صورتی که مقدار وارد شده در این فیلد شبای مربوط به پاد باشد این شماره شبا برای بانک مرکزی ارسال میگردد و در صورتی که شبای پادی نباشد نادیده گرفته میشود. |
مقادیر معتبر برای فیلد DetailType:
کد | توضیح |
1 | واریز حقوق |
2 | امور بیمه خدمات |
3 | امور درمانی |
4 | امور سرمایهگذاری و بورس |
5 | امور ارزی در چهارچوب ضوابط و مقررات |
6 | پرداخت قرض و تادیه دیون (قرضالحسنه، بدهی و...) |
7 | امور بازنشستگی |
8 | معاملات اموال منقول |
9 | معاملات اموال غیرمنقول |
10 | مدیریت نقدینگی |
11 | عوارض گمرکی |
12 | تسویه مالیاتی |
13 | سایر خدمات دولتی |
14 | تسهیلات و تعهدات |
15 | تودیع وثیقه |
16 | هزینهی عمومی و امور روزمره |
17 | کمکهای خیریه |
18 | خرید کالا |
19 | خرید خدمات |
نکته: مقدار شمارهی سپردهی واریز وجه برگشتی میتواند با شماره سپردهی مبدا یکسان باشد.
نکته: شناسه تراکنش (TransactionId و AsyncTrackerId) شامل چهار بخش به شکل زیر میباشد:
4321 - Random String – DateTime-Sum Char Code(OrgCode+Random String)
Random String: یک رشتهی تصادفی که به ازای هر کلاینت یکتا است، حداقل طول کاراکتر و حداکثر طول آن 100 است.
DateTime: تایماستمپ با دقت میلی ثانیه
Sum Char Code: جمع کد اسکی کاراکترهای سه بخش قبل
نمونه درخواست:
خروجی
پارامتر | نوع | توضیحات |
hasError | bool | نشاندهندهی این است که آیا سرویس با موفقیت از روی پلتفرم پاد فراخوانی شده است یا خیر. |
messageId | int | پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد. |
referenceNumber | string | شناسهی درخواست در پلتفرم پاد |
errorCode | int | کد ارور پلتفرمی |
count | int | پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد. |
ott | string | پارامتر درونپلتفرمیای که با توجه به این سرویس خاص موضوعیت ندارد. |
result | object | نتیجهی فراخوانی سرویس در این آبجکت نمایش داده میشود که در ادامه شرح داده خواهد شد. |
نکته: referenceNumber پارامتر مهمی است و جهت ردگیری درخواست در پلتفرم استفاده میشود. توصیه میشود این پارامتر را برای هر درخواست ذخیره کنید.
نکته: پارامتر errorCode، اگر اروری در فراخوانی سرویس در پلتفرم رخ دهد (hasError = true)، کد ارور در این پارامتر نمایش داده میشود. در صورت فراخوانی موفق سرویس در پلتفرم (hasError = false)، مقدار این پارامتر 0 است.
نکته: فراخوانی موفق سرویس از روی پلتفرم (hasError = false) الزاما به معنای دریافت پاسخ صحیح از سرویس مد نظر نیست.
بررسی آبجکت result:
پارامتر | نوع | توضیحات |
result | string | بدنه پاسخ دریافتی از سرویس مد نظر |
header | object | مجموعه headerهای پاسخ دریافتی از سرویس مد نظر |
statusCode | int | کد وضعیت پاسخ http مربوط به پاسخ دریافتی از سرویس مد نظر |
نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس در فیلد result موجود است. به صورت دقیقتر، بدنهی پاسخ را میتوان در فیلد result à result مشاهده کرد. بدنهی پاسخ دریافتی دارای ساختار زیر است:
پارامتر | نوع | توضیحات |
IsSuccess | bool | موفق یا ناموفق بودن دریافت لیست سپردهها |
RsCode | int | کد وضعیت عملیات |
Message | string | پیام |
کدهای خطا (errorCode) معمول در پلتفرم
کد | توضیحات |
21 | توکن کسبوکاری وارد نشده است |
227 | تایم اوت سرویس اصلی |
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است |
انتقال ساتنای گروهی
از این سرویس جهت ثبت انتقال ساتنای گروهی به صورت async استفاده میشود. ورودی سرویس یک آبجکت لیستی میباشد که طبق جدول زیر لیستی از مبالغ، شبای مقصد و... در ورودی دریافت شده و در خروجی نتیجه موفق یا ناموفق ثبت عملیات بازگردانده میشود. پس از فراخوانی این سرویس میبایست سرویس گزارش تراکنش گروهی فراخوانی شود.
به زودی امکان نوتیفای فراخوانیکننده، پس از انجام تمامی رکوردهای تراکنش نیز فراهم خواهد شد. و پس از نوتیفای فراخوانیکننده میبایست سرویس گزارش را فراخوانی کند.
-
شناسهی سرویس: 2470009
-
پارامترهای ورودی
Header | ||
پارامتر | نوع | توضیحات |
AsyncTrackerId* | string | شناسه تراکنش گروهی |
در بدنهی درخواست لیستی از تراکنشها در قالب json ارسال میشود که هر آبجکت تراکنش شامل پارامترهای زیر است:
Body | ||
پارامتر | نوع | توضیحات |
Amount* | long | مبلغ تراکنش |
DestinationDepNum* | string | شماره شبای مقصد |
RecieverName* | string | نام گیرندهی وجه |
RecieverlastName* | string | نام خانوادگی گیرندهی وجه |
TransactionDate* | string | تاریخ شمسی تراکنش (yyyy/mm/dd) |
SourceDepNum* | string | شماره سپرده مبدا |
Description* | string | توضیحات تراکنش |
TransactionId* | string | شناسه یکتای تراکنش |
DetailType* | string | بابت (مطابق جدول) |
TransactionBillNumber | string | شناسهی واریز جهت اعلام شناسه واریز در مقصد (کاربرد این فیلد در سمت بانک مقصد میباشد) |
SenderReturnDepositNumber* | string | شماره سپرده بازگشت وجه |
SenderCustomerNumber | string | شماره مشتری |
CommissionDepositNumber | string | سپرده کارمزد در صورت خالی بودن با شماره سپرده مبدا پر میگردد. |
DestBankCode* | string | کد بانک مقصد |
SenderShahabCode | string | کد شهاب |
SenderPostalCode | string | کد پستی |
SenderNationalCode | string | کد ملی |
SenderNameOrCompanyType | string | نام فرستنده |
SenderFamilyNameOrCompanyName | string | نام خانوادگی فرستنده |
IsFromBox | bool | پرداخت کارمزد از مبدا صندوق. در صورت وارد کردن مقدار true مبلغ کارمزد از صندوق کسر میگردد و در صورت وارد کردن مقدار false مبلغ کارمزد از سپرده کارمزد کسر میگردد. در صورت خالی بودن مقدار آن false در نظر گرفته میشود. |
SendToCentralBankIban | string | شماره شبای پاد در صورتی که مقدار وارد شده در این فیلد شبای مربوط به پاد باشد این شماره شبا برای بانک مرکزی ارسال میگردد و در صورتی که شبای پادی نباشد نادیده گرفته میشود. |
مقادیر معتبر برای فیلد DetailType:
کد | توضیح |
1 | واریز حقوق |
2 | امور بیمه خدمات |
3 | امور درمانی |
4 | امور سرمایهگذاری و بورس |
5 | امور ارزی در چهارچوب ضوابط و مقررات |
6 | پرداخت قرض و تادیه دیون (قرضالحسنه، بدهی و...) |
7 | امور بازنشستگی |
8 | معاملات اموال منقول |
9 | معاملات اموال غیرمنقول |
10 | مدیریت نقدینگی |
11 | عوارض گمرکی |
12 | تسویه مالیاتی |
13 | سایر خدمات دولتی |
14 | تسهیلات و تعهدات |
15 | تودیع وثیقه |
16 | هزینهی عمومی و امور روزمره |
17 | کمکهای خیریه |
18 | خرید کالا |
19 | خرید خدمات |
نکته: مقدار شمارهی سپردهی واریز وجه برگشتی میتواند با شماره سپردهی مبدا یکسان باشد.
نکته: در صورت وارد نکردن شماره مشتری، وارد کردن فیلدهای مربوط به مشتری شامل نام و نام خانوادگی فرستنده، کد ملی، کد شهاب و کد پستی الزامی است.
نکته: شناسه تراکنشها (TransactionId و AsyncTrackerId) شامل چهار بخش به شکل زیر میباشد:
4321 - Random String – DateTime-Sum Char Code(OrgCode+Random String+DateTime)
Random String: یک رشتهی تصادفی که به ازای هر کلاینت یکتا است، حداقل طول کاراکتر و حداکثر طول آن 100 است.
DateTime: تاریخ (میلادی) و ساعت (با فرمت 24ساعته) با دقت میلیثانیه. بهعنوان مثال:
4321-123456789-20220618113511111-1531
تاریخ و ساعت بالا به 18 ژوئن 2022، ساعت 11:35:11.111 اشاره دارد.
Sum Char Code: جمع کد اسکی کاراکترهای سه بخش قبل
نمونه بدنه درخواست:
- خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.
بدنهی پاسخ دریافتی دارای ساختار زیر است:
پارامتر | نوع | توضیحات |
IsSuccess | bool | موفق یا ناموفق بودن دریافت لیست سپردهها |
RsCode | int | کد وضعیت عملیات |
Message | string | پیام |
کدهای ارور (errorCode) معمول در پلتفرم
برای مشاهدهی کدهای ارور پلتفرم به این لینک مراجعه کنید.
کد خطاهای بانکی
در این لینک میتوانید لیست خطاهای موجود در سرویسهای سپرده بانک پاسارگاد را دریافت نمایید .