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

اصطلاحات#

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

کاربر/ پذیرنده: شخصی که در پنل پی استار حساب کاربری ایجاد کرده است.

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

apiKey :یک توکن برای احراز هویت کاربر و دسترسی به اپليکيشن، به منظور فراخوانی وبسرویس‌های دریافت دسترسی حساب و انتقال وجه است. این توکن باید در تمامی وبسرویس‌ها به عنوان توکن bearer در هدر authorization ارسال شود.

refreshToken :توکن apiKey به مدت 24 ساعت معتبر است. لذا برای ایجاد apiKey جدید به refreshToken نياز مي‌باشد.

applicationId : شناسه اپليکيشن، که بعد از ایجاد اپليکيشن در اختيار کاربر قرار مي‌گيرد.

accessPassword :رمز دسترسی به اپليکيشن، که بعد از ایجاد اپليکيشن در اختيار کاربر قرار مي‌گيرد.

accessIp :آی پی های مجاز برای فراخوانی وبسرویس‌ها که در اپليکيشن تنظيم شده اند.

وبسرویس refresh api key#

https://core.paystar.ir/api/application/refresh-api-key

برای‌ دریافت apiKey جدید ،سرویس بالا با متد POST فراخوانی شود.

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
refresh_token	string	توکن بازیابی API key	بله

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

{
    “status”: "ok",
    “data”: {
       “api_key”: “...”,
       “api_key_expire_date”: “...”
    },
}

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

https://core.paystar.ir/api/bank-transfer/v2/settlement

پس از گرفتن دسترسی به حساب بانکی، برای انتقال وجه باید وبسرویس بالا را با متد POST فراخوانی کنيد.

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
bank	string	رشته کاراکتری "016" برای بانک کشاورزی ارسال شود	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
transfers	array	آرایه‌ای از لیست درخواست‌های انتقال وجه که هر درخواست یک object به فرمت جدول زیر می‌باشد	بله

وبسرویس دریافت لیست درخواست‌های انتقال وجه#

https://core.paystar.ir/api/bank-transfer/settlement-requests

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

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

نام فیلد	نوع داده	شرح	اجباری
application_id	string	شناسه اپلیکیشن	بله
access_password	string	رمز دسترسی اپلیکیشن	بله
deposit	string	شماره حساب بانک که در اپلیکیشن ثبت شده است	خیر
track_id	string	کد رهگیری	خیر
limit	integer	تعداد رکورد‌های پاسخ	درصورت وارد کردن skip
skip	integer	تعدادرکورد‌هایی که رد شوند	درصورت وارد کردن limit