مقدمه

API های وندار بر اساس استاندارد REST ایجاد شده اند.

تمامی پاسخ API های ما بصورت JSON-encoded پاسخ داده خواهند شد.

بوسیله ارسال توکن در هر درخواست، احراز هویت نیز انجام می شود. (ممکن است در برخی از سرویس ها نحوه احراز هویت متفاوت باشد)

آیا این بخش مفید بود؟بلی خیر

https://api.vandar.io

احراز هویت

برای دریافت توکن و رفرش توکن اولیه مالک یا مدیر کسب و کار می تواند وارد داشبورد وندار شود و کسب و کار خود را انتخاب کند. و از منوی تنظیمات بخش تنظیمات مدیریت حساب، توکن ها را انتخاب کنید. و با زدن دکمه افزودن توکن جدید، و وارد کردن یک نام برای توکن و وارد کردن رمز عبور حساب کاربری خود یک توکن و رفرش توکن در یافت کنید.

از آنجاییکه عمر توکن ها محدود است و مقدار آن در فیلد expires_in (بر مبنای ثانیه) همراه توکن ارسال شده است،‌ باید قبل از منقضی شدن توکن با ارسال رفرش توکن، توکن جدید را دریافت کنید.

پارامترها

refreshtokenrequiredstring

مقداری که از فراخوانی متد قبل دریافت کرده‌اید

آیا این بخش مفید بود؟بلی خیر

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*******"
}

postman

جهت تست و توسعه سرویس‌ها از کالکشن پستمن وندار استفاده نمایید.

کلیه سرویس‌های وندار در کالکشن ارائه شده موجود می‌باشد، برای تست API ها کافیست نام انگلیسی کسب‌وکار خود را بجای پارامتر business و اکسس توکن دریافتی از وندار را در پارامتر access_token ارسال نمائید.

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

آیا این بخش مفید بود؟بلی خیر

vandar_postman_collection

خطاها

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.

درگاه پرداخت IPG

برای فروشگاه‌های اینترنتی که خدمات یا محصولاتی را در وب‌سـایت خود ارائه می‌کنند، از درگاه پرداخت وندار استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

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

ثبت درخواست تسویه

با استفاده از این سرویس می‌توانید درخواست تسویه خود را ثبت کنید

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

amountrequiredinteger

مبلغ تراکنش به تومان (بزرگتر یا مساوی 5000 و کوچکتر یا مساوی مبلغ کیف پول)

ibanrequiredstring

شماره شبا مقصد که قصد واریز وجه به آن را دارید

track_idrequiredstring

رشته پیگیری که به ازای هر درخواست تسویه بایستی یکتا باشد.
پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است

payment_numberoptionalinteger

شناسه واریز شماره ای اختیاری است

notify_urloptionalstring

آدرس وبهوکی که می‌توانید ارسال کنید تا از وضعیت نهایی این برداشت وجه مطلع شوید. در مواقع تست می‌توانید از وبسایت webhook.site استفاده کنید.

descriptionoptionalstring

ارسال توضیحات با محدودیت حداکثر 256 کاراکتر

sourceoptionalstring

در صورتی سرویس آوند برای شما فعال شده باشد در این بخش باید مقدار ACCOUNT ارسال گردد. و در صورتی که تسویه از کیف پول مد نظر باشد باید مقدار WALLET ارسال گردد. مقدار پیش فرض WALLET می باشد.

accountoptionalstring

در صورتی که سرویس آوند برای شما فعال شده باشد و مقدار source=ACCOUNT ارسال شده باشد. باید شماره شبای مبدا نیز در این بخش ارسال شود

is_instantoptionalboolean

اگر می‌خواهید درخواست ثبت تسویه در لحظه به بانک ارسال شود، مقدار true و در غیر این صورت مقدار false را ارسال کنید.

پاسخ ها

statusinteger

مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است

settlementarray

اطلاعات تسویه

idstring

شناسه یکتای تسویه

iban_idstring

شناسه یکتای شماره شبا

transaction_idinteger

شناسه یکتای تراکنش در وندار

amountinteger

مبلغ تسویه به ریال

amount_tomaninteger

مبلغ تسویه به تومان

wage_tomaninteger

کارمزد مبلغ تسویه به تومان

payment_numberinteger

شناسه پرداخت

statusstring

وضعیت تسویه

walletstring

مبلغ باقی مانده کیف پول بعد از تسویه

settlement_datestring

تاریخ انجام تسویه

settlement_timestring

زمان انجام تسویه

settlement_date_jalalistring

تاریخ شمسی انجام تسویه

settlement_done_time_predictionstring

زمان تخمینی واریز به حساب مقصد

predictionobject

تخمین زمان واریز

descriptionstring

توضیحات

receipt_urlstring

لینک رسید تسویه. در این لینک جزییات ثبت تسویه از جمله زمان ثبت تسویه، واریز کننده، دریافت کننده، زمان تخمینی واریز کد رهگیری و مبلغ و ... قابل مشاهده است

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/settlement/store',
  headers: {
    Authorization: 'Bearer token'
  },
  body: {
    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"
      }
    ]
  }
}

مشاهده لیست تسویه ها

در این بخش شما می‌توانید همه‌ی تسویه‌هایی را که تا به حال ثبت کرده‌اید، مشاهده نمایید.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

per_pageoptionalinteger

تعداد تراکنش های تسویه در هر صفحه را مشخص می‌کند

pageoptionalinteger

صفحه مورد نظر را مشخص می‌کند

پاسخ ها

statusinteger

مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است

walletinteger

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

blocked_amountinteger

مبلغی که به دستور احکام قضایی در حساب مسدود شده است.

deductible_amountinteger

مبلغ قابل برداشت امروز

currencystring

واحد پول

settlementsarray

لیست تسویه ها

idstring

شناسه تسویه

iban_idinteger

شناسه یکتای شماره شبا که برای پیگیری شبا در وندار مورد استفاده قرار می گیرد

gateway_transaction_idinteger

شناسه یکتای تسویه که برای پیگیری تسویه از وندار مورد استفاده قرار می‌گیرد.

amountinteger

مبلغ تسویه به تومان

payment_numberinteger

شناسه واریز ثبت شده در هنگام ثبت تسویه

statusstring

وضعیت تسویه

PENDING وقتی که تسویه به بانک فرستاده شده و در انتظار رسیدن به سیکل مورد نظر است
INIT وقتی که تسویه به بانک فرستاده می‌شود
DONE تسویه‌ای که با موفقیت انجام شده است
FAILED تسویه‌ای که با خطا مواجه شده است
CANCELED تسویه لغو شده است. لازم به ذکر است که امکان لغو تسویه در وضعیت تسویه‌ی آنی وجود ندارد

walletinteger

مبلغ کیف پول بعد از انجام این تسویه

settlement_datestring

تاریخ انجام تسویه به میلادی

descriptionstring

توضیحاتی که در هنگام ثبت تسویه ارسال شده است

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'GET',
  url: '/v2.1/business/:business/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
    }
  }
}

نمایش جزییات یک تسویه

در این بخش شما می‌توانید جزییات یک تسویه را مشاهده نمایید.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

settlement_idrequireduuid

آیدی تسویه ثبت شده

پاسخ ها

statusinteger

مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است

idstring

شناسه تسویه

iban_idinteger

شناسه یکتای شماره شبا که برای پیگیری شبا در وندار مورد استفاده قرار می گیرد

gateway_transaction_idinteger

شناسه یکتای تسویه که برای پیگیری تسویه از وندار مورد استفاده قرار می‌گیرد.

amountinteger

مبلغ تسویه به تومان

payment_numberinteger

شناسه واریز ثبت شده در هنگام ثبت تسویه

statusstring

وضعیت تسویه

PENDING وقتی که تسویه به بانک فرستاده شده و در انتظار رسیدن به سیکل مورد نظر است
INIT وقتی که تسویه به بانک فرستاده می‌شود
DONE تسویه‌ای که با موفقیت انجام شده است
FAILED تسویه‌ای که با خطا مواجه شده است
CANCELED تسویه لغو شده است. لازم به ذکر است که امکان لغو تسویه در وضعیت تسویه‌ی آنی وجود ندارد

walletinteger

مبلغ کیف پول بعد از انجام این تسویه

settlement_datestring

تاریخ انجام تسویه به میلادی

settlement_done_time_predictionstring

زمان تخمینی انجام تسویه

descriptionstring

توضیحاتی که در هنگام ثبت تسویه ارسال شده است

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'GET',
  url: '/v2.1/business/:business/settlement/:settlement_id',
  headers: {
    Authorization: 'Bearer token'
  }
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "status": 1,
  "data": {
    "settlement": {
      "id": "bcd614b0-7c0f-11ee-970d-f734b1e44174",
      "iban_id": 519883,
      "gateway_transaction_id": 169915889828,
      "amount": 100000,
      "payment_number": "123456",
      "status": "DONE",
      "wallet": 661965,
      "settlement_date": "2023-11-05",
      "settlement_done_time_prediction": "2023-11-06 03:45:00",
      "description": null
    }
  }
}

لغو یک تسویه

با استفاده از این سرویس، می‌توانید تسویه ثبت شده با وضعیت در حال انجام یا ناموفق را لغو کنید.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

transaction_idrequiredinteger

آی دی تراکنش تسویه ثبت شده

پاسخ ها

statusinteger

مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است

messagearray

درخواست تسویه شما از دستور پرداخت خارج شد و وجه تسویه به حساب شما برگشت داده شد

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'DELETE',
  url: '/v2.1/business/:business/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": "درخواست تسویه شما از دستور پرداخت خارج شد و وجه تسویه به حساب شما برگشت داده شد"
}

وضعیت سلامت بانک‌های سرویس تسویه

با استفاده از این آدرس ‌می‌توانید از وضعیت سلامت بانک‌های سرویس تسویه آنی مطلع شوید.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

has_abilityoptionalboolean

لیست بانک هایی که وندار سرویس تسویه آنی برای آنها ارائه می کند را نمایش می دهد.

is_healthyoptionalboolean

لیست بانک هایی که سرویس تسویه آنی آنها دارای صحت و سلامت هستند و امکان ثبت تسویه آنی برای آنها وجود دارد را نمایش می دهد.

is_activeoptionalboolean

لیست بانک هایی که از طریق ابزار تسویه آنی فعال کرده اید را نمایش می دهد.

پاسخ ها

namestring

نام بانک

codestring

کد بانک

limitobject

لیستی از محدودیت های ارائه سرویس

time_limitarray

لیستی از محدودیت های زمانی برای ارائه سرویس

start_timestring

زمان شروع محدودیت ارائه سرویس

end_timestring

زمان پایان محدودیت ارائه سرویس

amount_limitobject

محدودیت مبلغی استفاده از سرویس

totalinteger

مبلغ کلی محدودیت روزانه استفاده از سرویس (ریال)

usedinteger

مبلغ مصرف شده روز برای تسویه آنی (ریال)

remainedinteger

مبلغ باقی مانده برای استفاده از تسویه آنی (ریال)

is_activeboolean

وضعیت فعال بودن بانک

has_abilityboolean

وضعیت ارائه سرویس تسویه آنی برای بانک توسط وندار

is_healthyboolean

وضعیت سلامت ارائه سرویس تسویه آنی برای بانک

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/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/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

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

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

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

batch_idrequiredstring

شناسه یکتایی که برای ثبت هر تسویه گروهی ارسال می گردد. این مقدار از512 Hash اطلاعات آرایه ارسالی batches_settlement ایجاد می شود. نمونه از ساخت این مقدار را می توانید در نمونه کد زیر که به زبان php است مشاهده کنید.

ibanrequiredstring

شماره شبا مقصد که قصد واریز وجه به آن را دارید

track_idrequiredstring

رشته پیگیری که به ازای هر درخواست تسویه بایستی یکتا باشد. پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است

payment_numberoptionalinteger

شناسه واریز شماره ای اختیاری است

notify_urloptionalstring

بعد از مشخص شدن وضعیت تسویه این آدرس صدا زده می‌شود

descriptionoptionalstring

ارسال توضیحات با محدودیت حداکثر256 کاراکتر

is_instantoptionalboolean

اگر می‌خواهید درخواست ثبت تسویه در لحظه به بانک ارسال شود، مقدار true و در غیر این صورت مقدار false را ارسال کنید.

typeoptionalstring

اگر می خواهید تسویه خود به صورت آنی انجام شود، A2A و در غیر اینصورت مقدار ACH را می توانید ارسال کنید

پاسخ ها

batch_idstring

شناسه تسویه گروهی ثبت شده

statusobject

در این بخش جزییات کلی تسویه گروهی مشخص می شود.

total_countinteger

تعداد کل تسویه گروهی ثبت شده

init_countinteger

تعداد تسویه هایی که در حال ارسال هستند

submitted_countinteger

تعداد تسویه هایی که ارسال شده اند

failed_countinteger

تعداد تسویه هایی که با خطا مواجه شده اند

total_amountinteger

مبلغ کلی تسویه های گروهی

created_atinteger

تاریخ ایجاد تسویه گروهی (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
}

جزییات یک تسویه گروهی

در این بخش شما می‌توانید جزییات یک تسویه‌ ی گروهی و تسویه های ثبت شده در آن مشاهده نمایید.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

batch_idrequiredstring

شناسه تسویه گروهی ثبت شده

per_pageoptionalinteger

تعداد رکورد اطلاعاتی درخواست تسویه را مشخص می کند

pageoptionalinteger

صفحه مورد نظر را مشخص می‌کند

statusoptionalstring

INIT در حال ارسال
SUBMITTED ارسال شده
FAILED ناموفق

پاسخ ها

idstring

شناسه تسویه

track_idstring

شناسه یکتای ارسالی

payment_numberstring

شناسه پرداخت ارسالی

amountstring

مبلغ

ibanstring

شماره شبا

statusstring

در این بخش جزییات کلی تسویه گروهی مشخص می شود.

INIT در حال ارسال
SUBMITTED ارسال شده
FAILED ناموفق

transaction_idinteger

شناسه یکتای ونداری

error_messagestring

در صورت وضعیت خطا متن خطا در این پارامتر بر می گردد.

descriptionstring

در صورت ارسال توضیحات در هنگام ثبت تسویه گروهی این پارامتر بر می گردد.

آیا این بخش مفید بود؟بلی خیر

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
  }
}

لیست یک تسویه گروهی

در این بخش شما می‌توانید لیست تسویه‌های گروهی را که تا به حال ثبت کرده‌اید، مشاهده نمایید

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

پاسخ ها

batch_idstring

شناسه تسویه گروهی ثبت شده

statusobject

در این بخش جزییات کلی تسویه گروهی مشخص می شود.

total_countinteger

تعداد کل تسویه گروهی ثبت شده

init_countinteger

تعداد تسویه هایی که در حال ارسال هستند

submitted_countinteger

تعداد تسویه هایی که ارسال شده اند

failed_countinteger

تعداد تسویه هایی که با خطا مواجه شده اند

total_amountinteger

مبلغ کلی تسویه های گروهی

created_atinteger

تاریخ ایجاد تسویه گروهی (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/settlement/queued

GET /v3/business/:business/settlement/queued

GET /v3/business/:business/settlement/queued/:id

POST /v3/business/:business/settlement/queued/cancel

ثبت درخواست در نوبت

با استفاده از این سرویس می‌توانید درخواست تسویه در نویت خود را ثبت کنید

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

group_track_idrequiredstring

شناسه یکتایی که برای ثبت هر تسویه در نوبت ارسال می‌گردد. پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است.

settlementsrequiredarray

لیستی از تسویه‌های در نوبت

track_idrequiredstring

رشته پیگیری که به ازای هر درخواست تسویه بایستی یکتا باشد. پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است.

ibanrequiredstring

شماره شبا مقصد که قصد واریز وجه به آن را دارید

amountrequiredinteger

مبلغ جهت تسویه

typeoptionalstring

اگر می خواهید تسویه خود بصورت آنی انجام شود، AUTO و در غیر اینصورت مقدار ACH را می توانید ارسال کنید

payment_numberoptionalstring

شناسه واریز شماره‌ای اختیاری است

descriptionoptionalstring

ارسال توضیحات با محدودیت حداکثر256 کاراکتر

notify_urloptionalstring

بعد از مشخص شدن وضعیت تسویه این آدرس صدا زده می‌شود

پاسخ ها

idstring

شناسه تسویه در نوبت ثبت شده

track_idstring

شناسه یکتای ارسالی

IBANstring

شماره شبا

typestring

نوع تسویه (AUTO, ACH)

statusstring

وضعیت تسویه در نوبت.

PENDING در انتظار
DONE ارسال شده
CANCELED لغو شده

account_ownerarray

مشخصات صاحب شماره شبا

bank_codestring

شناسه بانک

descriptionstring

توضیحات تسویه در نوبت

notify_urlstring

ادرش وبهوک ارسالی

created_atinteger

تاریخ ایجاد تسویه در نوبت (timestamp)

canceled_atinteger

تاریخ لغو تسویه در نوبت (timestamp)

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/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"
}

لیست تسویه در نوبت

در این بخش شما می‌توانید لیست تسویه‌های در نوبت را که تا به حال ثبت کرده‌اید، مشاهده نمایید

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

pageoptionalinteger

صفحه مورد نظر را مشخص می‌کند

statusoptionalstring

PENDING در انتظار
CANCELED لغو شده

پاسخ ها

idstring

شناسه تسویه در نوبت ثبت شده

track_idstring

شناسه یکتای ارسالی

IBANstring

شماره شبا

typestring

نوع تسویه (A2A, ACH)

statusstring

وضعیت تسویه در نوبت.

PENDING در انتظار
DONE ارسال شده
CANCELED لغو شده

account_ownerarray

مشخصات صاحب شماره شبا

bank_codestring

شناسه بانک

descriptionstring

توضیحات تسویه در نوبت

notify_urlstring

ادرش وبهوک ارسالی

created_atinteger

تاریخ ایجاد تسویه در نوبت (timestamp)

canceled_atinteger

تاریخ لغو تسویه در نوبت (timestamp)

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/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": "&laquo; قبل",
        "active": false
      },
      {
        "url": "https://api.vandar.io/v1/settlement/group?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "بعد &raquo;",
        "active": false
      }
    ],
    "path": "https://api.vandar.io/v1/settlement/group",
    "per_page": 15,
    "to": 2,
    "total": 2
  },
  "message": "successful"
}

جزییات تسویه در نوبت

در این بخش شما می‌توانید جزییات یک تسویه‌‌ی در نوبت ثبت شده را مشاهده نمایید.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

queue_idrequiredstring

شناسه تسویه در نوبت ثبت شده

پاسخ ها

idstring

شناسه تسویه در نوبت ثبت شده

track_idstring

شناسه یکتای ارسالی

IBANstring

شماره شبا

typestring

نوع تسویه (A2A, ACH)

statusstring

وضعیت تسویه در نوبت.

PENDING در انتظار
DONE ارسال شده
CANCELED لغو شده

account_ownerarray

مشخصات صاحب شماره شبا

bank_codestring

شناسه بانک

descriptionstring

توضیحات تسویه در نوبت

notify_urlstring

ادرش وبهوک ارسالی

created_atinteger

تاریخ ایجاد تسویه در نوبت (timestamp)

canceled_atinteger

تاریخ لغو تسویه در نوبت (timestamp)

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'GET',
  url: 'https://api.vandar.io/v3/business/:business/settlement/queued/:queue_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
  }
}

کنسل کردن تسویه در نوبت

با استفاده از این سرویس می‌توانید درخواست تسویه‌های در نوبت خود را لغو کنید

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

idsrequiredarray

لیستی از شناسه‌های تسویه در نوبت

پاسخ ها

messagestring

پیام موفق یا ناموفق

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/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

واریز شناسه‌دار

«واریز شناسه‌دار»، سرویس مکمل سایر روش‌های پرداخت است که افراد و سازمان‌ها از آن استفاده می‌کنند. به کمک این سرویس، می‌توانید بدون محدودیت در شبکه بانکی، پرداخت و دریافت وجه داشته باشید. این سرویس به صورت پیشفرض برای همه کسب‌وکارهای فعال، قابل استفاده بوده و برای هر کسب‌وکار یک شناسه یکتا منحصر به فرد تخصیص می‌یابد. با استفاده از «واریز شناسه‌دار» این امکان وجود دارد که با واریز وجه از همه بانک‌هایی که در آن حساب دارید، موجودی «کیف پول وندار» خود را افزایش دهید.

آیا این بخش مفید بود؟بلی خیر

GET /v3/business/:business/cash-in/code

GET /v3/business/:business/cash-in/pic/transactions

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

بازگشت وجه

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

آیا این بخش مفید بود؟بلی خیر

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/nid-image

POST /v3/business/:business/customers/inquiry/fida

POST /v3/business/:business/customers/inquiry/postal-code

POST /v3/business/:business/customers/inquiry/company-information

POST /v3/business/:business/customers/inquiry/company-signature

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/card/activate/token

GET /v1/redirect/card/activate/:token

تغییر رمز اول کارت

بعد از فعالسازی کارت، جهت تغییر رمز اول کارت می توانید از این سرویس ها استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/card/change-pin/token

GET /v1/redirect/card/change-pin/:token

مسدود سازی کارت

بعد از فعالسازی کارت، در صورت نیاز به مسدود سازی کارت می توانید از این سرویس ها استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/card/block/token

GET /v1/redirect/card/block/:token

عملیات کارت

جهت انجام عملیات کارت می توانید از این سرویس ها استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/card/status?card_number=:card_number

عملیات بانکی

بعد از فعالسازی کارت، جهت انجام عملیات بانکی می توانید از این سرویس ها استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

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

مقدمه

احراز هویت

پارامترها

postman

خطاها

درگاه پرداخت IPG

تسویه

ثبت درخواست تسویه

پارامترها

پاسخ ها

مشاهده لیست تسویه ها

پارامترها

پاسخ ها

وضعیت های ممکن برای تسویه ها

نمایش جزییات یک تسویه

پارامترها

پاسخ ها

وضعیت های ممکن برای تسویه ها

لغو یک تسویه

پارامترها

پاسخ ها

وضعیت سلامت بانک‌های سرویس تسویه

پارامترها

پاسخ ها

تسویه گروهی

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

پارامترها

پاسخ ها

جزییات یک تسویه گروهی

پارامترها

وضعیت های تراکنش تسویه

پاسخ ها

وضعیت های تراکنش تسویه

لیست یک تسویه گروهی

پارامترها

پاسخ ها

تسویه در نوبت

ثبت درخواست در نوبت

پارامترها

پاسخ ها

وضعیت تسویه در نوبت

لیست تسویه در نوبت

پارامترها

وضعیت تسویه در نوبت

پاسخ ها

وضعیت تسویه در نوبت

جزییات تسویه در نوبت

پارامترها

پاسخ ها

وضعیت تسویه در نوبت

کنسل کردن تسویه در نوبت

پارامترها

پاسخ ها

ابزار واریز بانکی

واریز شناسه‌دار

پرداخت خودکار

بانک‌ها

مجوز پرداخت از حساب

پرداخت از حساب

بازگشت وجه

معامله امن «میاندو»

مشتریان

معاملات

تیکت

مشتریان

فیلد اختصاصی

کیف پول

تراکنش‌ها

شبا

کارت

احراز هویت

گزارشات

شناسه واریز

استعلام ها

صورت حساب

کسب و کار

بازگشت وجه

روند

تنظیمات کسب و کار

دریافت اطلاعات استاتیک