کیفپول پیاستار ( تسویه )
#
وبسرویس های برداشت کیفبرای فراخوانی وبسرویس های کیف پول ابتدا api key مربوط به کیف پول را از پنل کاربری و قسمت ویرایش کیف پول کپی کنید و آن را در header درخواستها و در قسمت Authorization ، به صورت
Bearer <TOKEN>
ارسال کنید. لازم به ذکر میباشد، api key به مدت 24 ساعت معتبر میباشد و برای ایجاد api key جدید باید با فراخوانی وبسرویس refresh api key و با ارسال
refresh token اقدام کنید.
وبسرویس refresh api key
https://core.paystar.ir/api/wallet/refresh-api-key
برای دریافت api key جدید، سرویس بالا با متد POST فراخوانی شود. لازم به ذکر است که باید api key قبلی در این وبسرویس هم مشابه سایر وبسرویسها در Header ارسال شود.
پارامترهای ورودی
نام فیلد | نوع داده | شرح | اجباری |
---|---|---|---|
wallet_hashid | string | شناسه کیف پول | بله |
password | string | رمز دسترسی کیف پول | بله |
refresh_token | string | توکن بازیابی api key | بله |
sign | string | امضا | بله |
لازم به ذکر است با استفاده از sign key که برای شما ایمیل شده است و متد HMAC و الگوریتم SHA512 مقدار عبارت زیر را امضا کرده و در وبسرویسها ارسال کنید:
#
وبسرویس ایجاد درخواست برداشتبه منظور ايجاد درخواست برداشت، بايد سرويس زير با متد POST فراخوانی شود:
https://core.paystar.ir/api/wallet/create-settlement
پارامترهای ورودی
نام فیلد | نوع داده | شرح | اجباری |
---|---|---|---|
wallet_hashid | string | شناسه کیف پول | بله |
withdraw_type | integer | عدد ثابت 7 ارسال شود | بله |
transfers | array | آرایه ای از آبجکت ها به شرح جدول زیر | بله |
password | string | رمز دسترسی کیف پول | بله |
sign | string | امضا | بله |
جدول نوع داده transfers
عنوان | نوع داده | شرح |
---|---|---|
amount | integer | مبلغ تراکنش |
destination_number | string | شماره حساب مقصد که میتوانید شماره حساب بانکی یا شماره شبا (26 کاراکتر) باشد (اگر حساب شما در بانک شامل کاراکتر اضافه مانند خط تیره میباشد با همان فرمت در پارامتر استفاده کنید) |
destination_firstname | string | نام صاحب حساب مقصد (حداقل 2 و حداکثر 30 کاراکتر) |
destination_lastname | string | نام خانوادگی صاحب حساب مقصد (حداقل 2 و حداکثر 30 کاراکتر ) |
track_id | string | این فیلد اختیاری و حداکثر 50 کاراکتر است. میتوانید با track id یکتا، از ایجاد دوباره یک تراکنش جلوگیری کنید. در صورت ورود track id تکراری خطا دریافت میکنید. فقط برای تراکنش های زیر یکصد میلیون تومان میتوانید track id ارسال کنید |
حتی اگر یک درخواست برداشت هم ارسال میکنید باید مطابق مستندات به صورت آرایه یک عضوی ارسال شود، در غیر این صورت خطا دریافت میکنید. لازم به ذکر در صورتی که برداشت آنی برای کیف شما فعال شده باشد، میتوانید با ارسال عدد 8 برای فیلد withdraw_type درخواست برداشت آنی ارسال کنید. در صورت ایجاد برداشت آنی، امکان لغو درخواست برداشت وجود ندارد. برای درخواستهای برداشت محدودیت فاصله زمانی تعریف شده است، لذا درخواستهای برداشت را به صورت گروهی در یک request ارسال کنید.
#
وبسرویس لغو درخواست برداشتبرای لغو درخواست برداشتی که در وضعیت pending (در انتظار) قرار دارد ، باید سرویس زیر را با متد POST فراخوانی کنید:
https://core.paystar.ir/api/wallet/cancel-settlement
پارامترهای ورودی
نام فیلد | نوع داده | شرح | اجباری |
---|---|---|---|
settlement_request_id | string | شناسه درخواست برداشت | بله |
wallet_hashid | string | شناسه کیف پول | بله |
password | string | رمز دسترسی کیف پول | بله |
sign | string | امضا | بله |
#
وبسرویس دریافت لیست درخواستهای برداشتجهت دريافت لیست درخواستهای برداشت، سرويس زير با متد GET فراخوانی گردد:
https://core.paystar.ir/api/wallet/settlement-requests
پارامترهای ورودی
نام فیلد | نوع داده | شرح | اجباری |
---|---|---|---|
wallet_hashid | string | شناسه کیف پول | بله |
settlement_request_id | string | شناسه درخواست برداشت | خیر |
track_id | string | کد رهگیری | خیر |
limit | integer | تعداد رکوردهای response | در صورت وارد کردن skip |
skip | integer | تعداد رکورد هایی که skip شوند | در صورت وارد کردن limit |
#
وبسرویس دریافت موجودی هاجهت دريافت لیست موجودی کیفپول، سرویس زیر را با متد GET فراخوانی کنید:
https://core.paystar.ir/api/wallet/wallets-balance
پارامترهای ورودی
نام فیلد | نوع داده | شرح | اجباری |
---|---|---|---|
wallet_hashid | string | شناسه کیف پول | بله |
با فراخوانی وبسرویس بالا موجودی کل کیف پول، موجودی قابل برداشت، موجودی در حال شارژ و موجودی در حال برداشت برگردانده میشود. مبلغ موجودی قابل برداشت بدون احتساب کارمزد برداشت ارائه شده است لذا تمام این مبلغ قابل برداشت نخواهد بود.
#
وبسرویس دریافت بانک های فعالبرای فراخوانی وبسرویس های کیف پول ابتدا api key مربوط به کیف پول را از پنل کاربری و قسمت ویرایش کیف پول کپی کنید و آن را در header درخواستها و در قسمت Authorization ، به صورت
Bearer <TOKEN>
ارسال کنید. لازم به ذکر میباشد، api key به مدت 24 ساعت معتبر میباشد و برای ایجاد api key جدید باید با فراخوانی وبسرویس refresh api key و با ارسال
refresh token اقدام کنید.
وبسرویس get bank status
https://core.paystar.ir/api/wallet/get-bank-status
برای دریافت لیست بانک ها، سرویس بالا با متد GET فراخوانی شود.
پارامترهای ورودی
نام فیلد | نوع داده | شرح | اجباری |
---|---|---|---|
wallet_hashid | string | شناسه کیف پول | بله |
این وب سرویس به منظور دریافت دریافت لیست بانک های فعال صورت می گیرد دصورتی که شبا مقصد از بانک های فعال باشد واریز داخلی (آنی) و در غیر این صورت واریز پایا انجام می گردد.
پارامتر های خروجی
عنوان | نوع داده | شرح |
---|---|---|
bank name | string | وضعیت بانک (active و inactive ) |