حساب دیجیتال پاسارگاد

خدمت‌دهنده

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

مقدمه

 

پیش از شروع

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

 

اطلاعات پروفایل کسب وکار

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

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

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

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

34984

scProductId

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

 

scApiKey

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result

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

HTTP

نمونه پاسخ

JSON

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

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

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

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

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 3734634

scProductId

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

 

scApiKey

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

 

businessId

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result

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

HTTP

 

نمونه پاسخ

JSON

 

اطلاعات پروفایل کاربری

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

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

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

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

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 29792

scProductId

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

 

scApiKey

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result

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

JSON

نمونه پاسخ

JSON

دریافت شماره کاربری

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

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

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

  • دقت شود که ارسال یکی پارامترهای شماره موبایل، کدملی و یا شناسه SSO برای بدست آوردن شناسه کاربر  کافی است، و ارسال همزمان پارامترها باعث میشود که رکورد متعلق به استعلام آن پارامتر نیز در خروجی نمایش داده شود .
  • میتوانید بیش از یک پارامتر کدملی یا شماره موبایل و یا SSOID ارسال نمایید تا همزمان شناسه کاربری متعلق چند شخص را بدست بیاورید .

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 367386

scProductId

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

 

scApiKey

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

 

cellPhoneNumber

شماره موبایل متعلق به شخصی دیگر

 

cellPhoneNumber

کد ملی شخص

 

nationalCode

کد ملی شخصی دیگر

 

nationalCode

شناسه کاربر در سامانه احراز هویت یکپارچه پاد SSO

 

ssoId

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result

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

 

id

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

HTTP

نمونه پاسخ

JSON  

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

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

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

هر کسب و کار دارای، دو نوع حساب می باشد:

  • حساب  کیف پول(wallet)که با عنوان "حساب دیجیتال من " در پنل کسب وکار  قابل مشاهده است، که با انجام اولین تراکنش مالی ، این حساب ایجاد خواهد شد.
  • حساب متعلق به اصناف (guild)کسب وکار  که با عنوان " حساب تفصیلی " در پنل کسب وکار قابل مشاهده است.
  • هر کاربر ثبت شده در پلتفرم پاد ، تنها دارای  حساب دیجیتال ( کیف پول ) است که با انجام اولین تراکنش مالی برای کار ایجاد خواهد شد.
  • هر کسب وکار تنها میتواند یک حساب دیجیتال ( کیف پول ) داشته باشد ، که مبالغ مربوط به خرج کرد یک کسب وکار  از این حساب برداشت میشود ، به عنوان نمونه اگر خریدی درپلتفرم پاد انجام شود ، یا فراخوانی سرویس دارای کارمزد باشد ، مبلغ کارمزد از این حساب کسر میشود.
  • هر حساب دیجیتال ( کیف پول ) بعد از تایید و احراز هویت کسب وکار، دارای یک شماره حساب سنتی ( بانک پاسارگاد)  وشماره شبا نیز خواهد بود.
  • هر حساب تفصیلی (صنف/ guild )محل در آمدهای یک کسب وکار است، و مبالغی که در نتیجه فروش ( پرداخت فاکتور توسط سایرین ) به کسب وکار تعلق میگیرد به یکی از این حسابهای صنفی که از قبل توسط کسب وکار ایجاد شده است واریز میشوند.
  • هر حساب تفصیلی دارای یک کد با حروف انگلیسی است که از آن به عنوان guild_code در سایر عملیاتهای مالی استفاده میشود.

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

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 39634

scProductId

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

 

scApiKey

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result

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

 

customerAmountSrvs

اطلاعات مربوط به حساب تفصیلی (اصناف) کسب وکار به صورت آرایه می باشد که شامل مبلغ، کد صنف  می باشد .

 

mainBusinessAmountSrvs

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

HTTP

نمونه پاسخ

JSON

 

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

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

نکات

  • تنها یکی از پارامترهای «شناسه کاربری پاد» یا «شماره حساب پاسارگاد» باید وارد شوند.
  • در پارامتر «شماره حساب پاسارگاد» وارد کردن شماره حساب چهار بخشی و دو بخشی، هر دو مجاز است.
  • این سرویس هر دو نوع شماره حساب دیجیتال و سنتی را پشتیبانی می کند.

شناسه سرویس

شناسه سرویس اصلی : 34468481

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

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

پارامترهای Body

توضیحات

نوع

نام پارامتر

شناسه کاربر

String

userId

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

String

depositNumber

مشاهده نتیجه کامل پاد

String

fullResponse

* پارامتر اجباری

فیلدهای خروجی

توضیحات

نوع

نام پارامتر

شناسه وضعیت

Array of Integer

result.result.errorCode

توضیح وضعیت

String

result.result.message

شماره شبا

String

result.result.IBAN

نتیجه کامل پاد

Json

result.result.full

آرایه ای از شناسه ارجاع های مرتبط

Array of String

result.result.relatedReferences

فرمت نتیجه کامل پاد (result.result.full) :

توضیحات

نوع

نام پارامتر

شماره شبای پاد

String

sheba

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

Boolean

registeredInSayyah

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

String

depositAccountNumber

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

مقدار

نام پارامتر

-

scProductId

-

userId

-

depositNumber

-

fullResponse

کدهای خطا

کد خطای پادیوم - فیلد errorCode

کد خطا

توضیح

0

بدون خطا

460

یکی و فقط یکی از پارامترهای userId و depositNumber را وارد کنید

462

قالب پارامتر userId اشتباه است

551

خطای داخلی سرور

شناسه وضعیت - فیلد result.result.errorCode

کد خطا

توضیح

0

بدون خطا

[78, null]

خطا در یافتن شماره حساب

[226, null]

کاربر فاقد شماره شبا می باشد

[null, 2]

خطا در یافتن شماره حساب

 

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

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

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

برای شارژ کیف پول برای کاربر سطح 3 به بالا و کسب وکار با مالک تایید شده  و تا سقف 500 هزار تومن ، از این سرویس استفاده نمایید .

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

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

محیط اصلی:

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

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

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

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

توضیحات

مقدار

نام پارامتر

ورودی

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

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

HTTP

نمونه پاسخ

JSON

تایید افزایش موجودی مستقیم  

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

(سندباکس: 42585)

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

توضیحات

مقدار

نام پارامتر

ورودی

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

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

HTTP

نمونه پاسخ

JSON

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

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

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

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

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

و به همان میزان، برای فیلد amount (متناظر با کد صنف)  مبلغ را با علامت مثبت وارد نمایید.

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

 34978

scProductId

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

 

scApiKey

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

 

guildCode

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

+1000

amount

مبلغ مربوط به (کیف پول)

-1000

customerAmount

کد ارز

 

currencyCode

توضیحات

 

description

کد کیف پول

پیشفرض: PODLAND_WALLET

 

wallet

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

 

uniqueId

خروجی

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

true/false

hasError

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

string

referenceNumber

 

string

result

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

HTTP

نمونه پاسخ

JSON

انتقال اعتبار به مخاطب

شناسه سرویس: 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

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

HTTP

نمونه پاسخ

JSON

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

شناسه سرویس: 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

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

HTTP

نمونه پاسخ

JSON

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

شناسه سرویس: 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

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

HTTP

 

نمونه پاسخ

JSON

 

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

شناسه سرویس: 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

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

HTTP

 

نمونه پاسخ

JSON

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

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

شناسه سرویس : 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

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

html

 

نمونه پاسخ

json

 

 

 

 

 

 

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

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

شناسه سرویس : 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

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

html

 

نمونه پاسخ

json

 

 

 

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

کد خطا

توضیح

21

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

227

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

378

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

تسویه و برداشت به شبا:

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

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

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

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

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

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