مقدمه

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

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

از طریق این سرویس می‌توانید شناسه واریز مختص کسب‌وکار خود را دریافت کنید

پارامترها

businessrequiredstring

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

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

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/cash-in/code',
  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": [
    {
      "code": "011100000000000",
      "bank": "ayandeh",
      "bank_code": "062",
      "bank_persian_name": "بانک آینده"
    }
  ]
}

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

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

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

ثبت مشتری حقیقی جدید

ثبت مشتری حقوقی جدید

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

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

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

احراز هویت وب‌هوک‌های دریافتی

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

نمونه هدر ارسالی:

"X-Signature": "nbSOn/WUA6lvhrkxv+QsTi9iCxhLskr8i4yz2rikj9I"

می‌توانید از نمونه کد بررسی این مقدار استفاده نمائید. در این قسمت شما نیاز است که با استفاده از داده دریافتی از سمت وندار با الگوریتم داده شده مقدار هش شده را بسازید و سپس با مقدار دریافتی از هدر بررسی کنید، درصورت برابر بودن این دو مقدار می‌توان نتیجه گرفت که هدر ارسالی هدر درست و معتبری است. جهت اعتبارسنجی یک (token)توکن از همکاران پشتیبانی وندار دریافت نمایید و در کلید هش قرار دهید.

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

$hmac_header = $_SERVER['X-Signature']

$data = file_get_contents('php://input')

$calculated_hmac = base64_encode(hash_hmac('sha256', $data, token, true))

if (hash_equals($hmac_header, $calculated_hmac)) {
  // Valid header
} else {
  // It's invalid
}

نمونه بادی ارسالی در وب‌هوک
{
  "created": 1625147852,
  "type": "hvt_created",
  "data": {
    "transaction_id": 1677854521,
    "transaction_uuid": "05bac628-fdf9-4d4b-af01-783af2051c05",
    "payment_number": "0077854521",
    "tracking_code": "05bac628-fdf9-4d4b-af01-783af2051c05",
    "ref_id": "140112011677854521",
    "amount": 10000,
    "wage": 1000,
    "payer": {
      "iban": ""
    },
    "transaction_at": "2023-12-01 22:00:00",
    "destination_account": "0203443585001",
    "destination_account_type": "VANDAR",
    "status": "transfer"
  }
}

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

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

پارامترها

businessrequiredstring

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

statusnullablestring

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

VERIFIED تراکنش های تایید شده(صرفا برای واریز های به حساب کسب و کار)
REFUND تراکنش های برگشت داده شده
TRANSFERRED تراکنش های منتقل شده به کیف پول
NEED_BUSINESS_CONFIRM تراکنش های منتظر تایید کسب و کار
INIT تراکنش های در حال تعیین وضعیت

amountnullableinteger

مبلغ تراکنش

payment_numbernullablestring

شناسه واریز

source_ibannullablestring

شماره شبای واریز کننده

destination_accountnullablestring

شماره حساب مقصد(میتواند شماره حساب کسب و کار یا شماره حساب وندار باشد)

bank_tracking_codenullablestring

شماره پیگری بانک(در صورت وجود و ارسال از سمت بانک)

transaction_at_startnullablestring

بازه تاریخ شروع تراکنش

transaction_at_endnullablestring

بازه تاریخ پایان تراکنش

پاسخ ها

idstring

شناسه یکتا

amountstring

مبلغ تراکنش

ibanstring

شماره شبا پرداخت‌کننده

iban_namestring

نام پرداخت‌کننده

transaction_atstring

تاریخ انجام تراکنش

cash_in_codestring

شناسه پرداخت

customer_idstring

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

customer_namestring

نام مشتری

destination_accountstring

شماره حساب مقصد

destination_account_typestring

نوع حساب مقصد

VANDAR واریز به حساب‌های وندار
BUSINESS واریز به حساب‌های کسب و کار

statusstring

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

VERIFIED تراکنش های تایید شده(صرفا برای واریز های به حساب کسب و کار)
REFUND تراکنش های برگشت داده شده
TRANSFERRED تراکنش های منتقل شده به کیف پول
NEED_BUSINESS_CONFIRM تراکنش های منتظر تایید کسب و کار
INIT تراکنش های در حال تعیین وضعیت

tracking_codestring

کد پیگیری سمت وندار

bank_tracking_codestring

کد پیگیری بانک

descriptionstring

توضیحات

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

var request = require('request')
var options = {
    method: 'GET',
    url: '/v3/business/:business/cash-in/pic/transactions',
    headers: {
        Accept: 'application/json',
        Authorization: 'Bearer token',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        status: 'VERIFIED',
        amount: 100000,
        payment_number: '12321'
        source_iban: 'IR120620000000100373537004'
        destination_account: '0203443585001'
        bank_tracking_code: '1234'
        transaction_at_start: '2024-10-10 00:00:00'
        transaction_at_end: '2024-10-11 00:00:00'
    })

}
request(options, function (error, response) {
    if (error) throw new Error(error)
    console.log(response.body)
})

{
  "status": 1,
  "message": "لیست پرداخت های مشکوک با موفقیت محاسبه شد.",
  "data": [
    {
      "id": 1,
      "amount": 10000,
      "iban": "IR120620000000100003530004",
      "iban_name": "محمد مقصودی",
      "transaction_at": "2024-01-01 23:00:00",
      "cash_in_code": "900000110000140",
      "customer_id": 1,
      "customer_name": "محمد مقصودی",
      "destination_account": "0203443585001",
      "destination_account_type": "VANDAR",
      "tracking_code": "9104-810-4564850-2-140308161129481047428127024480000",
      "bank_tracking_code": "0308160621971508",
      "status" : "INIT",
      "description": "انتقال وجه خدمات کاربر ثالث به سپرده 6118.350.2001.2 ش.پ 00001722063190806146-بانک سامان-172198-IR290560611828005573774001 __172198694634__-IR290560611828005573774001\n"
    }
  ],
  "meta": {
    "current_page": 1,
    "first_page_url": "http://api.vandar.local/v3/business/exir/cash-in/suspicious-payment?page=1",
    "from": null,
    "last_page": 1,
    "last_page_url": "http://api.vandar.local/v3/business/exir/cash-in/suspicious-payment?page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; قبل",
        "active": false
      },
      {
        "url": "http://api.vandar.local/v3/business/exir/cash-in/suspicious-payment?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "بعد &raquo;",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "http://api.vandar.local/v3/business/exir/cash-in/suspicious-payment",
    "per_page": 10,
    "prev_page_url": null,
    "to": null,
    "total": 0
  }
}

لیست تراکنش‌های مشکوک

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

پارامترها

businessrequiredstring

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

پاسخ ها

idstring

شناسه یکتا

amountstring

مبلغ تراکنش

ibanstring

شماره شبا پرداخت‌کننده

iban_namestring

نام پرداخت‌کننده

transaction_atstring

تاریخ انجام تراکنش

cash_in_codestring

شناسه پرداخت

customer_idstring

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

customer_namestring

نام مشتری

destination_accountstring

شماره حساب مقصد

destination_account_typestring

نوع حساب مقصد

VANDAR واریز به حساب‌های وندار
BUSINESS واریز به حساب‌های کسب و کار

statusstring

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

VERIFIED تراکنش های تایید شده(صرفا برای واریز های به حساب کسب و کار)
REFUND تراکنش های برگشت داده شده
TRANSFERRED تراکنش های منتقل شده به کیف پول
NEED_BUSINESS_CONFIRM تراکنش های منتظر تایید کسب و کار
INIT تراکنش های در حال تعیین وضعیت

tracking_codestring

کد پیگیری سمت وندار

bank_tracking_codestring

کد پیگیری بانک

descriptionstring

توضیحات

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

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/cash-in/suspicious-payment',
  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": "لیست پرداخت های مشکوک با موفقیت محاسبه شد.",
  "data": [
    {
      "id": 1,
      "amount": 10000,
      "iban": "IR120620000000100003530004",
      "iban_name": "محمد مقصودی",
      "transaction_at": "2024-01-01 23:00:00",
      "cash_in_code": "900000110000140",
      "customer_id": 1,
      "customer_name": "محمد مقصودی",
      "destination_account": "0203443585001",
      "destination_account_type": "VANDAR",
      "tracking_code": "9104-810-4564850-2-140308161129481047428127024480000",
      "bank_tracking_code": "0308160621971508",
      "status" : "NEED_BUSINESS_CONFIRM",
      "description": "انتقال وجه خدمات کاربر ثالث به سپرده 6118.350.2001.2 ش.پ 00001722063190806146-بانک سامان-172198-IR290560611828005573774001 __172198694634__-IR290560611828005573774001\n"
    }
  ],
  "meta": {
    "current_page": 1,
    "first_page_url": "http://api.vandar.local/v3/business/exir/cash-in/suspicious-payment?page=1",
    "from": null,
    "last_page": 1,
    "last_page_url": "http://api.vandar.local/v3/business/exir/cash-in/suspicious-payment?page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; قبل",
        "active": false
      },
      {
        "url": "http://api.vandar.local/v3/business/exir/cash-in/suspicious-payment?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "بعد &raquo;",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "http://api.vandar.local/v3/business/exir/cash-in/suspicious-payment",
    "per_page": 10,
    "prev_page_url": null,
    "to": null,
    "total": 0
  }
}

تایید یا رد تراکنش مشکوک

از طریق این سرویس می‌توانید تراکنش مشکوک را تایید یا رد نمایید.

پارامترها

businessrequiredstring

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

idrequiredstring

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

statusrequiredstring

وضعیت تایید یا رد

READY_TO_TRANSFER تایید تراکنش
READY_TO_REFUND رد تراکنش

saverequired_if status=READY_TO_TRANSFERboolean

در صورتیکه تراکنش را تایید کنید با ارسال مقدار true در این پارامتر شماره شبا به حساب‌های تایید شده مشتری اضافه می‌شود

پاسخ ها

statusboolean

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

payment_statusboolean

وضعیت تایید یا رد تراکنش

transferred تراکنش موفق
transfer_in_progress تراکنش در حال انجام
refunded بازگشت وجه موفق
refund_in_progress بازگشت وجه در حال انجام

messagestring

پیام تایید یا رد تراکنش

alert_messagestring

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

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

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/cash-in/suspicious-payment/:id',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    status: 'READY_TO_TRANSFER',
    save: true
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "status": 1,
  "payment_status": "transferred",
  "message": "تراکنش واریز تایید و به لیست واریز و برداشت اضافه شد.",
  "alert_message": null
}

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

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

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

بانک‌ها

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

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

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

تسویه

تسویه گروهی

تسویه در نوبت

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

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

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

پارامترها

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

احراز هویت وب‌هوک‌های دریافتی

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

پارامترها

پاسخ ها

نوع‌ها

وضعیت ها

لیست تراکنش‌های مشکوک

پارامترها

پاسخ ها

نوع‌ها

وضعیت ها

تایید یا رد تراکنش مشکوک

پارامترها

وضعیت‌ها

پاسخ ها

وضعیت‌ها

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

بانک‌ها

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

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

بازگشت وجه

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

مشتریان

معاملات

تیکت

مشتریان

فیلد اختصاصی

کیف پول

تراکنش‌ها

شبا

کارت

احراز هویت

گزارشات

شناسه واریز

استعلام ها

صورت حساب

کسب و کار

بازگشت وجه

روند

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

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

صدور کارت

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

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

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

عملیات کارت

عملیات بانکی