برداشت مستقیم از حساب بانک پاسارگاد

پارامتر

توضیحات

_token_

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

_token_issuer_

مقدار ثابت "1"

پارامتر

توضیحات

scProductId

شناسه­‌ی سرویس مدنظر

scApiKey

راهنمای دریافت این پارامتر در این لینک موجود است.

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

در صورت ارسال مقدار false ، تنها نتیجه نهایی سرویس که در فیلد result.result است ، با فرمت JSON  در Body پاسخ ، برگشت داده خواهد شد . و پارامترهای refrenceNumber و hasError در header پاسخ قابل مشاهده می‌باشد . 

true/false

scWrapper

Body

شناسه سرویس

39913  

scProductId

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

scApiKey

  طول مدت اشتراک به روز

subscriptionDays

سقف مبلغ قابل برداشت به ریال

maxAmount

  حداکثر تعداد دفعات برداشت

maxCount

سقف مبلغ قابل برداشت روزانه

dailyAmount

سقف مبلغ قابل برداشت برای هر تراکنش

perTransactionAmount

مقدار این پارامتر براساس حروف بزرگ انگلیسی وارد میشود:

اشتراک زماندار بدون محدودیت در مبلغ و تعداد دفعات برداشت

WITHDRAW_RULE_TYPE_SUBSCRIPTION

WITHDRAW_RULE_TYPE_SUBSCRIPTION_AMOUNT

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

WITHDRAW_RULE_TYPE_SUBSCRIPTION_AMOUNT_COUNT

اشتراک زماندار با سقف مبلغ و تعداد دفعات محدود

WITHDRAW_RULE_TYPE_AMOUNT_COUNT

اشتراک با سقف مبلغ و تعداد دفعات محدود و زمان نا محدود

WITHDRAW_RULE_TYPE_AMOUNT

اشتراک با سقف مبلغ محدود، زمان و تعداد دفعات نامحدود

WITHDRAW_RULE_TYPE_DAILY

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

typeCode

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result.result

شناسه طرح ایجاد شده.

id

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

{}

business

سایر پارامترها مربوط به مشخصات طرح ایجاد شده می‌باشد .

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

نمونه پاسخ

client-id   

18934772dssssserssssd559rr1058ba93b6

client-secret

cba91kjgkjhdrcea18

redirectUri

Top of Form

https://podiun.irBottom of Form

public Key

<RSAKeyValue><Modulus>AIh4eZKC4Wdalfd2Ipajo3wJaOnfZNijz8GVzj0eCoeIREVFPYZSZMh+0Q7AMATJH3afZy666oYuUxVNwMjB6/StEFDVmfMSVyeX+/nlj3UBoaatZzqFNroYUxJtjFEuP0M42iY9Gwe7CpOkTBUe6W/</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>

private Key

<RSAKeyValue><Modulus>AIJqhRw/Wi6dwyAFONuM3mywoacEus97/HCUws5gsYvGysU74hwh+/35NAlL099b9hJ8B8UpCRUL6I0G6cqrMRxT/mjvqKgkkRe0U5p/RD+HGO6psmfo5o92em03+vcYvjlVBCmZebaTvC2RDQCna9/ucNaXig1KBRcI5WtDqUU3</Modulus><Exponent>AQAB</Exponent><P> /zqFIci6feqPtED0gHtx7sDwkz1ZRKKISnQQ==</DQ><InverseQ>ANlBBxd6yrDdrO1rcfzcoGZ3vjLI7zUbcycM1JtqG8BoOeBoN/qIfOAVpLURUkEBAB17qBTQ8qcAAClhYnTR/rM=</InverseQ><D>fb/oCYyskDZeZwmiAVCbR4Io3LqaxmVuy78k94oUqApOik9rfmTmbcVUf4I2ETDC3J/rfhhLQZfx68m2tEzNVG/PVvzgpYIphiBSUZyoMfPV6jr82FXf3TjWnhIoYqdxuBwV/J3C34z5NDxSUiJaPccHCbQzJC5U/012AKtyxAE=</D></RSAKeyValue>

توضیحات

مقدار

نام پارامتر

آدرس URL  پایه ورود به پلتفرم – این نشانی ثابت است .

https://accounts.pod.ir/oauth2/authorize/?

شناسه کلاینت ( کلید اتصال )

client_id

دارای مقدار ثابت واژه  code – این مقدار پارامتر مشخص میکند که عملیات ورود و دریافت اکسس توکن را  دو مرحله ای انجام میدهید.

ابتدا oAuthCode را دریافت میکنید ، و از طریق آن accessToken را دریافت خواهید کرد .

code

response_type

آدرس بازگشت ثبت شده متعلق به کسب وکار در کلید اتصال

redirect_uri

دارای مقدار ثابت bpi   - این پارامتر در URL امکان ورود به صفحه ورود اینترنت بانک را فراهم میکند

bpi

social

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

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

login profile

کد ثابت مجوز ها را با "فاصله " یا کارکتر +   در کنار یکدیگر در این پارامتر وارد نمایید .

login profile

scope

 دارای مقدار ثابت social_login -  این پارامتر در URL باعث میشود کاربر بلافاصله وارد صفحه ورود اینترنت بانک پاسارگاد شود ، و صفحه ورود به پلتفرم پاد را  مشاهده ننماید .

social_login

prompt

آدرس ( لینک ) نهایی:

https://accounts.pod.ir/oauth2/authorize/?client_id=7115red6f47fbb526d2abb79db84a&response_type=code&redirect_uri=https://podium.ir&social=bpi&scope=login profile&prompt=social_login

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

مشخصه نحوه ی درخواست اکسس توکن – این مقدار  authorization_code ثابت است ، و به SSO   این موضوع را اعلام میکند ، که دریافت اکسس توکن براساس code دریافتی  در ورودی سرویس انجام شود .

authorization_code

grant_type

کد دریافتی بعد از ورود کاربر به صفحه ورود اینترنت بانک

code

شناسه کلید اتصال

client_id

رمز کلید اتصال

client_secret

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

redirect_uri

خروجی

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

access_token

زمان انقضای توکن براساس ثانیه

expires_in

با استفاده از این توکن ، میتوانید مجدد اکسس توکن کاربر را بدون نیاز به انجام لاگین در اینترنت بانک دریافت نمایید. باید از سرویس دریافت اکسس توکن از طریق refresh_token اقدام نمایید.

refresh_token

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

scope

نوع توکن ایجاد شده .

token_type

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

در مقدار پارامتر  Authorization  ابتدا واژه  Beare و بعد از آن یک فاصله ، و بعد اکسس توکن کاربر وارد میشود.

Bearer {{userAccessToken}}

Authorization

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

application/x-www-form-urlencoded

Content-Type

Body

الزامی - RSA  - الگوریتم ساخت جفت کلید عمومی / خصوصی

RSA

keyAlgorithm

اختیاری - XML – فرمت ساخت جفت کلید عمومی / خصوصی  ( امکان تولید کلید با فرمت PEM وجود ندارد )

keyFormat

اختیاری - 1024 - اندازه ساخت جفت کلید عمومی / خصوصی -  که در واحد بیت میبایست ثبت گردد  مثلا 1024 یا 2048 کیلوبیت

keySize

اختیاری – پیشفرض false  - اگر false ارسال شود ، کلیدی که قبلا در SSO برای کاربر ثبت شده بوده است ، بازگشت داده میشود.

در این صورت keyId در خروجی ثابت خواهد بود و تغییر نمیکند.

اگر true ارسال شود ،کلید قبلی کاربر حذف میشود و  یک جفت کلید جدید در SSOپاد تولید خواهد  شد و باز گشت داده میشود. در این صورت keyId در خروجی متفاوت خواهد بود

true/false

renew

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

validity

خروجی

شناسه جفت کلید تولید شده در SSO پاد

keyId

کلید خصوصی تولید شده

privateKey

کلید عمومی تولید شده

publicKey

اطلاعات کاربر

user

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

آدرس URL  پایه ورود به صفحه تخصیص مجوز  – این نشانی ثابت است .

https://pay.pod.ir/v1/pbc/issueWithdrawRuleByPlan/?

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

string

businessId

شناسه طرح برداشت تعریف شده توسط کسب وکار

string

planId

شناسه کلاینت ( کلید اتصال )

string

client_id

آدرس بازگشت ثبت شده متعلق به کسب وکار در کلید اتصال

string

redirect_uri

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

string

access_token

شناسه کلید خصوصی ثبت شده برای کاربر در مراحل قبل که در ساخت Signature استفاده شده است .

string

key_id

زمان  به فرمت unix TimeStamp که در  ساخت Signature استفاده شده است .

unixTimeStamp

timestamp

امضای تولید شده در مرحله قبل

string

signature

آدرس ( لینک ) نهایی:

https://pay.pod.ir/v1/pbc/issueWithdrawRuleByPlan/?

businessId=199402&planId=4048&redirectUri=https://podium.ir&access_token=d1643f18e2ec4e09dc557.

XzIwMjIxMg&key_id=226642b1671007106&timestamp=1671217298273&signature=ahgKQ5Z8%2FHGKopborR3dEUrQnfBR5w

UCtw0j2Lxj59B3DIpq3i%2FXWvOoK3iFp%2FSymBIhwhT4etRNlTc4Af3fWaUjlbfPGYcQ0Ei7MPmeKpDGyRLGf9aWWLJcLsL7%2FyC0gntOcxg%3D

توضیحات: 

• به منظور پیشبرد فرایند برداشت مستقیم کسب وکار لازم است در این مرحله یک فاکتور به نام کاربر خود ایجاد نماید تا بتواند از طریق آن مبلغ را از حساب کاربر برداشت نماید.
• دقت شود که در حین صدور فاکتور برای کاربر باید شناسه کاربری وی را در فیلد userId وارد نمایید.
• توضیحات کامل تر در مورد فاکتور را در مستند مربوط به خرید و پرداخت  در بازارچه سایت  podium.ir  مشاهده نمایید.

هرگونه پرداخت در پلتفرم پاد، از طریق فاکتور invoice صورت می گیرد.

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

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

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

-  نمونه زیر یک فاکتور با دو بند ( قلم ) را شامل می شود.

مقدار api_token را از پنل مدیریت کسب و کار دریافت نمایید.

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

توجه داشته باشید مقدار ott از api_token متفاوت است، مقدار ott را میتوانید از response سرویس 29816   هم دریافت نمایید و مجددا در سرویس صدور فاکتور فراخوانی نمایید.

اگر استفاده از ott در سیستم شما مقدور نیست، بجای متد بالا می توانید از سرویس 29797  استفاده نمایید که billNumber یکتا در آن اجباری می‌باشد و باید توسط کسب و کار ارسال شود و نیاز به ott ندارد.

* بندهای صدور فاکتور به صورت رنگ متفاوت در جدول پارامترها آمده اند ،

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

 productId[]   , price[]  , quantity[]  ,  productDescription[] , discount[]

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

- productId    : شناسه محصول

(برای کاهش تعداد موجودی - در صورتی که محصول قبلا در سیستم تعریف نشده است []productId برای آن بند مقدار 0 باید داشته باشد)

- price:  قیمت محصول (می تواند با قیمت تعریف شده محصول متفاوت باشد)

- quantity: تعداد محصول 

-  productDescription: شرح بند فاکتور

- discount: تخفیف برای بند فاکتور 

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

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

* علامت [] در نام پارامتر به منظور ارسال مقادیر آن پارامتر  به صورت آرایه است ، و سرویس صدور فاکتور ،  با پارامتر های با نام تکراری که دارای این علامت باشند ، به شکل مقادیر یک آرایه برخورد میکند.

مثلا وجود دو فیلد price[] در یک درخواست ، به این معنی است که یک آرایه به نام price با دو مقدار ارسال شده است .

//parameters in request

price[]=value1

price[]=value2

// parameters in service

price=[value1,value2];

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس:

 / عملیاتی / تستی procuction=29796 , sandbox=39291  

29796

scProductId

این مقدار را بعد از درخواست سرویس و تایید پادیوم ، میتوانید از پنل یا از طریق api دریافت نمایید.

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

scApiKey

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

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

redirectURL

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

userId

شماره قبض – شماره قبض دلخواه کسب و کار که بر اساس ساختار داخلی خودش آن را ثبت میکند و میتواند بعداً با استفاده از این مقدار فاکتور را به راحتی پیدا نماید.

مقدار billNumber در آدرس برگشت، به کسب و کار بازگردانده می شود. شماره قبض رقم می‌باشد و نه عدد. به این معنا که مقدار 1 از 01 متفاوت است و می توان برای نام گذاری از این شیوه بهره مند شد.

billNumber

متادیتا برای فاکتور – هرگونه اطلاعات اضافی در مورد فاکتور که در قالب json ذخیره می گردد و قابل جستجو می‌باشد. به عنوان مثال اگر این مقدار را ارسال کنیم.

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

{"name":"Aria"}

metadata

شرح فاکتور

description

yyyy/mm/dd تاریخ سررسید شمسی = مهلت پرداخت فاکتور، در صورتی که کاربر بخواهد پس از این زمان فاکتور را پرداخت نماید پیغام خطا دریافت می کند.

deadline

*شناسه محصول بند فاکتور، اگر شناسه محصول را نمی‌دانید مقدار صفر را ارسال نمایید

productId[]

*مبلغ بند فاکتور= قیمت محصول (می تواند با قیمت تعریف شده محصول متفاوت باشد)

price[]

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

quantity[]

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

productDescription[]

مبلغ تخفیف برای هر بند از فاکتور

discount[]

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

productId[]

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

price[]

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

productDescription[]

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

quantity[]

مبلغ تخفیف برای هر بند از فاکتور

discount[]

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

guildCode

کد ارز پیشفرض IRR

currencyCode

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

addressId

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

voucherHash

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

preferredTaxRate

پرداخت دومرحله ای true/false = گر true داده شود، کسب و کار باید دریافت وجه را تایید نماید، در غیر این صورت پس از یک ساعت، پول پرداخت شده به کیف پول کاربر برمی گردد. (پرداخت سه مرحله ای)

verificationNeeded

تایید خودکار فاکتور در پرداخت دومرحله ای true/false

verifyAfterTimeout

پیش نمایش فاکتور -در سیستم ثبت نمی گردد – در صورتی که true ارسال شود، یک پیش نمایش از فاکتور بازگردانده میشود و فاکتور ثبت نمی گردد. true/false  و با استفاده از سرویس پیش نمایش ، میتوان هش دسترسی به این فاکتور را بدست اورد و آنرا  در لینک مورد نظر قرار داد و به کاربر نمایش داد. توضیحات در سرویس نمایش پیش فاکتور 30359

preview

پرداخت فاکتور به روش امن – در صورتی که true ارسال شود، تایید یا لغو پرداخت برعهده مشتری قرار می گیرد و اگر تا 2 روز اقدامی صورت نگیرد، فاکتور به صورت خودکار تایید می شود. / مقدار دیفالت این پارامتر، در صورت عدم ارسال false می‌باشد.

safe

امکان اضافه کردن ووچر بعد از صدر فاکتور – در صورتی که true باشد، مشتری قادر خواهد بود در صفحه فاکتور پاد، کد تخفیف وارد نماید.

postVoucherEnabled

عنوان رویداد - در صورتی که فاکتور رویداد داشته باشد مقدار true را ارسال نمایید.

hasEvent

منطقه زمانی رویداد

eventTimeZone

یادآورهای رویداد - فرمت json/ یادآورهای رویداد

eventReminders

توضیحات رویداد

eventDescription

اطلاعات جانبی رویداد

eventMetadata

شماره تلفن همراه - در صورت عدم وجود کاربر ثبت شده در پلتفرم، جهت نمایش شماره کارت های مربوط به مشتری این پارامتر می تواند بجای userId ارسال گردد. در صورت وجود userId، این مقدار نادیده گرفته شده و شماره موبایل مربوط به userId به درگاه ارسال می گردد.

cellphoneNumber

در فاکتور غیر SAFE  (فاکتوری که تایید یا لغو آن بر عهده ی مشتری است ) پس از گذشت این زمان ، از زمان تایید فاکتور ، (فاکتور به صورت خودکار بسته می شود (به ثانیه و بالای 10 دقیقه) )

* باعث " بستن فاکتور "  ، فاکتور ی که  تایید شده ، بعد از گذشت این زمان  می شود.

closeTimeOut

   مهلت معلق بودن فاکتور است و پس از گذشت این زمان از صدور فاکتور، و تاییدنشدن فاکتور ، فاکتور به صورت خودکار کنسل خواهد شد (به ثانیه و بالای 6 دقیقه)

willCancelAfterTimeout

خروجی

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

true/false

hasError

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

string

referenceNumber

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

{}

result

مقادیر خروجی

شناسه فاکتور   -  در سایر سرویسها تحت عنوان  invoiceId استفاده خواهد شد.

invoiceId

id

totalAmountWithoutDiscount

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

delegationAmount 

مبلغ تعیین شده برای محصول

totalAmount

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

payableAmount 

مالیات بر ارزش افزوده

vat

تاریخ ایجاد فاکتور

issuanceDate 

شناسه پرداخت

paymentBillNumber  

شناسه انحصاری فاکتور

uniqueNumber 

وضعیت پرداخت فاکتور

payed 

serial

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

canceled 

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

closed 

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

safe 

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

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

false

subInvoice

اگر فاکتور ویرایش شود ( کاهش داده شود ) این فیلد برابر true خواهد شد.

false

edited

وضعیت در انتظار تایید پرداخت بودن فاکتور  

false

waiting

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

referenceNumber 

وضعیت فعال بودن  پرداخت دو مرحله ای 

verificationNeeded  

اطلاعات کسب وکار صادر کننده فاکتور

{}

business

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

[]

invoiceItemSrvs

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

guildSrv

وضعیت فعال بودن  اعمال بن تخفیف در پرداخت 

postVoucherEnabled 

false

willBeBlocked"

false

willBePaid

مراجعه شود به فیلد  closeTimeOut  در بدنه درخواست

unsafeCloseTimeOut 

shaparakTransactionDate

9951435100120006/inv-69751014/265

depositId

9951435100120006/inv-69751014/265

depositBillId

کاربر صادر کننده فاکتور

issuerSrv

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

userSrv

caller

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

نمونه پاسخ

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

کد خطا

توضیح

10

INVALID_DATE - ارسال فرمت اشتباه تاریخ در پارامتر deadLine

19

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

21

client not authenticated – بیزنس توکن  ( توکن کسب­­وکار  )  وارد نشده است

25

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

37

INVALID_ELEMENT_CODE - کد صنف با فرمت صحیح موجود در پنل مدیریت کسب و کار، وارد نشده است.

39

PERMISSION_ACCESS_DENIED - در صورت عدم ارسال پارامتر ott با این خطا رو به رو می شوید. به منظور بازنشانی کردن ott ، سرویس دریافت توکن یکبار مصرف فراخوانی نمایید.

53

INVALID_BUSINESS_GUILD - اگر صنف انتخابی در پنل کسب و کار نباشد این خطا را دریافت خواهید نمود. ابتدا باید آن صنف را از پنل مدیریت کسب و کار، اضافه نمایید.

56

INVALID_GUILD_AMOUNT - پارامتر کد صنف به درستی ارسال نشده است.

66

INVOICE_SAME_BIZ_AND_CUSTOMER - اگر توکن(_token_) و شناسه ی کاربر(userId) ای که استفاده می نمایید متعلق به یک کسب و کار باشد، این خطا را دریافت می کنید. چرا که صدور فاکتور از کسب و کار خودتان برای خودتان امکان پذیر نیست.

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

194

INVALID_REQUEST_PARAMETER - کد تخفیف وارد شده اشتباه می‌باشد.

227

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

378

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

999

UNKNOWN- خطای داخلی

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

3880802

scProductId

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

scApikey

الزامی - شناسه فاکتور ، متعلق به همان شخص

invoiceId

الزامی – این پارامتر مقدار ثابت  PODLAND_WALLET را خواهد داشت .

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

PODLAND_WALLET

wallet

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

commissionWallet

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

commissionGuild

خروجی

نتیجه عملیات پرداخت فاکتور ، که در صورت موفق بودن پرداخت ، مقدار true را خواهد داشت .

result

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

نمونه پاسخ

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

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

39914

scProductId

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

scApiKey

رکورد شروع نمایش گزارش

0

offset

تعداد رکوردهای نمایش گزارش

size

شناسه بیزنس

businessId

palnId  مربوط به یک طرح برای  نمایش مشخصات همان یک طرح ،

اگر قصد دارید لیست طرح های کسب وکار را ببیند این پارامتر را ارسال ننمایید.

id

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result

شناسه طرح یا همان planId

id

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

39915

scProductId

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

scApiKey

الزامی - رکورد شروع نمایش گزارش

0

offset

الزامی - تعداد رکوردهای نمایش گزارش

size

نمایش براساس کاربر

userId

palnId مربوط به یک طرح برای  نمایش مشخصات همان یک طرح ،

اگر قصد دارید لیست طرح های کسب وکار را ببیند این پارامتر را ارسال ننمایید.

id

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result

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

id

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

39916

scProductId

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

scApiKey

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

ruleId

خروجی

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

true/false

hasError

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

string

referenceNumber

نتیجه ی نهایی سرویس  . در صورت لغو موفق ، حاوی مقدار true   خواهد بود.

string

result

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

ورودی

Header

اکسس توکن کاربر

userAccessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

39917

scProductId

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

scApiKey

شناسه مجوز

ruleId

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

شناسه سرویس

367386

scProductId

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

scApiKey

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

cellPhoneNumber

کد ملی  کاربر

nationalCode

شناسه SSO کاربر

ssoId

خروجی

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

true/false

hasError

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

string

referenceNumber

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

string

result

شناسه کاربر در پاد

id

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

ورودی

Header

اکسس توکن کاربر

userAccessToken

_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

سطح میزان احراز شده ی کاربر را مشخص میکند .

پایین ترین سطح 1 می‌باشد که تنها شماره موبایل کاربر در پلتفرم ثبت شده است .

سطح 2  ، کاربر شماره موبایل خود را  با پاسخ دادن به OTP تایید کرده باشد که در این صورت کد ملی وی در پلتفرم ثبت میگردد.

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

سطح 4 ، کاربر با استفاده از اپلیکیشن های پاد ، احراز هویت تصویری نموده است .

بالاترین سطح 5 می‌باشد، که کاربر از طریق اینترنت بانک در پاد لاگین کرده باشد .

financialLevelSrv

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

registeredInSayyah

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

ورودی

Header

توکن ثابت کسب وکار  

Business Token

_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

سطح میزان احراز شده ی کاربر را مشخص میکند .

پایین ترین سطح 1 می‌باشد که تنها شماره موبایل کاربر در پلتفرم ثبت شده است .

سطح 2  ، کاربر شماره موبایل خود را  با پاسخ دادن به OTP تایید کرده باشد که در این صورت کد ملی وی در پلتفرم ثبت میگردد.

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

سطح 4 ، کاربر با استفاده از اپلیکیشن های پاد ، احراز هویت تصویری نموده است .

بالاترین سطح 5 می‌باشد، که کاربر از طریق اینترنت بانک در پاد لاگین کرده باشد .

financialLevelSrv

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

registeredInSayyah

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

نمونه پاسخ

توضیحات

مقدار

نام پارامتر

ورودی

Header

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

yourBusinessToken

_token_

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

1

_token_issuer_

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

application/x-www-form-urlencoded

Content-Type

Body

مشخصه نحوه ی درخواست اکسس توکن – این مقدار   refresh_token  ثابت است ، و به SSO   این موضوع را اعلام میکند ، که دریافت اکسس توکن براساس  refresh_token دریافتی  در ورودی سرویس انجام شود .

refresh_token

grant_type

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

refresh_token

شناسه کلید اتصال

client_id

رمز کلید اتصال

client_secret

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

redirect_uri

خروجی

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

access_token

زمان انقضای توکن براساس ثانیه

expires_in

با استفاده از این توکن ، میتوانید مجدد اکسس توکن کاربر را بدون نیاز به انجام لاگین در اینترنت بانک دریافت نمایید. باید از سرویس دریافت اکسس توکن از طریق refresh_token اقدام نمایید.

refresh_token

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

scope

نوع توکن ایجاد شده .

token_type

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

نمونه پاسخ

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

کد خطا

توضیح

21

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

227

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

378

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