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 های وندار از قواعد 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/v3/send
GET https://ipg.vandar.io/v3/:token
POST https://ipg.vandar.io/api/v3/transaction
POST https://ipg.vandar.io/api/v3/verify
با استفاده از سرویس تسویه میتوانید مبلغ موردنظر از کیف پول کسب و کار خود به مقصد شبای دلخواه (تمامی شباهای سامانه بانکی کشور) واریز نمائید.
POST /v3/business/:business/settlement/store
GET /v2.1/business/:business/settlement
DELETE /v2.1/business/:business/settlement/:transaction_id
GET /v3/business/:business/settlement/banks
با استفاده از این سرویس میتوانید درخواست تسویه خود را ثبت کنید
مبلغ تراکنش به تومان (بزرگتر یا مساوی 5000 و کوچکتر یا مساوی مبلغ کیف پول)
شماره شبا مقصد که قصد واریز وجه به آن را دارید
رشته پیگیری که به ازای هر درخواست تسویه بایستی یکتا باشد.
پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است
شناسه واریز شماره ای اختیاری است
آدرس وبهوکی که میتوانید ارسال کنید تا از وضعیت نهایی این برداشت وجه مطلع شوید. در مواقع تست میتوانید از وبسایت webhook.site استفاده کنید.
ارسال توضیحات با محدودیت حداکثر 256 کاراکتر
اگر میخواهید درخواست ثبت تسویه در لحظه به بانک ارسال شود، مقدار true و در غیر این صورت مقدار false را ارسال کنید.
اگر می خواهید تسویه خود به صورت حساب به حساب انجام شود، A2A (حساب به حساب) و در غیر اینصورت مقدار ACH (پایا) را می توانید ارسال کنید
مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
اطلاعات تسویه
شناسه یکتای تسویه
شناسه یکتای شماره شبا
شناسه یکتای تراکنش در وندار
مبلغ تسویه به ریال
مبلغ تسویه به تومان
کارمزد مبلغ تسویه به تومان
شناسه پرداخت
وضعیت تسویه
مبلغ باقی مانده کیف پول بعد از تسویه
تاریخ انجام تسویه
زمان انجام تسویه
تاریخ شمسی انجام تسویه
زمان تخمینی واریز به حساب مقصد
تخمین زمان واریز
توضیحات
لینک رسید تسویه. در این لینک جزییات ثبت تسویه از جمله زمان ثبت تسویه، واریز کننده، دریافت کننده، زمان تخمینی واریز کد رهگیری و مبلغ و ... قابل مشاهده است
نحوه انجام تسویه به صورت پایا(ACH) و یا حساب به حساب(A2A) است که بر اساس type ارسالی در درخواست، مشخص می شود
var request = require('request')
var options = {
method: 'POST',
url: '/v3/business/:business_name/settlement/store',
headers: {
Authorization: 'Bearer :token'
},
formData: {
amount: '5000',
iban: 'IR260620000000203443585001',
track_id: '7d274f0b-a6b0-4088-9ce6-00085596a792',
type: 'A2A',
is_instant: 1,
notify_url: 'https://webhook.site/e59952dc-c2ad-4355-b90d-ef1814ffb431',
payment_number: '123321000',
description: 'توضیحات تسویه حساب وندار'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"status": 1,
"data": {
"settlement": [
{
"id": "406f20de-397a-11ec-bf52-6b667e3feg6ba",
"iban_id": "ol3510a0-f998-1heb-8c11-2jd425426e06",
"transaction_id": 163559577610,
"amount": 50000,
"amount_toman": 5000,
"wage_toman": 0,
"payment_number": null,
"status": "PENDING",
"wallet": "221500",
"description": "تسویه حساب وندار",
"settlement_date": "2021-10-30",
"settlement_time": "15:39:36",
"settlement_date_jalali": "1400/08/08",
"settlement_done_time_prediction": "1400/08/08 16:00:00",
"is_instant": false,
"prediction": {
"date": "1400/8/8",
"time": "16:00:00",
"extra": "امروز"
},
"receipt_url": "https://vand.ar/Mcz6C",
"type": "A2A"
}
]
}
}
در این بخش شما میتوانید همهی تسویههایی را که تا به حال ثبت کردهاید، مشاهده نمایید.
نام انگلیسی کسب و کار
تعداد تراکنش های تسویه در هر صفحه را مشخص میکند
صفحه مورد نظر را مشخص میکند
مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
مبلغ کیف پول کاربر به تومان
مبلغی که به دستور احکام قضایی در حساب مسدود شده است.
مبلغ قابل برداشت امروز
واحد پول
لیست تسویه ها
شناسه تسویه
شناسه یکتای شماره شبا که برای پیگیری شبا در وندار مورد استفاده قرار می گیرد
شناسه یکتای تسویه که برای پیگیری تسویه از وندار مورد استفاده قرار میگیرد.
مبلغ تسویه به تومان
شناسه واریز ثبت شده در هنگام ثبت تسویه
وضعیت تسویه
PENDING
|
INIT
|
DONE
|
FAILED
|
CANCELED
|
مبلغ کیف پول بعد از انجام این تسویه
تاریخ انجام تسویه به میلادی
توضیحاتی که در هنگام ثبت تسویه ارسال شده است
var request = require('request')
var options = {
method: 'GET',
url: '/v2.1/business/:business_name/settlement',
headers: {
Authorization: 'Bearer :token'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"status": 1,
"data": {
"wallet": 26099,
"blocked_amount": 0,
"deductible_amount": 26099,
"currency": "Toman",
"settlements": {
"data": [
{
"id": "8edaa0a0-a33f-11ea-838d-676dce32760e",
"iban_id": 22822,
"gateway_transaction_id": 159024236678,
"amount": 100000,
"payment_number": null,
"status": "CANCELED",
"wallet": 160985,
"settlement_date": "2020-05-31",
"description": "توضیحات"
},
{
"id": "807003f0-8398-11ea-a42b-ede62b9de0c1",
"iban_id": 902,
"gateway_transaction_id": 158745010355,
"amount": 50000,
"payment_number": null,
"status": "DONE",
"wallet": 99485,
"settlement_date": "2020-04-21",
"description": "توضیحات"
},
{
"id": "010a7850-82ff-11ea-85bd-49ef214903e3",
"iban_id": 902,
"gateway_transaction_id": 158738422601,
"amount": 68000000,
"payment_number": null,
"status": "DONE",
"wallet": 126485,
"settlement_date": "2020-04-21",
"description": "توضیحات"
},
{
"id": "53665740-82cf-11ea-baf3-95ebee6a9eca",
"iban_id": 26,
"gateway_transaction_id": 158736374134,
"amount": 15000000,
"payment_number": null,
"status": "CANCELED",
"wallet": 43126485,
"settlement_date": "2020-04-21",
"description": "توضیحات"
},
{
"id": "456afdb0-82cf-11ea-8e13-3183b5b1630b",
"iban_id": 7215,
"gateway_transaction_id": 158736367341,
"amount": 5000000,
"payment_number": null,
"status": "CANCELED",
"wallet": 58126485,
"settlement_date": "2020-04-21",
"description": "توضیحات"
}
],
"first": "/v2.1/business/:business/settlement?page=1",
"last": "/v2.1/business/:business/settlement?page=19",
"prev": null,
"next": "/v2.1/business/:business/settlement?page=2",
"current_page": 1,
"from": 1,
"last_page": 19,
"path": "/v2.1/business/:business/settlement",
"per_page": 5,
"to": 5,
"total": 93
}
}
}
با استفاده از این سرویس، میتوانید تسویه ثبت شده با وضعیت در حال انجام یا ناموفق را لغو کنید.
نام انگلیسی کسب و کار
آی دی تراکنش تسویه ثبت شده
مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
درخواست تسویه شما از دستور پرداخت خارج شد و وجه تسویه به حساب شما برگشت داده شد
var request = require('request')
var options = {
method: 'DELETE',
url: '/v2.1/business/:business_name/settlement/:transaction_id',
headers: {
Authorization: 'Bearer :token'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"status": 1,
"message": "درخواست تسویه شما از دستور پرداخت خارج شد و وجه تسویه به حساب شما برگشت داده شد"
}
ParameterItem این آدرس میتوانید از وضعیت سلامت بانکهای سرویس تسویه مطلع شوید.
نام انگلیسی کسب و کار
لیست بانک هایی که وندار سرویس انتقال حساب به حساب برای آنها ارائه می کند را نمایش می دهد.
لیست بانک هایی که سرویس انتقال حساب به حساب آنها دارای صحت و سلامت هستند و امکان ثبت تسویه حساب به حساب برای آنها وجود دارد را نمایش می دهد.
لیست بانک هایی که ParameterItem ابزار حساب به حساب فعال کرده اید را نمایش می دهد.
نام بانک
کد بانک
اطلاعات بیشتر
لیستی از محدودیت های ارائه سرویس
لیستی از محدودیت های زمانی برای ارائه سرویس
زمان شروع محدودیت ارائه سرویس
زمان پایان محدودیت ارائه سرویس
محدودیت مبلغی استفاده از سرویس
مبلغ کلی محدودیت روزانه استفاده از سرویس (ریال)
مبلغ مصرف شده ParameterItem روز برای انتقال حساب به حساب (ریال)
مبلغ باقی مانده برای استفاده از انتقال حساب به حساب (ریال)
وضعیت فعال بودن بانک ParameterItem ابزار حساب به حساب
وضعیت ارائه سرویس حساب به حساب برای بانک توسط وندار
وضعیت سلامت ارائه سرویس حساب به حساب برای بانک
var request = require('request')
var options = {
method: 'GET',
url: '/v3/business/:business_name/settlement/banks',
headers: {
Authorization: 'Bearer :token'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"message": "وضعیت بانکها در حال حاضر به این صورت است.",
"data": [
{
"name": "بانک مرکزی",
"code": "010",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "صنعت و معدن",
"code": "011",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "ملت",
"code": "012",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 10000000,
"used": 0,
"remained": 10000000
}
},
"is_active": true,
"has_ability": true,
"is_healthy": true
}
},
{
"name": "رفاه",
"code": "013",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "مسکن",
"code": "014",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "سپه",
"code": "015",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "کشاورزی",
"code": "016",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "ملی",
"code": "017",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 235000,
"used": 0,
"remained": 235000
}
},
"is_active": true,
"has_ability": true,
"is_healthy": true
}
},
{
"name": "تجارت",
"code": "018",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "صادرات",
"code": "019",
"a2a": {
"limit": {
"time_limit": [
{
"start_time": "23:30",
"end_time": "06:00"
}
],
"amount_limit": {
"total": 25000000,
"used": 0,
"remained": 25000000
}
},
"is_active": true,
"has_ability": true,
"is_healthy": true
}
},
{
"name": "توسعه صادرات",
"code": "020",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "پست بانک",
"code": "021",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "توسعه تعاون",
"code": "022",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "اعتباری توسعه",
"code": "051",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "قوامین",
"code": "052",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "کارآفرین",
"code": "053",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "پارسیان",
"code": "054",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "اقتصاد نوین",
"code": "055",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "سامان",
"code": "056",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "پاسارگاد",
"code": "057",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "سرمایه",
"code": "058",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "سینا",
"code": "059",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "شهر",
"code": "061",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "آینده",
"code": "062",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "انصار",
"code": "063",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "گردشگری",
"code": "064",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "حکمت ایرانیان",
"code": "065",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "دی",
"code": "066",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "ایران زمین",
"code": "069",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "رسالت",
"code": "070",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "ایران و ونزوئلا",
"code": "095",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "مهر ایران",
"code": "060",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "ملل",
"code": "075",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "نور",
"code": "080",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "کوثر",
"code": "073",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "خاورمیانه",
"code": "078",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
},
{
"name": "مهر اقتصاد",
"code": "079",
"a2a": {
"limit": {
"time_limit": [],
"amount_limit": {
"total": 0,
"used": 0,
"remained": 0
}
},
"is_active": false,
"has_ability": false,
"is_healthy": false
}
}
]
}
}
با استفاده از سرویس تسویه گروهی میتوانید تسویه های خود به صورت دسته ای (گروهی) یکجا ثبت نمائید.
POST https://batch.vandar.io/api/v2/business/:business_name/batches-settlement
GET https://batch.vandar.io/api/v2/business/:business_name/batches
GET https://batch.vandar.io/api/v2/business/:business_name/batch-settlements/:batch_id
با استفاده از این سرویس می توانید درخواست تسویه های گروهی خود را ثبت کنید
شناسه یکتایی که برای ثبت هر تسویه گروهی ارسال می گردد. این مقدار از512 Hash اطلاعات آرایه ارسالی batches_settlement ایجاد می شود. نمونه از ساخت این مقدار را می توانید در نمونه کد زیر که به زبان php است مشاهده کنید.
شماره شبا مقصد که قصد واریز وجه به آن را دارید
رشته پیگیری که به ازای هر درخواست تسویه بایستی یکتا باشد. پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است
شناسه واریز شماره ای اختیاری است
بعد از مشخص شدن وضعیت تسویه این آدرس صدا زده میشود
ارسال توضیحات با محدودیت حداکثر256 کاراکتر
اگر میخواهید درخواست ثبت تسویه در لحظه به بانک ارسال شود، مقدار true و در غیر این صورت مقدار false را ارسال کنید.
اگر می خواهید تسویه خود به صورت حساب به حساب انجام شود، A2A و در غیر اینصورت مقدار ACH را می توانید ارسال کنید
شناسه تسویه گروهی ثبت شده
در این بخش جزییات کلی تسویه گروهی مشخص می شود.
تعداد کل تسویه گروهی ثبت شده
تعداد تسویه هایی که در حال ارسال هستند
تعداد تسویه هایی که ارسال شده اند
تعداد تسویه هایی که با خطا مواجه شده اند
مبلغ کلی تسویه های گروهی
تاریخ ایجاد تسویه گروهی (timestamp)
var request = require('request')
var options = {
method: 'POST',
url: 'https://batch.vandar.io/api/v2/business/:business/batches-settlement',
headers: {
Authorization: 'Bearer :token'
},
body: JSON.stringify({
batch_id:
'e94cf0682d8721dee87c9e50544a17c079a0efe1e9a2514d410a49883c82180c9967bfe9ca2afdc2fba60d57e42b87c630c3f9f73eb3edb1aaf3438b4bfe7d6f',
batches_settlement: [
{
track_id: 'c612c886-7215-416c-bb55-2cefcde40e7d',
iban: 'IR350700001000116383322001',
amount: 50000,
payment_number: 1,
description: 'test'
}
]
})
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"batch_id": "900e69c676f67008de9bed005a014fb6e604222bb5e824ab65fc4153757cb640",
"status": {
"total_count": 1,
"init_count": 0,
"submitted_count": 1,
"failed_count": 0
},
"total_amount": 50000,
"created_at": 1629672276
}
در این بخش شما میتوانید جزییات یک تسویه ی گروهی و تسویه های ثبت شده در آن مشاهده نمایید.
تعداد رکورد اطلاعاتی درخواست تسویه را مشخص می کند
صفحه مورد نظر را مشخص میکند
INIT
|
SUBMITTED
|
FAILED
|
شناسه تسویه
شناسه یکتای ارسالی
شناسه پرداخت ارسالی
مبلغ
شماره شبا
در این بخش جزییات کلی تسویه گروهی مشخص می شود.
INIT
|
SUBMITTED
|
FAILED
|
شناسه یکتای ونداری
در صورت وضعیت خطا متن خطا در این پارامتر بر می گردد.
در صورت ارسال توضیحات در هنگام ثبت تسویه گروهی این پارامتر بر می گردد.
var request = require('request')
var options = {
method: 'GET',
url: 'https://batch.vandar.io/api/v2/business/:business/batch-settlements/:batch_id',
headers: {
Authorization: 'Bearer :token'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"data": [
{
"id": "8736c960-039a-11ec-8171-334dd8b08284",
"track_id": "d18ca2e8-4204-11ec-81d3-0242ac130003",
"payment_number": "2",
"amount": "50000",
"iban": "IR150620000000203214109001",
"status": "SUBMITTED",
"transaction_id": 162967221235,
"error_message": null,
"description": null
}
],
"links": {
"first": "http://batch.vandar.io/api/v1/business/vandario/batch-settlements/900e69c676f67008de9bed005a014fb6e604222bb5e824ab65fc4153757cb640?page=1",
"last": "http://batch.vandar.io/api/v1/business/vandario/batch-settlements/900e69c676f67008de9bed005a014fb6e604222bb5e824ab65fc4153757cb640?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "http://batch.vandar.io/api/v1/business/vandario/batch-settlements/900e69c676f67008de9bed005a014fb6e604222bb5e824ab65fc4153757cb640",
"per_page": 10,
"to": 1,
"total": 1
}
}
در این بخش شما میتوانید لیست تسویههای گروهی را که تا به حال ثبت کردهاید، مشاهده نمایید
شناسه تسویه گروهی ثبت شده
در این بخش جزییات کلی تسویه گروهی مشخص می شود.
تعداد کل تسویه گروهی ثبت شده
تعداد تسویه هایی که در حال ارسال هستند
تعداد تسویه هایی که ارسال شده اند
تعداد تسویه هایی که با خطا مواجه شده اند
مبلغ کلی تسویه های گروهی
تاریخ ایجاد تسویه گروهی (timestamp)
var request = require('request')
var options = {
method: 'GET',
url: ' https://batch.vandar.io/api/v2/business/:business/batches?per_page=20&page=1&status=SUBMITTED',
headers: {
Authorization: 'Bearer :token'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"data": [
{
"batch_id": "900e69c676f67008de9bed005a014fb6e604222bb5e824ab65fc4153757cb640",
"status": {
"total_count": 1,
"init_count": 0,
"submitted_count": 1,
"failed_count": 0
},
"total_amount": 50000,
"created_at": 1629672276
}
],
"links": {
"first": "http://batch.vandar.io/api/v1/business/{business}/batches?page=1",
"last": "http://batch.vandar.io/api/v1/business/{business}/batches?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "http://batch.vandar.io/api/v1/business/{business}/batches",
"per_page": 10,
"to": 1,
"total": 1
}
}
با استفاده از سرویس تسویه در نوبت میتوانید هنگامی که کیف پول شما به اندازه کافی موجودی ندارد، تسویه های خود ثبت نمائید و پس از اینکه کیف پول شما افزایش پیدا کرد این تسویهها به بانک ارسال میشود.
POST /v3/business/:business_name/settlement/queued
GET /v3/business/:business_name/settlement/queued
GET /v3/business/:business_name/settlement/queued/:settlement_queued_id
POST /v3/business/:business_name/settlement/queued/cancel
با استفاده از این سرویس میتوانید درخواست تسویه در نویت خود را ثبت کنید
شناسه یکتایی که برای ثبت هر تسویه در نوبت ارسال میگردد. پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است.
لیستی از تسویههای در نوبت
رشته پیگیری که به ازای هر درخواست تسویه بایستی یکتا باشد. پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است.
شماره شبا مقصد که قصد واریز وجه به آن را دارید
مبلغ جهت تسویه
اگر می خواهید تسویه خود با الویت حساب به حساب انجام شود، AUTO و در غیر اینصورت مقدار ACH را می توانید ارسال کنید
شناسه واریز شمارهای اختیاری است
ارسال توضیحات با محدودیت حداکثر256 کاراکتر
بعد از مشخص شدن وضعیت تسویه این آدرس صدا زده میشود
شناسه تسویه در نوبت ثبت شده
شناسه یکتای ارسالی
شماره شبا
نوع تسویه (AUTO, ACH)
وضعیت تسویه در نوبت.
PENDING
|
DONE
|
CANCELED
|
مشخصات صاحب شماره شبا
شناسه بانک
توضیحات تسویه در نوبت
ادرش وبهوک ارسالی
تاریخ ایجاد تسویه در نوبت (timestamp)
تاریخ لغو تسویه در نوبت (timestamp)
var request = require('request')
var options = {
method: 'POST',
url: '/v3/business/:business_name/settlement/queued',
headers: {
Authorization: 'Bearer :token'
},
body: JSON.stringify({
"group_track_id": "fa4a8dfd-14bc-bbvv-98ce-137853ea1bvv",
"settlements": [
{
"track_id": "41a2f403-e27f-42a2-bec1-c2a7aa6da992",
"iban": "IR350700001000116383322001",
"amount": 150000,
"type": "A2A",
"payment_number": "5454887",
"description": "تسویه",
"notify_url": "https://example.com/notify_url"
}
]
})
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"data": [
{
"id": "fa4a8ae0-14bc-11ee-98ce-137853ea1c78",
"track_id": "41a2f403-e27f-42a2-bec1-c2a7aa6da992",
"amount": 150000,
"IBAN": "IR350700001000116383322001",
"type": "A2A",
"status": "PENDING",
"account_owner": [
{
"firstName": "مهدي",
"lastName": "آزادبر"
}
],
"bank_code": "056",
"description": "تسویه",
"payment_number": "5454887",
"notify_url": "https://example.com/notify_url",
"created_at": 1687851238,
"canceled_at": null
}
],
"message": "successful"
}
در این بخش شما میتوانید لیست تسویههای در نوبت را که تا به حال ثبت کردهاید، مشاهده نمایید
صفحه مورد نظر را مشخص میکند
PENDING
|
CANCELED
|
شناسه تسویه در نوبت ثبت شده
شناسه یکتای ارسالی
شماره شبا
نوع تسویه (A2A, ACH)
وضعیت تسویه در نوبت.
PENDING
|
DONE
|
CANCELED
|
مشخصات صاحب شماره شبا
شناسه بانک
توضیحات تسویه در نوبت
ادرش وبهوک ارسالی
تاریخ ایجاد تسویه در نوبت (timestamp)
تاریخ لغو تسویه در نوبت (timestamp)
var request = require('request')
var options = {
method: 'GET',
url: '/v3/business/:business_name/settlement/queued?page=1&status=PENDING',
headers: {
Authorization: 'Bearer :token'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"data": [
{
"id": "fa4a8ae0-14bc-11ee-98ce-137853ea1c78",
"track_id": "41a2f403-e27f-42a2-bec1-c2a7aa6da992",
"amount": 150000,
"IBAN": "IR350700001000116383322001",
"type": "A2A",
"status": "PENDING",
"account_owner": [
{
"firstName": "مهدي",
"lastName": "آزادبر"
}
],
"bank_code": "056",
"description": "تسویه",
"payment_number": "5454887",
"notify_url": "https://example.com/notify_url",
"created_at": 1687851238,
"canceled_at": null
},
{
"id": "1b6d7ef0-1287-11ee-8b19-370369bd4c23",
"track_id": "c9be7161-5852-4d3e-a03b-6499859a0e29",
"amount": 150000,
"IBAN": "IR350700001000116383322001",
"type": "A2A",
"status": "PENDING",
"account_owner": [
{
"firstName": "مهدي",
"lastName": "آزادبر"
}
],
"bank_code": "056",
"description": "تسویه",
"payment_number": null,
"notify_url": null,
"created_at": 1687608198,
"canceled_at": null
}
],
"links": {
"first": "https://api.vandar.io/v1/settlement/group?page=1",
"last": "https://api.vandar.io/v1/settlement/group?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« قبل",
"active": false
},
{
"url": "https://api.vandar.io/v1/settlement/group?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "بعد »",
"active": false
}
],
"path": "https://api.vandar.io/v1/settlement/group",
"per_page": 15,
"to": 2,
"total": 2
},
"message": "successful"
}
در این بخش شما میتوانید جزییات یک تسویهی در نوبت ثبت شده را مشاهده نمایید.
شناسه تسویه در نوبت ثبت شده
شناسه یکتای ارسالی
شماره شبا
نوع تسویه (A2A, ACH)
وضعیت تسویه در نوبت.
PENDING
|
DONE
|
CANCELED
|
مشخصات صاحب شماره شبا
شناسه بانک
توضیحات تسویه در نوبت
ادرش وبهوک ارسالی
تاریخ ایجاد تسویه در نوبت (timestamp)
تاریخ لغو تسویه در نوبت (timestamp)
var request = require('request')
var options = {
method: 'GET',
url: 'https://batch.vandar.io/api/v2/business/:business/batch-settlements/:batch_id',
headers: {
Authorization: 'Bearer :token'
}
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"message": "successful",
"data": {
"id": "fa4a8ae0-14bc-11ee-98ce-137853ea1c78",
"track_id": "41a2f403-e27f-42a2-bec1-c2a7aa6da992",
"amount": 150000,
"IBAN": "IR350700001000116383322001",
"type": "A2A",
"status": "PENDING",
"account_owner": [
{
"firstName": "مهدي",
"lastName": "آزادبر"
}
],
"bank_code": "056",
"description": "تسویه",
"payment_number": "5454887",
"notify_url": "https://example.com/notify_url",
"created_at": 1687851238,
"canceled_at": null
}
}
با استفاده از این سرویس میتوانید درخواست تسویههای در نوبت خود را لغو کنید
لیستی از شناسههای تسویه در نوبت
پیام موفق یا ناموفق
var request = require('request')
var options = {
method: 'POST',
url: '/v3/business/:business_name/settlement/queued/cancel',
headers: {
Authorization: 'Bearer :token'
},
body: JSON.stringify({
"ids": [
"b7c703d0-1285-11ee-a3d6-574a92d9641f",
"fa4a8ae0-14bc-11ee-98ce-137853ea1c78",
]
})
}
request(options, function (error, response) {
if (error) throw new Error(error)
console.log(response.body)
})
{
"message": "successful"
}
ابزار «واریز بانکی» یا به اصطلاح ،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
سرویس پرداخت خودکار یا دایرکت دبیت سرویسی است که یک فرد وجوهی را از حساب بانکی شخص دیگری خارج می کند در واقع شما به بانک اجازه می دهید که مبلغی را مستقیما از حسابتان کسر و در قبال آن خدماتی را به شما ارایه دهد. به طور کلی دایرکت دبیت برداشت مستقیم پول برای انجام معاملات مالی در صورت صدور مجوز توسط پرداخت کننده می باشد. این کار بیشتر زمانی انجام می شود که شما بخواهید اشتراک خود را تمدید کنید.
جهت دسترسی به حساب در سرویس پرداخت خودکار، نیاز به ایجاد یک مجوز در بانک وجود دارد. بر اساس این مجوز، کسبوکار شما اجازه برداشت از حساب کاربر را خواهد داشت.
POST /v3/business/:business/subscription/authorization/store
GET https://subscription.vandar.io/authorizations/:token
PATCH /v3/business/:business/subscription/authorization/:id/verify
GET /v3/business/:business/subscription/authorization
GET /v3/business/:business/subscription/authorization/:id
DELETE /v3/business/:business/subscription/authorization/:id
در این سرویس میتوانید از حساب کاربران خود یکبار یا به صورت دورهای بر اساس مجوزی که از کاربر گرفتهاید، وجهی را برداشت نمایید.
POST /v3/business/:business/subscription/withdrawal/store
GET /v3/business/:business/subscription/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/: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
در این بخش سرویسهای ثبت مشتری، فیلدهای اختصاصی مشتری، مشاهده لیست مشتریان، ویرایش اطلاعات مشتری، حذف مشتری و مشاهده اطلاعات یک مشتری ارائه میشوند.
GET /v2/business/:business/customers
POST /v2/business/:business/customers
PUT /v2/business/:business/customers/:customer_uuid
DELETE /v2/business/:business/customers/:customer_uuid
GET /v2/business/:business/customers/:customer_uuid
با استفاده از این سرویس میتوانید فیلدهای اختصاصی برای کسب و کار ثبت نمایید.
GET /v2/business/business/customers/fields
POST /v2/business/:business/customers/fields
PUT /v2/business/:business/customers/fields/:fields
DELETE /v2/business/:business/customers/fields/:fields
GET /v2/business/:business/customers/fields/:fields
در این بخش مدیریت کیف پول مشتریان که شامل واریز، برداشت و مشاهده موجودی کیف پول مشتری میباشد، صورت میگیرد.
GET /v2/business/:business/customers/:customer_uuid/wallet
POST /v2/business/:business/customers/:customer_uuid/wallet/deposit
POST /v2/business/:business/customers/:customer_uuid/wallet/withdraw
POST /v3/business/:business/customers/:customer_uuid/ibans
GET /v3/business/:business/customers/:customer_uuid/ibans
DELETE /v3/business/:business/customers/:customer_uuid/ibans
POST /v3/business/:business/customers/:customer_uuid/ibans/:iban/inquiry
POST /v3/business/:business/customers/:customer_uuid/ibans/:iban/set-default
POST /v3/business/:business/customers/:customer_uuid/cards/to-iban
POST /v3/business/:business/customers/:customer_uuid/cards
GET /v3/business/:business/customers/:customer_uuid/cards
DELETE /v3/business/:business/customers/:customer_uuid/cards/:card
POST /v3/business/:business/customers/:customer_uuid/cards/:card/inquiry
POST /v3/business/:business/customers/:customer_uuid/cards/:card/set-default
این سرویس جهت احراز هویت طرفحسابهای پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان میتوانند اطلاعات هویتی مخاطبان خود را مورد سنجش قرار دهند.
در حال حاضر وب سرویس احراز هویت مخاطبین به دو دسته کلی تقصیم شده است:
برای احراز هویت مخاطبینی که از قبل توسط پذیرنده ثبت نام نشده اند وارد کردن اطلاعات مربوط به هر سرویس الزامی است.
POST /v3/business/:business/customers/:customer_uuid/authentication/kyc
POST /v3/business/:business/customers/authentication/kyc
POST /v3/business/:business/customers/:customer_uuid/authentication/shahkar
POST /v3/business/:business/customers/authentication/shahkar
این سرویس جهت ایجاد شناسه پرداخت و انتصاب آن به طرفحسابهای پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان میتوانند به ازای هر مشتری یک شناسه پرداخت منحصر به فرد ایجاد کنند.
POST /v3/business/:business/customers/:customer_uuid/cash-in-code
GET /v3/business/:business/customers/:customer_uuid/cash-in-code
POST /v3/business/:business/customers/inquiry/kyc/face-recognition-by-image
POST /v3/business/:business/customers/inquiry/kyc/face-recognition-by-video
POST /v3/business/:business/customers/inquiry/kyc/face-match-with-national-card
POST /v3/business/:business/customers/inquiry/kyc/random-gesture
POST /v3/business/:business/customers/inquiry/kyc/ocr/national-card
POST /v3/business/:business/customers/inquiry/kyc/ocr/credit-card
POST /v3/business/:business/customers/inquiry/kyc/ocr/face-recognition
POST /v3/business/:business/customers/inquiry/kyc/ocr/civil-registration
POST /v3/business/:business/customers/inquiry/kyc/ocr/postal-code