API های وندار بر اساس استاندارد REST ایجاد شده اند.
تمامی پاسخ API های ما بصورت JSON-encoded پاسخ داده خواهند شد.
بوسیله ارسال توکن در هر درخواست، احراز هویت نیز انجام می شود. (ممکن است در برخی از سرویس ها نحوه احراز هویت متفاوت باشد)
API های وندار بر اساس استاندارد REST ایجاد شده اند.
تمامی پاسخ API های ما بصورت JSON-encoded پاسخ داده خواهند شد.
بوسیله ارسال توکن در هر درخواست، احراز هویت نیز انجام می شود. (ممکن است در برخی از سرویس ها نحوه احراز هویت متفاوت باشد)
https://api.vandar.io
برای دریافت توکن و رفرش توکن اولیه مالک یا مدیر کسب و کار می تواند وارد داشبورد وندار شود و کسب و کار خود را انتخاب کند. و از منوی تنظیمات بخش تنظیمات مدیریت حساب، توکن ها را انتخاب کنید. و با زدن دکمه افزودن توکن جدید، و وارد کردن یک نام برای توکن و وارد کردن رمز عبور حساب کاربری خود یک توکن و رفرش توکن در یافت کنید.
از آنجاییکه عمر توکن ها محدود است و مقدار آن در فیلد expires_in (بر مبنای ثانیه) همراه توکن ارسال شده است، باید قبل از منقضی شدن توکن با ارسال رفرش توکن، توکن جدید را دریافت کنید.
مقداری که از فراخوانی متد قبل دریافت کردهاید
var request = require('request')
var options = {
method: 'POST',
url: '/v3/refreshtoken',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
refreshtoken: '{refreshtoken}'
})
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"token_type": "Bearer",
"expires_in": 432000,
"access_token": "bPJO9cJLGRqClDadEua7ztoCLC5E***********",
"refresh_token": "def50200c4d2462d2de167da1*******"
}
جهت تست و توسعه سرویسها از کالکشن پستمن وندار استفاده نمایید.
کلیه سرویسهای وندار در کالکشن ارائه شده موجود میباشد، برای تست API ها کافیست نام انگلیسی کسبوکار خود را بجای پارامتر business و اکسس توکن دریافتی از وندار را در پارامتر access_token ارسال نمائید.
نام انگلیسی کسبوکار در داشبورد وندار، بخش تنظیمات،اطلاعات پایه و در فیلد نام انگلیسی برند موجود میباشد.
API های وندار از قواعد HTTP response پیروی میکند.
بطور کلی در رنج 2xx
پاسخ های موفق را دریافت میکنید.
رنج 4xx
زمانی بوجود میآید که اطلاعات اشتباهی از سمت شما به API ها ارسال شده است.
خطاهایی در رنج 5xx
نشان دهنده مشکلاتی از سمت API های وندار بوده که می توانید آن را با پشتیبانی مطرح کنید.
200 - OK | Everything worked as expected. |
400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 - Unauthorized | No valid API key provided. |
402 - Request Failed | The parameters were valid but the request failed. |
403 - Forbidden | The API key doesn't have permissions to perform the request. |
برای فروشگاههای اینترنتی که خدمات یا محصولاتی را در وبسـایت خود ارائه میکنند، از درگاه پرداخت وندار استفاده کنید.
POST https://ipg.vandar.io/api/v4/send
GET https://ipg.vandar.io/v4/:token
POST https://ipg.vandar.io/api/v4/transaction
POST https://ipg.vandar.io/api/v4/verify
با استفاده از سرویس تسویه میتوانید مبلغ موردنظر از کیف پول کسب و کار خود به مقصد شبای دلخواه (تمامی شباهای سامانه بانکی کشور) واریز نمائید.
POST /v3/business/:business/settlement/store
GET /v2.1/business/:business/settlement
GET /v2.1/business/:business/settlement/:settlement_id
DELETE /v2.1/business/:business/settlement/:transaction_id
GET /v3/business/:business/settlement/banks
با استفاده از سرویس تسویه گروهی میتوانید تسویه های خود به صورت دسته ای (گروهی) یکجا ثبت نمائید.
POST https://batch.vandar.io/api/v2/business/:business/batches-settlement
GET https://batch.vandar.io/api/v2/business/:business/batches
GET https://batch.vandar.io/api/v2/business/:business/batch-settlements/:batch_id
با استفاده از سرویس تسویه در نوبت میتوانید هنگامی که کیف پول شما به اندازه کافی موجودی ندارد، تسویه های خود ثبت نمائید و پس از اینکه کیف پول شما افزایش پیدا کرد این تسویهها به بانک ارسال میشود.
POST /v3/business/:business/settlement/queued
GET /v3/business/:business/settlement/queued
GET /v3/business/:business/settlement/queued/:id
POST /v3/business/:business/settlement/queued/cancel
ابزار «واریز بانکی» یا به اصطلاح ،cash in یکی از بهترین روشهای شارژ کیف پول کسبوکار ها است. کسب و کارهایی که مبالغ زیادی از حساب آنها برداشته میشود، با استفاده از این ویژگی میتوانند مبلغی را از حساب بانک آینده خود به کیف پول خود در وندار اضافه کرده و پس از آن تعیین کنند که چه مقدار وجه از کیف پولشان خارج شود.
GET /v3/business/:business/cash-in/account
POST /v3/business/:business/cash-in/account/deposit
POST /v3/business/:business/cash-in/account/balance
«واریز شناسهدار»، سرویس مکمل سایر روشهای پرداخت است که افراد و سازمانها از آن استفاده میکنند. به کمک این سرویس، میتوانید بدون محدودیت در شبکه بانکی، پرداخت و دریافت وجه داشته باشید. این سرویس به صورت پیشفرض برای همه کسبوکارهای فعال، قابل استفاده بوده و برای هر کسبوکار یک شناسه یکتا منحصر به فرد تخصیص مییابد. با استفاده از «واریز شناسهدار» این امکان وجود دارد که با واریز وجه از همه بانکهایی که در آن حساب دارید، موجودی «کیف پول وندار» خود را افزایش دهید.
GET /v3/business/:business/cash-in/code
GET /v3/business/:business/cash-in/suspicious-payment
POST /v3/business/:business/cash-in/suspicious-payment/:id
سرویس پرداخت خودکار یا دایرکت دبیت سرویسی است که یک فرد وجوهی را از حساب بانکی شخص دیگری خارج می کند در واقع شما به بانک اجازه می دهید که مبلغی را مستقیما از حسابتان کسر و در قبال آن خدماتی را به شما ارایه دهد. به طور کلی دایرکت دبیت برداشت مستقیم پول برای انجام معاملات مالی در صورت صدور مجوز توسط پرداخت کننده می باشد. این کار بیشتر زمانی انجام می شود که شما بخواهید اشتراک خود را تمدید کنید.
لیست بانکهای فعال دایرکتدبیت برای کسبوکار شما از طریق این سرویس قابل دسترس میباشد. همچنین امکان مدیریت بانکها در داشبورد وندار، بخش پرداخت خودکار فراهم میباشد.
GET /v3/business/:business/subscription/banks/actives
جهت دسترسی به حساب در سرویس پرداخت خودکار، نیاز به ایجاد یک مجوز در بانک وجود دارد. بر اساس این مجوز، کسبوکار شما اجازه برداشت از حساب کاربر را خواهد داشت.
POST /v3/business/:business/subscription/authorization/store
GET https://subscription.vandar.io/authorizations/:token
PATCH /v3/business/:business/subscription/authorization/:authorization_id/verify
GET /v3/business/:business/subscription/authorization/:authorization_id/search
GET /v3/business/:business/subscription/authorization
GET /v3/business/:business/subscription/authorization/:authorization_id/calculation
DELETE /v3/business/:business/subscription/authorization/:authorization_id
در این سرویس میتوانید از حساب کاربران خود یکبار یا به صورت دورهای بر اساس مجوزی که از کاربر گرفتهاید، وجهی را برداشت نمایید.
POST /v3/business/:business/subscription/withdrawal/store
GET /v3/business/:business/subscription/withdrawal/:withdrawal_id
GET /v3/business/:business/subscription/withdrawal/track-id/:track_id
GET /v3/business/:business/subscription/withdrawal
GET /v3/business/:business/subscription/withdrawal?q=:authorization_id
PUT /v3/business/:business/subscription/withdrawal/:withdrawal_id
این سرویس را میتوانید تا سقف محدودیت مبلغ و تعداد برداشت تعیین شده برای مجوز فراخوانی نمایید.
نام انگلیسی کسب و کار
شناسه دریافتی در بخش ایجاد مجوز که میخواهید مبلغ از آن مجوز برداشت شود.
مبلغ برداشت وجه
اجباری در حالت is_instant=0
: تاریخی که در آن روز از حساب برداشت شود. روز معین شده باید بعد از روز جاری باشد.
این پارامتر مشخص میکند که برداشت وجه در همین لحظه انجام شود یا در آینده. مقدار این پارامتر می تواند 0 یا 1 باشد. 1 به معنای این که برداشت در لحظه انجام شود و 0 به این معنا که برداشت در آینده انجام شود. در صورت عدم ارسال، 1 در نظر گرفته میشود.
آدرس وبهوکی که میتوانید ارسال کنید تا از وضعیت نهایی این برداشت وجه مطلع شوید که طول آن نباید بیشتر از ۲۰۴۸ کاراکتر باشد. در مواقع تست میتوانید از وبسایت webhook.siteاستفاده کنید.
حداکثر تعداد دفعاتی که میخواهید برای این برداشت وجه تلاش شود. حداقل ۱ و حداکثر ۱۶ مرتبه میتوان برای یک برداشت وجه تلاش کرد. دقت داشته باشید که در صورت عدم ارسال این پارامتر، مقدار آن برابر با ۱ در نظر گرفته میشود. همچنین در نظر داشته باشید این پارامتر برای برداشت وجههای آنی (is_instant: 1) برابر با ۱ در نظر گرفته میشود (و برداشت وجه آنی بلافاصله پس از استعلام (نمایش برداشت وجه - withdrawal show)، تعیین وضعیت میشود که حالت FAILED است یا DONE). در صورتی که برداشت وجه به صورت آنی نباشد (is_instant: 0) اگر برداشت وجه موفقیتآمیز باشد (status: DONE) که دیگر تلاشی صورت نمیگیرد، اما اگر برداشت وجه به هر دلیل موفقیتآمیز نباشد، تا زمانی که برداشت وجه موفقیتآمیز شود و یا مقدار retry_count به تعداد max_retry_count برسد سعی به برداشت وجه صورت میگیرد. لازم به ذکر است که تا زمانی که برداشت وجه موفقیتآمیز نباشد وضعیت آن برداشت وجه به حالت PENDING است و فقط زمانی که مقدار retry_count به max_retry_count (ارسالی از شما) برسد و هنوز برداشت وجه موفقیتآمیز نبوده باشد دیگر تلاشی برای برداشت وجه صورت نمیگیرد و وضعیت آن برداشت وجه از حالت PENDING به حالت FAILED تبدیل میشود.
توضیحات اختیاری برای ثبت برداشت وجه
شناسه پیگیری که به ازای هر درخواست برداشت باید یکتا باشد. پیشنهاد ما استفاده از uuid برای این پارامتر میباشد. این پارامتر به حروف بزرگ و کوچک حساس است. با استفاده از این پارامتر می توان در سرویس نمایش برداشت وجه بر اساس شناسه پیگیری که در ادامه توضیح داده می شود از جزییات برداشت وجه مطع شوید.
مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
پیغام درخواست برداشت وجه با موفقیت ثبت شد.
شناسه درخواست برداشت وجه
شناسه مجوز پرداخت از حساب
تعداد دفعات تلاش برای برداشت وجه
حداکثر تعداد دفعات تلاش برای برداشت وجه
شناسه یکتای تراکنش برداشت وجه
شناسه بازگشت وجه
مبلغ برداشت وجه
کارمزد
اطلاعات حساب مشتری
شناسه پرداخت
شناسه پیگیری
وضعیت درخواست برداشت وجه
PENDING
|
INIT
|
DONE
|
FAILED
|
CANCELED
|
REVERSED
|
توضیحات
تاریخ درخواست برداشت وجه ارسالی توسط شما
آدرس وبهوکی که میتوانید ارسال کنید تا از وضعیت نهایی این برداشت وجه مطلع شوید که طول آن نباید بیشتر از ۲۰۴۸ کاراکتر باشد. لازم به ذکر است که متد POST برای ارسال به این آدرس در نظر گرفته شده است و فیلدهای withdrawal_id, authorization_id, gateway_transaction_id, status, amount, wage_amount, payment_number, error_code و error_message برای شما ارسال میشود. در شرایطی که شما در حال تست هستید میتوانید از وبسایت webhook.site استفاده کنید.
نشان دهنده این است که برداشت وجه به صورت آنی انجام شده است یا خیر.
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا کد خطا برگردانده میشود)
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا متن خطا برگردانده میشود)
var request = require('request')
var options = {
method: 'POST',
url: '/v3/business/:business/subscription/withdrawal/store',
headers: {
Accept: 'application/json',
Authorization: 'Bearer token',
'Content-Type': 'application/json'
},
body: JSON.stringify({
authorization_id: '9f307e30-dc77-11ea-830e-7533ca1787c5',
amount: '10000',
withdrawal_date: '2020-07-04',
is_instant: 1,
notify_url: 'https://yourdomain.com/notify/me',
max_retry_count: 1,
description: 'تست',
track_id: 'd2c5bf5a-280f-4ee5-8888-3d220b63bcc0'
})
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"status": 1,
"message": "درخواست برداشت وجه با موفقیت ثبت شد.",
"result": {
"withdrawal": {
"id": "8c6e27c0-dbbd-11ea-a2f6-e9c8bf97463f",
"authorization_id": "9f307e30-dc77-11ea-830e-7533ca1787c5",
"retry_count": 1,
"max_retry_count": 1,
"gateway_transaction_id": "159714176734",
"refund_id": null,
"amount": "10000",
"wage_amount": "200",
"payment_number": null,
"payer_account": {
"account_number": "807-021-2254034-1",
"pan": "621986******0808"
},
"track_id": "d2c5bf5a-280f-4ee5-8888-3d220b63bcc0",
"status": "INIT",
"description": null,
"withdrawal_date": "1399/05/21",
"notify_url": "https://yourdomain.com/notify/me",
"is_instant": 1,
"error_code": null,
"error_message": null
}
}
}
جهت نمایش جزئیات و استعلام وضعیت یک برداشت وجه از این سرویس استفاده نمایید. در پاسخ این سرویس امکان دریافت شماره حساب مشتری را خواهید داشت. توجه داشته باشید که برخی بانکها بعد از یک ساعت اطلاعات حساب پرداختکننده را در اختیار وندار قرار داده و ممکن است با تاخیر، اطلاعات حساب مشتری بروزرسانی شود.
نام انگلیسی کسب و کار
شناسه برداشت وجه
مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
پیغام برداشت وجه با موفقیت به نمایش درآمد.
شناسه درخواست برداشت وجه
شناسه مجوز پرداخت از حساب
تعداد دفعات تلاش برای برداشت وجه
حداکثر تعداد دفعات تلاش برای برداشت وجه
شناسه یکتای تراکنش برداشت وجه
شناسه بازگشت وجه
مبلغ برداشت وجه
کارمزد
شناسه بانکی برداشت وجه
اطلاعات حساب مشتری
شناسه پیگیری
وضعیت درخواست برداشت وجه
PENDING
|
INIT
|
DONE
|
FAILED
|
CANCELED
|
REVERSED
|
توضیحات
تاریخ درخواست برداشت وجه ارسالی توسط شما
آدرس وبهوک ارسالی جهت اطلاع از وضعیت تراکنش
نشان دهنده این است که برداشت وجه به صورت آنی انجام شده است یا خیر.
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا کد خطا برگردانده میشود)
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا متن خطا برگردانده میشود)
var request = require('request')
var options = {
method: 'GET',
url: '/v3/business/:business/subscription/withdrawal/:withdrawal_id',
headers: {
Accept: 'application/json',
Authorization: 'Bearer token',
'Content-Type': 'application/json'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"status": 1,
"message": "برداشت وجه با موفقیت به نمایش درآمد.",
"result": {
"withdrawal": {
"id": "f3d084e0-b603-11ea-94ad-ebc7f5bf8e12",
"authorization_id": "9f307e30-dc77-11ea-830e-7533ca1787c5",
"retry_count": 1,
"max_retry_count": 1,
"gateway_transaction_id": 159281892196,
"refund_id": "9f307e30-dc77-11ea-830e-7533ca1787c6",
"amount": "10000",
"wage_amount": "200",
"payment_number": null,
"payer_account": {
"account_number": "807-021-2254034-1",
"pan": "621986******0808"
},
"track_id": "d2c5bf5a-280f-4ee5-8888-3d220b63bcc0",
"status": "DONE",
"description": null,
"withdrawal_date": "1399/04/04",
"notify_url": "http://yourdomain.com/notify/me",
"is_instant": 1,
"error_code": null,
"error_message": null
}
},
}
}
در صورتی که شناسه پیگیری یکتا سرویس خود را هنگام ثبت درخواست برداشت وجه ارسال میکنید، میتوانید از طریق این سرویس جزئیات و استعلام یک برداشت وجه را بر اساس این شناسه دریافت نمایید. در پاسخ این سرویس امکان دریافت شماره حساب مشتری را خواهید داشت. توجه داشته باشید که برخی بانکها بعد از یک ساعت اطلاعات حساب پرداختکننده را در اختیار وندار قرار داده و ممکن است با تاخیر، اطلاعات حساب مشتری بروزرسانی شود.
نام انگلیسی کسب و کار
شناسه پیگیری
مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
پیغام برداشت وجه با موفقیت به نمایش درآمد.
شناسه درخواست برداشت وجه
شناسه مجوز پرداخت از حساب
تعداد دفعات تلاش برای برداشت وجه
حداکثر تعداد دفعات تلاش برای برداشت وجه
شناسه یکتای تراکنش برداشت وجه
شناسه بازگشت وجه
مبلغ برداشت وجه
کارمزد
شناسه بانکی برداشت وجه
اطلاعات حساب مشتری
شناسه پیگیری
وضعیت درخواست برداشت وجه
PENDING
|
INIT
|
DONE
|
FAILED
|
CANCELED
|
REVERSED
|
توضیحات
تاریخ درخواست برداشت وجه ارسالی توسط شما
آدرس وبهوک ارسالی جهت اطلاع از وضعیت تراکنش
نشان دهنده این است که برداشت وجه به صورت آنی انجام شده است یا خیر.
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا کد خطا برگردانده میشود)
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا متن خطا برگردانده میشود)
var request = require('request')
var options = {
method: 'GET',
url: '/v3/business/:business/subscription/withdrawal/track-id/:track_id',
headers: {
Accept: 'application/json',
Authorization: 'Bearer token',
'Content-Type': 'application/json'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"status": 1,
"message": "برداشت وجه با موفقیت به نمایش درآمد.",
"result": {
"withdrawal": {
"id": "f3d084e0-b603-11ea-94ad-ebc7f5bf8e12",
"authorization_id": "9f307e30-dc77-11ea-830e-7533ca1787c5",
"retry_count": 1,
"max_retry_count": 1,
"gateway_transaction_id": 159281892196,
"refund_id": "9f307e30-dc77-11ea-830e-7533ca1787c6",
"amount": "10000",
"wage_amount": "200",
"payment_number": null,
"payer_account": {
"account_number": "807-021-2254034-1",
"pan": "621986******0808"
},
"track_id": "d2c5bf5a-280f-4ee5-8888-3d220b63bcc0",
"status": "DONE",
"description": null,
"withdrawal_date": "1399/04/04",
"notify_url": "http://yourdomain.com/notify/me",
"is_instant": 1,
"error_code": null,
"error_message": null
}
},
}
}
جهت مشاهده لیست تراکنشهای برداشت وجه از این سرویس استفاده نمایید.
نام انگلیسی کسب و کار
شناسه درخواست برداشت وجه
شناسه مجوز پرداخت از حساب
تعداد دفعات تلاش برای برداشت وجه
حداکثر تعداد دفعات تلاش برای برداشت وجه
شناسه یکتای تراکنش برداشت وجه
شناسه بازگشت وجه
مبلغ برداشت وجه
کارمزد
شناسه بانکی برداشت وجه
اطلاعات حساب مشتری
شناسه پیگیری
وضعیت درخواست برداشت وجه
PENDING
|
INIT
|
DONE
|
FAILED
|
CANCELED
|
REVERSED
|
توضیحات
تاریخ درخواست برداشت وجه ارسالی توسط شما
آدرس وبهوک ارسالی جهت اطلاع از وضعیت تراکنش
نشان دهنده این است که برداشت وجه به صورت آنی انجام شده است یا خیر.
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا کد خطا برگردانده میشود)
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا متن خطا برگردانده میشود)
آدرس اولین صفحه
آدرس آخرین صفحه
آدرس صفحه قبل
آدرس صفحه بعد
آدرس همین صفحه
شماره اولین آیتم که در این صفحه آمده است
تعداد کل صفحات
آرایه ای قابل استفاده برای نمایش pagination
آدرس خالص بدون صفحه بندی
تعداد آیتم در هر صفحه
شماره آخرین آیتمی که در این صفحه آمده است
تعداد کل آیتم ها
var request = require('request')
var options = {
method: 'GET',
url: '/v3/business/:business/subscription/withdrawal',
headers: {
Accept: 'application/json',
Authorization: 'Bearer token',
'Content-Type': 'application/json'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"data": [
{
"id": "f3d084e0-b603-11ea-94ad-ebc7f5bf8e12",
"authorization_id": "9f307e30-dc77-11ea-830e-7533ca1787c5",
"retry_count": 1,
"max_retry_count": 1,
"gateway_transaction_id": 159281892196,
"refund_id": "9f307e30-dc77-11ea-830e-7533ca1787c6",
"amount": "10000",
"wage_amount": "200",
"payment_number": null,
"payer_account": {
"account_number": "807-021-2254034-1",
"pan": "621986******0808"
},
"track_id": "d2c5bf5a-280f-4ee5-8888-3d220b63bcc0",
"status": "DONE",
"description": null,
"withdrawal_date": "1399/04/04",
"notify_url": "http://yourdomain.com/notify/me",
"is_instant": 1,
"error_code": null,
"error_message": null
},
{
"id": "88a2c1d0-ff9f-11eb-9054-d393c32ed3b6",
"authorization_id": "fa99a8f0-fb51-11eb-8a87-41af5f44fd0d",
"retry_count": 1,
"max_retry_count": 1,
"gateway_transaction_id": 162923462083,
"refund_id": null,
"amount": "11000",
"wage_amount": "0",
"payment_number": null,
"payer_account": {
"account_number": "807-021-2254034-1",
"pan": "621986******0808"
},
"track_id": "eb7dfff7-a752-402b-a46b-024545f06c76",
"status": "FAILED",
"description": null,
"withdrawal_date": "1400/05/27",
"notify_url": null,
"is_instant": 1,
"error_code": "01",
"error_message": "عدم کفایت موجودی"
},
...
],
"links": {
"first": "/v3/business/vandario/subscription/withdrawal?page=1",
"last": "/v3/business/vandario/subscription/withdrawal?page=33",
"prev": null,
"next": "/v3/business/vandario/subscription/withdrawal?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 33,
"links": [
{
"url": null,
"label": "« قبلی",
"active": false
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=1",
"label": "1",
"active": true
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=2",
"label": "2",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=32",
"label": "32",
"active": false
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=33",
"label": "33",
"active": false
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=2",
"label": "بعدی »",
"active": false
}
],
"path": "/v3/business/vandario/subscription/withdrawal",
"per_page": 20,
"to": 20,
"total": 656
}
}
جهت مشاهده لیست تراکنشهای برداشت وجه از یک مجوز از این سرویس استفاده نمایید.
نام انگلیسی کسب و کار
شناسه مجوز پرداخت از حساب
شناسه درخواست برداشت وجه
شناسه مجوز پرداخت از حساب
تعداد دفعات تلاش برای برداشت وجه
حداکثر تعداد دفعات تلاش برای برداشت وجه
شناسه یکتای تراکنش برداشت وجه
شناسه بازگشت وجه
مبلغ برداشت وجه
کارمزد
شناسه بانکی برداشت وجه
اطلاعات حساب مشتری
شناسه پیگیری
وضعیت درخواست برداشت وجه
PENDING
|
INIT
|
DONE
|
FAILED
|
CANCELED
|
REVERSED
|
توضیحات
تاریخ درخواست برداشت وجه ارسالی توسط شما
آدرس وبهوک ارسالی جهت اطلاع از وضعیت تراکنش
نشان دهنده این است که برداشت وجه به صورت آنی انجام شده است یا خیر.
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا کد خطا برگردانده میشود)
در زمان ثبت برداشت null می باشد (بعد از استعلام برداشت وجه در صورت وجود خطا متن خطا برگردانده میشود)
آدرس اولین صفحه
آدرس آخرین صفحه
آدرس صفحه قبل
آدرس صفحه بعد
آدرس همین صفحه
شماره اولین آیتم که در این صفحه آمده است
تعداد کل صفحات
آرایه ای قابل استفاده برای نمایش pagination
آدرس خالص بدون صفحه بندی
تعداد آیتم در هر صفحه
شماره آخرین آیتمی که در این صفحه آمده است
تعداد کل آیتم ها
var request = require('request')
var options = {
method: 'GET',
url: '/v3/business/:business/subscription/withdrawal?q=:authorization_id',
headers: {
Accept: 'application/json',
Authorization: 'Bearer token',
'Content-Type': 'application/json'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"data": [
{
"id": "f3d084e0-b603-11ea-94ad-ebc7f5bf8e12",
"authorization_id": "9f307e30-dc77-11ea-830e-7533ca1787c5",
"retry_count": 1,
"max_retry_count": 1,
"gateway_transaction_id": 159281892196,
"refund_id": "9f307e30-dc77-11ea-830e-7533ca1787c6",
"amount": "10000",
"wage_amount": "200",
"payment_number": null,
"payer_account": {
"account_number": "807-021-2254034-1",
"pan": "621986******0808"
},
"track_id": "d2c5bf5a-280f-4ee5-8888-3d220b63bcc0",
"status": "DONE",
"description": null,
"withdrawal_date": "1399/04/04",
"notify_url": "http://yourdomain.com/notify/me",
"is_instant": 1,
"error_code": null,
"error_message": null
},
{
"id": "88a2c1d0-ff9f-11eb-9054-d393c32ed3b6",
"authorization_id": "fa99a8f0-fb51-11eb-8a87-41af5f44fd0d",
"retry_count": 1,
"max_retry_count": 1,
"gateway_transaction_id": 162923462083,
"refund_id": null,
"amount": "11000",
"wage_amount": "0",
"payment_number": null,
"payer_account": {
"account_number": "807-021-2254034-1",
"pan": "621986******0808"
},
"track_id": "eb7dfff7-a752-402b-a46b-024545f06c76",
"status": "FAILED",
"description": null,
"withdrawal_date": "1400/05/27",
"notify_url": null,
"is_instant": 1,
"error_code": "01",
"error_message": "عدم کفایت موجودی"
},
...
],
"links": {
"first": "/v3/business/vandario/subscription/withdrawal?page=1",
"last": "/v3/business/vandario/subscription/withdrawal?page=33",
"prev": null,
"next": "/v3/business/vandario/subscription/withdrawal?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 33,
"links": [
{
"url": null,
"label": "« قبلی",
"active": false
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=1",
"label": "1",
"active": true
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=2",
"label": "2",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=32",
"label": "32",
"active": false
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=33",
"label": "33",
"active": false
},
{
"url": "/v3/business/vandario/subscription/withdrawal?page=2",
"label": "بعدی »",
"active": false
}
],
"path": "/v3/business/vandario/subscription/withdrawal",
"per_page": 20,
"to": 20,
"total": 656
}
}
جهت لغو دستور برداشت وجه از این سرویس استفاده نمایید.
نام انگلیسی کسب و کار
شناسه برداشت وجه
مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
پیغام برداشت وجه با موفقیت لغو گردید.
شناسهی برداشت وجهی که قصد کنسل کردن آن را داشتید.
var request = require('request')
var options = {
method: 'PUT',
url: '/v3/business/:business/subscription/withdrawal/:withdrawal_id',
headers: {
Accept: 'application/json',
Authorization: 'Bearer token',
'Content-Type': 'application/json'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"status": 1,
"message": "برداشت وجه با موفقیت لغو گردید.",
"result": {
"withdrawal": {
"id": "8c6e27c0-dbbd-11ea-a2f6-e9c8bf97463f"
}
}
}
لیست خطاهای دریافتی هنگام برداشت وجه ناموفق
در سرویسهای استعلام وضعیت برداشت وجه و همچنین در وبهوک ارسالی جهت اطلاع از وضعیت نهایی تراکنش، در صورتیکه تراکنش ناموفق باشد کد خطا در پارامتر error_code و شرح خطا در پارامتر error_message برگردانده می شود.
error_code | error_message |
00 | خطای داخلی، به ما اطلاع دادهشدهاست و در حال رفع آن هستیم |
01 | عدم کفایت موجودی |
02 | اختلال در شبکه سرویس دهنده |
03 | خطای سرور سرویس دهنده |
04 | سقف مجاز تعداد تراکنش روزانه این مجوز پر شده است |
05 | سقف مجاز تعداد تراکنش ماهانه این مجوز پر شده است |
06 | خطای سرویس دهنده |
07 | زمان تراکنش قبل از زمان مورد توافق در مجوز است |
08 | مبلغ نامعتبر است |
09 | مبلغ وارد شده بیش از حد مجاز روزانه است |
10 | واگذار کننده به عنوان مشتری بانک موردنظر ثبت نشده است |
11 | محدودیت سقف مجاز تراکنش در بانک |
12 | مجوز فعالی برای کاربر با شماره موبایل متفاوت وجود دارد |
13 | مجوز نامعتبر است |
14 | مجوز منقضی شده است |
15 | زمان انجام تراکنش برای این مجوز نامعتبر است |
16 | مشکل در سپرده بانکی کاربر |
17 | مجوز در بانک لغو شده است |
18 | کارت مبدا غیرفعال می باشد |
19 | کارت مبدا منقضی شده است |
20 | اطلاعات کارت نامعتبر است |
21 | سپرده متعلق به کاربر نیست یا عدم وجود حق برداشت |
22 | شماره سپرده نامعتبر است |
23 | پارامترهای ورودی به درستی وارد نشده اند |
24 | کارت یا سپرده نامعتبر می باشد |
25 | حساب فاقد کد شهاب می باشد |
28 | حساب مسدود است |
جهت بازگشت وجه یک تراکنش موفق پرداخت از حساب، میتوانید از این سرویس استفاده نمایید.
POST /v3/business/:business/subscription/refunds
GET /v3/business/:business/subscription/refunds/:refund_id
GET /v3/business/:business/subscription/refunds
میاندو برای خریدار هویت فروشنده و برای فروشنده، پرداخت مبلغ از سوی خریدار را تضمین میکند. خریدار مبلغ معامله را نزد میاندو به امانت میگذارد تا پس از ارائه کالا یا خدمت و تایید خریدار، این مبلغ برای فروشنده آزاد شود.
مشتریان در میاندو به اشخاصی اطلاق میشود که به عنوان طرفین معامله (خریدار، فروشنده) به خرید و فروش میپردازند.
POST /miando/api/v1/customers
GET /miando/api/v1/customers
GET /miando/api/v1/customers/:id
پیش نویسی است که پس از تایید طرفین به یک قرارداد بین فروشنده و خریدار در میاندو ثبت میشود.
POST /miando/api/v1/agreements
POST /miando/api/v1/agreements/:tracking_code
POST /miando/api/v1/agreements/:tracking_code/finalize
POST /miando/api/v1/agreements/:tracking_code/cancel
GET /miando/api/v1/agreements
GET /miando/api/v1/agreements/:tracking_code
اگر در روند معامله مشکلی پیش آمد میتوانید با ثبت تیکت مشکل خود را بیان کنید.
POST /miando/api/v1/tickets
در این بخش سرویسهای ثبت مشتری، فیلدهای اختصاصی مشتری، مشاهده لیست مشتریان، ویرایش اطلاعات مشتری، حذف مشتری و مشاهده اطلاعات یک مشتری ارائه میشوند.
GET /v2/business/:business/customers
POST /v2/business/:business/customers
PUT /v2/business/:business/customers/:customer
DELETE /v2/business/:business/customers/:customer
GET /v2/business/:business/customers/:customer
با استفاده از این سرویس میتوانید فیلدهای اختصاصی برای کسب و کار ثبت نمایید.
GET /v2/business/business/customers/fields
POST /v2/business/:business/customers/fields
PUT /v2/business/:business/customers/fields/:field_id
DELETE /v2/business/:business/customers/fields/:field_id
GET /v2/business/:business/customers/fields/:field_id
در این بخش مدیریت کیف پول مشتریان که شامل واریز، برداشت و مشاهده موجودی کیف پول مشتری میباشد، صورت میگیرد.
GET /v2/business/:business/customers/:customer/wallet
POST /v2/business/:business/customers/:customer/wallet/deposit
POST /v2/business/:business/customers/:customer/wallet/withdraw
در این بخش اطلاعات تراکنشهای مشتریان قابل مشاهده میباشد.
POST /v2/business/:business/customers/:customer/transactions
POST /v3/business/:business/customers/:customer/ibans
GET /v3/business/:business/customers/:customer/ibans
DELETE /v3/business/:business/customers/:customer/ibans
POST /v3/business/:business/customers/:customer/ibans/:iban/inquiry
POST /v3/business/:business/customers/:customer/ibans/:iban/set-default
POST /v3/business/:business/customers/:customer/cards
GET /v3/business/:business/customers/:customer/cards
DELETE /v3/business/:business/customers/:customer/cards/:card
POST /v3/business/:business/customers/:customer/cards/:card/inquiry
POST /v3/business/:business/customers/:customer/cards/:card/set-default
POST /v3/business/:business/customers/:customer/cards/to-iban
این سرویس جهت احراز هویت طرفحسابهای پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان میتوانند اطلاعات هویتی مخاطبان خود را مورد سنجش قرار دهند.
در حال حاضر وب سرویس احراز هویت مخاطبین به دو دسته کلی تقصیم شده است:
برای احراز هویت مخاطبینی که از قبل توسط پذیرنده ثبت نام نشده اند وارد کردن اطلاعات مربوط به هر سرویس الزامی است.
POST /v3/business/:business/customers/:customer/authentication/kyc
POST /v3/business/:business/customers/authentication/kyc
POST /v3/business/:business/customers/:customer/authentication/shahkar
POST /v3/business/:business/customers/authentication/shahkar
این سرویس جهت گزارش گیری از طرفحسابهای پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان میتوانند گزارش های مربوط به مخاطبان خود را مشاهده کنند.
POST /v2/business/:customer/customers/:customer/logs
این سرویس جهت ایجاد شناسه واریز و انتصاب آن به طرفحسابهای پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان میتوانند به ازای هر مشتری یک شناسه واریز منحصر به فرد ایجاد کنند.
GET /v3/business/:business/customers/:customer/cash-in-code
سرویس استعلام مشتریان
POST /v3/business/:business/customers/inquiry/nid
POST /v3/business/:business/customers/inquiry/postal-code
POST /v3/business/:business/customers/national-code-iban-inquiry
POST /v3/business/:business/customers/match-mobile-card
از وبسرویس صورت حساب وندار جهت مشاهده موجودی کیف پول، گزارش تراکنش ها و تسویه انجام شده در وندار مورد استفاده قرار میگیرد
GET /v2/business/:business/balance
GET /v3/business/:business/transaction
با استفاده از این بخش میتوانید اطلاعات کسبوکار و لیست کاربران کسبوکار خود را مشاهده کنید.
GET /v2/business/:business
GET /v2/business/:business/iam
با استفاده از سرویس بازگشت وجه می توانید برای بازگرداندن مبلغ یک تراکنشِ موفقِ درگاه پرداخت، به شماره کارت پرداختکننده استفاده کنید.
POST /v3/business/:business/transaction/:transaction_id/refund
با استفاده از سرویس روند، میتوانید کارتهای بانکی با طرح و لوگوی اختصاصی کسبوکار خود برای کاربران صادر کنید و تمامی عملیات بانکی مانند انتقال وجه، پایا، ساتنا، دریافت موجودی، پیگیری تراکنشها و مشاهده صورتحساب را از طریق API انجام دهید.
قبل از فراخوانی سرویسهای روند، لازم است تنظیمات مربوط به کسبوکار شما تعریف شود.
POST /v1/business/:business/ravand/set-config
برای صدور کارت، باید لیستی از اطلاعاتی مانند استانها، شهرها، کد صنف، تحصیلات و مشاغل را دریافت کنید. با ارسال شناسههای مربوط به این اطلاعات، میتوانید جزئیات اطلاعات کاربران خود را بهروزرسانی کنید.
GET /v1/business/:business/ravand/provinces
GET /v1/business/:business/ravand/cities
GET /v1/business/:business/ravand/guilds
GET /v1/business/:business/ravand/educations
GET /v1/business/:business/ravand/occupations
برای صدور کارت، این سرویس ها باید فراخوانی شوند: ایجاد کارت، بهروزرسانی اطلاعات، آپلود مدارک هویتی، دریافت متن ویدیوی احراز هویت، نهاییسازی درخواست و پیگیری درخواست. با استفاده از این سرویسها میتوانید فرآیند صدور کارت را برای کاربران خود بهطور کامل انجام دهید
POST /v1/business/:business/ravand/provider/:provider/cardholder
PUT /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id
GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/video-caption
POST /v1/business/business/ravand/provider/:provider/cardholder/:cardholder_id/upload
POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/finalize
GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/inquiry
بعد از دریافت کارت فیزیکی، جهت فعالسازی کارت می توانید از این سرویس ها استفاده کنید.
POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/token
GET /v1/redirect/:token
بعد از فعالسازی کارت، جهت انجام عملیات بانکی می توانید از این سرویس ها استفاده کنید.
GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/accounts-info
POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/balance
GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/bank-statement
GET /v1/business/:business/ravand/reasons
POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer
POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer/retry-otp
POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer/confirm-otp