# سرویس تسویه حساب

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

# احراز هویت

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

مهم

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

method:post
https://pay.ir/api/v1/authenticate

# پارامتر

فیلد نوع توضیحات
mobile String شماره موبایل ثبت نام شده در pay.ir
password String کلمه عبور

# استعلام شماره شبا

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

method:post
https://pay.ir/api/v1.2/cashout/inquiry?token={your-token}

# پارامتر

فیلد نوع توضیحات
sheba String شماره شبا 24 رقمی بدون IR

# درخواست تسویه حساب

با این متد میتونید درخواست تسویه حساب از موجودی کیف پول تون برای شماره شبای مدنظر ثبت کنید پارامترهای موجود در جدول زیر رو با متد Post به ادرس زیر ارسال کنید

مهم

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

method:post
https://pay.ir/api/v1.2/cashout/request?token={your-token}

# پارامتر

فیلد نوع توضیحات
amount String مبلغ به ریال
name String نام صاحب حساب دریافت کننده
sheba String شماره شبای بانک مقصد
uid String شناسه یکتا به ازای هر درخواست

# استعلام وضعیت تسویه حساب

با این متد میتونید اطلاعات تسویه حسابی که ثبت کردید رو دریافت و در دیتابیس تون برای نمایش به کاربر ذخیره کنید

method:post
https://pay.ir/api/v1/cashout/status?token={your-token}

# پارامتر

فیلد نوع توضیحات
id Integer شناسه تسویه حساب

# حذف درخواست تسویه حساب

با استفاده از این متد قادر خواهید بود درخواست تسویه حسابی که ثبت کردید رو حذف کنید. درخواست های ثبت شده تا قبل از اقدام به پرداخت توسط شبکه پرداخت پی قابل حذف هستن

method:post
https://pay.ir/api/v1.2/cashout/delete?token={your-token}

# پارامتر

فیلد نوع توضیحات
id Integer شناسه تسویه حساب دریافتی هنگام ثبت درخواست

# پیگیری درخواست ثبت شده

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

method:post
https://pay.ir/api/v1.2/cashout/track?token={your-token}

# پارامتر

فیلد نوع توضیحات
uid String شناسه یکتا به ازای هر درخواست

# دریافت لیست تراکنش ها

با این متد میتونید لیست تراکنش های ثبت شده در پنل کاربری تون رو دریافت و در پلتفرم تون ذخیره کنید

method:post 
https://pay.ir/api/v1/transaction/get?token={your-token}

# پارامتر

فیلد نوع توضیحات
from_date DateTime 2018-10-10
to_date DateTime 2018-10-10
from_amount Integer از مبلغ (ریال)
to_amount Integer تا مبلغ (ریال)
transaction_id Integer شماره تراکنش
card_number String شماره کارت
factor_number String شماره فاکتور

# دریافت موجودی کیف پول

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

method:post
https://pay.ir/api/v1/wallet/balance?token={your-token}