podium logo

بن کارت خدمات الکترونیک پاسارگاد

خدمت‌دهنده

پرداخت الکترونیک پاسارگاد

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

برچسب‌ها

مقدمه 

سازمان‌هایی که برای همکاران خود از شرکت پرداخت الکترونیک پاسارگاد خدمات «بن‌کارت» دریافت کرده باشند، می‌توانند به کمک این APIها، بن‌کارت‌های همکاران خود را مدیریت کنند. این مجموعه شامل دو سرویس اصلی زیر است:

سرویس‌های شارژ و دشارژ: افزایش و کاهش اعتبار بن‌کارت

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

نکته : شماره سپرده وارد شده در ورودی می‌بایست در لیست سپرده های مشتری اعلامی به بانک (طبق شماره مشتری ارسال شده در هدر) موجود باشد تا شماره شبا در خروجی نمایش داده شده و سرویس با موفقیت اجرا گردد در صورتیکه شماره سپرده در لیست سپرده های مشتری موجود نباشد پاسخ سرویس ناموفق بوده و کد و پیغام خطا مطابق با جدول پیوست نمایش داده خواهد شد.

پیش از شروع

  • 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) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.

مراحل دریافت سروس بن کارت

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

نمونه فرم حقوقی متقاضی در این لینک موجود است.

clasor

ترتیب‌های فراخوانی سرویس

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

clasor

نکته:  ابتدا با مراجعه به وب سایت www.podium.ir اقدام به ساخت کسب و کار نمایید

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

دانلود فرم درخواست برای شخص حقیقی

دانلود فرم درخواست برای شخص حقوقی

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

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

  • شناسه سرویس محیط اصلی : 1860604
  • شناسه سرویس سندباکس: 154028
  • پارامتر ورودی سرویس

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

پارامتر درخواست
  • مشخصات پارامتر درخواست (Body)

نام پارامتر

نوع

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

توضیحات

OrganizationName

String

اجباری

نام موسسه

CustomerNumber

String

اختیاری

شماره مشتری

OrganizationCode

Integer

 اختیاری

کد موسسه

FirstResult

Integer

اجباری

شاخص نتیجه اول لیست خروجی

MaxResult

Integer

اجباری

حداکثر تعداد لیست خروجی

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

  • پارامتر های پاسخ سرویس در Result 

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

json
  • مشخصات پارامتر پاسخ

نام پارامتر

نوع

توضیحات

IsSuccess

Boolean

نتیجه موفق یا ناموفق

Rscode

Int

کد پاسخ

Message

String

پیغام

ResultData

List

طبق جدول ResultData

ErrorList

List

طبق جدول ErrorList
  • جدول خروجی موفق -  ResultData

نام پارامتر

نوع

توضیحات

OrganizationName

String

نام موسسه

CustomerNumber

String

شماره مشتری موسسه

OrganizationCode

Integer

کد موسسه

OrganizationState

Integer

 وضعیت موسسه (1 = فعال ، 0 = غیرفعال)

Accounts

List

لیست شماره حساب های بن کارت موسسه

AccountNumber

String

شماره حساب

AccountDesc

String

توضیح شماره حساب
  • جدول خروجی ناموفق -  ErrorList

نام پارامتر

نوع

توضیحات

Code

Int

کد خطا

Desc

String

پیغام خطا

ParamName

String

نام پارامتر دارای خطا

ParamPath

String

مسیر پارامتر دارای خطا

 ساختار خروجی نا موفق

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

json

 

راهنمای دریافت بن کارت‌های مؤسسه

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

در صورتی که شماره کارت وارد نشود، لیست بن کارت های یک موسسه (با در نظر گرفته شدن فیلتر های اعمال شده) به همراه لیستی از اطلاعات مربوط به حسابهای موسسه (شرح حساب و موجودی هر حساب) نمایش داده می شود.

در این حالت، از میان ورودیهای سرویس، این موارد اجباری هستند:

  1. شناسه موسسه
  2. شاخص نتیجه اول لیست خروجی (برای صفحه بندی)
  3. حداکثر تعداد لیست خروجی

با توجه به موارد فوق نحوه فراخوان سرویس به شرح ذیل است.

  • شناسه سرویس محیط اصلی : 2959536

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

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

پارامتر درخواست
  • مشخصات پارامتر درخواست (Body)

نام پارامتر

نوع

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

توضیحات

CustomerNumber

String

اجباری

شماره مشتری

OrganizationId

String

اجباری

شناسه موسسه

CardNumber

Integer

اجباری

شماره کارت

IssueDateFrom

Date

اجباری

تاریخ صدور از توضیحات: به فرمت شمسی به صورت: YYYY/MM/DD

IssueDateTo

Date

اجباری

تاریخ صدور تا توضیحات: به فرمت شمسی  به صورت : YYYY/MM/DD

CardState

Integer

 

وضعیت کارت

FirstResult

Integer

 

شاخص نتیجه اول لیست خروجی )برای صفحه بندی)

MaxResult

Integer

 

حداکثر تعداد لیست خروجی
  • پارامتر های خروجی :

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

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

json

 

 

  • ساختار خروجی ناموفق:

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

json

در صورت بروز سایر خطاها ساختار خروجی ناموفق به صورت زیر می باشد :

json

 

 

  • مشخصات پارامتر پاسخ

نام پارامتر

نوع

توضیحات

IsSuccess

Boolean

نتیجه موفق یا ناموفق

Rscode

Int

کد پاسخ

Message

String

پیغام

ResultData

List

طبق جدول ResultData

ErrorList

List

طبق جدول ErrorList
  • جدول خروجی موفق -  ResultData

نام پارامتر

نوع

توضیحات

OrganizationId

String

شناسه موسسه

OrganizationName

String

نام موسسه

Result

List

مطابق جدول Result

 جدول خروجی موفق -  Result

نام پارامتر

نوع

توضیحات

CardNumber

Int

شماره کارت

CardHolderFullName

String

نام دارندهی کارت

CardHolderPersonnelNo

String

شماره پرسنلی دارنده کارت

IssueDate

String

تاریخ صدور

CardState

String

وضعیت کارت

TotalAmount

String

موجودی کل
  • جدول خروجی ناموفق -  ErrorList

نام پارامتر

نوع

توضیحات

Code

Int

کد خطا

Desc

String

پیغام خطا

ParamName

String

نام پارامتر دارای خطا

ParamPath

String

مسیر پارامتر دارای خطا

ساختار خروجی نا موفق:

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

json

 

راهنمای دریافت وضعیت بن کارت

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

  • شناسه سرویس محیط اصلی : 3024588

  • پارامتر ورودی سرویس

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

پارامتر درخواست
  • مشخصات پارامتر درخواست (Body)

نام پارامتر

نوع

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

توضیحات

CustomerNumber

String

اجباری

شماره مشتری موسسه

OrganizationId

String

اجباری

کد سازمان یاId  موسسه بن کارت

CardNumber

String

اجباری

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

json

 

 

  • پارامتر های پاسخ موفق ResultData :

نام پارامتر

نوع

توضیحات

CardNumber

string

شماره کارت

CardHolderFullName

string

نام دارنده ی کارت

CardHolderPersonnelNo

string

کد پرسنلی صاحب کارت

IssueDate

string

تاریخ صدور

CardState

string

وضعیت کارت :

  1. فعال
  2. غیرفعال
  3. هات
  4. منقضی

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

json

 

 

  • پارامتر های پاسخ موفق ErrorList:

نام پارامتر

نوع

توضیحات

Code

Integer

کد خطا

Desc

string

پیغام خطا

ParamName

string

نام پارامتر داری خطا

ParamPath

string

مسیر پارامتر دارای خطا

 در صورت بروز سایر خطاها ساختار خروجی ناموفق به صورت زیر می باشد 

json

 

  • راهنمای شارژ بن کارت

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

توجه:

1-شماره سپرده وارد شده در ورودی میبایست در لیست سپرده های مشتری (طبق شماره مشتری ارسال شده در هدر) موجود باشد تا شماره شبا در خروجی نمایش داده شده و سرویس با موفقیت اجرا گردد در صورتیکه شماره سپرده در لیست سپرده های مشتری موجود نباشد پاسخ سرویس ناموفق بوده و کد و پیغام خطا مطابق با جدول پیوست نمایش داده خواهد شد.

2- لازم بذکر است برای مشتری سندباد علاوه بر مورد قبل ،شماره مشتری وارد شده در هدر میبایست در لیست مشتریان مجاز موجود باشد .

3- درصورت بروز خطای پلتفرمی نظیر 227 و 999 لازم است قبل از فراخوانی مجدد سرویس شارژ بن کار، سرویس های مربوط به گزارش شارژ فراخوانی گردد.

  • شناسه سرویس محیط اصلی : 1862020

  • شناسه سرویس سندباکس :  156348

  • پارامتر ورودی سرویس:

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

پارامتر درخواست

CustomerNumber

String

اجباری

شماره مشتری
  • مشخصات پارامتر درخواست (Body):

نام پارامتر

نوع

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

توضیحات

CustomerNumber

string

اجباری

شماره مشتری

OrganizationId

 string اختیاری/شرطی شناسه موسسه اختیاری (شرطی) رجوع به نکات
OrganizationCode string اختیاری/شرطی کد موسسه اختیاری(شرطی) رجوع به نکات

CardLists

List

اجباری

لیست کارت ها جهت شارژ

DepositNumber

string

اجباری

شماره سپرده

RoutingAccount Number

string

 اجباری

شماره سپرده شارژ موسسه اختیاری(شرطی) رجوع به نکات

RoutingAccountId

string

 اجباری

شناسه سپرده شارژ موسسه اختیاری(شرطی)رجوع به نکات

FeePayType

int

اختیاری

نحوه پرداخت کارمزد-مطابق جدول ذیل اختیاری(شرطی)رجوع به نکات

PayFeeAccountNumber

string

اختیاری

شماره سپرده جهت برداشت کارمزد اختیاری(شرطی) رجوع به نکات
  • نحوه پرداخت کارمزد:

کد

توضیحات

2

برداشت از سپرده

5

برداشت از سرفصل هزینه تبلیغات

6

عدم دریافت هزینه

نکات:  

1- همواره تعداد آیتمهای لیست دو پارامترCardNumbers و Amounts باید برابر و متناظر باشند.

2- در صورت خالی بودن مقدار organizationCode وارد کردن مقدار OrganizationId اجباری می باشد و یا بالعکس و به عبارتی دیگر درج مقدار برای یکی از دو فیلد organizationCode یا OrganizationId الزامی بوده و حداقل یکی از این فیلدها باید در ورودی ارسال گردد.

3- در صورت خالی بودنRoutingAccountId  واردکردن مقدار RoutingAccountNumberاجباری می باشد و بالعکس به عبارتی دیگر درج مقدار برای یکی از دو فیلد RoutingAccountId یا RoutingAccountNumber  الزامی بوده و حداقل یکی از این فیلدها باید در ورودی ارسال گردد.

4- اگر نحوه پرداخت کارمزد, برداشت از سپرده انتخاب شود, مقدار PayFeeAccountNumber اجباری است در غیر اینصورت اختیاری است.

  • شرح پارامتر های CardLists

نام پارامتر

نوع

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

توضیحات

CardNumbers

string

اجباری

لیستی از شماره کارتها

Amounts

string

اجباری

مبالغ شارژ )متناظر با شماره بن کارتها(

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

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

 

json

ساختار خروجی نا موفق:

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

json

در صورت بروز سایر خطاها ساختار خروجی ناموفق به صورت زیر می باشد :

json

  • راهنمای دشارژ بن کارت

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

توجه:

1-شماره سپرده وارد شده در ورودی میبایست در لیست سپرده های مشتری (طبق شماره مشتری ارسال شده در هدر) موجود باشد تا شماره شبا در خروجی نمایش داده شده و سرویس با موفقیت اجرا گردد در صورتیکه شماره سپرده در لیست سپرده های مشتری موجود نباشد پاسخ سرویس ناموفق بوده و کد و پیغام خطا مطابق با جدول پیوست نمایش داده خواهد شد.

2- لازم بذکر است برای مشتری سندباد علاوه بر مورد قبل ،شماره مشتری وارد شده در هدر میبایست در لیست مشتریان مجاز موجود باشد .

  • شناسه سرویس محیط اصلی : 1862812

  • شناسه سرویس سندباکس  : 156349

  • پارامتر ورودی سرویس:

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

پارامتر درخواست

CustomerNumber

String

اجباری

شماره مشتری
  • مشخصات پارامتر درخواست (Body):

نام پارامتر

نوع

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

توضیحات

CustomerNumber

string

اجباری

شماره مشتری

OrganizationCode

string

اجباری

کد موسسه
CardPANs

List

اجباری

شماره کارت ها

Amounts

List

اجباری

مبالغ

RoutingAccountNumber

String

اختیاری

شماره حساب موسسه- جهت برداشت مبلغ (کارت/کارتها به این حساب متصل می باشند)

ReverseChargeType

int

اجباری

نحوه بازگردانی شارژ:

1- سپرده مقصد پیش فرض موسسه

2- وارد نمودن شماره سپرده

DestDepositNumber

String

اجباری

سپرده جهت برگشت شارژ درصورتی که نحوه بازگردانی شارژ "واردکردن سپرده" انتخاب شود، اجباری است

HotCard

Boolean

اختیاری

مسدود کردن کارتها پس از بازگردانی شارژ

TransactionId

String

اجباری

شماره مرجع(طبق پیوست)

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

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

json

ساختار خروجی نا موفق:

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

json
  • جدول ResultData – خروجی موفق

نام فیلد

نوع فیلد

توضیحات

OrganizationName

String

نام موسسه

OrganizationCode

String

کد موسسه

TotalDischargeAmount

Decimal

مبلغ کل بازگردانی شارژ

BatchId

Int

کد

DechargeDetaile

List

وضعیت بازگرداندن شارژ کارت ها
  • جدول DechargeDetaile– (وضعیت بازگرداندن شارژ کارت ها)

نام فیلد

نوع فیلد

توضیحات

CardPan

String

شماره کارت

Amount

String

مبلغ

ReverseChargeState

Int

وضعیت دشارژ

TrxNumber

String

سند برگشت شارژ

CardState

Int

وضعیت فعلی کارت

ErrorMessage

String

شرح خطا
  • جدول ErrorList– خروجی ناموفق

نام فیلد

نوع فیلد

توضیحات

Code

Int

کد خطا

Desc

String

پیغام خطا

ParamName

String

نام پارامتر دارای خطا

ParamPath

String

مسیر پارامتر دارای خطا
  • نحوه ایجاد شناسه یکتای تراکنش یا TransactionId:

شناسه تراکنش شامل چهار بخش به شکل زیر می باشد:

OrgCode - Random String – DateTime-Sum Char Code (OrgCode+Random String)

نمونه:

C3109-Ee877c33d24104d3b92290a18fb0d8828-20200927212945073-3310

 

  1. OrgCode: کد سازمان که می بایست از PODIUM دریافت گردد. ( لازم به ذکر است در زمان تست این کد ارایه میگردد.(
  2. Random String: یک رشته تصادفی که به ازای هر کلاینت یکتا است ، حداقل طول آن 8 رقم است و حداکثر طول آن 100 می باشد.
  3. Date Time: بادقت میلی ثانیه و با فرمت مقابل: 20200631125438441
  4. Sum Char Code: جمع کد اسکی کارکترهای سه بخش قبلی (موارد 1 و 2 و 3) میباشد.

 

راهنمای دریافت جزئیات شارژ دسته‌ای مؤسسه

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

  • شناسه سرویس محیط اصلی : 2487303

  • شناسه سرویس سندباکس  : 158326

  • پارامتر ورودی سرویس

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

پارامتر درخواست
  • مشخصات پارامتر درخواست (Body)

نام پارامتر

نوع

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

توضیحات

CustomerNumber

string

اجباری

شماره مشتری

OrganizationId

Long

اجباری

شناسه موسسه

BatchId

Long

اجباری

شناسه شارژ دسته ای

FirstResult

int

اجباری

شاخص نتیجه اول لیست خروجی

MaxResult

int

اجباری

حداکثر تعداد لیست خروجی
  • پارامتر های خروجی :

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

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

json

ساختار خروجی نا موفق:

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

json

در صورت بروز سایر خطاها ساختار خروجی ناموفق به صورت زیر می باشد :

json

 

 

  • جدول ResultData – خروجی موفق

نام فیلد

نوع فیلد

توضیحات

OrganizationName

String

نام موسسه

RoutingAccountTypeId

String

شناسه حساب موسسه

Result

List

طبق جدول Result
  •  جدول Result

نام فیلد

نوع فیلد

توضیحات

Id

String

شناسه شارژ بن کارت

Amount

String

مبلغ شارژ

PersonnelCode

String

کد پرسنلی

RoutingAccountTypeId

String

شناسه حساب متصل به کارت

CardPAN

String

شماره کارت

Reversed

String

برگشت شارژ

Date

String

تاریخ شارژ

OpenToBuy

String

موجودی کارت

TrxNumber

String

شماره سند
  •  جدول ErrorList– خروجی ناموفق

نام فیلد

نوع فیلد

توضیحات

Code

Int

کد خطا

Desc

String

پیغام خطا

ParamName

String

نام پارامتر دارای خطا

ParamPath

String

مسیر پارامتر دارای خطا

راهنمای گزارش شارژ دسته‌ای (کلی) مؤسسه بن کارت

با استفاده این سرویس میتوان گزارش شارژ دسته ای موسسه را دریافت نمود .

  • شناسه سرویس محیط اصلی : 2487632

  • شناسه سرویس سندباکس  : 158327

  • پارامتر ورودی سرویس

نام پارامتر

نوع

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

توضیحات

Body

Json

اجباری

پارامتر درخواست
  • مشخصات پارامتر درخواست (Body)

نام پارامتر

نوع

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

توضیحات

CustomerNumber

string

اجباری

شماره مشتری

OrganizationId

Long

اجباری

شناسه موسسه

RoutingAccountId

Long

اجباری

شناسه حساب

ChargeDateFrom

String

اجباری

تاریخ شارژ از

ChargeDateTo

String

اجباری

تاریخ شارژ تا

FirstResult

int

اجباری

شاخص نتیجه اول لیست خروجی

MaxResult

int

اجباری

حداکثر تعداد لیست خروجی
  • پارامتر های خروجی :

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

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

json

ساختار خروجی نا موفق:

در صورت بروز سایر خطاها ساختار خروجی ناموفق به صورت زیر می باشد :

json

 

 

  • جدول ResultData – خروجی موفق

نام فیلد

نوع فیلد

توضیحات

BatchId

String

شناسه شارژ

TotalAmount

String

مبلغ کل

ApplyDate

String

تاریخ شارژ

ApplyTime

String

زمان شارژ

AccountNumber

String

شماره سپرده

AccountTypeDesc

String

شرح شماره سپرده

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

کد خطا

عنوان

توضیحات

1

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

 

1038

اطلاعات ورودی اشتباه است

 

2941

مقداری برای پارامتر ورودی اجباری ارسال نشده است

زمانی که پارامتر اجباری در ورودی سرویس ارسال نگردد

2986

شماره شبا/شماره سپرده متعلق به مشتری نمی باشد

در صورتیکه شماره سپرده دریافت شده در ورودی سرویس دریافت صورت حساب در لیست سپرده های مشتری نباشد

2989

شماره مشتری نامعتبر است

زمانی که شماره مشتری در بادی درخواست نامعتبر باشد.

1056

شناسه تراکنش تکراری است

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

1644

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

درصورت خالی بودن مقدار فیلد شماره کارت

1675

شماره کارت صحیح نمی باشد

درصورت خالی بودن فیلد شماره کارت

1685

مبلغ وارد شده نامعتبر است

درصورت خالی بودن مقدار فیلد مبلغ

1187

شماره سپرده یا حساب نامعتبر است.

درصورت خالی بودن مقدار فیلد شماره سپرده

3155

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

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

2128

حساب متعلق به این موسسه نیست.

در صورت نامعتبر بودن مقدار فیلد RoutingAccountNumber

0

نوع حساب موسسه معتبر نیست

در صورتی که نوع حساب موسسه معتبر باشد.

1651

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

 

1134

پارامترهای صفحه بندی نامعتبر است.

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