مقدمه

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

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

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

محدودیت های درخواست به API

برای متد POST در هر ۳ ثانیه ۳۰ درخواست

و برای باقی متد ها در هر ۳ ثانیه ۱۰۰ درخواست قابل پذیرش است.

توجه داشته باشید که در حال حاضر برخی از مسیرها با base url روبرو تعیین نشده است.

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

https://api.vandar.io

تمدید توکن

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

در حال حاضر عمر توکن‌ها ۵ روز و عمر رفرش توکن ۱۰ روز می‌باشد و لازم است قبل از منقضی شدن توکن اقدام به تمدید توکن نموده و توکن و رفرش توکن جدید را جایگزین نمایید.

پارامترها
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 ارسال نمائید.

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

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

خطاها

API های وندار از قواعد REST پیروی می‌کند.

بطور کلی در رنج 2xx پاسخ های موفق را دریافت می‌کنید.

رنج 4xx زمانی بوجود می‌آید که اطلاعات اشتباهی از سمت شما به API ها ارسال شده است.

خطاهایی در رنج 5xx نشان دهنده مشکلاتی از سمت API های وندار بوده که می توانید آن را با پشتیبانی مطرح کنید.

آیا این بخش مفید بود؟بلی خیر
HTTP STATUS CODE SUMMARY

200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
402 - Request FailedThe parameters were valid but the request failed.
403 - ForbiddenThe API key doesn't have permissions to perform the request.

کسب و کار

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

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

GET /v2/business/:business

GET /v2/business/:business/iam

صورت حساب

در این بخش می‌توانید سرویس‌های دریافت موجودی کیف پول کسب و کار در وندار و همچنین لیست تراکنش‌ها و تسویه‌های ثبت شده را مشاهده نمایید.

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

GET /v2/business/:business/balance

GET /v3/business/:business/transaction

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

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

نکته

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

قبل از شروع پیاده سازی بهتر است یک بار فرایند پرداخت را با هم مرور کنیم
  • مرحله اول: ارسال اطلاعات تراکنش و دریافت توکن پرداخت.
  • مرحله دوم: انتقال کاربر به صفحه پرداخت با توکنی که از مرحله اول دریافت کردید.
  • مرحله سوم (اختیاری): قبل از تایید تراکنش اطلاعات تراکنش را دریافت می‌کنید.
  • مرحله چهارم: بعد از فرایند پرداخت کاربر به آدرسی بازگشتی که در مرحله اول ارسال کردید، بر‌میگردد. و شما برای نهایی شدن تراکنش حتما باید متد وریفای تراکنش رو صدا بزنید. و نتیجه نهایی تراکنش را دریافت کنید. پایان تراکنش

این چهار مرحله کلی، مقدمه چند نکته مهم است که توجه شما را به این نکات جلب می‌کنم

همگام‌سازی آدرس درگاه پرداخت و callback_url

در مرحله اول، باید پارامتری به نام callback_url را همراه با درخواست خود ارسال کنید. توجه داشته باشید که از این پس، آدرس callback_url باید حتماً با دامنه‌ای که برای آن ترمینال شاپرکی دریافت کرده‌اید، مطابقت داشته باشد. به عنوان مثال، اگر دامنه ثبت‌شده در شاپرک vandar.io است، آدرس callback_url نیز باید یکی از مشتقات این دامنه باشد، مانند:

https://vandar.io/:path

https://subdomain.vandar.io/:path

همگام‌سازی آدرس درگاه پرداخت و HTTP Referer

یکی دیگر از موارد بسیار مهم زمانی است که کاربر شما به صفحه درگاه پرداخت منتقل می‌شود. در این انتقال، درخواست ریدایرکت به همراه هدر Referer ارسال می‌شود. از این پس، آدرس Referer باید دارای دو ویژگی زیر باشد:

پر بودن: هدر Referer نباید خالی باشد.

مطابقت با دامنه ترمینال شاپرکی: آدرس Referer باید با دامنه‌ای که ترمینال شاپرکی برای آن صادر شده است، همخوانی داشته باشد.

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

این ورژن آخرین ورژن درگاه پرداخت وندار است. ورژن های قدیمی وندار پابرجا است. اما با توجه به تغییرات انجام شده سرعت انجام تراکنش در این ورژن بالاتر است. و این ورژن قابلیت های درگاه پرداخت دومرحله ای و تک مرحله ای را همزمان داراست. به هیچ عنوان در ورودی و خروجی ها تغییر داده نشده است. پس فقط با تغییر آدرس می‌توانید به ورژن ۳ مهاجرت کنید.

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

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

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

بازگشت وجه

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

شرایط لازم برای بازگشت وجه
  • فعال بودن ابزار بازگشت وجه
  • موفق بودن تراکنش
  • داشتن موجودی کافی در کیف‌ پول
آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/transaction/:transaction_id/refund

تسویه

با استفاده از سرویس تسویه می‌توانید مبلغ موردنظر از کیف پول کسب و کار خود به مقصد شبای دلخواه (تمامی شباهای سامانه بانکی کشور) واریز نمائید.

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

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

تسویه گروهی

با استفاده از سرویس تسویه گروهی می‌توانید تسویه های خود به صورت دسته ای (گروهی) یکجا ثبت نمائید.

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

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

تسویه در نوبت

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

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

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

آوند

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

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

عملیات حساب

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

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

GET /v3/business/:business/settlement/account/:iban/last-balance

GET /v3/business/:business/settlement/account/statement

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

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

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

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

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

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

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

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

POST /v3/business/:business/cash-in/account/deposit

POST /v3/business/:business/cash-in/account/balance

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

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

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

بانک‌ها

لیست بانک‌های فعال دایرکت‌دبیت برای کسب‌وکار شما از طریق این سرویس قابل دسترس می‌باشد. همچنین امکان مدیریت بانک‌ها در داشبورد وندار، بخش پرداخت خودکار فراهم می‌باشد.

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

GET /v3/business/:business/subscription/banks/actives

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

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

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

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

ایجاد مجوز

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

پارامترها
businessrequiredstring

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

bank_coderequiredstring

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

mobilerequiredstring

شماره موبایل کاربر

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

callback_urlrequiredstring

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

countrequiredinteger

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

daily_countoptionalinteger

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

limitrequiredinteger

حداکثر مبلغ قابل برداشت به ازای هر تراکنش(واحد: ریال).

daily_limitoptionalinteger

حداکثر مبلغ قابل برداشت روزانه(واحد: ریال).

expiration_daterequiredstring

تاریخ انقضای مجوز. این تاریخ باید بزرگتر از تاریخ روز جاری باشد و به صورت میلادی وارد می‌شود.

پارامترهای بیشتر
national_codeoptionalstring

کدملی کاربر

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

nameoptionalstring

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

emailoptionalstring

ایمیل کاربر که بهتر است برای پیگیری‌های بعدی ارسال شود.

wage_typeoptionalstring

کارمزد تراکنش، که می‌تواند دو مقدار APPLICATION_USER یا APPLICATION_SELF باشد اگر این مقدار را برابر با APPLICATION_SELF قرار دهید کارمزد از شما کسر می‌شود و اگر برابر با APPLICATION_USER قرار دهید این مقدار از کاربر کسر می‌شود.

اگر مقدار wage_type در درخواست ارسال نشود این مقدار از بخش پرداخت خودکار -> جزییات که در پنل کاربری شما در وندار قرار گرفته است خوانده می‌‌شود. در نظر داشته باشید که اولویت با مقداری است که در درخواست ارسال کرده‌اید.

token دریافتی در این قسمت یکبار مصرف است و پس از ۲۰ دقیقه منقضی می‌شود.

پاسخ ها
statusinteger

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

messagestring

پیغام درخواست توکن با موفقیت ثبت شد.

tokenstring

توکن دریافتی جهت انتقال کاربر به صفحه بانک جهت احرازهویت حساب

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

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/subscription/authorization/store',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    bank_code: '062',
    mobile: '09123456789',
    callback_url: 'https://yourdomain.com',
    count: 1,
    limit: 1000,
    expiration_date: '2023-01-01',
    name: '',
    email: 'a@b.com',
    wage_type: 'APPLICATION_SELF'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "status": 1,
  "message": "درخواست توکن با موفقیت ثبت شد.",
  "result": {
    "authorization": {
      "token": "0cf235d0-d48b-11ea-86cd-298ec898a9bd"
    }
  }
}

انتقال کاربر به بانک

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


در صورتی که در ارتباط با بانک اختلال پیش آمده باشد پارامتر status با مقدار FAILED_TO_ACCESS_BANK به عنوان کوئری پارامتر به آدرس بازگشتی شما ارسال می‌شود.

بازگشت کاربر از بانک
کاربر از صفحه بانک، به آدرس برگشتی‌ای که در مرحله ایجاد مجوز ارسال کرده‌اید هدایت می‌شود.


در صورت اجازه‌ی دسترسی به حساب در صفحه‌ی بانک

https://yourdomain.com/callback?token=:token&authorization_id=:id&status=SUCCEED

در صورت عدم اجازه‌ی دسترسی به حساب در صفحه‌ی بانک یا بروز خطا

https://yourdomain.com/callback?token=:token&status=FAILED&error_code=21

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

var request = require('request')
var options = {
  method: 'GET',
  url: 'https://subscription.vandar.io/authorizations/:token'
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

تایید مجوز

درصورتی که کاربر اجازه دسترسی به مجوز را صادر کرده باشد، باید مجوز ایجاد شده را از طریق ارسال authorization_id تایید کنید. برای جلوگیری از تغییر وضعیت مجوزهای پیشین، تنها یک بار امکان تایید مجوز را دارید.

جهت جلوگیری از ایجاد مجوز رهاشده، مجوزهایی که پس از ۲۰ دقیقه تایید نشوند به شکل خودکار در وندار و در بانک لغو می‌شوند.

پارامترها
businessrequiredstring

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

authorization_idrequiredstring

شناسه مجوز

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

var request = require('request')
var options = {
  method: 'PATCH',
  url: '/v3/business/:business/subscription/authorization/:authorization_id/verify',
  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": "مجوز با موفقیت تایید شد."
}

لیست مجوزها

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

با ارسال پارامترهای mobile و status به عنوان کوئری پارامتر، امکان جستجو خواهید داشت

پارامترها
businessrequiredstring

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

پاسخ ها
idinteger

شناسه مجوز

customer_uuidstring

شناسه مشتری

tokenstring

توکنی که در مرحله اول برای انتقال کاربر به صفحه بانک دریافت کرده‌اید.

bank_codestring

کد بانک

callback_urlstring

آدرس بازگشتی‌

countinteger

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

limitinteger

حداکثر مبلغ قابل برداشت به ازای هر تراکنش(واحد: ریال)

mobilestring

شماره موبایل کاربر

namestring

نام کاربر

emailstring

ایمیل کاربر

national_codestring

کدملی کاربر در صورتی که بانک به وندار برگردانده باشد

expiration_datestring

تاریخ انقضای مجوز

statusstring
payer_accountstring

اطلاعات حساب مشتری

نکته

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

created_atstring

زمان ایجاد مجوز

revoked_atstring

زمان لغو مجوز

firststring

آدرس اولین صفحه

laststring

آدرس آخرین صفحه

prevstring

آدرس صفحه قبل

nextstring

آدرس صفحه بعد

current_pageinteger

آدرس همین صفحه

frominteger

شماره اولین آیتم که در این صفحه آمده است

last_pageinteger

تعداد کل صفحات

linksarray

آرایه ای قابل استفاده برای نمایش pagination

pathstring

آدرس خالص بدون صفحه بندی

per_pageinteger

تعداد آیتم در هر صفحه

tointeger

شماره آخرین آیتمی که در این صفحه آمده است

totalinteger

تعداد کل آیتم ها

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

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/subscription/authorization',
  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": "9f307e30-dc77-11ea-830e-7533ca1787c5",
      "customer_uuid": "b4d1e440-d426-11ea-a9d3-051cbf7b8f81",
      "token": "96ff2c90-d426-11ea-b499-6ddbc3441df4",
      "bank_code": "062",
      "callback_url": "https://yourdomain.com/callback",
      "count": 7,
      "limit": "10200",
      "mobile": "09129311989",
      "name": "محمد مقصودی",
      "email": "customer.email@gmail.com",
      "national_code": "2993968416",
      "expiration_date": "1400/04/04 14:47:09",
      "status": "ACTIVE",
      "payer_account": {
          "account_number": "0201794880100",
          "pan": "6362********9805"
      },
      "created_at": "1399/04/04 14:47:09",
      "revoked_at": null,
    },
    {
      "id": "9f307e30-dc77-11ea-830e-7533ca1787c5",
      "customer_uuid": "b4d1e440-d426-11ea-a9d3-051cbf7b8f81",
      "token": "96ff2c90-d426-11ea-b499-6ddbc3441df4",
      "bank_code": "062",
      "callback_url": "https://yourdomain.com/callback",
      "count": 7,
      "limit": "10200",
      "mobile": "09129311989",
      "name": "محمد مقصودی",
      "email": "customer.email@gmail.com",
      "national_code": "2993968416",
      "expiration_date": "1400/04/04 14:47:09",
      "status": "REVOKED",
      "payer_account": {
          "account_number": "0201794880100",
          "pan": "6362********9805"
      },
      "created_at": "1399/04/04 14:47:09",
      "revoked_at": "1399/05/04 14:47:09",
    },
    ...
  ],
  "links": {
    "first": "/v3/business/vandario/subscription/authorization?page=1",
    "last": "/v3/business/vandario/subscription/authorization?page=134",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 134,
    "links": [
      {
        "url": null,
        "label": "« قبلی",
        "active": false
      },
      {
        "url": "/v3/business/vandario/subscription/authorization?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "/v3/business/vandario/subscription/authorization?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "/v3/business/vandario/subscription/authorization?page=133",
        "label": "133",
        "active": false
      },
      {
        "url": "/v3/business/vandario/subscription/authorization?page=134",
        "label": "134",
        "active": false
      },
      {
        "url": "/v3/business/vandario/subscription/authorization?page=2",
        "label": "بعدی »",
        "active": false
      }
    ],
    "path": "/v3/business/vandario/subscription/authorization",
    "per_page": 20,
    "to": 20,
    "total": 2675
  }
}

گزارش محاسبات تجمیعی مجوز

جهت مشاهده گزارش محاسبات تجمیعی یک مجوز از این سرویس استفاده نمایید.

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

پارامترها
businessrequiredstring

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

authorization_idrequiredstring

شناسه مجوز

پاسخ ها
statusinteger

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

messagestring

گزارش محاسبات تجمیعی مجوز

authorization_idinteger

شناسه مجوز

statusstring
countinteger

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

current_month_withdrawal_countinteger

تعداد برداشت‌های ثبت شده در ماه جاری

نکته

برداشت‌های ثبت شده شامل وضعیت‌های زیر می‌باشد

current_day_withdrawal_countinteger

تعداد برداشت‌های ثبت شده در روز جاری

total_withdrawal_countinteger

تعداد کل برداشت‌های ثبت شده

current_month_remaining_countinteger

تعداد دفعات باقیمانده برداشت در ماه جاری

current_day_remaining_countinteger

تعداد دفعات باقیمانده برداشت در روز جاری

total_remaining_countinteger

تعداد دفعات باقیمانده برداشت تا پایان اعتبار مجوز

limitinteger

حداکثر مبلغ قابل برداشت به ازای هر تراکنش(واحد: ریال)

current_month_withdrawal_amountinteger

مجموع مبالغ برداشت‌های ثبت شده در ماه جاری

current_day_withdrawal_amountinteger

مجموع مبالغ برداشت‌های ثبت شده در روز جاری

total_withdrawal_amountinteger

مجموع کل مبالغ برداشت‌های ثبت شده

current_month_remaining_withdrawal_amountinteger

مجموع مبلغ باقیمانده برداشت در ماه جاری

current_day_remaining_withdrawal_amountinteger

مجموع مبلغ باقیمانده برداشت در روز جاری

total_remaining_withdrawal_amountinteger

مجموع مبلغ باقیمانده برداشت تا پایان اعتبار مجوز

created_atstring

زمان ایجاد مجوز

expiration_datestring

تاریخ انقضای مجوز

remaining_expirationstring

مدت زمان باقیمانده از اعتبار مجوز

نکته

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

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

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/subscription/authorization/:authorization_id/calculation',
  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": {
    "authorization_id": "42485636-f1c2-30d4-9046-ec5f01f56630",
    "status": "ACTIVE",
    "count": 4,
    "current_month_withdrawal_count": 1,
    "current_day_withdrawal_count": 1,
    "total_withdrawal_count": 1,
    "current_month_remaining_count": 3,
    "current_day_remaining_count": 1,
    "total_remaining_count": 67,
    "limit": 10000,
    "current_month_withdrawal_amount": 1000,
    "current_day_withdrawal_amount": 10000,
    "total_withdrawal_amount": 1000,
    "current_month_remaining_withdrawal_amount": 39000,
    "current_day_remaining_withdrawal_amount": 20000,
    "total_remaining_withdrawal_amount": 679000,
    "created_at": "1402/07/01 21:40:50",
    "expiration_date": "1403/11/01 00:00:00",
    "remaining_expiration": {
      "years": 1,
      "months": 3,
      "days": 14
    }
  }
}

لغو مجوز

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

پارامترها
businessrequiredstring

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

authorization_idrequiredstring

شناسه مجوز

پاسخ ها
statusinteger

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

messagestring

پیغام مجوز با موفقیت لغو گردید.

idstring

شناسه مجوز

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

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

{
  "status": 1,
  "message": "مجوز با موفقیت لغو گردید.",
  "result": {
    "authorization": {
      "id": "9f307e30-dc77-11ea-830e-7533ca1787c5"
    }
  }
}

خطاها

لیست خطاهای دریافتی ثبت مجوز پرداخت از حساب

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

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

error_codeerror_message
00خطای داخلی، به ما اطلاع داده‌شده‌است و در حال رفع آن هستیم
02انصراف کاربر از تایید مجوز
03خطای سرور سرویس دهنده
04انصراف کاربر از احراز هویت
05خطای سرویس دهنده
06کد ملی که برای صاحب شماره موبایل ثبت شده است، با کد ملی لاگین کننده در بانک مغایرت دارد
07ذخیره مشخصات مشتری با خطا مواجه شده است
08شماره حساب فعالی برای این کاربر یافت نشد
09دریافت اطلاعات حساب مشتری با خطا مواجه شده است
10مشتری مجوز فعالی در این بانک دارد
11تاریخ ورودی برای این مجوز نامعتبر است
12کاربر عضو همراه کارت نیست
13کاربر تاکنون در همراه کارت لاگین نکرده است
14کاربر عضو بلوبانک نیست
15درخواست مشابهی برای این کاربر در انتظار تعیین وضعیت است
17کاربر مجاز به انجام عملیات نیست
18سپرده متعلق به کاربر نیست یا عدم وجود حق برداشت
19شماره سپرده مورد نظر وجود ندارد
22بانک درخواست شده در لیست بانک های دردسترس وندار نیست
23اپلیکیشن مربوط به درخواست شما در وندار موجود نیست
24اپلیکیشن مربوط به درخواست شما در وندار فعال نیست
29صفحه مجوز منقضی شده است

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

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

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

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

بازگشت وجه

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

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

لیست بانک‌هایی که از این قابلیت پشتیبانی می‌کنند: بانک ملی، پست‌بانک‌ایران، اقتصادنوین، سامان، سرمایه، سینا، آینده، دی، ایران‌زمین، کشاورزی، فردابانک، مهرایران، پارسیان، تجارت

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

POST /v3/business/:business/subscription/refunds

GET /v3/business/:business/subscription/refunds/:refund_id

GET /v3/business/:business/subscription/refunds

مشتریان

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

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

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

فیلد اختصاصی

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

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

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

کیف پول

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

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

GET /v2/business/:business/customers/:customer/wallet

POST /v2/business/:business/customers/:customer/wallet/deposit

POST /v2/business/:business/customers/:customer/wallet/withdraw

تراکنش‌ها

در این بخش اطلاعات تراکنش‌های مشتریان قابل مشاهده می‌باشد.

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

POST /v2/business/:business/customers/:customer/transactions

احراز هویت

نکته

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

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

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

POST /v3/business/:business/customers/:customer/authentication/kyc

POST /v3/business/:business/customers/:customer/authentication/shahkar

شناسه واریز

این سرویس جهت ایجاد شناسه واریز و انتصاب آن به طرف‌حساب‌های پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان می‌توانند به ازای هر مشتری یک شناسه واریز منحصر به فرد ایجاد کنند.

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

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

شبا

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

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

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

کارت

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

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

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

گزارشات

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

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

GET /v2/business/:business/customers/:customer/logs

استعلام ها

سرویس های استعلامی

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

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

POST /v3/business/:business/customers/inquiry/kyc

POST /v3/business/:business/customers/inquiry/shahkar

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/inquiry/national-code-iban

POST /v3/business/:business/customers/inquiry/match-mobile-card

POST /v3/business/:business/customers/inquiry/iban

POST /v3/business/:business/customers/inquiry/card

روند

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

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

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

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

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

POST /v1/business/:business/ravand/set-config

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

برای صدور کارت، باید لیستی از اطلاعاتی مانند استان‌ها، شهرها، کد صنف، تحصیلات و مشاغل را دریافت کنید. با ارسال شناسه‌های مربوط به این اطلاعات، می‌توانید جزئیات اطلاعات کاربران خود را به‌روزرسانی کنید.

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

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

صدور کارت

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

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

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

فعالسازی کارت

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

عملیات کارت

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

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

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

عملیات بانکی

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

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

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

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer/inquiry

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer/inquiry/paya-satna