Skip to main content

کیف‌پول پی‌استار ( تسویه )

وبسرویس های برداشت کیف#

برای فراخوانی وبسرویس های کیف پول ابتدا api key مربوط به کیف پول را از پنل کاربری و قسمت ویرایش کیف پول کپی کنید و آن را در header درخواستها و در قسمت Authorization ، به صورت

  • Bearer <TOKEN>

ارسال کنید. لازم به ذکر میباشد، api key به مدت 24 ساعت معتبر میباشد و برای ایجاد api key جدید باید با فراخوانی وبسرویس refresh api key و با ارسال
refresh‌ t‌oken اقدام کنید.

وبسرویس refresh api key

  • https://core.paystar.ir/api/wallet/refresh-api-key

برای دریافت api key جدید، سرویس بالا با متد POST فراخوانی شود. لازم به ذکر است که باید api key قبلی در این وبسرویس هم مشابه سایر وبسرویسها در Header ارسال شود.

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

نام فیلدنوع دادهشرحاجباری
wallet_hashidstringشناسه کیف پولبله
passwordstringرمز دسترسی کیف پولبله
refresh_tokenstringتوکن بازیابی api keyبله
signstringامضابله

لازم به ذکر است با استفاده از sign key که برای شما ایمیل شده است و متد HMAC و الگوریتم SHA512 مقدار عبارت زیر را امضا کرده و در وبسرویسها ارسال کنید:

WALLET_HASHID#PASSWORD

وبسرویس ایجاد درخواست برداشت#

به منظور ايجاد درخواست برداشت، بايد سرويس زير با متد POST فراخوانی شود:

  • https://core.paystar.ir/api/wallet/create-settlement

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

نام فیلدنوع دادهشرحاجباری
wallet_hashidstringشناسه کیف پولبله
withdraw_typeintegerعدد ثابت 7 ارسال شودبله
transfersarrayآرایه ای از آبجکت ها به شرح جدول زیربله
passwordstringرمز دسترسی کیف پولبله
signstringامضابله

جدول نوع داده transfers

عنواننوع دادهشرح
amountintegerمبلغ تراکنش
destination_numberstringشماره حساب مقصد که میتوانید شماره حساب بانکی یا شماره شبا (26 کاراکتر) باشد (اگر حساب شما در بانک شامل کاراکتر اضافه مانند خط تیره میباشد با همان فرمت در پارامتر استفاده کنید)
destination_firstnamestringنام صاحب حساب مقصد (حداقل 2 و حداکثر 30 کاراکتر)
destination_lastnamestringنام خانوادگی صاحب حساب مقصد (حداقل 2 و حداکثر 30 کاراکتر )
track_idstringاین فیلد اختیاری و حداکثر 50 کاراکتر است. میتوانید با track id یکتا، از ایجاد دوباره یک تراکنش جلوگیری کنید. در صورت ورود track id تکراری خطا دریافت میکنید. فقط برای تراکنش های زیر یکصد میلیون تومان میتوانید track id ارسال کنید

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

وبسرویس لغو درخواست برداشت#

برای لغو درخواست برداشتی که در وضعیت pending (در انتظار) قرار دارد ، باید سرویس زیر را با متد POST فراخوانی کنید:

  • https://core.paystar.ir/api/wallet/cancel-settlement

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

نام فیلدنوع دادهشرحاجباری
settlement_request_idstringشناسه درخواست برداشتبله
wallet_hashidstringشناسه کیف پولبله
passwordstringرمز دسترسی کیف پولبله
signstringامضابله

وبسرویس دریافت لیست درخواستهای برداشت#

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

  • https://core.paystar.ir/api/wallet/settlement-requests

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

نام فیلدنوع دادهشرحاجباری
wallet_hashidstringشناسه کیف پولبله
settlement_request_idstringشناسه درخواست برداشتخیر
track_idstringکد رهگیریخیر
limitintegerتعداد رکوردهای responseدر صورت وارد کردن skip
skipintegerتعداد رکورد هایی که skip شونددر صورت وارد کردن limit

وبسرویس دریافت موجودی ها#

جهت دريافت لیست موجودی کیف‌پول، سرویس زیر را با متد GET فراخوانی کنید:

  • https://core.paystar.ir/api/wallet/wallets-balance

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

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

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