مقدمه

 

پیش از شروع

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

 

استعلام شماره شبا

  • شناسه سرویس : 3374348

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

نام پارامتر

نوع

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

توضیحات

iban

String

اجباری

شماره شبای معتبر که باید یک رشته به طول ۲۶ کاراکتر باشد

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

 

  • result:  آبجکتی از پاسخ سرویس شامل:
    • IBAN:  شماره شبا
    • bankName:  نام بانک
    • deposit:  شماره حساب
    • depositStatus:  میتواند مقادیر زیر را بگیرد
      • ‌02 :  حساب فعال است
      • ‌03 :  حساب مسدود با قابلیت واریز
      • ‌04 :  حساب مسدود بدون قابلیت واریز
      • ‌05 :  حساب راکد است
      • ‌06 :  بروز خطادر پاسخ دهی , شرح خطا در فیلد توضیحات است
      • ‌07 :  سایر موارد
    • depositDescription:  شرح حساب
    • depositComment:
    • depositOwners:  آرایه ای از صاحبان حساب
      • firstName:  نام
      • lastName:  نام خانوادگی
  • status: وضعیت فراخوانی سرویس
    • DONE: فراخوانی موفق سرویس
    • FAILED: فراخوانی ناموفق سرویس
  • error: جزییات خطا (در صورت بروز خطا)
  • trackId: ‌ کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود.

 

تبدیل شماره حساب به شبا

سرویس دریافت شماره شبا از روی شماره حساب ( شبکه بانکی )

  • شناسه سرویس : 3374338

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

نام پارامتر

نوع

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

توضیحات

deposit

Integer

اجباری

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

bankCode

Integer

اجباری

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

نکته : تنها عدد شماره حساب (بدون نقطه "." یا خط تیره "-" یا فاصله " ") قابل قبول میباشد.

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

 

deposit: شماره حساب

accountStatus:  میتواند مقادیر زیر را بگیرد

‌02: حساب فعال است

‌03: حساب مسدود با قابلیت واریز

‌04: حساب مسدود بدون قابلیت واریز

‌05: حساب راکد است

‌06: بروز خطادر پاسخ دهی, شرح خطا در فیلد توضیحات

bankName: نام بانک

iban: شماره شبا محاسبه شده

depositOwners: آرایه ای از صاحبان حساب

status: وضعیت فراخوانی سرویس

DONE:  فراخوانی موفق سرویس

: FAILED فراخوانی ناموفق سرویس

 

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

دریافت شماره حساب از شماره کارت

  • شناسه سرویس : 3374339

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

نام پارامتر

نوع

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

توضیحات

Card

String

اجباری

شماره کارت

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

 

  • result: آبجکتی از پاسخ سرویس شامل:
    • destCard شماره کارت وارد شده
    • name نام صاحب حساب
    • account: ‌ شماره حساب مربوط به شماره کارت وارد شده
    • result: نتیجه فراخوانی سرویس
    • description: توضیحات تکمیلی در مورد نتیجه
    • doTime: زمان انجام تراکنش
  • trackId: کد پیگیری است که با استفاده از آن میتوانید از سرویس‌های فینوتکی کارمزد را استعلام کنید.
  • status: وضعیت فراخوانی سرویس
    • DONE: فراخوانی موفق سرویس
    • FAILED: فراخوانی ناموفق سرویس
  • error: جزییات خطا (در صورت بروز خطا)

 

تبدیل کارت به شبا

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

  • شناسه سرویس : 3374340

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

نام پارامتر

نوع

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

توضیحات

Card

teString

اجباری

شماره کارت

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

  • پارامتر های پاسخ سرویس در Result :
   
json
  • result: آبجکتی از پاسخ سرویس شامل:
    • IBAN: شماره شبا
    • bankName: نام بانک
    • deposit: شماره حساب
    • card: شماره کارت
    • depositStatus: میتواند مقادیر زیر را بگیرد
      • ‌02 : حساب فعال است
      • ‌03 : حساب مسدود با قابلیت واریز
      • ‌04 : حساب مسدود بدون قابلیت واریز
      • ‌05 : حساب راکد است
      • ‌06 : بروز خطادر پاسخ دهی , شرح خطا در فیلد توضیحات است
      • ‌07 : سایر موارد
    • depositOwners: صاحبان حساب
  • status: وضعیت فراخوانی سرویس
    • DONE: فراخوانی موفق سرویس
    • FAILED: فراخوانی ناموفق سرویس
  • error: جزییات خطا (در صورت بروز خطا)
  • trackId: ‌ کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود

استعلام شماره کارت

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

  • شناسه سرویس : 3374342

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

نام پارامتر

نوع

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

توضیحات

Card

Integer

اجباری

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

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

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

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

referenceNumber

string

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

errorCode

int

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

Count

int

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

Ott

string

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

Result

object

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

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

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

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

json

 

 

  • result: آبجکتی از پاسخ سرویس شامل:
    • destCard:  شماره کارت به صورت xxxx-xxxx-xxxx-{چهار رقم آخر شماره کارت}
    • name:  نام صاحب کارت
    •  result: نتیجه فراخوانی سرویس
    • description:  توضیحات تکمیلی در مورد نتیجه
    • doTime: زمان انجام تراکنش
    • bankName: نام بانک
  • status: وضعیت فراخوانی سرویس
    • DONE: فراخوانی موفق سرویس
    • FAILED: فراخوانی ناموفق سرویس
  • error: جزییات خطا (در صورت بروز خطا)
  • trackId: کد پیگیری درخواست

 

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

کد خطا

عنوان

توضیحات

403

unauthorized scope

عدم دسترسی به اسکوپ یا توکن نامعتبر

400

VALIDATION_ERROR

عدم دسترسی به اسکوپ آدرس ارسالی

409

DUPLICATE_DATA

در صورتی که در سرویس تعریف مشتری،‌ مشتری ای دوباره تعریف شود

Clasor npm package version 2.1.4