مقدمه

 

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

نحوه‌ی ارسال درخواست فعالسازی سرویس ، و دریافت کلید فراخوانی سرویس (   _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

 

افزایش اعتبار حساب دیجیتال خود از طریق حساب بانک پاسارگاد

توضیحات:

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

  • توجه داشته باشید ، شماره حساب شما باید در پلتفرم پاد ثبت شده باشد
  • برای استفاده از این سرویس شما باید APIKEY ( کلید فراخوانی سرویس ) را بر  مبنای شماره سرویس و شماره حساب پاسارگاد خود دریافت کرده باشید ( به راهنمای دریافت apikey مراجعه نمایید )
  • توجه داشته باشید که حداقل زمان ممکن برای انجام این انتقال وجه بین 15 تا 20 دقیقه می باشد .
  • توجه داشته باشید . در این نسخه از سرویس، انتقال وجه،  به شماره حساب پاد انجام میشود.

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

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

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

3160893

scProductId

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

 

scApiKey

درخواست انتقال وجه که حاوی یک JSON با مقادیر زیر است .

 

json

{}

request

پارامترهای request

الزامی - مبلغ انتقال به ریال  - در صورت عدم ارسال پیغام خطای   "مبلغ الزامی است" دریافت میگردد.

string

Amount

الزامی - شماره حساب بانک پاسارگاد ، متعلق به شخص فراخوانی کننده ی سرویس – در صورت عدم ارسال پیغام خطای  " شماره حساب مبدا الزامی است" دریافت میگردد.

string

srcDeposit

شرح دلخواه

string

Comment

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result

نتیجه عملیات در بانک

true/false

IsSuccess

تاریخ انجام تراکنش به شکل 1401/05/26 - 10:20:24

 

Transactiondate

کد خطای تولید شده در بانک – مقدار 1 به معنای نتیجه موفق است -

 

RsCode

نتیجه عملیات به صورت متنی

 

Message

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

مراجعه شود به مستند تولید transactioId

مراجعه شود به سرویس استعلام وضعیت تراکنش

 

TransactionId

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

 

TransactionCode

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

از طریق این شناسه میتوانید در پادیوم وضعیت انتقال وجه انجام شده را پیگیری نمایید .

 

userBillNumber

شماره سند

 

DocumentNumber

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

 

json

 

نمونه پاسخ

 

json

 

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

کد خطا

توضیح

21

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

227

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

378

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

403

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

       

 

 

 

انتقال اعتبار به حساب دیجیتال  دیگران از طریق شناسه واریز 

توضیحات:

در این سرویس با استفاده از توکن کسب وکار   و یا اکسس توکن خود و با استفاده از شماره حساب بانک پاسارگاد خود میتوانید  ،

 شماره حساب دیجیتال کاربر یا کسب وکار دیگری را شارژ نمایید.

  • توجه داشته باشید ، شماره حساب شما باید در پلتفرم پاد ثبت شده باشد
  • برای استفاده از این سرویس شما باید APIKEY ( کلید فراخوانی سرویس ) را بر  مبنای شماره سرویس و شماره حساب پاسارگاد خود دریافت کرده باشید ( به راهنمای دریافت apikey مراجعه نمایید )
  • توجه داشته باشید که حداقل زمان ممکن برای انجام این انتقال وجه بین 15 تا 20 دقیقه می باشد .
  • توجه داشته باشید . در این نسخه از سرویس، انتقال وجه،  به شماره حساب پاد انجام میشود.
  • توجه داشته باشید که کسب وکار مورد نظر باید کد "شناسه واریز" خود را از طریق پنل یا سرویس 3171054    دریافت کرده باشد و در اختیار شما قرار داده باشد . ( پنل کسب  وکار ->حساب دیجیتال من -> دریافت شناسه واریز )
  • توجه داشته باشید که کسب وکار و یا کاربر موردنظر میتواند از طریق سرویس 3171054   اقدام به دریافت شناسه واریز حساب دیجیتال خود نماید تا در اختیار شما جهت استفاده در  این سرویس قرار دهد.

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

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

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

3169570

scProductId

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

 

scApiKey

درخواست انتقال وجه که حاوی یک JSON با مقادیر زیر است .

json

{}

request

پارامترهای request

الزامی - مبلغ انتقال به ریال  - در صورت عدم ارسال پیغام خطای   "مبلغ الزامی است" دریافت میگردد.

string

Amount

الزامی - شماره حساب بانک پاسارگاد ، متعلق به شخص فراخوانی کننده ی سرویس – در صورت عدم ارسال پیغام خطای  " شماره حساب مبدا الزامی است" دریافت میگردد.

string

srcDeposit

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

 

userBillNumber

شرح دلخواه

string

Comment

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result

نتیجه عملیات در بانک

true/false

IsSuccess

تاریخ انجام تراکنش به شکل 1401/05/26 - 10:20:24

 

Transactiondate

کد خطای تولید شده در بانک – مقدار 1 به معنای نتیجه موفق است -

 

RsCode

نتیجه عملیات به صورت متنی

 

Message

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

مراجعه شود به مستند تولید transactioId

مراجعه شود به سرویس استعلام وضعیت تراکنش

 

TransactionId

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

 

TransactionCode

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

از طریق این شناسه میتوانید در پادیوم وضعیت انتقال وجه انجام شده را پیگیری نمایید .

 

userBillNumber

شماره سند

 

DocumentNumber

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

json

نمونه پاسخ

json

 

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

کد خطا

توضیح

21

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

227

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

378

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

403

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

       

 

 

 

 

 

 

دریافت شناسه واریز حساب دیجیتال 

توضیحات:

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

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

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

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

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

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

3171054 

scProductId

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

 

scApiKey

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result.result

شناسه واریز که میتوانید در سرویس 3169570 و در فیلد userBillNumber استفاده نمایید.

string

userBillNumber

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

403

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

       

 

 

 

 

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