مقدمه

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

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

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

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

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

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

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

vandar_postman_collection

خطاها

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

بطور کلی در رنج 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.

کسب و کار

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

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

GET /v2/business/:business

GET /v2/business/:business/iam

صورت حساب

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

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

GET /v2/business/:business/balance

GET /v3/business/:business/transaction

کیف پول

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

پارامترها

businessrequiredstring

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

پاسخ ها

statusinteger

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

walletinteger

مقدار موجودی کیف پول کسب و کار به تومان

wallet_without_payment_facilitator_walletinteger

مقدار موجودی کیف پول بدون موجودی غیرقابل برداشت پرداختیاری

payment_facilitator_walletinteger

مقدار موجودی غیرقابل برداشت پرداختیاری

currencystring

واحد پولی مقدار موجودی را مشخص می‌کند

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

var request = require('request')
var options = {
  method: 'GET',
  url: '/v2/business/:business/balance',
  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,
  "data": {
    "wallet": 22963,
    "wallet_without_payment_facilitator_wallet": 13183,
    "payment_facilitator_wallet": 9780,
    "currency": "Toman"
  }
}

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

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

پارامترها

businessrequiredstring

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

fromDateoptionalstring

شروع بازه زمانی با فرمت 14000102

toDateoptionalstring

پایان بازه زمانی با فرمت 14000201

statusKindoptionalstring

این پارامتر مشخص کننده نوع تراکنش می‌باشد

transactions واریز
settlements برداشت

statusoptionalstring

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

succeed وضعیت موفق
failed وضعیت نا‌موفق
pending وضعیت در حال انجام
canceled وضعیت لغو شده

channeloptionalstring

این پارامتر مشخص می‌کند که تراکنش از چه کانالی انجام شده است

ipg تراکنش های درگاه پرداخت
form تراکنش های فرم پرداخت
refund تراکنش های بازگشت وجه
subscription تراکنش های سرویس پرداخت خودکار
settlements تراکنش های تسویه و تسهیم
cash-in تراکنش های واریز بانکی
pos تراکنش های کارتخوان
shaparak_settlement تراکنش های تسویه شاپرک
cash-in-by-code تراکنش های واریز با شناسه

formIdoptionalstring

شناسه فرم پرداخت

ref_idoptionalstring

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

tracking_codeoptionalstring

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

idoptionalstring

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

track_idoptionalstring

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

factor_numberoptionalstring

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

per_pageoptionalstring

تعداد رکورد اطلاعاتی درخواست صورت حساب را مشخص می‌کند (حداکثر مقدار مجاز 100 می‌باشد)

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

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

orderoptionalstring

مشخص کننده ترتیب لیست تراکنش های خروجی. این مقدار به صورت پیش فرض DESC می باشد.

ASC ترتیب صعودی (تراکنش های قدیم به جدید)
DESC تر تیب نزولی (تراکنش های جدید به قدیمی)

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

محدوده ی جستجو

پاسخ ها

statusinteger

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

has_moreboolean

در صورتی عناصر بیشتری از مجموعه وجود دارد این مقدار برابر با true می باشد. در غیر اینصورت مقدار false برگشت داده می شود. در صورت true بودن می توانید از پارامتر ورودی start_after در ورودی استفاده کنید

idinteger

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

uuidstring

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

amountinteger

مبلغ کل تراکنش به تومان

wageinteger

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

statusinteger

نوع تراکنش را مشخص می‌کند

1 نشان دهنده تراکنش با وضعیت موفق
-1 نشان دهنده تراکنش با وضعیت ناموفق
2 نشان دهنده تسویه با وضعیت موفق
-2 نشان دهنده تسویه با وضعیت درحال انجام
3 نشان دهنده تراکنش با وضعیت درحال انجام
-3 نشان دهنده تسویه با وضعیت ناموفق
4 نشان دهنده تراکنش اصلاح شده می باشد
-4 نشان دهنده تسویه با وضعیت لغو شده
5 نشان دهنده تراکنش واریزی از نوع انتقال وجه داخلی
-5 نشان دهنده تراکنش خروجی از نوع انتقال وجه داخلی
6 نشان دهنده تراکنش نوع حق اشتراک
-6 نشان دهنده تسویه ای است که از سمت وندار یا بانک برگشت داده شده است
9 نشان دهنده نوع تراکنش کارمزد وندار

ref_idinteger

شناسه مرجع تراکنش یا تسویه

tracking_codeinteger

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

verifiedinteger

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

channelstring

توضیحات فارسی نوع تراکنش

payment_datestring

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

effective_time_stampinteger

مقدار timestamp تاریخ و زمان اتمام تراکنش

receipt_urlstring

لینک رسید برای تسویه های موفق

created_atstring

تاریخ و زمان شروع تراکنش

walletinteger

موجودی کیف پول بعد از تراکنش

resultstring

توضیحات تراکنش که از شرکت پرداخت برگشت داده می‌شود

descriptionstring

توضیحات تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است

factorNumberstring

شماره فاکتور تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است

mobilestring

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

callback_urlstring

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

form_titlestring

در صورت پرداخت از فرم پرداخت عنوان فرم نمایش داده می‌شود

settlementstring

portstring

پورت انجام تراکنش که در حال حاضر می تواند SAMAN و یا BEHPARDAKHT باشد

is_depositboolean

مشخص کننده نوع افزایشی یا کاهشی بودن تراکنش می باشد که مقدار true از نوع افزایشی و مقدار false از نوع کاهشی می باشد

payerjson

اطلاعات پرداخت کننده تراکنش را مشخص‌ می‌کند

ipstring

ip پرداخت کننده در زمان پرداخت را مشخص می‌کند

namestring

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

slugstring

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

avatarstring

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

emailstring

ایمیل پرداخت کننده را مشخص می‌کند

phonestring

شماره تماس پرداخت کننده را مشخص می‌کند

addressstring

آدرس پرداخت کننده را مشخص می‌کند

mobilestring

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

additional_fieldsjson

فیلد هایی که به صورت دلخواه به فرم اضافه کرده‌اید در این بخش نمایش داره می‌شود

descriptionstring

توضیحات پرداخت کننده را مشخص می‌کند

receiverjson

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

namestring

نام صاحب حساب که تسویه به آن صورت گرفته است

slugstring

درصورتی که تراکنش انتقال وحه داخلی باشد شناسه ونداری دریافت کننده مبلغ را نمایش می دهد

avatarstring

درصورتی که تراکنش انتقال وحه داخلی باشد عکس دریافت کننده مبلغ را نمایش می دهد

ibanstring

شماره شبا که تسویه به آن صورت گرفته است

bank_namestring

نام بانک شماره شبا که تسویه به آن صورت گرفته است

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

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/transaction',
  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,
  "has_more": true,
  "data": {
    "id": 165374316188,
    "uuid": "73b82710-de88-11ec-ae19-47c5d7c58ae4",
    "amount": 1650000,
    "wage": 0,
    "status": -1,
    "ref_id": null,
    "tracking_code": null,
    "card_number": null,
    "cid": null,
    "verified": 0,
    "channel": "پرداخت اینترنتی",
    "payment_date": null,
    "payment_number": null,
    "created_at": "17:46:57 - 1401/3/7",
    "updated_at": "17:46:58 - 1401/3/7",
    "wallet": 0,
    "result": null,
    "description": "خرید به شماره سفارش : 91 | محصولات - تست (165)",
    "factorNumber": null,
    "mobile": null,
    "callback_url": "http://wordpress.local/?wc-api=WC_Vandar&wc_order=91",
    "form_title": null,
    "settlement": null,
    "settlement_port": null,
    "comments": [],
    "api_token": "QRI4AZLY17SCG",
    "logs": {
      "transaction_id": 165374316188,
      "result_code": "-2",
      "result_message": "کاربر صفحه پرداخت را ترک کرده است.",
      "log_date": "1401-03-07 18:20:48",
      "group": "خطای کاربر"
    },
    "revised_transaction_id": null,
    "refund": null,
    "refund_detail_ids": [],
    "port": "SAMAN",
    "is_deposit": true,
    "payer": {
      "ip": "167.235.19.231",
      "iban": null,
      "name": null,
      "slug": null,
      "avatar": null,
      "legal_name": null,
      "business_owner": null,
      "email": null,
      "phone": null,
      "address": null,
      "mobile": null,
      "additional_fields": null,
      "description": "خرید به شماره سفارش : 91 | محصولات - تست (165)"
    },
    "receiver": {
      "name": null,
      "legal_name": null,
      "slug": null,
      "avatar": null,
      "business_owner": null,
      "iban": null,
      "bank_name": null
    },
    "receipt_url": null,
    "time_prediction": {
      "settlement_done_time_prediction": null,
      "settlement_cancelable_time": null,
      "is_settlement_paya_report_finally": null,
      "settlement_paya_report_finally_time": null,
      "is_after_time_prediction": null,
      "p2p_time_prediction": null
    }
  }
}

درگاه پرداخت 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/transaction/:transaction_id/refund

تسویه

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

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

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

آوند

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

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

عملیات حساب

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

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

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

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

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

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

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

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

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

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

مشتریان

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

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

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/authentication/kyc

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

شناسه واریز

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

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

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

شبا

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

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

گزارشات

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

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

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

استعلام ها

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

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

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 انجام دهید.

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

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

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

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

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

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

مقدمه

تمدید توکن

پارامترها

کالکشن Postman

خطاها

کسب و کار

صورت حساب

کیف پول

پارامترها

پاسخ ها

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

پارامترها

انواع مجاز

وضعیت‌های مجاز

کانال‌های مجاز

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

وضعیت‌های مجاز

پاسخ ها

موارد قابل انتخاب

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

بازگشت وجه

تسویه

تسویه گروهی

تسویه در نوبت

آوند

عملیات حساب

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

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

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

بانک‌ها

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

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

بازگشت وجه

مشتریان

فیلد اختصاصی

کیف پول

تراکنش‌ها

احراز هویت

شناسه واریز

شبا

کارت

گزارشات

استعلام ها

روند

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

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

صدور کارت

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

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

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

عملیات کارت

عملیات بانکی