پرداخت کسب‌وکارهای واسط

خدمت‌دهنده

بازارچه پادیوم

مقدمه

با گسترش کسبوکارهایی که دارای ماهیت پلتفرمی هستند و نقش واسط بین کاربران و ارائه دهندگان خدمات را ایفا میکنند چالش دریافت پول و تسهیم آن میان ذینفعان پر رنگ تر شده است. دلیل این امر این است که با وجود اینکه سامانهها یا واسطهای ارائه دهنده خدمات، کل مبلغ پرداختی را از کاربر دریافت میکنند اما عمدتا بخش کوچکی از این مبالغ متعلق به آنها است. دریافت این موجودی علاوه برتحمیل چالشهای مالیاتی، بار عملیاتی زیادی جهت انتقال سهم هریک از ذینفعان را نیز در پی خواهد داشت.
درواقع کسبوکارهای واسط پس از دریافت پول از کاربران، میبایست کارمزد خود را از وجوه دریافتی کسر کرده و مابقی را به حساب ذینفعان واریز کنند.در این مستند تلاش شده است که راهکاری به منظور مدیریت دریافت و تسهیم وجوه میان ذینفعان با کمترین پیچیدگی تشریح شود.

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

پیش از شروع

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

تسویه و برداشت (به شبا و کارت)

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

صدور/ تأیید/ بستن فاکتور

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

مشارکت در فورش (تسهیم)

مراجعه شود به مستندات تسهیم درفروش در سایت پادیوم

پرداخت/ تأیید

مراجعه شود به مستندات پرداخت در سایت پادیوم 

مشاهده‌ی موجودی کسب‌و کار

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

مشاهده موجودی کاربر

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

 

ثبت و ویرایش کاربر (توسط کسب و کار)

/nzh/biz/registerUser/

/nzh/editProfile/

 

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

 

جهت ثبت اطلاعات کاربر به گونه ای که کاربر بتواند در SSO پاد لاگین نماید لازم است از طریق سرویس زیر با توکن کسب وکار خود اقدام نمایید:

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

 

برای عملیات انتقال وجه لازم است شماره موبایل یا ایمیل کاربر به همراه شماره شبا بانکی ثبت گردد.

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

 

  • در ویرایش  در صورتی که هر یک از فیلدها ارسال نشود و یا خالی ارسال شود، مقدار آن در پروفایل کاربر خالی می شود
  • و پارامتر nickname باید یکتا ارسال شود .
  • برای ویرایش باید کاربر را لاگین نمایید
  • و بعد ا زآن پیامک ارسالی به کاربر باید توسط کاربر یا سرویس تایید  ​/nzh​/confirmEditProfile​/  به سیستم ارسال شود .
  • برای لاگین کردن کاربر به مستند ارسال OTP مراجعه شود .
  • با افزودن کاربر ، کاربر به عنوان مخاطب کسب وکار ثبت میشود.

ثبت کاربر  = شناسه سرویس : 47283 ( سندباکس : 67742) 

ویرایش کاربر =  شناسه سرویس 29793 ( سندباکس 39288 )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

47283

scProductId

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

*

scApiKey

نام کاربری جهت ثبت نام

*

username

SSO client_id دریافتی از پنل کسب وکار

*

client_id

SSO client_secret  دریافتی از پنل کسب وکار

*

client_secret

نام کاربر

 

firstName

نام خانوادگی کاربر

 

lastName

تاریخ تولد شمسی

 

birthDate

شماره موبایل

 

cellphoneNumber

کد ملی

 

nationalCode

در صورت ارسال مقدار false پیامک یا ایمیل تایید برای کاربر ارسال نمیشود. ارسال این پارامتر نیاز به نقش master_verifier دارد

 

true

sendVerification

 

 

email

متادیتای کاربر ذخیره شده برای کلاینت

 

 

client_metadata

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

 

nickName

 

 

phoneNumber

MAN_GENDER یا WOMAN_GENDER

 

gender

 

 

country

 

 

state

 

 

city

 

 

postalcode

 

 

address

ADDRESS_TYPE_HOME, ADDRESS_TYPE_WORK

 

addressType

 

 

sheba

 

 

profileImage

محل تولد

 

birthState

شماره شناسنامه

 

identificationNumber

نام پدر

 

fatherName

RELIGION_ISLAM, RELIGION_ZOROASTRIAN, RELIGION_CHRISTIAN, RELIGION_KALIMI, RELIGION_JEW, RELIGION_SHIA, RELIGION_SUNNI

 

religion

CUSTOMER_EDUCATION_ILLITERATE, CUSTOMER_EDUCATION_ASSOCIATE, CUSTOMER_EDUCATION_BACHELOR, CUSTOMER_EDUCATION_DIPLOMA, CUSTOMER_EDUCATION_MASTER, CUSTOMER_EDUCATION_PHD, CUSTOMER_EDUCATION_BELOW_DIPLOMA, CUSTOMER_EDUCATION_POST_DOCTORAL

 

education

وضعیت اقامت

 

CUSTOMER_RESIDENTIAL_STATUS_RESIDENT, CUSTOMER_RESIDENTIAL_STATUS_NON_RESIDENT

 

residentialStatus

شهر محل صدور شناسنامه

 

 

registerCityLocation

استان محل صدور شناسنامه

 

registerStateLocation

کشور ملیت ( تبعه )

 

nationalityCountry

کشور محل تولد

 

birthCountry

CUSTOMER_SURNAME_LIEUTENANT, CUSTOMER_SURNAME_TECHNICIAN, CUSTOMER_SURNAME_COMMANDER, CUSTOMER_SURNAME_DOCTOR, CUSTOMER_SURNAME_MAJOR_GENERAL, CUSTOMER_SURNAME_COLONEL, CUSTOMER_SURNAME_ENGINEER, CUSTOMER_SURNAME_CAPTAIN, CUSTOMER_SURNAME_MAJOR

 

surname

وضعیت تأهل

CUSTOMER_MARRIAGE_STATUS_MARRIED, CUSTOMER_MARRIAGE_STATUS_SINGLE

 

marriageStatus

نوع شناسنامه

 

serialType

شماره حوزه صدور شناسنامه

 

registerZoneNumber

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

 

nationalCardSerial

آرایه ای از مشاغل

JOB_SKILFUL, JOB_GENERAL_PRACTITIONER, JOB_EMPLOYEE, JOB_AGRICULTURAL, JOB_BUSINESSMAN, JOB_RETIRED, JOB_PRODUCTION, JOB_SERVICES, JOB_STRUCTURAL, JOB_CULTURAL, JOB_STUDENT, JOB_GOVERNMENTS_EMPLOYEE, JOB_SPECIALIST, JOB_COLLEGIAN, JOB_SOLDIER, JOB_LAWYER, JOB_ACCOUNTANTS

 

jobs

 

 

jobDescriptions

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

 

true

private

خروجی

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

true/false

hasError

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

string

referenceNumber

شماره مشتری

string

result

 

 

 

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

 
json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

       

افزودن و ویرایش کسب و کار زیر مجموعه/ شعبه (واسط/ Dealer / Broker)

  • اضافه کردن کسب و کار زیرمجموعه

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

اضافه کردن کسب و کار زیر مجموعه (توسط کسب و کار اصلی)

کسب و کار می‌تواند با استفاده از سرویس زیر، کسب و کارهای دیگری را که با آنها همکاری دارد را ثبت نماید.

در خروجی این سرویس  توکن کسب وکار بدست می آید که میتوان با استفاده از آن عملیات مالی را انجام داد.

  • این امکان برای کارگزاران و کسب و کارهایی که به تسهیم درآمد نیاز دارند بسیار مهم است.
  • با این اقدام، همزمان با ثبت کسب و کار، پنل کاربری نیز ساخته می‌شود.
  • ایمیل کسب و کار و شماره موبایلی که برای او ثبت می شود، برای مواقعی که لازم باشد خود آن کسب و کار در پنل مدیریتی خود وارد شود و برخی اقدامات را بر عهده بگیرد، ضروری است و صاحب کسب و کار می‌تواند با استفاده از آن رمز عبور خود را تعیین نماید. بنابراین صحت این موارد را کنترل نمایید.
  • لازم به ذکر است، کسب و کارهای جدید ثبت شده، دسترسی محدود به سرویس‌های پلتفرم خواهند داشت، مگر آنکه توسط کسب و کار تایید شده ثبت شده و یا تایید شده باشند.
  • بعد از ثبت کسب وکار جدید ، توکن ثابت (apiToken/BusinessToken) را دریافت خواهید کرد که توسط آن براساس دسترسی های موجود ، میتوانید هر گونه عملیات مرتبط با حساب دیجیتال و سایر سرویسها را انجام دهید

سرویس زیر عملیات مهم زیر را در یک عملیات انجام می‌دهد:

  • با استفاده از نام کاربری و ایمیل و شماره موبایل که دریافت می کند، امکان ورود به پنل مدیریت کسب و کار برای کسب و کار دیگر فراهم می‌شود
  • اطلاعات کسب و کار در پلتفرم (اصلی یا سندباکس) ثبت می‌شود
  • یک اپلیکیشن (client) پیشفرض برای کسب و کار به صورت یکپارچه ایجاد می‌شود که برای هر دو سرور سندباکس و اصلی اعتبار دارد

بنابراین در صورتی که سرویس زیر را برای مثال در سندباکس فراخوانی نمودید، برای انتقال به سرور اصلی کافیست با همان توکنی که برای کسب و کار از سرور سندباکس دریافت نموده‌اید، اطلاعات پروفایل کاربر را در سرور اصلی دریافت نموده و یک کسب و کار برای آن کاربر ثبت نمایید.

  • هم‌چنین کاربر در ابتدا با هر سطحی می‌تواند کسب و کار ثبت نماید و کسب وکار ایجاد شده، کسب و کار تایید نشده خواهد بود. اما در زمان تایید کسب وکار، حتما می بایست مالک کسب وکار سطح 3 یا بالاتر باشد و برای تایید کسب وکار ارسال شناسه مالک کسب و کار (ownerId) در سرویس زیر، برای کسب و کارهای فاقد شماره ثبت که دارای سطح کاربری 3 یا بالاتر می باشد، الزامی است.
  • لازم به ذکر است، شماره شبای این کسب و کارها مبتنی بر کد ملی صاحب کسب و کار ساخته می‌شود. در صورتی که owner کسب و کار تغییر یابد، شماره شباهای ساخته شده با کد ملی قبلی غیر فعال شده و از حساب‌های کسب و کار جدا می‌گردد تا owner جدید با کد ملی خود، شبای جدید دریافت نماید.

همچنین در این سرویس می توان از کد به جای اسامی کشور، استان و شهر استفاده نمود (که در ادامه سرویس های مربوط به اخذ کد را معرفی خواهیم کرد.)

شناسه سرویس : 29832    ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 29832   

scProductId

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

 

scApiKey

 

 

username

 

 

businessName

 

[]

guildCode

 

 

country

 

 

state

 

 

city

 

 

address

 

 

description

 

 

ownerId

 

 

country

 

 

state

 

 

city

 

 

address

 

 

description

 

 

email

 

 

cellphone

 

 

agentFirstName

 

 

agentLastName

 

 

agentCellphoneNumber

 

 

sheba

 

 

nationalCode

 

 

economicCode

 

 

registrationNumber

 

 

postalCode

 

 

fax

 

 

phone

 

 

logoImage

 

 

agentNationalCode

 

 

lat

 

 

lng

 

 

coverImage

 

 

 

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

شناسه بیزنس

 

Id

شناسه کاربر

 

userId

شناسه sso کاربر

 

ssoId

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

 

apiToken

 

 

 

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

انتقال وجه به کسب و کار زیر مجموعه

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

 

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

- همان مشتریان او هستند که پس از صدور فاکتور (چه پرداخت شود یا نشود) دنبال کننده می شوند.

- کسب و کارهایی که توسط یک کسب و کار دیگر ایجاد می شوند.

- کاربرانی که از درگاه های معرفی کسب و کارها خودشان کسب و کار را دنبال می کنند.

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

- اضافه کردن  به لیست مشتریان ( دنبال کنندگان ) توسط سرویس.

 

کسب و کار می تواند از طریق API زیر، مبلغ مورد نظر خود را به کیف پول دنبال کنندگان خود انتقال دهد:

 

شناسه سرویس : 34985     ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

34985      

scProductId

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

 

scApiKey

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

*

userId

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

*

guildCode

مبلغ انتقال

*

amount

شرح انتقال

*

description

کد ارز

IRR/USD/.

currencyCode

  ثابت   // کد کیف پول*

PODLAND_WALLET  *

wallet

ارسال شناسه دلخواه و یکتا به منظور امکان جستجو در لیست ها بر اساس شناسه یکتا

 

uniqueId

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

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

* کسب وکار زیرمجموعه باید کسب وکار اصلی را توسط سرویس  "اضافه کردن به لیست مشتریان(دنبال کننده)"   در لیست مشتریان خود اضافه کند ، تا بتواند انتقال وجه را انجام دهد

شناسه سرویس :34982    ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 

scProductId

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

 

scApiKey

شناسه کسب و کار موردنظر

 

businessId

** مقدار پارامتر follow اگر true وارد شود کسب و کار داده شده،  دنبال می شود

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

True/false

follow

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

سرویس اضافه کردن صنف / حساب تفصیلی برای کسب و کار

صنف( حساب تفصیلی ) محل در آمد کسب وکار است ، که مبالغ دریافتی از پرداخت فاکتور ، وارد صنف مورد نظر کسب وکار میشود تا بتواند مدیریت بهتری بر روی درآمدهای خود داشته باشد .

شناسه سرویس : 55070  ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 55070  

scProductId

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

 

scApiKey

نام صنف مورد نظر با حروف بزرگ

 

guildCode

 

 

 

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

سرویس دریافت لیست اصناف / حسابهای تفصیلی

با استفاده از این سرویس میتوانید ، لیست اصناف کسب وکار خود را بدست آورید .

شناسه سرویس : 29891  ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 29891

scProductId

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

 

scApiKey

 

0

offset

 

 

size

 

 

 

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

 

 

 

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

json

 

نمونه پاسخ

json

 

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

کد خطا

توضیح

21

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

227

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

378

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

 

سرویس دریافت اصناف موجود در پاد

با استفاده از این سرویس ، میتوانید لیست اصناف پیش فرض در پاد را بدست آورید.

شناسه سرویس : 29833  ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 29833 

scProductId

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

 

scApiKey

 

0

offset

 

 

size

 

 

name

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

 

 

 

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

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

برای انجام تسویه ، باید شماره شبا ی مقصد مورد نظر  را پیش از تسویه ، در سیستم اضافه نمایید .

شناسه سرویس : 46871 ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 46871

scProductId

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

 

scApiKey

 

 

sheba

 

 

name

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

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

توضیحات: با استفاده از این سرویس میتوانید صورتحساب کیف پول خود را بدست آورید .

شناسه سرویس : 34991 ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 34991

scProductId

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

 

scApiKey

 فاصله از مبدا

 

offset

 اندازه خروجی

 

size

حد پایین تاریخ صورتحساب

 

dateFrom

حد بالای تاریخ صورتحساب

 

dateTo

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

 

description

حد پایین مبلغ بند

 

amountFrom

حد بالای مبلغ بند

 

amountTo

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

پیشفرض false

true/false

block

کد صنف حساب

 

guildCode

کد ارز

 

currencyCode

در صورت false، گزارش صورت حساب غیر قابل برداشت و در صورت true،گزارش صورت حساب قابل برداشت را دریافت خواهید کرد

true/false

withdrawableAccount

بدهکار / بستانکار true/false

true/false

debtor

کد کیف پول

 

wallet

خروجی

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

true/false

hasError

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

string

referenceNumber

آرایه ای از تراکنش های مالی

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

دریافت صورت حساب صنفی

در این سرویس ، دریافت اطلاعات مربوط حساب صنفی خود را دریافت نمایید 

شناسه سرویس : 34990 ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 34990

scProductId

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

 

scApiKey

 فاصله از مبدا

 

offset

 اندازه خروجی

 

size

حد پایین تاریخ صورتحساب

 

dateFrom

حد بالای تاریخ صورتحساب

 

dateTo

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

 

description

حد پایین مبلغ بند

 

amountFrom

حد بالای مبلغ بند

 

amountTo

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

پیشفرض false

true/false

block

کد صنف حساب

 

guildCode

کد ارز

 

currencyCode

در صورت false، گزارش صورت حساب غیر قابل برداشت و در صورت true،گزارش صورت حساب قابل برداشت را دریافت خواهید کرد

true/false

withdrawableAccount

بدهکار / بستانکار true/false

true/false

debtor

خروجی

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

true/false

hasError

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

string

referenceNumber

آرایه ای از تراکنش های مالی

string

result

 

 

 

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

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

توضیحات:

شارژ کیف پول ( کیف پول برای کاربر سطح 3 به بالا و کسب وکار با مالک تایید شده)

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

محیط اصلی :

https://core.pod.ir/nzh/payAnyCreditInvoice?hash=1449c111a2c64155b5b6c34be40c439&gateway=pep

محیط سندباکس :

http://sandbox.pod.ir:8080/nzh/payAnyCreditInvoice?hash=7933fa779f4d47e0b913889cff8d01e9&gateway=LOC

 

سپس باید این پرداخت تایید شود ، در غیر این صورت پول عودت داده خواهد شد.

شناسه سرویس :  34976  ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 34976

scProductId

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

 

scApiKey

* مبلغ افزایش موجودی  به ریال

 

amount

* شناسه کاربر مربوط به هر کیف پول و هر کاربری که میخواهید کیف پولش را شارژ کنید.

 

userId

* شماره قبض یکتا جهت جلوگیری از اجرای تراکنش تکراری

 

billNumber

* آدرس بازگشت

PODLAND_WALLET

wallet

* آدرس بازگشت

 

redirectUrl

مشخصه درگاه PEP : درگاه شاپرکی  و LOC درگاه سندباکس

PEP , LOC

gateway

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

 

verificationNeeded

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

تأیید افزایش موجودی

توضیحات:

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

شناسه سرویس : 34977  (سندباکس : 42585)

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 prod=34977 sandbox=42585,

scProductId

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

 

scApiKey

* شماره قبض

 

billNumber 

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

 

id

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

انتقال وجه - افزودن نوع مخاطب

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

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

برای اینکار باید ابتدا نوع مخاطبین خود را ایجاد نمایید.

شناسه سرویس : 46941 ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 46941

scProductId

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

 

scApiKey

* کد دلخواه شامل حروف و اعداد انگلیسی بدون فاصله، که ارجاعات بعدی از این کد استفاده می گردد

PhoneCode2

typeCode

* نام نوع مخاطب که می تواند فارسی و انگلیسی باشد و به عنوان برچسب نمایشی استفاده می گردد

 

name

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

شامل مقادیر زیر می تواند باشد:

CELLPHONE_SCOPE

EMAIL_SCOPE

FIRSTNAME_SCOPE

LASTNAME_SCOPE

NATIONALCODE_SCOPE

DEBITCARD_SCOPE

USERNAME_SCOPE

NICKNAME_SCOPE

 

CELLPHONE_SCOPE

scopes

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

انتقال وجه - افزودن مخاطب

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

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

شناسه سرویس : 46940  ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

46940

scProductId

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

 

scApiKey

* شناسه کاربرِی که مخاطب برای آن ثبت گردد

 

userId

نام مخاطب، در صورتی که نام خانوادگی وارد نشود اجباری می باشد

 

firstName

نام خانوادگی مخاطب، در صورتی که نام وارد نشود اجباری می باشد

 

lastName

شماره تلفن مخاطب

 

cellphoneNumber

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

 

email

نام کاربری مخاطب

 

username

کد نوع مخاطب

 

typeCode

شناسه کاربری مالک contactType

 

ownerId

شناسه یکتا برای ثبت در contact دریافت می شود

 

uniqueId

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

 

 

 

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

 سرویس اضافه کردن دنبال کننده

* کسب وکار زیرمجموعه باید کسب وکار اصلی را توسط سرویس  "اضافه کردن به لیست مشتریان(دنبال کننده)"   در لیست مشتریان خود اضافه کند ، تا بتواند انتقال وجه را انجام دهد .

شناسه سرویس :34982    ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 

scProductId

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

 

scApiKey

شناسه کسب و کار موردنظر

 

businessId

** مقدار پارامتر follow اگر true وارد شود کسب و کار داده شده،  دنبال می شود

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

True/false

follow

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

نمونه پاسخ

json

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

کد خطا

توضیح

21

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

227

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

378

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

 

انتقال وجه به مخاطب

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

شناسه سرویس :  34980  ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 34980

scProductId

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

 

scApiKey

شناسه مخاطب

 

contactId

مبلغ

 

amount

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

 

 

 

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

json

 

نمونه پاسخ

json

 

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

کد خطا

توضیح

21

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

227

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

378

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

 

انتقال وجه به مشتری (دنبال کننده)

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

شناسه سرویس : 34985 ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 34985

scProductId

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

 

scApiKey

* کد صنف مربوط به حساب

 

guildCode

* مبلغ

 

amount

* شناسه کاربر (مشتری)

 

userId

* توضیحات

 

description

* کد کیف پول

 

wallet

کد ارز IRR/USD و ...

 

currencyCode

شناسه یکتا برای انتقال وجه

 

uniqueId

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

 

نمونه پاسخ

json

 

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

کد خطا

توضیح

21

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

227

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

378

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

 

انتقال بین حساب‌های صنفی و کیف پول متعلق به خود

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

شناسه سرویس : 34978 ( سندباکس :    )

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 34978

scProductId

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

 

scApiKey

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

 

guildCode

لیست مبالغ بند های سند

 

amount

مبلغ مربوط به بند سند حساب نقش مشتری (کیف پول)

 

customerAmount

کد ارز

 

currencyCode

توضیحات

 

description

کد کیف پول

پیشفرض: PODLAND_WALLET

 

 

wallet

شناسه یکتا برای انتقال وجه

 

uniqueId

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

json

 

نمونه پاسخ

json

 

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

کد خطا

توضیح

21

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

227

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

378

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

 

درخواست اعطای مجوز عملیات مالی

شماره سرویس : 1118907

پارامترهای ورودی

نام پارامتر

نوع پارامتر

اجباری

توضیحات

ownerUserId

String

*

شناسه کاربری اعطا کننده مجوز

operationCode

String

*

شناسه عملیات  (جدول شماره1)

guildCode

String

*

کد صنف

پارامتر ownerUserId، شناسه کسب وکاری می باشد که شما قصد اخذ مجوز مالی را از آن دارید.

پارامتر operationCode، شناسه عملیات مالی ای است که شما درخواست مجوز دسترسی به آن را دارید.

مقدار قابل ارسال

توضیحات

FINANCIAL_OPERATION_INVOICE

عملیات مالی مربوط به فاکتور

FINANCIAL_OPERATION_TRANSFER

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

FINANCIAL_OPERATION_REQUEST_SETTLEMENT

عملیات مالی مربوط به تسویه حساب

FINANCIAL_OPERATION_GET_CREDIT

عملیات مالی مربوط به موجودی حساب

FINANCIAL_OPERATION_ACCOUNT_BILL

عملیات مربوط به صورتحساب

جدول شماره یک

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

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

“جهت تایید اعطای مجوز مالی به "نام کسب وکار درخواست دهنده مجوز" در صنف "نوع صنف ارسالی" برای نوع عملیات درخواست صورت حساب کد زیر را به همین شماره ارسال نمایید xxxxx"

 

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

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

شماره سرویس : 1118911

پارامترهای ورودی

نام پارامتر

نوع پارامتر

اجباری

توضیحات

Code

String

*

کد پیامک شده

 

تأیید درخواست اعتطا مجوز عملیات مالی

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

شماره سرویس : 1118915

پارامترهای ورودی

نام پارامتر

نوع پارامتر

اجباری

توضیحات

Id

String

*

شناسه مجوز

 

اعطای مجوز عملیات مالی

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

شماره سرویس : 1118917

پارامترهای ورودی

نام پارامتر

نوع پارامتر

اجباری

توضیحات

grantedUserId

String

*

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

operationCode

String

*

شناسه عملیات  (جدول شماره1)

guildCode

String

*

کد صنف

 

دریافت لیست مجوزها

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

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

پارامترهای ورودی

نام پارامتر

نوع پارامتر

اجباری

توضیحات

Id

String

 

شناسه کاربری اعطا کننده مجوز

ownerUserId

String

 

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

grantedUserId

String

 

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

operationCode

String

 

شناسه عملیات (جدول شماره یک)

guildCode

String

 

شناسه صنف

Grant

String

 

تایید شده (true) / تایید نشده (false)

offset

Int

*

صفحه شروع

Size

Int

*

تعداد رکورد

 

لغو مجوز عملیات مالی

در صورتیکه کسب وکاری خواهان لغو موقت مجوز عملیات مالی ای که اعطا کرده باشد، می تواند از سرویس زیر استفاده کرده و مجوز مد نظر را به صورت موقت لغو نماید و هر زمانی که تصمیم به اعطای مجدد همان مجوز بگیرد، با فراخوانی سرویس و تایید اعطای مجوز مجددا آن مجوز را تایید و راه اندازی نماید

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

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

پارامترهای ورودی

نام پارامتر

نوع پارامتر

اجباری

توضیحات

Id

String

*

شناسه مجوز مالی

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

json

 

 

حذف مجوز عملیات مالی

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

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

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

پارامترهای ورودی

نام پارامتر

نوع پارامتر

اجباری

توضیحات

Id

String

*

شناسه مجوز مالی

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

json

 

صدور فاکتور برای مشتری

صدور فاکتور توسط کسب و کاری دیگر برای مشتری

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

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

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

پارامترهای ورودی body

نام پارامتر

نوع پارامتر

اجباری

توضیحات

productId

String

*

شناسه محصول

price

String

*

مبلغ بند فاکتور

Quantity

String

*

تعداد محصول در هر بند فاکتور

productDescription

String

*

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

guildCode

String

*

کد صنف فاکتور

businessId

String

*

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

پارامتر ورودی Header

نام پارامتر

نوع پارامتر

اجباری

توضیحات

_ott_

String

*

 

لازم بذکر است:

  • پارامتر businessId، شناسه کسب وکاری می باشد که مجوز لازم را برای شما صادر کرده است.
  • سرویس مذکور نیز مانند سایر سرویس های مربوط به فاکتور، نیازمند ott می باشد که شما می‌توانید آن را از آخرین درخواست به پلتفرم یا از طریق API زیر دریافت نمایید. فقط دقت نمایید که توکنی که با آن ott می گیرید با توکنی که در درخواست بعدی باید استفاده شود، یکی باشد. سرویس ott در کالکشن postman در اختیار شما می باشد

 

انتقال اعتبار به مشتری

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

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

یادآوری: شناسه عملیات دریافت مجوز مالی برای انتقال وجه در سرویس درخواست اعطای مجوز عملیات مالی FINANCIAL_OPERATION_TRANSFER” می‌باشد

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

پارامترهای ورودی body

نام پارامتر

نوع پارامتر

اجباری

توضیحات

amount

String

*

مبلغ اعتبار

UserId

String

*

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

description

String

*

توضیحات

wallet

String

*

کد حساب دیجیتال

guildCode

String

*

کد صنف مربوط به حساب

businessId

String

*

شناسه کسب وکار دیگر برای انتقال وجه

لازم بذکر است:

  • پارامتر userId، شناسه کاربری می باشد که دنبال کننده کسب وکار شما است.
  • پارامتر  businessId، شناسه کسب وکاری می باشد که اعطا کننده مجوز انتقال اعتبار به شما است و شما از حساب ایشان اعتبار مورد نظر را به کاربر خود، منتقل می کنید.

پارامتر ورودی Header

نام پارامتر

نوع پارامتر

اجباری

توضیحات

_ott_

String

*

 

 

دریافت اعتبار

دریافت اعتبار کسب و کار دیگر

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

یادآوری: شناسه عملیات دریافت مجوز مالی برای موجودی حساب در سرویس درخواست اعطای مجوز عملیات مالی، "FINANCIAL_OPERATION_GET_CREDIT"  می باشد.

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

پارامترهای ورودی body

نام پارامتر

نوع پارامتر

اجباری

توضیحات

guildCode

String

*

کد صنف

businessId

String

*

شناسه کسب وکار

خروجی سرویس شامل بخش های گوناگون می باشد که در قسمت customerAmountSrvs شامل حساب‌های دیجیتال‌ کسب وکار اعطا کننده مجوز است که توسط پارامتر wallet قابل تشخیص می‌باشد.

فیلد hasWithdrawBlock مسدودی برداشت را نمایش می‌دهد و فیلد hasWillBeBlock نمایانگر مسدودی منفی است.

 قسمت mainBusinessAmountSrvs شامل لیست حساب‌های کسب و کاری اعطا کننده مجوز می‌باشد که هر کدام با guildSrv قابل تشخیص هستند.

 لازم به ذکر است، هر حساب کسب و کار در هر guild دارای 3 مقدار موجودی کل (amount)، مبلغ قابل برداشت (withdrawableAmount) و مبلغ غیر قابل برداشت (notWithdrawableAmount) می‌باشد.

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

 

دریافت گزارش صورتحساب

دریافت گزارش صورتحساب کسب و کار دیگر

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

یادآوری : شناسه عملیات دریافت مجوز مالی برای گزارش صورتحساب در سرویس درخواست اعطای مجوز عملیات مالی، " FINANCIAL_OPERATION_GET_ACCOUNT_BILL" می باشد.

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

پارامترهای ورودی body

نام پارامتر

نوع پارامتر

اجباری

توضیحات

guildCode

String

*

کد صنف فاکتور

businessId

String

*

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

dateFrom

String

 

حد پایین تاریخ صورتحساب

dateTo

String

 

حد بالای تاریخ صورتحساب

description

String

 

فیلتر روی توضیحات بند سند به صورت like

amountFrom

String

 

حد پایین مبلغ بند

amountTo

String

 

حد بالای مبلغ بند

Block

String

 

فیلتر روی حساب های مسدودی یا غیر مسدودی به صورت true/false

currencyCode

String

 

کد ارز

withdrawableAccount

String

 

false/true

لازم به توضیح است:

  • در صورتیکه پارامتر dateFrom و dateTo خالی ارسال شود، سرویس به صورت پیش فرض، تاریخ روز را محاسبه خواهد کرد.
  • در صورتیکه مقدار پارامتر withdrawableAccount ، false  ارسال گردد، گزارش صورت حساب غیر قابل برداشت و در صورت true  ارسال شدن، گزارش صورت حساب قابل برداشت را نشان خواهد داد

 

برداشت اعتبار

درخواست برداشت اعتبار از حساب دیگر

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

یادآوری: شناسه عملیات دریافت مجوز مالی برای تسویه حساب در سرویس درخواست اعطای مجوز عملیات مالی، "FINANCIAL_OPERATION_REQUEST_SETTLEMENT" می باشد.

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

پارامترهای ورودی body

نام پارامتر

نوع پارامتر

اجباری

توضیحات

amount

String

*

مبلغ برداشت

guildCode

String

*

کد صنف

businessId

String

*

شناسه کسب وکار

لازم بذکر است:

  • پارامتر businessId، شناسه کسب وکار اعطا کننده مجوز جهت تسویه از حساب آن کسب وکار می باشد.
Clasor npm package version 2.1.4
به پادیوم قدرت داده اند:
pasargad
fanap
pod