مقدمه

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

تسویه گروهی

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

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

POST https://batch.vandar.io/api/v2/business/:business/batches-settlement

GET https://batch.vandar.io/api/v2/business/:business/batches

GET https://batch.vandar.io/api/v2/business/:business/batch-settlements/:batch_id

تسویه در نوبت

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GET /v3/business/:business/cash-in/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

ایجاد مجوز

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

پارامترها

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 قرار دهید این مقدار از کاربر کسر می‌شود.

پاسخ ها

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 دریافتی از قسمت قبل را در انتهای آدرس می‌گذارید و کاربر در مرورگر به صفحه بانک منتقل می‌شود. کاربر پس از تایید مجوز در صفحه بانک، به آدرس بازگشتی‌ای که در مرحله ایجاد مجوز ارسال کرده‌اید هدایت خواهد شد.

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

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

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": "مجوز با موفقیت تایید شد."
}

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

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

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

این مقدار را در پارامتر id ارسال نمایید.

پارامترها

businessrequiredstring

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

authorization_idrequiredstring

شناسه مجوز یا توکن ایجاد شده در مرحله درخواست مجوز

پاسخ ها

statusinteger

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

messagestring

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

idinteger

شناسه مجوز

customer_uuidstring

شناسه مشتری

tokenstring

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

bank_codestring

کد بانک

callback_urlstring

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

countinteger

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

limitinteger

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

mobilestring

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

namestring

نام مشتری

emailstring

ایمیل مشتری

national_codestring

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

expiration_datestring

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

statusstring

PENDING_VERIFY مجوز در انتظار تایید است
ACTIVE مجوز فعال است
REVOKED مجوز لغو شده است
EXPIRED مجوز منقضی شده است
REVOKED_AUTO مجوز بصورت سیستمی لغو شده است در صورت عدم تایید مجوز تا ۲۰ دقیقه در صورتیکه کاربر از طریق بانک اقدام به لغو مجوز کند

payer_accountstring

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

created_atstring

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

revoked_atstring

زمان لغو مجوز

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

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/subscription/authorization/:authorization_id/search',
  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": {
    "authorizations": {
      "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": "09121234567",
      "name": "محمد مقصودی",
      "email": "customer.email@gmail.com",
      "national_code": "1234567890",
      "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
    }
  }
}

لیست مجوزها

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

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

پارامترها

businessrequiredstring

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

پاسخ ها

idinteger

شناسه مجوز

customer_uuidstring

شناسه مشتری

tokenstring

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

bank_codestring

کد بانک

callback_urlstring

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

countinteger

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

limitinteger

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

mobilestring

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

namestring

نام کاربر

emailstring

ایمیل کاربر

national_codestring

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

expiration_datestring

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

statusstring

PENDING_VERIFY مجوز در انتظار تایید است
ACTIVE مجوز فعال است
REVOKED مجوز لغو شده است
EXPIRED مجوز منقضی شده است
REVOKED_AUTO مجوز بصورت سیستمی لغو شده است در صورت عدم تایید مجوز تا ۲۰ دقیقه در صورتیکه کاربر از طریق بانک اقدام به لغو مجوز کند

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

PENDING_VERIFY مجوز در انتظار تایید است
ACTIVE مجوز فعال است
REVOKED مجوز لغو شده است
EXPIRED مجوز منقضی شده است
REVOKED_AUTO مجوز بصورت سیستمی لغو شده است در صورت عدم تایید مجوز تا ۲۰ دقیقه در صورتیکه کاربر از طریق بانک اقدام به لغو مجوز کند

countinteger

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

current_month_withdrawal_countinteger

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

PENDING تراکنش غیرآنی و در انتظار پرداخت است
INIT تراکنش به سمت بانک فرستاده شده است و هنوز تعیین وضعیت نشده است
DONE تراکنش موفق
REFUND تراکنش موفقی که به حساب کاربر برگشت خورده است

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، به آدرس بازگشتی‌ای که در مرحله ثبت درخواست مجوز ارسال کرده‌اید برگردانده می‌شود. شرح کد خطای دریافتی از جدول مقابل قابل دسترس است.

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

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

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

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

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

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

تسویه

تسویه گروهی

تسویه در نوبت

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

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

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

بانک‌ها

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

ایجاد مجوز

پارامترها

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

پاسخ ها

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

تایید مجوز

پارامترها

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

پارامترها

پاسخ ها

وضعیت‌ها

لیست مجوزها

پارامترها

پاسخ ها

وضعیت‌ها

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

پارامترها

پاسخ ها

وضعیت‌ها

وضعیت‌ها

لغو مجوز

پارامترها

پاسخ ها

خطاها

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

بازگشت وجه

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

مشتریان

معاملات

تیکت

مشتریان

فیلد اختصاصی

کیف پول

تراکنش‌ها

شبا

کارت

احراز هویت

گزارشات

شناسه واریز

استعلام ها

صورت حساب

کسب و کار

بازگشت وجه

روند

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

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

صدور کارت

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

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

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

عملیات کارت

عملیات بانکی